config

package
v0.0.0-...-55ed90b Latest Latest
Warning

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

Go to latest
Published: Feb 11, 2024 License: Apache-2.0 Imports: 29 Imported by: 1

Documentation

Index

Constants

View Source
const PennywiseDir = ".pennywise"

Variables

View Source
var ErrorInvalidConfigFile = errors.New("parsing config file failed, check file syntax")

Functions

func ConfigurationFilePath

func ConfigurationFilePath() string

func CredentialsFilePath

func CredentialsFilePath() string

func DetectProjectMetadata

func DetectProjectMetadata(path string) *schema.ProjectMetadata

func FileExists

func FileExists(path string) bool

func IsDev

func IsDev() bool

func IsEnvPresent

func IsEnvPresent(s string) bool

func IsTest

func IsTest() bool

func RootDir

func RootDir() string

Types

type Config

type Config struct {
	Credentials   Credentials
	Configuration Configuration

	Version         string `yaml:"version,omitempty" ignored:"true"`
	LogLevel        string `yaml:"log_level,omitempty" envconfig:"LOG_LEVEL"`
	DebugReport     bool   `ignored:"true"`
	NoColor         bool   `yaml:"no_color,omitempty" envconfig:"NO_COLOR"`
	SkipUpdateCheck bool   `yaml:"skip_update_check,omitempty" envconfig:"SKIP_UPDATE_CHECK"`
	Parallelism     *int   `envconfig:"PARALLELISM"`

	APIKey                    string `envconfig:"API_KEY"`
	PricingAPIEndpoint        string `yaml:"pricing_api_endpoint,omitempty" envconfig:"PRICING_API_ENDPOINT"`
	PricingCacheDisabled      bool   `yaml:"pricing_cache_disabled" envconfig:"PRICING_CACHE_DISABLED"`
	PricingCacheObjectSize    int    `yaml:"pricing_cache_object_size" envconfig:"PRICING_CACHE_OBJECT_SIZE"`
	DefaultPricingAPIEndpoint string `yaml:"default_pricing_api_endpoint,omitempty" envconfig:"DEFAULT_PRICING_API_ENDPOINT"`
	DashboardAPIEndpoint      string `yaml:"dashboard_api_endpoint,omitempty" envconfig:"DASHBOARD_API_ENDPOINT"`
	DashboardEndpoint         string `yaml:"dashboard_endpoint,omitempty" envconfig:"DASHBOARD_ENDPOINT"`
	UsageAPIEndpoint          string `yaml:"usage_api_endpoint,omitempty" envconfig:"USAGE_API_ENDPOINT"`
	UsageActualCosts          bool   `yaml:"usage_actual_costs,omitempty" envconfig:"USAGE_ACTUAL_COSTS"`
	PolicyV2APIEndpoint       string `yaml:"policy_v2_api_endpoint,omitempty" envconfig:"POLICY_V2_API_ENDPOINT"`
	PoliciesEnabled           bool
	TagPoliciesEnabled        bool
	EnableDashboard           bool  `yaml:"enable_dashboard,omitempty" envconfig:"ENABLE_DASHBOARD"`
	EnableCloud               *bool `yaml:"enable_cloud,omitempty" envconfig:"ENABLE_CLOUD"`
	EnableCloudUpload         *bool `yaml:"enable_cloud_upload,omitempty" envconfig:"ENABLE_CLOUD_UPLOAD"`
	DisableHCLParsing         bool  `yaml:"disable_hcl_parsing,omitempty" envconfig:"DISABLE_HCL_PARSING"`

	TLSInsecureSkipVerify *bool  `envconfig:"TLS_INSECURE_SKIP_VERIFY"`
	TLSCACertFile         string `envconfig:"TLS_CA_CERT_FILE"`

	Currency       string `envconfig:"CURRENCY"`
	CurrencyFormat string `envconfig:"CURRENCY_FORMAT"`

	AWSOverrideRegion    string `envconfig:"AWS_OVERRIDE_REGION"`
	AzureOverrideRegion  string `envconfig:"AZURE_OVERRIDE_REGION"`
	GoogleOverrideRegion string `envconfig:"GOOGLE_OVERRIDE_REGION"`

	// TerraformSourceMap replaces any source URL with the provided value.
	TerraformSourceMap TerraformSourceMap `envconfig:"TERRAFORM_SOURCE_MAP"`

	// Org settings
	EnableCloudForOrganization bool

	Projects        []*Project `yaml:"projects" ignored:"true"`
	Format          string     `yaml:"format,omitempty" ignored:"true"`
	ShowAllProjects bool       `yaml:"show_all_projects,omitempty" ignored:"true"`
	ShowSkipped     bool       `yaml:"show_skipped,omitempty" ignored:"true"`
	SyncUsageFile   bool       `yaml:"sync_usage_file,omitempty" ignored:"true"`
	Fields          []string   `yaml:"fields,omitempty" ignored:"true"`
	CompareTo       string
	GitDiffTarget   *string

	// Base configuration settings
	// RootPath defines the raw value of the `--path` flag provided by the user
	RootPath string
	// ConfigFilePath defines the raw value of the `--config-file` flag provided by the user
	ConfigFilePath string

	NoCache bool `yaml:"fields,omitempty" ignored:"true"`

	SkipErrLine bool

	// for testing
	EventsDisabled bool
	// contains filtered or unexported fields
}

