pipelines.go

package buildkite

import (
	"context"
	"encoding/json"
	"fmt"
)

// PipelinesService handles communication with the pipeline related
// methods of the buildkite API.
//
// buildkite API docs: https://buildkite.com/docs/api/pipelines
type PipelinesService struct {
	client *Client
}

// CreatePipeline - Create a Pipeline.
type CreatePipeline struct {
	Name       string `json:"name"`
	Repository string `json:"repository"`

	// Either configuration needs to be specified as a yaml string or steps.
	Configuration string `json:"configuration,omitempty"`
	Steps         []Step `json:"steps,omitempty"`

	// Optional fields
	DefaultBranch                   string            `json:"default_branch,omitempty"`
	Description                     string            `json:"description,omitempty"`
	Env                             map[string]string `json:"env,omitempty"`
	ProviderSettings                ProviderSettings  `json:"provider_settings,omitempty"`
	BranchConfiguration             string            `json:"branch_configuration,omitempty"`
	SkipQueuedBranchBuilds          bool              `json:"skip_queued_branch_builds"`
	SkipQueuedBranchBuildsFilter    string            `json:"skip_queued_branch_builds_filter,omitempty"`
	CancelRunningBranchBuilds       bool              `json:"cancel_running_branch_builds"`
	CancelRunningBranchBuildsFilter string            `json:"cancel_running_branch_builds_filter,omitempty"`
	TeamUuids                       []string          `json:"team_uuids,omitempty"`
	ClusterID                       string            `json:"cluster_id,omitempty"`
	Visibility                      string            `json:"visibility,omitempty"`
	Tags                            []string          `json:"tags,omitempty"`
}

type UpdatePipeline struct {
	// Either configuration needs to be specified as a yaml string or steps (based on what the pipeline uses)
	Configuration string `json:"configuration,omitempty"`
	Steps         []Step `json:"steps,omitempty"`

	Name                            string           `json:"name,omitempty"`
	Repository                      string           `json:"repository,omitempty"`
	DefaultBranch                   string           `json:"default_branch,omitempty"`
	Description                     string           `json:"description,omitempty"`
	ProviderSettings                ProviderSettings `json:"provider_settings,omitempty"`
	BranchConfiguration             string           `json:"branch_configuration,omitempty"`
	SkipQueuedBranchBuilds          bool             `json:"skip_queued_branch_builds"`
	SkipQueuedBranchBuildsFilter    string           `json:"skip_queued_branch_builds_filter,omitempty"`
	CancelRunningBranchBuilds       bool             `json:"cancel_running_branch_builds"`
	CancelRunningBranchBuildsFilter string           `json:"cancel_running_branch_builds_filter,omitempty"`
	ClusterID                       string           `json:"cluster_id,omitempty"`
	Visibility                      string           `json:"visibility,omitempty"`
	Tags                            []string         `json:"tags,omitempty"`
}

