2020-04-19 11:44:11 -04:00
|
|
|
//
|
2021-02-16 22:47:24 -05:00
|
|
|
// Copyright 2021, Sander van Harmelen
|
2020-04-19 11:44:11 -04:00
|
|
|
//
|
|
|
|
// 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"
|
2021-02-16 22:47:24 -05:00
|
|
|
"net/http"
|
2020-04-19 11:44:11 -04:00
|
|
|
"time"
|
|
|
|
)
|
|
|
|
|
|
|
|
// DeploymentsService handles communication with the deployment related methods
|
|
|
|
// of the GitLab API.
|
|
|
|
//
|
|
|
|
// GitLab API docs: https://docs.gitlab.com/ce/api/deployments.html
|
|
|
|
type DeploymentsService struct {
|
|
|
|
client *Client
|
|
|
|
}
|
|
|
|
|
|
|
|
// Deployment represents the Gitlab deployment
|
|
|
|
type Deployment struct {
|
|
|
|
ID int `json:"id"`
|
|
|
|
IID int `json:"iid"`
|
|
|
|
Ref string `json:"ref"`
|
|
|
|
SHA string `json:"sha"`
|
2021-01-28 11:56:38 -05:00
|
|
|
Status string `json:"status"`
|
2020-04-19 11:44:11 -04:00
|
|
|
CreatedAt *time.Time `json:"created_at"`
|
2020-09-06 11:37:53 -04:00
|
|
|
UpdatedAt *time.Time `json:"updated_at"`
|
2020-04-19 11:44:11 -04:00
|
|
|
User *ProjectUser `json:"user"`
|
|
|
|
Environment *Environment `json:"environment"`
|
|
|
|
Deployable struct {
|
|
|
|
ID int `json:"id"`
|
|
|
|
Status string `json:"status"`
|
|
|
|
Stage string `json:"stage"`
|
|
|
|
Name string `json:"name"`
|
|
|
|
Ref string `json:"ref"`
|
|
|
|
Tag bool `json:"tag"`
|
|
|
|
Coverage float64 `json:"coverage"`
|
|
|
|
CreatedAt *time.Time `json:"created_at"`
|
|
|
|
StartedAt *time.Time `json:"started_at"`
|
|
|
|
FinishedAt *time.Time `json:"finished_at"`
|
|
|
|
Duration float64 `json:"duration"`
|
|
|
|
User *User `json:"user"`
|
|
|
|
Commit *Commit `json:"commit"`
|
|
|
|
Pipeline struct {
|
2021-01-28 11:56:38 -05:00
|
|
|
ID int `json:"id"`
|
|
|
|
SHA string `json:"sha"`
|
|
|
|
Ref string `json:"ref"`
|
|
|
|
Status string `json:"status"`
|
|
|
|
CreatedAt *time.Time `json:"created_at"`
|
|
|
|
UpdatedAt *time.Time `json:"updated_at"`
|
2020-04-19 11:44:11 -04:00
|
|
|
} `json:"pipeline"`
|
|
|
|
Runner *Runner `json:"runner"`
|
|
|
|
} `json:"deployable"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// ListProjectDeploymentsOptions represents the available ListProjectDeployments() options.
|
|
|
|
//
|
|
|
|
// GitLab API docs:
|
|
|
|
// https://docs.gitlab.com/ce/api/deployments.html#list-project-deployments
|
|
|
|
type ListProjectDeploymentsOptions struct {
|
|
|
|
ListOptions
|
2020-04-19 16:23:05 -04:00
|
|
|
OrderBy *string `url:"order_by,omitempty" json:"order_by,omitempty"`
|
|
|
|
Sort *string `url:"sort,omitempty" json:"sort,omitempty"`
|
|
|
|
UpdatedAfter *time.Time `url:"updated_after,omitempty" json:"updated_after,omitempty"`
|
2021-04-22 20:08:53 -04:00
|
|
|
UpdatedBefore *time.Time `url:"updated_before,omitempty" json:"updated_before,omitempty"`
|
2020-04-19 16:23:05 -04:00
|
|
|
Environment *string `url:"environment,omitempty" json:"environment,omitempty"`
|
|
|
|
Status *string `url:"status,omitempty" json:"status,omitempty"`
|
2020-04-19 11:44:11 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
// ListProjectDeployments gets a list of deployments in a project.
|
|
|
|
//
|
|
|
|
// GitLab API docs: https://docs.gitlab.com/ce/api/deployments.html#list-project-deployments
|
2020-04-19 16:23:05 -04:00
|
|
|
func (s *DeploymentsService) ListProjectDeployments(pid interface{}, opts *ListProjectDeploymentsOptions, options ...RequestOptionFunc) ([]*Deployment, *Response, error) {
|
2020-04-19 11:44:11 -04:00
|
|
|
project, err := parseID(pid)
|
|
|
|
if err != nil {
|
|
|
|
return nil, nil, err
|
|
|
|
}
|
|
|
|
u := fmt.Sprintf("projects/%s/deployments", pathEscape(project))
|
|
|
|
|
2021-02-16 22:47:24 -05:00
|
|
|
req, err := s.client.NewRequest(http.MethodGet, u, opts, options)
|
2020-04-19 11:44:11 -04:00
|
|
|
if err != nil {
|
|
|
|
return nil, nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
var ds []*Deployment
|
|
|
|
resp, err := s.client.Do(req, &ds)
|
|
|
|
if err != nil {
|
|
|
|
return nil, resp, err
|
|
|
|
}
|
|
|
|
|
|
|
|
return ds, resp, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetProjectDeployment get a deployment for a project.
|
|
|
|
//
|
|
|
|
// GitLab API docs: https://docs.gitlab.com/ce/api/deployments.html#get-a-specific-deployment
|
2020-04-19 16:23:05 -04:00
|
|
|
func (s *DeploymentsService) GetProjectDeployment(pid interface{}, deployment int, options ...RequestOptionFunc) (*Deployment, *Response, error) {
|
2020-04-19 11:44:11 -04:00
|
|
|
project, err := parseID(pid)
|
|
|
|
if err != nil {
|
|
|
|
return nil, nil, err
|
|
|
|
}
|
|
|
|
u := fmt.Sprintf("projects/%s/deployments/%d", pathEscape(project), deployment)
|
|
|
|
|
2021-02-16 22:47:24 -05:00
|
|
|
req, err := s.client.NewRequest(http.MethodGet, u, nil, options)
|
2020-04-19 11:44:11 -04:00
|
|
|
if err != nil {
|
|
|
|
return nil, nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
d := new(Deployment)
|
|
|
|
resp, err := s.client.Do(req, d)
|
|
|
|
if err != nil {
|
|
|
|
return nil, resp, err
|
|
|
|
}
|
|
|
|
|
|
|
|
return d, resp, err
|
|
|
|
}
|
2020-04-19 16:23:05 -04:00
|
|
|
|
|
|
|
// CreateProjectDeploymentOptions represents the available
|
|
|
|
// CreateProjectDeployment() options.
|
|
|
|
//
|
|
|
|
// GitLab API docs: https://docs.gitlab.com/ee/api/deployments.html#create-a-deployment
|
|
|
|
type CreateProjectDeploymentOptions struct {
|
|
|
|
Environment *string `url:"environment,omitempty" json:"environment,omitempty"`
|
|
|
|
Ref *string `url:"ref,omitempty" json:"ref,omitempty"`
|
|
|
|
SHA *string `url:"sha,omitempty" json:"sha,omitempty"`
|
|
|
|
Tag *bool `url:"tag,omitempty" json:"tag,omitempty"`
|
|
|
|
Status *DeploymentStatusValue `url:"status,omitempty" json:"status,omitempty"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// CreateProjectDeployment creates a project deployment.
|
|
|
|
//
|
|
|
|
// GitLab API docs: https://docs.gitlab.com/ee/api/deployments.html#create-a-deployment
|
|
|
|
func (s *DeploymentsService) CreateProjectDeployment(pid interface{}, opt *CreateProjectDeploymentOptions, options ...RequestOptionFunc) (*Deployment, *Response, error) {
|
|
|
|
project, err := parseID(pid)
|
|
|
|
if err != nil {
|
|
|
|
return nil, nil, err
|
|
|
|
}
|
|
|
|
u := fmt.Sprintf("projects/%s/deployments", pathEscape(project))
|
|
|
|
|
2021-02-16 22:47:24 -05:00
|
|
|
req, err := s.client.NewRequest(http.MethodPost, u, opt, options)
|
2020-04-19 16:23:05 -04:00
|
|
|
if err != nil {
|
|
|
|
return nil, nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
d := new(Deployment)
|
|
|
|
resp, err := s.client.Do(req, &d)
|
|
|
|
if err != nil {
|
|
|
|
return nil, resp, err
|
|
|
|
}
|
|
|
|
|
|
|
|
return d, resp, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// UpdateProjectDeploymentOptions represents the available
|
|
|
|
// UpdateProjectDeployment() options.
|
|
|
|
//
|
|
|
|
// GitLab API docs: https://docs.gitlab.com/ee/api/deployments.html#updating-a-deployment
|
|
|
|
type UpdateProjectDeploymentOptions struct {
|
|
|
|
Status *DeploymentStatusValue `url:"status,omitempty" json:"status,omitempty"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// UpdateProjectDeployment updates a project deployment.
|
|
|
|
//
|
|
|
|
// GitLab API docs: https://docs.gitlab.com/ee/api/deployments.html#updating-a-deployment
|
|
|
|
func (s *DeploymentsService) UpdateProjectDeployment(pid interface{}, deployment int, opt *UpdateProjectDeploymentOptions, options ...RequestOptionFunc) (*Deployment, *Response, error) {
|
|
|
|
project, err := parseID(pid)
|
|
|
|
if err != nil {
|
|
|
|
return nil, nil, err
|
|
|
|
}
|
|
|
|
u := fmt.Sprintf("projects/%s/deployments/%d", pathEscape(project), deployment)
|
|
|
|
|
2021-02-16 22:47:24 -05:00
|
|
|
req, err := s.client.NewRequest(http.MethodPut, u, opt, options)
|
2020-04-19 16:23:05 -04:00
|
|
|
if err != nil {
|
|
|
|
return nil, nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
d := new(Deployment)
|
|
|
|
resp, err := s.client.Do(req, &d)
|
|
|
|
if err != nil {
|
|
|
|
return nil, resp, err
|
|
|
|
}
|
|
|
|
|
|
|
|
return d, resp, err
|
|
|
|
}
|