d2b09d854f
Implement a new error handling library based on pkg/errors. It provides stack saving on wrapping and exports some function to add stack saving also to external errors. It also implements custom zerolog error formatting without adding too much verbosity by just printing the chain error file:line without a full stack trace of every error. * Add a --detailed-errors options to print error with they full chain * Wrap all error returns. Use errors.WithStack to wrap without adding a new messsage and error.Wrap[f] to add a message. * Add golangci-lint wrapcheck to check that external packages errors are wrapped. This won't check that internal packages error are wrapped. But we want also to ensure this case so we'll have to find something else to check also these.
318 lines
11 KiB
Go
318 lines
11 KiB
Go
// Copyright 2019 Sorint.lab
|
|
//
|
|
// 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 client
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"net/url"
|
|
"strconv"
|
|
"strings"
|
|
|
|
"agola.io/agola/internal/errors"
|
|
"agola.io/agola/internal/util"
|
|
rsapitypes "agola.io/agola/services/runservice/api/types"
|
|
rstypes "agola.io/agola/services/runservice/types"
|
|
)
|
|
|
|
var jsonContent = http.Header{"Content-Type": []string{"application/json"}}
|
|
|
|
type Client struct {
|
|
url string
|
|
client *http.Client
|
|
}
|
|
|
|
// NewClient initializes and returns a API client.
|
|
func NewClient(url string) *Client {
|
|
return &Client{
|
|
url: strings.TrimSuffix(url, "/"),
|
|
client: &http.Client{},
|
|
}
|
|
}
|
|
|
|
// SetHTTPClient replaces default http.Client with user given one.
|
|
func (c *Client) SetHTTPClient(client *http.Client) {
|
|
c.client = client
|
|
}
|
|
|
|
func (c *Client) doRequest(ctx context.Context, method, path string, query url.Values, contentLength int64, header http.Header, ibody io.Reader) (*http.Response, error) {
|
|
u, err := url.Parse(c.url + "/api/v1alpha" + path)
|
|
if err != nil {
|
|
return nil, errors.WithStack(err)
|
|
}
|
|
u.RawQuery = query.Encode()
|
|
|
|
req, err := http.NewRequest(method, u.String(), ibody)
|
|
req = req.WithContext(ctx)
|
|
if err != nil {
|
|
return nil, errors.WithStack(err)
|
|
}
|
|
for k, v := range header {
|
|
req.Header[k] = v
|
|
}
|
|
|
|
if contentLength >= 0 {
|
|
req.ContentLength = contentLength
|
|
}
|
|
|
|
res, err := c.client.Do(req)
|
|
|
|
return res, errors.WithStack(err)
|
|
}
|
|
|
|
func (c *Client) getResponse(ctx context.Context, method, path string, query url.Values, contentLength int64, header http.Header, ibody io.Reader) (*http.Response, error) {
|
|
resp, err := c.doRequest(ctx, method, path, query, contentLength, header, ibody)
|
|
if err != nil {
|
|
return nil, errors.WithStack(err)
|
|
}
|
|
|
|
if err := util.ErrFromRemote(resp); err != nil {
|
|
return resp, errors.WithStack(err)
|
|
}
|
|
|
|
return resp, nil
|
|
}
|
|
|
|
func (c *Client) getParsedResponse(ctx context.Context, method, path string, query url.Values, header http.Header, ibody io.Reader, obj interface{}) (*http.Response, error) {
|
|
resp, err := c.getResponse(ctx, method, path, query, -1, header, ibody)
|
|
if err != nil {
|
|
return resp, errors.WithStack(err)
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
d := json.NewDecoder(resp.Body)
|
|
|
|
return resp, errors.WithStack(d.Decode(obj))
|
|
}
|
|
|
|
func (c *Client) SendExecutorStatus(ctx context.Context, executor *rstypes.Executor) (*http.Response, error) {
|
|
executorj, err := json.Marshal(executor)
|
|
if err != nil {
|
|
return nil, errors.WithStack(err)
|
|
}
|
|
return c.getResponse(ctx, "POST", fmt.Sprintf("/executor/%s", executor.ID), nil, -1, jsonContent, bytes.NewReader(executorj))
|
|
}
|
|
|
|
func (c *Client) SendExecutorTaskStatus(ctx context.Context, executorID string, et *rstypes.ExecutorTask) (*http.Response, error) {
|
|
etj, err := json.Marshal(et)
|
|
if err != nil {
|
|
return nil, errors.WithStack(err)
|
|
}
|
|
return c.getResponse(ctx, "POST", fmt.Sprintf("/executor/%s/tasks/%s", executorID, et.ID), nil, -1, jsonContent, bytes.NewReader(etj))
|
|
}
|
|
|
|
func (c *Client) GetExecutorTask(ctx context.Context, executorID, etID string) (*rstypes.ExecutorTask, *http.Response, error) {
|
|
et := new(rstypes.ExecutorTask)
|
|
resp, err := c.getParsedResponse(ctx, "GET", fmt.Sprintf("/executor/%s/tasks/%s", executorID, etID), nil, jsonContent, nil, et)
|
|
return et, resp, errors.WithStack(err)
|
|
}
|
|
|
|
func (c *Client) GetExecutorTasks(ctx context.Context, executorID string) ([]*rstypes.ExecutorTask, *http.Response, error) {
|
|
ets := []*rstypes.ExecutorTask{}
|
|
resp, err := c.getParsedResponse(ctx, "GET", fmt.Sprintf("/executor/%s/tasks", executorID), nil, jsonContent, nil, &ets)
|
|
return ets, resp, errors.WithStack(err)
|
|
}
|
|
|
|
func (c *Client) GetArchive(ctx context.Context, taskID string, step int) (*http.Response, error) {
|
|
q := url.Values{}
|
|
q.Add("taskid", taskID)
|
|
q.Add("step", strconv.Itoa(step))
|
|
|
|
return c.getResponse(ctx, "GET", "/executor/archives", q, -1, nil, nil)
|
|
}
|
|
|
|
func (c *Client) CheckCache(ctx context.Context, key string, prefix bool) (*http.Response, error) {
|
|
q := url.Values{}
|
|
if prefix {
|
|
q.Add("prefix", "")
|
|
}
|
|
return c.getResponse(ctx, "HEAD", fmt.Sprintf("/executor/caches/%s", url.PathEscape(key)), q, -1, nil, nil)
|
|
}
|
|
|
|
func (c *Client) GetCache(ctx context.Context, key string, prefix bool) (*http.Response, error) {
|
|
q := url.Values{}
|
|
if prefix {
|
|
q.Add("prefix", "")
|
|
}
|
|
return c.getResponse(ctx, "GET", fmt.Sprintf("/executor/caches/%s", url.PathEscape(key)), q, -1, nil, nil)
|
|
}
|
|
|
|
func (c *Client) PutCache(ctx context.Context, key string, size int64, r io.Reader) (*http.Response, error) {
|
|
return c.getResponse(ctx, "POST", fmt.Sprintf("/executor/caches/%s", url.PathEscape(key)), nil, size, nil, r)
|
|
}
|
|
|
|
func (c *Client) GetRuns(ctx context.Context, phaseFilter, resultFilter, groups []string, lastRun bool, changeGroups []string, start string, limit int, asc bool) (*rsapitypes.GetRunsResponse, *http.Response, error) {
|
|
q := url.Values{}
|
|
for _, phase := range phaseFilter {
|
|
q.Add("phase", phase)
|
|
}
|
|
for _, result := range resultFilter {
|
|
q.Add("result", result)
|
|
}
|
|
for _, group := range groups {
|
|
q.Add("group", group)
|
|
}
|
|
if lastRun {
|
|
q.Add("lastrun", "")
|
|
}
|
|
for _, changeGroup := range changeGroups {
|
|
q.Add("changegroup", changeGroup)
|
|
}
|
|
if start != "" {
|
|
q.Add("start", start)
|
|
}
|
|
if limit > 0 {
|
|
q.Add("limit", strconv.Itoa(limit))
|
|
}
|
|
if asc {
|
|
q.Add("asc", "")
|
|
}
|
|
|
|
getRunsResponse := new(rsapitypes.GetRunsResponse)
|
|
resp, err := c.getParsedResponse(ctx, "GET", "/runs", q, jsonContent, nil, getRunsResponse)
|
|
return getRunsResponse, resp, errors.WithStack(err)
|
|
}
|
|
|
|
func (c *Client) GetQueuedRuns(ctx context.Context, start string, limit int, changeGroups []string) (*rsapitypes.GetRunsResponse, *http.Response, error) {
|
|
return c.GetRuns(ctx, []string{"queued"}, nil, []string{}, false, changeGroups, start, limit, true)
|
|
}
|
|
|
|
func (c *Client) GetRunningRuns(ctx context.Context, start string, limit int, changeGroups []string) (*rsapitypes.GetRunsResponse, *http.Response, error) {
|
|
return c.GetRuns(ctx, []string{"running"}, nil, []string{}, false, changeGroups, start, limit, true)
|
|
}
|
|
|
|
func (c *Client) GetGroupQueuedRuns(ctx context.Context, group string, limit int, changeGroups []string) (*rsapitypes.GetRunsResponse, *http.Response, error) {
|
|
return c.GetRuns(ctx, []string{"queued"}, nil, []string{group}, false, changeGroups, "", limit, false)
|
|
}
|
|
|
|
func (c *Client) GetGroupRunningRuns(ctx context.Context, group string, limit int, changeGroups []string) (*rsapitypes.GetRunsResponse, *http.Response, error) {
|
|
return c.GetRuns(ctx, []string{"running"}, nil, []string{group}, false, changeGroups, "", limit, false)
|
|
}
|
|
|
|
func (c *Client) GetGroupFirstQueuedRuns(ctx context.Context, group string, changeGroups []string) (*rsapitypes.GetRunsResponse, *http.Response, error) {
|
|
return c.GetRuns(ctx, []string{"queued"}, nil, []string{group}, false, changeGroups, "", 1, true)
|
|
}
|
|
|
|
func (c *Client) GetGroupLastRun(ctx context.Context, group string, changeGroups []string) (*rsapitypes.GetRunsResponse, *http.Response, error) {
|
|
return c.GetRuns(ctx, nil, nil, []string{group}, false, changeGroups, "", 1, false)
|
|
}
|
|
|
|
func (c *Client) CreateRun(ctx context.Context, req *rsapitypes.RunCreateRequest) (*rsapitypes.RunResponse, *http.Response, error) {
|
|
reqj, err := json.Marshal(req)
|
|
if err != nil {
|
|
return nil, nil, errors.WithStack(err)
|
|
}
|
|
|
|
res := new(rsapitypes.RunResponse)
|
|
resp, err := c.getParsedResponse(ctx, "POST", "/runs", nil, jsonContent, bytes.NewReader(reqj), res)
|
|
return res, resp, errors.WithStack(err)
|
|
}
|
|
|
|
func (c *Client) RunActions(ctx context.Context, runID string, req *rsapitypes.RunActionsRequest) (*http.Response, error) {
|
|
reqj, err := json.Marshal(req)
|
|
if err != nil {
|
|
return nil, errors.WithStack(err)
|
|
}
|
|
return c.getResponse(ctx, "PUT", fmt.Sprintf("/runs/%s/actions", runID), nil, -1, jsonContent, bytes.NewReader(reqj))
|
|
}
|
|
|
|
func (c *Client) StartRun(ctx context.Context, runID string, changeGroupsUpdateToken string) (*http.Response, error) {
|
|
req := &rsapitypes.RunActionsRequest{
|
|
ActionType: rsapitypes.RunActionTypeChangePhase,
|
|
Phase: rstypes.RunPhaseRunning,
|
|
ChangeGroupsUpdateToken: changeGroupsUpdateToken,
|
|
}
|
|
|
|
return c.RunActions(ctx, runID, req)
|
|
}
|
|
|
|
func (c *Client) RunTaskActions(ctx context.Context, runID, taskID string, req *rsapitypes.RunTaskActionsRequest) (*http.Response, error) {
|
|
reqj, err := json.Marshal(req)
|
|
if err != nil {
|
|
return nil, errors.WithStack(err)
|
|
}
|
|
return c.getResponse(ctx, "PUT", fmt.Sprintf("/runs/%s/tasks/%s/actions", runID, taskID), nil, -1, jsonContent, bytes.NewReader(reqj))
|
|
}
|
|
|
|
func (c *Client) RunTaskSetAnnotations(ctx context.Context, runID, taskID string, annotations map[string]string, changeGroupsUpdateToken string) (*http.Response, error) {
|
|
req := &rsapitypes.RunTaskActionsRequest{
|
|
ActionType: rsapitypes.RunTaskActionTypeSetAnnotations,
|
|
Annotations: annotations,
|
|
ChangeGroupsUpdateToken: changeGroupsUpdateToken,
|
|
}
|
|
|
|
return c.RunTaskActions(ctx, runID, taskID, req)
|
|
}
|
|
|
|
func (c *Client) ApproveRunTask(ctx context.Context, runID, taskID string, changeGroupsUpdateToken string) (*http.Response, error) {
|
|
req := &rsapitypes.RunTaskActionsRequest{
|
|
ActionType: rsapitypes.RunTaskActionTypeApprove,
|
|
ChangeGroupsUpdateToken: changeGroupsUpdateToken,
|
|
}
|
|
|
|
return c.RunTaskActions(ctx, runID, taskID, req)
|
|
}
|
|
|
|
func (c *Client) GetRun(ctx context.Context, runID string, changeGroups []string) (*rsapitypes.RunResponse, *http.Response, error) {
|
|
q := url.Values{}
|
|
for _, changeGroup := range changeGroups {
|
|
q.Add("changegroup", changeGroup)
|
|
}
|
|
|
|
runResponse := new(rsapitypes.RunResponse)
|
|
resp, err := c.getParsedResponse(ctx, "GET", fmt.Sprintf("/runs/%s", runID), q, jsonContent, nil, runResponse)
|
|
return runResponse, resp, errors.WithStack(err)
|
|
}
|
|
|
|
func (c *Client) GetLogs(ctx context.Context, runID, taskID string, setup bool, step int, follow bool) (*http.Response, error) {
|
|
q := url.Values{}
|
|
q.Add("runid", runID)
|
|
q.Add("taskid", taskID)
|
|
if setup {
|
|
q.Add("setup", "")
|
|
} else {
|
|
q.Add("step", strconv.Itoa(step))
|
|
}
|
|
if follow {
|
|
q.Add("follow", "")
|
|
}
|
|
|
|
return c.getResponse(ctx, "GET", "/logs", q, -1, nil, nil)
|
|
}
|
|
|
|
func (c *Client) DeleteLogs(ctx context.Context, runID, taskID string, setup bool, step int) (*http.Response, error) {
|
|
q := url.Values{}
|
|
q.Add("runid", runID)
|
|
q.Add("taskid", taskID)
|
|
if setup {
|
|
q.Add("setup", "")
|
|
} else {
|
|
q.Add("step", strconv.Itoa(step))
|
|
}
|
|
|
|
return c.getResponse(ctx, "DELETE", "/logs", q, -1, nil, nil)
|
|
}
|
|
|
|
func (c *Client) GetRunEvents(ctx context.Context, startRunEventID string) (*http.Response, error) {
|
|
q := url.Values{}
|
|
q.Add("startruneventid", startRunEventID)
|
|
|
|
return c.getResponse(ctx, "GET", "/runs/events", q, -1, nil, nil)
|
|
}
|