// Pipeline represents a buildkite pipeline.
type Pipeline struct {
	ID                              string     `json:"id,omitempty"`
	GraphQLID                       string     `json:"graphql_id,omitempty"`
	URL                             string     `json:"url,omitempty"`
	WebURL                          string     `json:"web_url,omitempty"`
	Name                            string     `json:"name,omitempty"`
	Slug                            string     `json:"slug,omitempty"`
	Repository                      string     `json:"repository,omitempty"`
	BuildsURL                       string     `json:"builds_url,omitempty"`
	BadgeURL                        string     `json:"badge_url,omitempty"`
	CreatedAt                       *Timestamp `json:"created_at,omitempty"`
	ArchivedAt                      *Timestamp `json:"archived_at,omitempty"`
	DefaultBranch                   string     `json:"default_branch,omitempty"`
	Description                     string     `json:"description,omitempty"`
	BranchConfiguration             string     `json:"branch_configuration,omitempty"`
	SkipQueuedBranchBuilds          bool       `json:"skip_queued_branch_builds"`
	SkipQueuedBranchBuildsFilter    string     `json:"skip_queued_branch_builds_filter,omitempty"`
	CancelRunningBranchBuilds       bool       `json:"cancel_running_branch_builds"`
	CancelRunningBranchBuildsFilter string     `json:"cancel_running_branch_builds_filter,omitempty"`
	ClusterID                       string     `json:"cluster_id,omitempty"`
	Visibility                      string     `json:"visibility,omitempty"`
	Tags                            []string   `json:"tags,omitempty"`

	ScheduledBuildsCount int `json:"scheduled_builds_count,omitempty"`
	RunningBuildsCount   int `json:"running_builds_count,omitempty"`
	ScheduledJobsCount   int `json:"scheduled_jobs_count,omitempty"`
	RunningJobsCount     int `json:"running_jobs_count,omitempty"`
	WaitingJobsCount     int `json:"waiting_jobs_count,omitempty"`

	// the provider of sources
	Provider Provider `json:"provider,omitempty"`

	// build steps
	Steps         []Step         `json:"steps,omitempty"`
	Configuration string         `json:"configuration,omitempty"`
	Env           map[string]any `json:"env,omitempty"`
}

// Step represents a build step in buildkites build pipeline
type Step struct {
	Type                string            `json:"type,omitempty"`
	Name                string            `json:"name,omitempty"`
	Label               string            `json:"label,omitempty"`
	Command             string            `json:"command,omitempty"`
	ArtifactPaths       string            `json:"artifact_paths,omitempty"`
	BranchConfiguration string            `json:"branch_configuration,omitempty"`
	Env                 map[string]string `json:"env,omitempty"`
	TimeoutInMinutes    *int              `json:"timeout_in_minutes,omitempty"`
	AgentQueryRules     []string          `json:"agent_query_rules,omitempty"`
	Plugins             Plugins           `json:"plugins,omitempty"`
}

type Plugins map[string]Plugin

// Support deprecated map structure as well as array structure
func (p *Plugins) UnmarshalJSON(bs []byte) error {
	type plugins2 Plugins // avoid unmarshal recursion
	err := json.Unmarshal(bs, (*plugins2)(p))
	if err == nil {
		return nil
	}

	asArray := []map[string]Plugin{}
	if err2 := json.Unmarshal(bs, &asArray); err2 != nil {
		return fmt.Errorf("plugins are neither a map or an array: %s, %s", err.Error(), err2.Error())
	}
	for _, plugin := range asArray {
		if len(plugin) != 1 {
			return fmt.Errorf("plugins as arrays must have a single key")
		}
		if *p == nil {
			*p = map[string]Plugin{}
		}
		for k, v := range plugin {
			(*p)[k] = v
		}
	}
	return nil
}

// This is kept vague (map of string to whatever) as there are a lot of custom
// plugins out there.
type Plugin map[string]interface{}

// PipelineListOptions specifies the optional parameters to the
// PipelinesService.List method.
type PipelineListOptions struct{ ListOptions }

// Create - Creates a pipeline for a given organisation.
//
// buildkite API docs: https://buildkite.com/docs/rest-api/pipelines#create-a-pipeline
func (ps *PipelinesService) Create(ctx context.Context, org string, p CreatePipeline) (Pipeline, *Response, error) {
	u := fmt.Sprintf("v2/organizations/%s/pipelines", org)
	req, err := ps.client.NewRequest(ctx, "POST", u, p)
	if err != nil {
		return Pipeline{}, nil, err
	}

	var pipeline Pipeline
	resp, err := ps.client.Do(req, &pipeline)
	if err != nil {
		return Pipeline{}, resp, err
	}

	return pipeline, resp, err
}

