configversion

package
v0.3.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 22, 2024 License: MPL-2.0 Imports: 23 Imported by: 0

Documentation

Overview

Package configversion handles terraform configurations.

Index

Constants

View Source 
const (
	DefaultAutoQueueRuns = true

	// List all available configuration version statuses.
	ConfigurationErrored  ConfigurationStatus = "errored"
	ConfigurationPending  ConfigurationStatus = "pending"
	ConfigurationUploaded ConfigurationStatus = "uploaded"

	// Default maximum config size is 10mb.
	DefaultConfigMaxSize int64 = 1024 * 1024 * 10
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	*otfapi.Client

	// Client does not implement all of service yet
	Service
}

func (*Client) DownloadConfig 

func (c *Client) DownloadConfig(ctx context.Context, cvID string) ([]byte, error)

DownloadConfig downloads a configuration version tarball. Only configuration versions in the uploaded state may be downloaded.

type ConfigUploader 

type ConfigUploader interface {
	// Upload uploads the config tarball and returns a status indicating success
	// or failure.
	Upload(ctx context.Context, config []byte) (ConfigurationStatus, error)
	// SetErrored sets the config version status to 'errored' in the store.
	SetErrored(ctx context.Context) error
}

ConfigUploader uploads a config

type ConfigurationStatus 

type ConfigurationStatus string

ConfigurationStatus represents a configuration version status.

type ConfigurationVersion 

type ConfigurationVersion struct {
	ID                string
	CreatedAt         time.Time
	AutoQueueRuns     bool
	Source            Source
	Speculative       bool
	Status            ConfigurationStatus
	StatusTimestamps  []ConfigurationVersionStatusTimestamp
	WorkspaceID       string
	IngressAttributes *IngressAttributes
}

ConfigurationVersion is a representation of an uploaded or ingressed Terraform configuration.

func NewConfigurationVersion 

func NewConfigurationVersion(workspaceID string, opts CreateOptions) (*ConfigurationVersion, error)

NewConfigurationVersion creates a ConfigurationVersion object from scratch

func (*ConfigurationVersion) AddStatusTimestamp 

func (cv *ConfigurationVersion) AddStatusTimestamp(status ConfigurationStatus, timestamp time.Time)

func (*ConfigurationVersion) StatusTimestamp 

func (cv *ConfigurationVersion) StatusTimestamp(status ConfigurationStatus) (time.Time, error)

func (*ConfigurationVersion) String 

func (cv *ConfigurationVersion) String() string

func (*ConfigurationVersion) Upload 

func (cv *ConfigurationVersion) Upload(ctx context.Context, config []byte, uploader ConfigUploader) error

Upload saves the config to the db and updates status accordingly.

type ConfigurationVersionGetOptions 

type ConfigurationVersionGetOptions struct {
	// ID of config version to retrieve
	ID *string

	// Get latest config version for this workspace ID
	WorkspaceID *string

	// A list of relations to include
	Include *string `schema:"include"`
}

ConfigurationVersionGetOptions are options for retrieving a single config version. Either ID *or* WorkspaceID must be specfiied.

type ConfigurationVersionStatusTimestamp 

type ConfigurationVersionStatusTimestamp struct {
	Status    ConfigurationStatus
	Timestamp time.Time
}

type CreateOptions added in v0.2.2 

type CreateOptions struct {
	AutoQueueRuns *bool
	Speculative   *bool
	Source        Source
	*IngressAttributes
}

CreateOptions represents the options for creating a configuration version. See jsonapi.CreateOptions for more details.

type FakeService added in v0.2.2 

type FakeService struct {
	// contains filtered or unexported fields
}

func (*FakeService) Create added in v0.2.2 

func (f *FakeService) Create(context.Context, string, CreateOptions) (*ConfigurationVersion, error)

func (*FakeService) Get added in v0.2.2 

func (f *FakeService) Get(context.Context, string) (*ConfigurationVersion, error)

func (*FakeService) GetLatest added in v0.2.2 

func (f *FakeService) GetLatest(context.Context, string) (*ConfigurationVersion, error)

func (*FakeService) UploadConfig added in v0.2.2 

func (f *FakeService) UploadConfig(context.Context, string, []byte) error

type IngressAttributes 

type IngressAttributes struct {
	// ID     string
	Branch string
	// CloneURL          string
	// CommitMessage     string
	CommitSHA string
	CommitURL string
	// CompareURL        string
	Repo              string
	IsPullRequest     bool
	OnDefaultBranch   bool
	PullRequestNumber int
	PullRequestURL    string
	PullRequestTitle  string
	// PullRequestBody   string
	Tag             string
	SenderUsername  string
	SenderAvatarURL string
	SenderHTMLURL   string
}

func NewIngressFromRow added in v0.1.6 

func NewIngressFromRow(row *sqlc.IngressAttribute) *IngressAttributes

type ListOptions added in v0.2.2 

type ListOptions struct {
	// A list of relations to include
	Include *string `schema:"include"`

	resource.PageOptions
}

ListOptions are options for paginating and filtering a list of configuration versions

type Options 

type Options struct {
	logr.Logger

	WorkspaceAuthorizer internal.Authorizer
	MaxConfigSize       int64

	internal.Cache
	*sql.DB
	*surl.Signer
	*tfeapi.Responder
}

type Service 

type Service struct {
	logr.Logger
	// contains filtered or unexported fields
}

func NewService 

func NewService(opts Options) *Service

func (*Service) AddHandlers added in v0.2.2 

func (s *Service) AddHandlers(r *mux.Router)

func (*Service) Create added in v0.2.2 

func (s *Service) Create(ctx context.Context, workspaceID string, opts CreateOptions) (*ConfigurationVersion, error)

func (*Service) Delete added in v0.2.2 

func (s *Service) Delete(ctx context.Context, cvID string) error

func (*Service) DownloadConfig 

func (s *Service) DownloadConfig(ctx context.Context, cvID string) ([]byte, error)

DownloadConfig retrieves a tarball from the db

func (*Service) Get added in v0.2.2 

func (s *Service) Get(ctx context.Context, cvID string) (*ConfigurationVersion, error)

func (*Service) GetLatest added in v0.2.2 

func (s *Service) GetLatest(ctx context.Context, workspaceID string) (*ConfigurationVersion, error)

func (*Service) List added in v0.2.2 

func (s *Service) List(ctx context.Context, workspaceID string, opts ListOptions) (*resource.Page[*ConfigurationVersion], error)

func (*Service) UploadConfig 

func (s *Service) UploadConfig(ctx context.Context, cvID string, config []byte) error

UploadConfig saves a configuration tarball to the db

NOTE: unauthenticated - access granted only via signed URL

type Source added in v0.1.8 

type Source string

Source representse of a run. 

const (
	SourceAPI       Source = "tfe-api"
	SourceGithub    Source = "github"
	SourceGitlab    Source = "gitlab"
	SourceTerraform Source = "terraform+cloud"

	DefaultSource = SourceAPI
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.