func DefaultConfig

func DefaultConfig() *Config

func (*Config) CachePath

func (c *Config) CachePath() string

CachePath finds path which contains the .infracost directory. It traverses parent directories until a .infracost folder is found. If no .infracost folders exist then CachePath uses the current wd.

func (*Config) IsLogging

func (c *Config) IsLogging() bool

func (*Config) IsSelfHosted

func (c *Config) IsSelfHosted() bool

func (*Config) LoadFromConfigFile

func (c *Config) LoadFromConfigFile(path string, cmd *cobra.Command) error

func (*Config) LoadFromEnv

func (c *Config) LoadFromEnv() error

func (*Config) LoadGlobalFlags

func (c *Config) LoadGlobalFlags(cmd *cobra.Command) error

func (*Config) LogFields

func (c *Config) LogFields() map[string]interface{}

LogFields sets the meta fields that are added to any log line entries.

func (*Config) LogWriter

func (c *Config) LogWriter() io.Writer

LogWriter returns the writer the Logger should use to write logs to. In most cases this should be stderr, but it can also be a file.

func (*Config) RepoPath

func (c *Config) RepoPath() string

RepoPath returns the filepath to either the config-file location or initial path provided by the user.

func (*Config) SetLogDisableTimestamps

func (c *Config) SetLogDisableTimestamps(v bool)

SetLogDisableTimestamps sets if logs should contain the timestamp the line is written at.

func (*Config) SetLogWriter

func (c *Config) SetLogWriter(w io.Writer)

SetLogWriter sets the io.Writer that the logs should be piped to.

func (*Config) WriteLevel

func (c *Config) WriteLevel() string

WriteLevel is the log level that the Logger writes to LogWriter.

type ConfigFileSpec

type ConfigFileSpec struct {
	Version  string     `yaml:"version"`
	Projects []*Project `yaml:"projects" ignored:"true"`
}

func LoadConfigFile

func LoadConfigFile(path string) (ConfigFileSpec, error)

func (*ConfigFileSpec) UnmarshalYAML

func (f *ConfigFileSpec) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.v2.Unmarshaller interface. Marshalls the yaml into an intermediary struct so that we can catch field violations before the data is set on the main ConfigFileSpec. Note this method must return a YamlError type so that we don't run into error collisions with the base yaml.v2 errors.

type Configuration

type Configuration struct {
	Version               string `yaml:"version"`
	Currency              string `yaml:"currency,omitempty"`
	EnableDashboard       *bool  `yaml:"enable_dashboard,omitempty"`
	DisableHCLParsing     *bool  `yaml:"disable_hcl_parsing,omitempty"`
	TLSInsecureSkipVerify *bool  `yaml:"tls_insecure_skip_verify,omitempty"`
	TLSCACertFile         string `yaml:"tls_ca_cert_file,omitempty"`
	EnableCloud           *bool  `yaml:"enable_cloud"`
	EnableCloudUpload     *bool  `yaml:"enable_cloud_upload"`
}

func (Configuration) Save

func (c Configuration) Save() error

type ContextValues

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

ContextValues is a type that wraps a map with methods that safely handle concurrent reads and writes.

func NewContextValues

func NewContextValues(values map[string]interface{}) *ContextValues

NewContextValues returns a new instance of ContextValues.

func (*ContextValues) GetValue

func (cv *ContextValues) GetValue(key string) (interface{}, bool)

