Платформа ЦРНП "Мирокод" для разработки проектов
https://git.mirocod.ru
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
454 lines
14 KiB
454 lines
14 KiB
// |
|
// 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" |
|
"time" |
|
) |
|
|
|
// RunnersService handles communication with the runner related methods of the |
|
// GitLab API. |
|
// |
|
// GitLab API docs: https://docs.gitlab.com/ce/api/runners.html |
|
type RunnersService struct { |
|
client *Client |
|
} |
|
|
|
// Runner represents a GitLab CI Runner. |
|
// |
|
// GitLab API docs: https://docs.gitlab.com/ce/api/runners.html |
|
type Runner struct { |
|
ID int `json:"id"` |
|
Description string `json:"description"` |
|
Active bool `json:"active"` |
|
IsShared bool `json:"is_shared"` |
|
IPAddress string `json:"ip_address"` |
|
Name string `json:"name"` |
|
Online bool `json:"online"` |
|
Status string `json:"status"` |
|
Token string `json:"token"` |
|
} |
|
|
|
// RunnerDetails represents the GitLab CI runner details. |
|
// |
|
// GitLab API docs: https://docs.gitlab.com/ce/api/runners.html |
|
type RunnerDetails struct { |
|
Active bool `json:"active"` |
|
Architecture string `json:"architecture"` |
|
Description string `json:"description"` |
|
ID int `json:"id"` |
|
IPAddress string `json:"ip_address"` |
|
IsShared bool `json:"is_shared"` |
|
ContactedAt *time.Time `json:"contacted_at"` |
|
Name string `json:"name"` |
|
Online bool `json:"online"` |
|
Status string `json:"status"` |
|
Platform string `json:"platform"` |
|
Projects []struct { |
|
ID int `json:"id"` |
|
Name string `json:"name"` |
|
NameWithNamespace string `json:"name_with_namespace"` |
|
Path string `json:"path"` |
|
PathWithNamespace string `json:"path_with_namespace"` |
|
} `json:"projects"` |
|
Token string `json:"token"` |
|
Revision string `json:"revision"` |
|
TagList []string `json:"tag_list"` |
|
Version string `json:"version"` |
|
Locked bool `json:"locked"` |
|
AccessLevel string `json:"access_level"` |
|
MaximumTimeout int `json:"maximum_timeout"` |
|
Groups []struct { |
|
ID int `json:"id"` |
|
Name string `json:"name"` |
|
WebURL string `json:"web_url"` |
|
} `json:"groups"` |
|
} |
|
|
|
// ListRunnersOptions represents the available ListRunners() options. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#list-owned-runners |
|
type ListRunnersOptions struct { |
|
ListOptions |
|
Scope *string `url:"scope,omitempty" json:"scope,omitempty"` |
|
Type *string `url:"type,omitempty" json:"type,omitempty"` |
|
Status *string `url:"status,omitempty" json:"status,omitempty"` |
|
TagList []string `url:"tag_list,comma,omitempty" json:"tag_list,omitempty"` |
|
} |
|
|
|
// ListRunners gets a list of runners accessible by the authenticated user. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#list-owned-runners |
|
func (s *RunnersService) ListRunners(opt *ListRunnersOptions, options ...RequestOptionFunc) ([]*Runner, *Response, error) { |
|
req, err := s.client.NewRequest("GET", "runners", opt, options) |
|
if err != nil { |
|
return nil, nil, err |
|
} |
|
|
|
var rs []*Runner |
|
resp, err := s.client.Do(req, &rs) |
|
if err != nil { |
|
return nil, resp, err |
|
} |
|
|
|
return rs, resp, err |
|
} |
|
|
|
// ListAllRunners gets a list of all runners in the GitLab instance. Access is |
|
// restricted to users with admin privileges. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#list-all-runners |
|
func (s *RunnersService) ListAllRunners(opt *ListRunnersOptions, options ...RequestOptionFunc) ([]*Runner, *Response, error) { |
|
req, err := s.client.NewRequest("GET", "runners/all", opt, options) |
|
if err != nil { |
|
return nil, nil, err |
|
} |
|
|
|
var rs []*Runner |
|
resp, err := s.client.Do(req, &rs) |
|
if err != nil { |
|
return nil, resp, err |
|
} |
|
|
|
return rs, resp, err |
|
} |
|
|
|
// GetRunnerDetails returns details for given runner. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#get-runner-39-s-details |
|
func (s *RunnersService) GetRunnerDetails(rid interface{}, options ...RequestOptionFunc) (*RunnerDetails, *Response, error) { |
|
runner, err := parseID(rid) |
|
if err != nil { |
|
return nil, nil, err |
|
} |
|
u := fmt.Sprintf("runners/%s", runner) |
|
|
|
req, err := s.client.NewRequest("GET", u, nil, options) |
|
if err != nil { |
|
return nil, nil, err |
|
} |
|
|
|
var rs *RunnerDetails |
|
resp, err := s.client.Do(req, &rs) |
|
if err != nil { |
|
return nil, resp, err |
|
} |
|
|
|
return rs, resp, err |
|
} |
|
|
|
// UpdateRunnerDetailsOptions represents the available UpdateRunnerDetails() options. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#update-runner-39-s-details |
|
type UpdateRunnerDetailsOptions struct { |
|
Description *string `url:"description,omitempty" json:"description,omitempty"` |
|
Active *bool `url:"active,omitempty" json:"active,omitempty"` |
|
TagList []string `url:"tag_list[],omitempty" json:"tag_list,omitempty"` |
|
RunUntagged *bool `url:"run_untagged,omitempty" json:"run_untagged,omitempty"` |
|
Locked *bool `url:"locked,omitempty" json:"locked,omitempty"` |
|
AccessLevel *string `url:"access_level,omitempty" json:"access_level,omitempty"` |
|
MaximumTimeout *int `url:"maximum_timeout,omitempty" json:"maximum_timeout,omitempty"` |
|
} |
|
|
|
// UpdateRunnerDetails updates details for a given runner. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#update-runner-39-s-details |
|
func (s *RunnersService) UpdateRunnerDetails(rid interface{}, opt *UpdateRunnerDetailsOptions, options ...RequestOptionFunc) (*RunnerDetails, *Response, error) { |
|
runner, err := parseID(rid) |
|
if err != nil { |
|
return nil, nil, err |
|
} |
|
u := fmt.Sprintf("runners/%s", runner) |
|
|
|
req, err := s.client.NewRequest("PUT", u, opt, options) |
|
if err != nil { |
|
return nil, nil, err |
|
} |
|
|
|
var rs *RunnerDetails |
|
resp, err := s.client.Do(req, &rs) |
|
if err != nil { |
|
return nil, resp, err |
|
} |
|
|
|
return rs, resp, err |
|
} |
|
|
|
// RemoveRunner removes a runner. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#remove-a-runner |
|
func (s *RunnersService) RemoveRunner(rid interface{}, options ...RequestOptionFunc) (*Response, error) { |
|
runner, err := parseID(rid) |
|
if err != nil { |
|
return nil, err |
|
} |
|
u := fmt.Sprintf("runners/%s", runner) |
|
|
|
req, err := s.client.NewRequest("DELETE", u, nil, options) |
|
if err != nil { |
|
return nil, err |
|
} |
|
|
|
return s.client.Do(req, nil) |
|
} |
|
|
|
// ListRunnerJobsOptions represents the available ListRunnerJobs() |
|
// options. Status can be one of: running, success, failed, canceled. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#list-runners-jobs |
|
type ListRunnerJobsOptions struct { |
|
ListOptions |
|
Status *string `url:"status,omitempty" json:"status,omitempty"` |
|
OrderBy *string `url:"order_by,omitempty" json:"order_by,omitempty"` |
|
Sort *string `url:"sort,omitempty" json:"sort,omitempty"` |
|
} |
|
|
|
// ListRunnerJobs gets a list of jobs that are being processed or were processed by specified Runner. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#list-runner-39-s-jobs |
|
func (s *RunnersService) ListRunnerJobs(rid interface{}, opt *ListRunnerJobsOptions, options ...RequestOptionFunc) ([]*Job, *Response, error) { |
|
runner, err := parseID(rid) |
|
if err != nil { |
|
return nil, nil, err |
|
} |
|
u := fmt.Sprintf("runners/%s/jobs", runner) |
|
|
|
req, err := s.client.NewRequest("GET", u, opt, options) |
|
if err != nil { |
|
return nil, nil, err |
|
} |
|
|
|
var rs []*Job |
|
resp, err := s.client.Do(req, &rs) |
|
if err != nil { |
|
return nil, resp, err |
|
} |
|
|
|
return rs, resp, err |
|
} |
|
|
|
// ListProjectRunnersOptions represents the available ListProjectRunners() |
|
// options. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#list-project-s-runners |
|
type ListProjectRunnersOptions ListRunnersOptions |
|
|
|
// ListProjectRunners gets a list of runners accessible by the authenticated user. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#list-project-s-runners |
|
func (s *RunnersService) ListProjectRunners(pid interface{}, opt *ListProjectRunnersOptions, options ...RequestOptionFunc) ([]*Runner, *Response, error) { |
|
project, err := parseID(pid) |
|
if err != nil { |
|
return nil, nil, err |
|
} |
|
u := fmt.Sprintf("projects/%s/runners", pathEscape(project)) |
|
|
|
req, err := s.client.NewRequest("GET", u, opt, options) |
|
if err != nil { |
|
return nil, nil, err |
|
} |
|
|
|
var rs []*Runner |
|
resp, err := s.client.Do(req, &rs) |
|
if err != nil { |
|
return nil, resp, err |
|
} |
|
|
|
return rs, resp, err |
|
} |
|
|
|
// EnableProjectRunnerOptions represents the available EnableProjectRunner() |
|
// options. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#enable-a-runner-in-project |
|
type EnableProjectRunnerOptions struct { |
|
RunnerID int `json:"runner_id"` |
|
} |
|
|
|
// EnableProjectRunner enables an available specific runner in the project. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#enable-a-runner-in-project |
|
func (s *RunnersService) EnableProjectRunner(pid interface{}, opt *EnableProjectRunnerOptions, options ...RequestOptionFunc) (*Runner, *Response, error) { |
|
project, err := parseID(pid) |
|
if err != nil { |
|
return nil, nil, err |
|
} |
|
u := fmt.Sprintf("projects/%s/runners", pathEscape(project)) |
|
|
|
req, err := s.client.NewRequest("POST", u, opt, options) |
|
if err != nil { |
|
return nil, nil, err |
|
} |
|
|
|
var r *Runner |
|
resp, err := s.client.Do(req, &r) |
|
if err != nil { |
|
return nil, resp, err |
|
} |
|
|
|
return r, resp, err |
|
} |
|
|
|
// DisableProjectRunner disables a specific runner from project. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#disable-a-runner-from-project |
|
func (s *RunnersService) DisableProjectRunner(pid interface{}, runner int, options ...RequestOptionFunc) (*Response, error) { |
|
project, err := parseID(pid) |
|
if err != nil { |
|
return nil, err |
|
} |
|
u := fmt.Sprintf("projects/%s/runners/%d", pathEscape(project), runner) |
|
|
|
req, err := s.client.NewRequest("DELETE", u, nil, options) |
|
if err != nil { |
|
return nil, err |
|
} |
|
|
|
return s.client.Do(req, nil) |
|
} |
|
|
|
// ListGroupsRunnersOptions represents the available ListGroupsRunners() options. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ee/api/runners.html#list-groups-runners |
|
type ListGroupsRunnersOptions struct { |
|
ListOptions |
|
Type *string `url:"type,omitempty" json:"type,omitempty"` |
|
Status *string `url:"status,omitempty" json:"status,omitempty"` |
|
TagList []string `url:"tag_list,comma,omitempty" json:"tag_list,omitempty"` |
|
} |
|
|
|
// ListGroupsRunners lists all runners (specific and shared) available in the |
|
// group as well it’s ancestor groups. Shared runners are listed if at least one |
|
// shared runner is defined. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ee/api/runners.html#list-groups-runners |
|
func (s *RunnersService) ListGroupsRunners(gid interface{}, opt *ListGroupsRunnersOptions, options ...RequestOptionFunc) ([]*Runner, *Response, error) { |
|
group, err := parseID(gid) |
|
if err != nil { |
|
return nil, nil, err |
|
} |
|
u := fmt.Sprintf("groups/%s/runners", pathEscape(group)) |
|
|
|
req, err := s.client.NewRequest("GET", u, opt, options) |
|
if err != nil { |
|
return nil, nil, err |
|
} |
|
|
|
var rs []*Runner |
|
resp, err := s.client.Do(req, &rs) |
|
if err != nil { |
|
return nil, resp, err |
|
} |
|
|
|
return rs, resp, err |
|
} |
|
|
|
// RegisterNewRunnerOptions represents the available RegisterNewRunner() |
|
// options. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#register-a-new-runner |
|
type RegisterNewRunnerOptions struct { |
|
Token *string `url:"token" json:"token"` |
|
Description *string `url:"description,omitempty" json:"description,omitempty"` |
|
Info *string `url:"info,omitempty" json:"info,omitempty"` |
|
Active *bool `url:"active,omitempty" json:"active,omitempty"` |
|
Locked *bool `url:"locked,omitempty" json:"locked,omitempty"` |
|
RunUntagged *bool `url:"run_untagged,omitempty" json:"run_untagged,omitempty"` |
|
TagList []string `url:"tag_list[],omitempty" json:"tag_list,omitempty"` |
|
MaximumTimeout *int `url:"maximum_timeout,omitempty" json:"maximum_timeout,omitempty"` |
|
} |
|
|
|
// RegisterNewRunner registers a new Runner for the instance. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#register-a-new-runner |
|
func (s *RunnersService) RegisterNewRunner(opt *RegisterNewRunnerOptions, options ...RequestOptionFunc) (*Runner, *Response, error) { |
|
req, err := s.client.NewRequest("POST", "runners", opt, options) |
|
if err != nil { |
|
return nil, nil, err |
|
} |
|
|
|
var r *Runner |
|
resp, err := s.client.Do(req, &r) |
|
if err != nil { |
|
return nil, resp, err |
|
} |
|
|
|
return r, resp, err |
|
} |
|
|
|
// DeleteRegisteredRunnerOptions represents the available |
|
// DeleteRegisteredRunner() options. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#delete-a-registered-runner |
|
type DeleteRegisteredRunnerOptions struct { |
|
Token *string `url:"token" json:"token"` |
|
} |
|
|
|
// DeleteRegisteredRunner registers a new Runner for the instance. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#delete-a-registered-runner |
|
func (s *RunnersService) DeleteRegisteredRunner(opt *DeleteRegisteredRunnerOptions, options ...RequestOptionFunc) (*Response, error) { |
|
req, err := s.client.NewRequest("DELETE", "runners", opt, options) |
|
if err != nil { |
|
return nil, err |
|
} |
|
|
|
return s.client.Do(req, nil) |
|
} |
|
|
|
// VerifyRegisteredRunnerOptions represents the available |
|
// VerifyRegisteredRunner() options. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#verify-authentication-for-a-registered-runner |
|
type VerifyRegisteredRunnerOptions struct { |
|
Token *string `url:"token" json:"token"` |
|
} |
|
|
|
// VerifyRegisteredRunner registers a new Runner for the instance. |
|
// |
|
// GitLab API docs: |
|
// https://docs.gitlab.com/ce/api/runners.html#verify-authentication-for-a-registered-runner |
|
func (s *RunnersService) VerifyRegisteredRunner(opt *VerifyRegisteredRunnerOptions, options ...RequestOptionFunc) (*Response, error) { |
|
req, err := s.client.NewRequest("POST", "runners/verify", opt, options) |
|
if err != nil { |
|
return nil, err |
|
} |
|
|
|
return s.client.Do(req, nil) |
|
}
|
|
|