pipeline.go

//go:generate mockgen -source=$GOFILE -package=mock -destination=./mocks/$GOFILE
package circleci

import (
	"context"
	"fmt"
	"time"
)

type Pipelines interface {
	List(ctx context.Context, options PipelineListOptions) (*PipelineList, error)
	Continue(ctx context.Context, options PipelineContinueOptions) error
	Get(ctx context.Context, pipelineID string) (*Pipeline, error)
	GetConfig(ctx context.Context, pipelineID string) (*PipelineConfig, error)
	ListWorkflows(ctx context.Context, pipelineID string, options PipelineListWorkflowsOptions) (*WorkflowList, error)
}

type pipelines struct {
	client *Client
}

type PipelineList struct {
	Items         []*Pipeline `json:"items"`
	NextPageToken string      `json:"next_page_token"`
}

type Pipeline struct {
	ID          string           `json:"id"`
	ProjectSlug string           `json:"project_slug"`
	State       string           `json:"state"`
	Number      int64            `json:"number"`
	CreatedAt   time.Time        `json:"created_at"`
	UpdatedAt   time.Time        `json:"updated_at,omitempty"`
	Trigger     *Trigger         `json:"trigger"`
	Vcs         *VCS             `json:"vcs"`
	Errors      []*PipelineError `json:"errors"`
}

type Trigger struct {
	Type       string    `json:"type"`
	ReceivedAt time.Time `json:"received_at"`
	Actor      *Actor    `json:"actor"`
}

type Actor struct {
	Login     string `json:"login"`
	AvatarURL string `json:"avatar_url"`
}

type VCS struct {
	ProviderName        string  `json:"provider_name"`
	TargetRepositoryURL string  `json:"target_repository_url"`
	Branch              string  `json:"branch,omitempty"`
	ReviewID            string  `json:"review_id,omitempty"`
	ReviewURL           string  `json:"review_url,omitempty"`
	Revision            string  `json:"revision"`
	Tag                 string  `json:"tag,omitempty"`
	OriginRepositoryURL string  `json:"origin_repository_url"`
	Commit              *Commit `json:"commit"`
}

type Commit struct {
	Subject string `json:"subject"`
	Body    string `json:"body"`
}

type PipelineError struct {
	Type    string `json:"type"`
	Message string `json:"message"`
}

type PipelineListOptions struct {
	OrgSlug   *string `url:"org-slug,omitempty"`
	Mine      *bool   `url:"mine,omitempty"`
	PageToken *string `url:"page-token,omitempty"`
}

func (o PipelineListOptions) valid() error {
	// Nothing is required
	return nil
}

func (s *pipelines) List(ctx context.Context, options PipelineListOptions) (*PipelineList, error) {
	if err := options.valid(); err != nil {
		return nil, err
	}

	u := "pipeline"
	req, err := s.client.newRequest("GET", u, &options)
	if err != nil {
		return nil, err
	}

	pl := &PipelineList{}
	err = s.client.do(ctx, req, pl)
	if err != nil {
		return nil, err
	}

	return pl, nil
}

type PipelineContinueOptions struct {
	ContinuationKey *string                `json:"continuation-key"`
	Configuration   *string                `json:"configuration"`
	Parameters      map[string]interface{} `json:"parameters,omitempty"`
}

func (o PipelineContinueOptions) valid() error {
	if !validString(o.ContinuationKey) {
		return ErrRequiredPipelineContinuationKey
	}

	if !validString(o.Configuration) {
		return ErrRequiredPipelineConfiguration
	}

	return nil
}

func (s *pipelines) Continue(ctx context.Context, options PipelineContinueOptions) error {
	if err := options.valid(); err != nil {
		return err
	}

	u := "pipeline/continue"
	req, err := s.client.newRequest("POST", u, &options)
	if err != nil {
		return err
	}

	return s.client.do(ctx, req, nil)
}

func (s *pipelines) Get(ctx context.Context, pipelineID string) (*Pipeline, error) {
	if !validString(&pipelineID) {
		return nil, ErrRequiredPipelinePipelineID
	}
	u := fmt.Sprintf("pipeline/%s", pipelineID)
	req, err := s.client.newRequest("GET", u, nil)
	if err != nil {
		return nil, err
	}

	p := &Pipeline{}
	err = s.client.do(ctx, req, p)
	if err != nil {
		return nil, err
	}

	return p, nil
}

type PipelineConfig struct {
	Source              string `json:"source"`
	Compiled            string `json:"compiled"`
	SetupConfig         string `json:"setup-config"`
	CompiledSetupConfig string `json:"compiled-setup-config"`
}

func (s *pipelines) GetConfig(ctx context.Context, pipelineID string) (*PipelineConfig, error) {
	if !validString(&pipelineID) {
		return nil, ErrRequiredPipelinePipelineID
	}
	u := fmt.Sprintf("pipeline/%s/config", pipelineID)
	req, err := s.client.newRequest("GET", u, nil)
	if err != nil {
		return nil, err
	}

	pc := &PipelineConfig{}
	err = s.client.do(ctx, req, pc)
	if err != nil {
		return nil, err
	}

	return pc, nil
}

type WorkflowList struct {
	Items         []*Workflow `json:"items"`
	NextPageToken string      `json:"next_page_token"`
}

type PipelineListWorkflowsOptions struct {
	PageToken *string `url:"page-token,omitempty"`
}

func (o PipelineListWorkflowsOptions) valid() error {
	// Nothing is required
	return nil
}

func (s *pipelines) ListWorkflows(ctx context.Context, pipelineID string, options PipelineListWorkflowsOptions) (*WorkflowList, error) {
	if err := options.valid(); err != nil {
		return nil, err
	}

	if !validString(&pipelineID) {
		return nil, ErrRequiredPipelinePipelineID
	}

	u := fmt.Sprintf("pipeline/%s/workflow", pipelineID)
	req, err := s.client.newRequest("GET", u, &options)
	if err != nil {
		return nil, err
	}

	wl := &WorkflowList{}
	err = s.client.do(ctx, req, wl)
	if err != nil {
		return nil, err
	}

	return wl, nil
}