GetValue safely retrieves a value from the map. It locks the mutex for reading, deferring the unlock until the method returns. This prevents a race condition if a separate goroutine writes to the map concurrently.

func (*ContextValues) SetValue

func (cv *ContextValues) SetValue(key string, value interface{})

SetValue safely sets a value in the map. It locks the mutex for writing, deferring the unlock until the method returns. This prevents a race condition if separate goroutines read or write to the map concurrently.

func (*ContextValues) Values

func (cv *ContextValues) Values() map[string]interface{}

Values safely retrieves a copy of the map. This method locks the mutex for reading, deferring the unlock until the method returns. By returning a copy, this prevents a race condition if separate goroutines read or write to the original map concurrently. However, creating a copy may be expensive for large maps.

type Credentials

type Credentials struct {
	Version            string `yaml:"version"`
	APIKey             string `yaml:"api_key,omitempty"`
	PricingAPIEndpoint string `yaml:"pricing_api_endpoint,omitempty"`
}

func (Credentials) Save

func (c Credentials) Save() error

type Project

type Project struct {
	// ConfigSha can be provided to identify the configuration used for the project
	ConfigSha string `yaml:"config_sha,omitempty"  ignored:"true"`
	// Path to the Terraform directory or JSON/plan file.
	// A path can be repeated with different parameters, e.g. for multiple workspaces.
	Path string `yaml:"path" ignored:"true"`
	// ExcludePaths defines a list of directories that the provider should ignore.
	ExcludePaths []string `yaml:"exclude_paths,omitempty" ignored:"true"`
	// DependencyPaths is a list of any paths that this project depends on. These paths are relative to the
	// config file and NOT the project.
	DependencyPaths []string `yaml:"dependency_paths,omitempty"`
	// IncludeAllPaths tells autodetect to use all folders with valid project files.
	IncludeAllPaths bool `yaml:"include_all_paths,omitempty" ignored:"true"`
	// Name is a user defined name for the project
	Name string `yaml:"name,omitempty" ignored:"true"`
	// TerraformVarFiles is any var files that are to be used with the project.
	TerraformVarFiles []string `yaml:"terraform_var_files,omitempty"`
	// TerraformVars is a slice of input vars that are to be used with the project.
	TerraformVars map[string]string `yaml:"terraform_vars,omitempty"`
	// TerraformForceCLI will run a project by calling out to the terraform/terragrunt binary to generate a plan JSON file.
	TerraformForceCLI bool `yaml:"terraform_force_cli,omitempty"`
	// TerraformPlanFlags are flags to pass to terraform plan with Terraform directory paths
	TerraformPlanFlags string `yaml:"terraform_plan_flags,omitempty" ignored:"true"`
	// TerraformInitFlags are flags to pass to terraform init
	TerraformInitFlags string `yaml:"terraform_init_flags,omitempty" ignored:"true"`
	// TerraformBinary is an optional field used to change the path to the terraform or terragrunt binary
	TerraformBinary string `yaml:"terraform_binary,omitempty" envconfig:"TERRAFORM_BINARY"`
	// TerraformWorkspace is an optional field used to set the Terraform workspace
	TerraformWorkspace string `yaml:"terraform_workspace,omitempty" envconfig:"TERRAFORM_WORKSPACE"`
	// TerraformCloudHost is used to override the default app.terraform.io backend host. Only applicable for
	// terraform cloud/enterprise users.
	TerraformCloudHost string `yaml:"terraform_cloud_host,omitempty" envconfig:"TERRAFORM_CLOUD_HOST"`
	// TerraformCloudToken sets the Team API Token or User API Token so infracost can use it to access the plan.
	// Only applicable for terraform cloud/enterprise users.
	TerraformCloudToken string `yaml:"terraform_cloud_token,omitempty" envconfig:"TERRAFORM_CLOUD_TOKEN"`
	// TerragruntFlags set additional flags that should be passed to terragrunt.
	TerragruntFlags string `yaml:"terragrunt_flags,omitempty" envconfig:"TERRAGRUNT_FLAGS"`
	// UsageFile is the full path to usage file that specifies values for usage-based resources
	UsageFile string `yaml:"usage_file,omitempty" ignored:"true"`
	// TerraformUseState sets if the users wants to use the terraform state for infracost ops.
	TerraformUseState bool              `yaml:"terraform_use_state,omitempty" ignored:"true"`
	Env               map[string]string `yaml:"env,omitempty" ignored:"true"`
}

