// // Copyright 2017, Sander van Harmelen // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // package gitlab import ( "fmt" "net/url" ) // EnvironmentsService handles communication with the environment related methods // of the GitLab API. // // GitLab API docs: https://docs.gitlab.com/ce/api/environments.html type EnvironmentsService struct { client *Client } // Environment represents a GitLab environment. // // GitLab API docs: https://docs.gitlab.com/ce/api/environments.html type Environment struct { ID int `json:"id"` Name string `json:"name"` Slug string `json:"slug"` ExternalURL string `json:"external_url"` } func (env Environment) String() string { return Stringify(env) } // ListEnvironmentsOptions represents the available ListEnvironments() options. // // GitLab API docs: // https://docs.gitlab.com/ee/api/environments.html#list-environments type ListEnvironmentsOptions ListOptions // ListEnvironments gets a list of environments from a project, sorted by name // alphabetically. // // GitLab API docs: // https://docs.gitlab.com/ee/api/environments.html#list-environments func (s *EnvironmentsService) ListEnvironments(pid interface{}, opts *ListEnvironmentsOptions, options ...OptionFunc) ([]*Environment, *Response, error) { project, err := parseID(pid) if err != nil { return nil, nil, err } u := fmt.Sprintf("projects/%s/environments", url.QueryEscape(project)) req, err := s.client.NewRequest("GET", u, opts, options) if err != nil { return nil, nil, err } var envs []*Environment resp, err := s.client.Do(req, &envs) if err != nil { return nil, resp, err } return envs, resp, err } // CreateEnvironmentOptions represents the available CreateEnvironment() options. // // GitLab API docs: // https://docs.gitlab.com/ee/api/environments.html#create-a-new-environment type CreateEnvironmentOptions struct { Name *string `url:"name,omitempty" json:"name,omitempty"` ExternalURL *string `url:"external_url,omitempty" json:"external_url,omitempty"` } // CreateEnvironment adds a environment to a project. This is an idempotent // method and can be called multiple times with the same parameters. Createing // an environment that is already a environment does not affect the // existing environmentship. // // GitLab API docs: // https://docs.gitlab.com/ee/api/environments.html#create-a-new-environment func (s *EnvironmentsService) CreateEnvironment(pid interface{}, opt *CreateEnvironmentOptions, options ...OptionFunc) (*Environment, *Response, error) { project, err := parseID(pid) if err != nil { return nil, nil, err } u := fmt.Sprintf("projects/%s/environments", url.QueryEscape(project)) req, err := s.client.NewRequest("POST", u, opt, options) if err != nil { return nil, nil, err } env := new(Environment) resp, err := s.client.Do(req, env) if err != nil { return nil, resp, err } return env, resp, err } // EditEnvironmentOptions represents the available EditEnvironment() options. // // GitLab API docs: // https://docs.gitlab.com/ee/api/environments.html#edit-an-existing-environment type EditEnvironmentOptions struct { Name *string `url:"name,omitempty" json:"name,omitempty"` ExternalURL *string `url:"external_url,omitempty" json:"external_url,omitempty"` } // EditEnvironment updates a project team environment to a specified access level.. // // GitLab API docs: // https://docs.gitlab.com/ee/api/environments.html#edit-an-existing-environment func (s *EnvironmentsService) EditEnvironment(pid interface{}, environment int, opt *EditEnvironmentOptions, options ...OptionFunc) (*Environment, *Response, error) { project, err := parseID(pid) if err != nil { return nil, nil, err } u := fmt.Sprintf("projects/%s/environments/%d", url.QueryEscape(project), environment) req, err := s.client.NewRequest("PUT", u, opt, options) if err != nil { return nil, nil, err } env := new(Environment) resp, err := s.client.Do(req, env) if err != nil { return nil, resp, err } return env, resp, err } // DeleteEnvironment removes a environment from a project team. // // GitLab API docs: // https://docs.gitlab.com/ce/api/environments.html#remove-a-environment-from-a-group-or-project func (s *EnvironmentsService) DeleteEnvironment(pid interface{}, environment int, options ...OptionFunc) (*Response, error) { project, err := parseID(pid) if err != nil { return nil, err } u := fmt.Sprintf("projects/%s/environments/%d", url.QueryEscape(project), environment) req, err := s.client.NewRequest("DELETE", u, nil, options) if err != nil { return nil, err } return s.client.Do(req, nil) }