terraform

package
v0.52.0 Latest Latest
Warning

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

 Go to latest Published: Oct 10, 2025 License: Apache-2.0 Imports: 34 Imported by: 0

Documentation

Overview

Package terraform is a generated GoMock package.

Index

Constants

View Source 
const (

	// DefaultStateLockTimeout is the default timeout for acquiring Terraform state locks
	DefaultStateLockTimeout = "10m"
)

Variables

View Source 
var (
	// ErrRecipeNameEmpty is the error when the recipe name is empty.
	ErrRecipeNameEmpty = errors.New("recipe name cannot be empty")
)

Functions

func GetProviderEnvSecretIDs added in v0.36.0 

func GetProviderEnvSecretIDs(envConfig recipes.Configuration) map[string][]string

GetProviderEnvSecretIDs parses the envConfig to extract secret IDs configured in providers configuration and environment variables and returns a map of secret store IDs and corresponding slice of keys.

func Install 

func Install(ctx context.Context, installer *install.Installer, tfDir string) (*tfexec.Terraform, error)

Install installs Terraform using a global shared binary approach. It uses a global mutex to ensure thread-safe access to the shared Terraform binary. This approach prevents concurrent file system operations that were causing state lock errors.

func NewExecutor 

func NewExecutor(ucpConn sdk.Connection, secretProvider *secretprovider.SecretProvider, kubernetesClients kubernetesclientprovider.KubernetesClientProvider) *executor

NewExecutor creates a new Executor with the given UCP connection and secret provider, to execute a Terraform recipe.

func NewTerraform 

func NewTerraform(ctx context.Context, tfRootDir, execPath string) (*tfexec.Terraform, error)

NewTerraform creates a working directory for Terraform execution and new Terraform executor with Terraform logs enabled.

Types

type MockTerraformExecutor 

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

MockTerraformExecutor is a mock of TerraformExecutor interface.

func NewMockTerraformExecutor 

func NewMockTerraformExecutor(ctrl *gomock.Controller) *MockTerraformExecutor

NewMockTerraformExecutor creates a new mock instance.

func (*MockTerraformExecutor) Delete 

func (m *MockTerraformExecutor) Delete(arg0 context.Context, arg1 Options) error

Delete mocks base method.

func (*MockTerraformExecutor) Deploy 

func (m *MockTerraformExecutor) Deploy(arg0 context.Context, arg1 Options) (*tfjson.State, error)

Deploy mocks base method.

func (*MockTerraformExecutor) EXPECT 

func (m *MockTerraformExecutor) EXPECT() *MockTerraformExecutorMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockTerraformExecutor) GetRecipeMetadata 

func (m *MockTerraformExecutor) GetRecipeMetadata(arg0 context.Context, arg1 Options) (map[string]any, error)

GetRecipeMetadata mocks base method.

type MockTerraformExecutorDeleteCall added in v0.35.0 

type MockTerraformExecutorDeleteCall struct {
	*gomock.Call
}

MockTerraformExecutorDeleteCall wrap *gomock.Call

func (*MockTerraformExecutorDeleteCall) Do added in v0.35.0 

func (c *MockTerraformExecutorDeleteCall) Do(f func(context.Context, Options) error) *MockTerraformExecutorDeleteCall

Do rewrite *gomock.Call.Do

func (*MockTerraformExecutorDeleteCall) DoAndReturn added in v0.35.0 

func (c *MockTerraformExecutorDeleteCall) DoAndReturn(f func(context.Context, Options) error) *MockTerraformExecutorDeleteCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockTerraformExecutorDeleteCall) Return added in v0.35.0 

func (c *MockTerraformExecutorDeleteCall) Return(arg0 error) *MockTerraformExecutorDeleteCall

Return rewrite *gomock.Call.Return

type MockTerraformExecutorDeployCall added in v0.35.0 

type MockTerraformExecutorDeployCall struct {
	*gomock.Call
}

MockTerraformExecutorDeployCall wrap *gomock.Call

func (*MockTerraformExecutorDeployCall) Do added in v0.35.0 

func (c *MockTerraformExecutorDeployCall) Do(f func(context.Context, Options) (*tfjson.State, error)) *MockTerraformExecutorDeployCall

Do rewrite *gomock.Call.Do

func (*MockTerraformExecutorDeployCall) DoAndReturn added in v0.35.0 