Project defines a specific terraform project config. This can be used specify per folder/project configurations so that users don't have to provide flags every run. Fields are documented below. More info is outlined here: https://www.infracost.io/config-file

type ProjectContext

type ProjectContext struct {
	RunContext    *RunContext
	ProjectConfig *Project

	ContextValues *ContextValues

	UsingCache bool
	CacheErr   string
	// contains filtered or unexported fields
}

func NewProjectContext

func NewProjectContext(runCtx *RunContext, projectCfg *Project, logFields interface{}) *ProjectContext

func (*ProjectContext) Logger

func (c *ProjectContext) Logger() zerolog.Logger

func (*ProjectContext) SetFrom

func (c *ProjectContext) SetFrom(d ProjectContexter)

type ProjectContexter

type ProjectContexter interface {
	ProjectContext() map[string]interface{}
}

type RunContext

type RunContext struct {
	Config        *Config
	State         *State
	CMD           string
	ContextValues *ContextValues

	ModuleMutex *intSync.KeyMutex
	StartTime   int64

	OutWriter io.Writer
	ErrWriter io.Writer
	Exit      func(code int)
	// contains filtered or unexported fields
}

func EmptyRunContext

func EmptyRunContext() *RunContext

func NewRunContextFromEnv

func NewRunContextFromEnv(rootCtx context.Context) (*RunContext, error)

func (*RunContext) Context

func (r *RunContext) Context() context.Context

Context returns the underlying context.

func (*RunContext) EventEnv

func (r *RunContext) EventEnv() map[string]interface{}

func (*RunContext) EventEnvWithProjectContexts

func (r *RunContext) EventEnvWithProjectContexts(projectContexts []*ProjectContext) map[string]interface{}

func (*RunContext) GetParallelism

func (r *RunContext) GetParallelism() (int, error)

func (*RunContext) GetResourceWarnings

func (r *RunContext) GetResourceWarnings() map[string]map[string]int

func (*RunContext) IsCIRun

func (r *RunContext) IsCIRun() bool

func (*RunContext) IsCloudEnabled

func (r *RunContext) IsCloudEnabled() bool

func (*RunContext) IsCloudUploadEnabled

func (r *RunContext) IsCloudUploadEnabled() bool

func (*RunContext) IsCloudUploadExplicitlyEnabled

func (r *RunContext) IsCloudUploadExplicitlyEnabled() bool

IsCloudUploadExplicitlyEnabled returns true if cloud upload has been enabled through one of the env variables ENABLE_CLOUD, ENABLE_CLOUD_UPLOAD, or ENABLE_DASHBOARD

func (*RunContext) IsInfracostComment

func (r *RunContext) IsInfracostComment() bool

func (*RunContext) SetIsInfracostComment

func (r *RunContext) SetIsInfracostComment()

SetIsInfracostComment identifies that the primary command being run is `infracost comment`

func (*RunContext) SetResourceWarnings

func (r *RunContext) SetResourceWarnings(resourceWarnings map[string]map[string]int)

func (*RunContext) UUID

func (r *RunContext) UUID() uuid.UUID

UUID returns the underlying run uuid. This can be used to globally identify the run context.

type State

type State struct {
	InstallID              string `json:"installId"`
	LatestReleaseVersion   string `json:"latestReleaseVersion"`
	LatestReleaseCheckedAt string `json:"latestReleaseCheckedAt"`
}

func LoadState

func LoadState() (*State, error)

func (*State) Save

func (s *State) Save() error

type TerraformSourceMap

type TerraformSourceMap map[string]string

func (*TerraformSourceMap) Decode

func (s *TerraformSourceMap) Decode(value string) error

type YamlError

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

YamlError is a custom error type that allows setting multiple error messages under a base message. It is used to decipher between internal errors and the yaml.v2 errors.

func (*YamlError) Error

func (y *YamlError) Error() string

Error implements the error interface returning the YamlError as a string. If a raw error is set it simply returns the error message from that. Otherwise, it constructs an indented error message out of the base and errors.

YamlError.Error supports multiple nesting and can construct heavily indented output if needed. e.g.

&YamlError{
	base: "top message",
	errors: []error{
		errors.New("top error 1"),
		&YamlError{
			base: "child message",
			errors: []error{
				errors.New("child error 1"),
			},
		},
	},
}

would output a string like so:

top message:
	top error 1
	child message:
		child error 1

This can be useful for ui error messages where you need to highlight issues with specific fields/entries.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL