config

type BuildConfigResponse ¶ added in v0.1.26061

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 ¶ added in v0.1.25569

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

func New(cfg *settings.Config) *ConfigCompiler

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

func (c *ConfigCompiler) ProcessConfig(opts ProcessConfigOpts) error

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

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 ¶ added in v0.1.26061

type GQLErrorsCollection []GQLResponseError

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

func (errs GQLErrorsCollection) Error() string

type GQLResponseError ¶ added in v0.1.26061

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 ¶ added in v0.1.26061

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(kvMap Values) []KeyVal

type LegacyConfigResponse ¶ added in v0.1.26061

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 map[string]interface{} `json:"pipeline_parameters,omitempty"`
	PipelineValues     map[string]interface{} `json:"pipeline_values,omitempty"`
}

type Parameters ¶ added in v0.1.25569

type Parameters map[string]interface{}

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

type ProcessConfigOpts ¶ added in v0.1.25569

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

	VerboseOutput bool
}

type ValidateConfigOpts ¶ added in v0.1.25569

type ValidateConfigOpts struct {
	ConfigPath string
	OrgID      string
	OrgSlug    string

	IgnoreDeprecatedImages bool
	VerboseOutput          bool
}

type Values ¶ added in v0.1.25569

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() Values