// Get fetches a pipeline.
//
// buildkite API docs: https://buildkite.com/docs/rest-api/pipelines#get-a-pipeline
func (ps *PipelinesService) Get(ctx context.Context, org string, slug string) (Pipeline, *Response, error) {
	u := fmt.Sprintf("v2/organizations/%s/pipelines/%s", org, slug)
	req, err := ps.client.NewRequest(ctx, "GET", u, nil)
	if err != nil {
		return Pipeline{}, nil, err
	}

	var pipeline Pipeline
	resp, err := ps.client.Do(req, &pipeline)
	if err != nil {
		return Pipeline{}, resp, err
	}

	return pipeline, resp, err
}

// List the pipelines for a given organisation.
//
// buildkite API docs: https://buildkite.com/docs/api/pipelines#list-pipelines
func (ps *PipelinesService) List(ctx context.Context, org string, opt *PipelineListOptions) ([]Pipeline, *Response, error) {
	u := fmt.Sprintf("v2/organizations/%s/pipelines", org)
	u, err := addOptions(u, opt)
	if err != nil {
		return nil, nil, err
	}

	req, err := ps.client.NewRequest(ctx, "GET", u, nil)
	if err != nil {
		return nil, nil, err
	}

	var pipelines []Pipeline
	resp, err := ps.client.Do(req, &pipelines)
	if err != nil {
		return nil, resp, err
	}

	return pipelines, resp, err
}

// Delete a pipeline.
//
// buildkite API docs: https://buildkite.com/docs/rest-api/pipelines#delete-a-pipeline
func (ps *PipelinesService) Delete(ctx context.Context, org, slug string) (*Response, error) {
	u := fmt.Sprintf("v2/organizations/%s/pipelines/%s", org, slug)
	req, err := ps.client.NewRequest(ctx, "DELETE", u, nil)
	if err != nil {
		return nil, err
	}

	return ps.client.Do(req, nil)
}

// Update - Updates a pipeline.
//
// buildkite API docs: https://buildkite.com/docs/rest-api/pipelines#update-a-pipeline
func (ps *PipelinesService) Update(ctx context.Context, org, slug string, up UpdatePipeline) (Pipeline, *Response, error) {
	u := fmt.Sprintf("v2/organizations/%s/pipelines/%s", org, slug)
	req, err := ps.client.NewRequest(ctx, "PATCH", u, up)
	if err != nil {
		return Pipeline{}, nil, err
	}

	var p Pipeline
	resp, err := ps.client.Do(req, &p)
	if err != nil {
		return Pipeline{}, resp, err
	}

	return p, resp, err
}

// AddWebhook - Adds webhook in github for pipeline.
//
// buildkite API docs: https://buildkite.com/docs/apis/rest-api/pipelines#add-a-webhook
func (ps *PipelinesService) AddWebhook(ctx context.Context, org string, slug string) (*Response, error) {
	u := fmt.Sprintf("v2/organizations/%s/pipelines/%s/webhook", org, slug)
	req, err := ps.client.NewRequest(ctx, "POST", u, nil)
	if err != nil {
		return nil, err
	}

	return ps.client.Do(req, nil)
}

// Archive - Archives a pipeline.
//
// buildkite API docs: https://buildkite.com/docs/apis/rest-api/pipelines#archive-a-pipeline
func (ps *PipelinesService) Archive(ctx context.Context, org string, slug string) (*Response, error) {
	u := fmt.Sprintf("v2/organizations/%s/pipelines/%s/archive", org, slug)
	req, err := ps.client.NewRequest(ctx, "POST", u, nil)
	if err != nil {
		return nil, err
	}

	return ps.client.Do(req, nil)
}

// Unarchive - Unarchive a pipeline.
//
// buildkite API docs: https://buildkite.com/docs/apis/rest-api/pipelines#unarchive-a-pipeline
func (ps *PipelinesService) Unarchive(ctx context.Context, org string, slug string) (*Response, error) {
	u := fmt.Sprintf("v2/organizations/%s/pipelines/%s/unarchive", org, slug)
	req, err := ps.client.NewRequest(ctx, "POST", u, nil)
	if err != nil {
		return nil, err
	}

	return ps.client.Do(req, nil)
}