mirror of
https://github.com/hashicorp/packer.git
synced 2026-09-19 06:21:41 -04:00
Lucas Bajolet
98198b5af8
The GetBuilds function, available on both HCL2 and legacy JSON configuration objects, used to return the Build interface. This typing by interface is not useful in this instance, since all the uses of `GetBuilds' are self-contained within Packer, and we're never using any other implementation for it than `*CoreBuild`. We've been relying on the dynamic type for all the builds being *CoreBuild in some places of the code, so to avoid potential surprises in the future, we'll change the signature now so it returns only concrete types.
103 lines
3.1 KiB
Go
103 lines
3.1 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: BUSL-1.1
|
|
|
|
package packer
|
|
|
|
import (
|
|
hcl "github.com/hashicorp/hcl/v2"
|
|
packersdk "github.com/hashicorp/packer-plugin-sdk/packer"
|
|
plugingetter "github.com/hashicorp/packer/packer/plugin-getter"
|
|
)
|
|
|
|
type GetBuildsOptions struct {
|
|
// Get builds except the ones that match with except and with only the ones
|
|
// that match with Only. When those are empty everything matches.
|
|
Except, Only []string
|
|
Debug, Force bool
|
|
OnError string
|
|
|
|
// count only/except match count; so say something when nothing matched.
|
|
ExceptMatches, OnlyMatches int
|
|
}
|
|
|
|
type BuildGetter interface {
|
|
// GetBuilds return all possible builds for a config. It also starts all
|
|
// builders.
|
|
// TODO(azr): rename to builder starter ?
|
|
GetBuilds(GetBuildsOptions) ([]*CoreBuild, hcl.Diagnostics)
|
|
}
|
|
|
|
type Evaluator interface {
|
|
// EvaluateExpression is meant to be used in the `packer console` command.
|
|
// It parses the input string and returns what needs to be displayed. In
|
|
// case of an error the error should be displayed.
|
|
EvaluateExpression(expr string) (output string, exit bool, diags hcl.Diagnostics)
|
|
}
|
|
|
|
type InitializeOptions struct {
|
|
// When set, the execution of datasources will be skipped and the datasource will provide
|
|
// an output spec that will be used for validation only.
|
|
SkipDatasourcesExecution bool
|
|
// UseSequential changes the way data sources and locals are evaluated.
|
|
//
|
|
// In this mode, instead of using two separate phases to evaluate datasources first, then
|
|
// local variables, here we instead use a DAG so both are evaluated at once, based on the
|
|
// dependencies between them.
|
|
//
|
|
// This is optional and defaults to false for now, but this may become a default later.
|
|
UseSequential bool
|
|
}
|
|
|
|
type PluginBinaryDetector interface {
|
|
// DetectPluginBinaries is used only for HCL2 templates, and loads required
|
|
// plugins if specified.
|
|
DetectPluginBinaries() hcl.Diagnostics
|
|
}
|
|
|
|
// The Handler handles all Packer things. This interface reflects the Packer
|
|
// commands, ex: init, console ( evaluate ), fix config, inspect config, etc. To
|
|
// run a build we will start the builds and then the core of Packer handles
|
|
// execution.
|
|
type Handler interface {
|
|
Initialize(InitializeOptions) hcl.Diagnostics
|
|
// PluginRequirements returns the list of plugin Requirements from the
|
|
// config file.
|
|
PluginRequirements() (plugingetter.Requirements, hcl.Diagnostics)
|
|
Evaluator
|
|
BuildGetter
|
|
ConfigFixer
|
|
ConfigInspector
|
|
PluginBinaryDetector
|
|
}
|
|
|
|
//go:generate enumer -type FixConfigMode
|
|
type FixConfigMode int
|
|
|
|
const (
|
|
// Stdout will make FixConfig simply print what the config should be; it
|
|
// will only work when a single file is passed.
|
|
Stdout FixConfigMode = iota
|
|
// Inplace fixes your files on the spot.
|
|
Inplace
|
|
// Diff shows a full diff.
|
|
Diff
|
|
)
|
|
|
|
type FixConfigOptions struct {
|
|
Mode FixConfigMode
|
|
}
|
|
|
|
type ConfigFixer interface {
|
|
// FixConfig will output the config in a fixed manner.
|
|
FixConfig(FixConfigOptions) hcl.Diagnostics
|
|
}
|
|
|
|
type InspectConfigOptions struct {
|
|
packersdk.Ui
|
|
}
|
|
|
|
type ConfigInspector interface {
|
|
// Inspect will output self inspection for a configuration
|
|
InspectConfig(InspectConfigOptions) (ret int)
|
|
}
|