func (c *MockTerraformExecutorDeployCall) DoAndReturn(f func(context.Context, Options) (*tfjson.State, error)) *MockTerraformExecutorDeployCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockTerraformExecutorDeployCall) Return added in v0.35.0 

func (c *MockTerraformExecutorDeployCall) Return(arg0 *tfjson.State, arg1 error) *MockTerraformExecutorDeployCall

Return rewrite *gomock.Call.Return

type MockTerraformExecutorGetRecipeMetadataCall added in v0.35.0 

type MockTerraformExecutorGetRecipeMetadataCall struct {
	*gomock.Call
}

MockTerraformExecutorGetRecipeMetadataCall wrap *gomock.Call

func (*MockTerraformExecutorGetRecipeMetadataCall) Do added in v0.35.0 

func (c *MockTerraformExecutorGetRecipeMetadataCall) Do(f func(context.Context, Options) (map[string]any, error)) *MockTerraformExecutorGetRecipeMetadataCall

Do rewrite *gomock.Call.Do

func (*MockTerraformExecutorGetRecipeMetadataCall) DoAndReturn added in v0.35.0 

func (c *MockTerraformExecutorGetRecipeMetadataCall) DoAndReturn(f func(context.Context, Options) (map[string]any, error)) *MockTerraformExecutorGetRecipeMetadataCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockTerraformExecutorGetRecipeMetadataCall) Return added in v0.35.0 

func (c *MockTerraformExecutorGetRecipeMetadataCall) Return(arg0 map[string]any, arg1 error) *MockTerraformExecutorGetRecipeMetadataCall

Return rewrite *gomock.Call.Return

type MockTerraformExecutorMockRecorder 

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

MockTerraformExecutorMockRecorder is the mock recorder for MockTerraformExecutor.

func (*MockTerraformExecutorMockRecorder) Delete 

func (mr *MockTerraformExecutorMockRecorder) Delete(arg0, arg1 any) *MockTerraformExecutorDeleteCall

Delete indicates an expected call of Delete.

func (*MockTerraformExecutorMockRecorder) Deploy 

func (mr *MockTerraformExecutorMockRecorder) Deploy(arg0, arg1 any) *MockTerraformExecutorDeployCall

Deploy indicates an expected call of Deploy.

func (*MockTerraformExecutorMockRecorder) GetRecipeMetadata 

func (mr *MockTerraformExecutorMockRecorder) GetRecipeMetadata(arg0, arg1 any) *MockTerraformExecutorGetRecipeMetadataCall

GetRecipeMetadata indicates an expected call of GetRecipeMetadata.

type Options 

type Options struct {
	// RootDir is the root directory of where Terraform is installed and executed for a specific recipe deployment/deletion request.
	RootDir string

	// EnvConfig is the kubernetes runtime and cloud provider configuration for the Radius Environment in which the application consuming the terraform recipe will be deployed.
	EnvConfig *recipes.Configuration

	// EnvRecipe is the recipe metadata associated with the Radius Environment in which the application consuming the terraform recipe will be deployed.
	EnvRecipe *recipes.EnvironmentDefinition

	// ResourceRecipe is recipe metadata associated with the Radius resource deploying the Terraform recipe.
	ResourceRecipe *recipes.ResourceMetadata

	// Secrets represents a map of secrets required for recipe execution.
	// The map's key represents the secretStoreIDs while the value represents the secret data.
	Secrets map[string]recipes.SecretData

	// StateLockTimeout is the timeout duration for acquiring Terraform state locks.
	// If not specified, Terraform's default timeout will be used.
	StateLockTimeout string
}

Options represents the options required to build inputs to interact with Terraform.

type TerraformExecutor 

type TerraformExecutor interface {
	// Deploy installs terraform and runs terraform init and apply on the terraform module referenced by the recipe using terraform-exec.
	Deploy(ctx context.Context, options Options) (*tfjson.State, error)

	// Delete installs terraform and runs terraform destroy on the terraform module referenced by the recipe using terraform-exec,
	// and deletes the Kubernetes secret created for terraform state store.
	Delete(ctx context.Context, options Options) error

	// GetRecipeMetadata installs terraform and runs terraform get to retrieve information on the terraform module
	GetRecipeMetadata(ctx context.Context, options Options) (map[string]any, error)
}

Source Files

View all Source files

Directories

Path Synopsis
backends
Package backends is a generated GoMock package.
 Package backends is a generated GoMock package.
providers
Package providers is a generated GoMock package.
 Package providers is a generated GoMock package.

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.