config

Documentation

Index

• Variables
• func GetCompileHost(cfgHost string) string
• type APIClient
• type BuildConfigResponse
• type CompileConfigRequest
• type ConfigCompiler
  • func New(apiClient APIClient, collaboratorsClient collaborators.CollaboratorsClient) *ConfigCompiler
  • func NewWithConfig(cfg *settings.Config) (*ConfigCompiler, error)
  • func (c *ConfigCompiler) ConfigQuery(configPath string, orgID string, params Parameters, values Values) (*ConfigResponse, error)
  • func (c *ConfigCompiler) ProcessConfig(opts ProcessConfigOpts) (response *ConfigResponse, err error)
  • func (c *ConfigCompiler) ValidateConfig(opts ValidateConfigOpts) error
• type ConfigError
• type ConfigResponse
• type GQLErrorsCollection
  • func (errs GQLErrorsCollection) Error() string
• type GQLResponseError
• type KeyVal
  • func PrepareForGraphQL(kvMap Values) []KeyVal
• type LegacyConfigResponse
• type Options
• type Parameters
• type ProcessConfigOpts
• type ValidateConfigOpts
• type Values
  • func LocalPipelineValues(parameters Parameters) Values

Variables

var (

	// Making this the one true source for default config path
	DefaultConfigPath = ".circleci/config.yml"
)

Functions

func GetCompileHost

func GetCompileHost(cfgHost string) string

Types

type APIClient

type APIClient interface {
	CompileConfig(configContent string, orgID string, params Parameters, values Values) (*ConfigResponse, error)
}

type BuildConfigResponse

type BuildConfigResponse struct {
	BuildConfig struct {
		LegacyConfigResponse
	}
}

BuildConfigResponse wraps the GQL result of the ConfigQuery

type CompileConfigRequest

type CompileConfigRequest struct {
	ConfigYaml string  `json:"config_yaml"`
	Options    Options `json:"options"`
}

CompileConfigRequest - the structure of the data we send to the downstream compilation service.

type ConfigCompiler

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

func New

func New(apiClient APIClient, collaboratorsClient collaborators.CollaboratorsClient) *ConfigCompiler

func NewWithConfig

func NewWithConfig(cfg *settings.Config) (*ConfigCompiler, error)

func (*ConfigCompiler) ConfigQuery

func (c *ConfigCompiler) ConfigQuery(
	configPath string,
	orgID string,
	params Parameters,
	values Values,
) (*ConfigResponse, error)

ConfigQuery - attempts to compile or validate a given config file with the passed in params/values. If the orgID is passed in, the config-compilation with private orbs should work.

func (*ConfigCompiler) ProcessConfig

func (c *ConfigCompiler) ProcessConfig(opts ProcessConfigOpts) (response *ConfigResponse, err error)

func (*ConfigCompiler) ValidateConfig

func (c *ConfigCompiler) ValidateConfig(opts ValidateConfigOpts) error

The <path> arg is actually optional, in order to support compatibility with the --path flag.

type ConfigError

type ConfigError struct {
	Message string `json:"message"`
}

type ConfigResponse

type ConfigResponse struct {
	Valid      bool          `json:"valid"`
	SourceYaml string        `json:"source-yaml"`
	OutputYaml string        `json:"output-yaml"`
	Errors     []ConfigError `json:"errors"`
}

ConfigResponse - the structure of what is returned from the downstream compilation endpoint

type GQLErrorsCollection

type GQLErrorsCollection []GQLResponseError

GQLErrorsCollection is a slice of errors returned by the GraphQL server. Each error is made up of a GQLResponseError type.

func (GQLErrorsCollection) Error

func (errs GQLErrorsCollection) Error() string

Error turns a GQLErrorsCollection into an acceptable error string that can be printed to the user.

type GQLResponseError

type GQLResponseError struct {
	Message       string
	Value         string
	AllowedValues []string
	EnumType      string
	Type          string
}

GQLResponseError is a mapping of the data returned by the GraphQL server of key-value pairs. Typically used with the structure "Message: string", but other response errors provide additional fields.

type KeyVal

type KeyVal struct {
	Key string      `json:"key"`
	Val interface{} `json:"val"`
}

KeyVal is a data structure specifically for passing pipeline data to GraphQL which doesn't support free-form maps.

func PrepareForGraphQL

func PrepareForGraphQL(kvMap Values) []KeyVal

PrepareForGraphQL takes a golang homogenous map, and transforms it into a list of keyval pairs, since GraphQL does not support homogenous maps.

type LegacyConfigResponse

type LegacyConfigResponse struct {
	Valid      bool
	SourceYaml string
	OutputYaml string

	Errors GQLErrorsCollection
}

LegacyConfigResponse is a structure that matches the result of the GQL query, so that we can use mapstructure to convert from nested maps to a strongly typed struct.

type Options

type Options struct {
	OwnerID string `json:"owner_id,omitempty"`
	// PipelineParameters are deprecated and will be removed in the future.
	// Use PipelineValues instead.
	PipelineParameters map[string]interface{} `json:"pipeline_parameters,omitempty"`
	PipelineValues     map[string]interface{} `json:"pipeline_values,omitempty"`
}

type Parameters

type Parameters map[string]interface{}

Static typing is bypassed using an empty interface here due to pipeline parameters supporting multiple types.

type ProcessConfigOpts

type ProcessConfigOpts struct {
	ConfigPath             string
	OrgID                  string
	OrgSlug                string
	PipelineParamsFilePath string

	VerboseOutput bool
}

type ValidateConfigOpts

type ValidateConfigOpts struct {
	ConfigPath string
	OrgID      string
	OrgSlug    string

	IgnoreDeprecatedImages bool
	VerboseOutput          bool
}

type Values

type Values map[string]interface{}

CircleCI provides various `<< pipeline.x >>` values to be used in your config, but sometimes we need to fabricate those values when validating config.

func LocalPipelineValues

func LocalPipelineValues(parameters Parameters) Values

LocalPipelineValues returns a map of pipeline values that can be used for local validation. The given parameters will be prefixed with "pipeline.parameters." and accessible via << pipeline.parameters.foo >>.