pkg/config/config.go

package config

import (
	"log/slog"
	"time"

	"github.com/Azure/aztfexport/internal/tfaddr"
	"github.com/Azure/aztfexport/pkg/telemetry"
	"github.com/Azure/azure-sdk-for-go/sdk/azcore"
	"github.com/Azure/azure-sdk-for-go/sdk/azcore/arm"
	"github.com/magodo/armid"
	"github.com/magodo/terraform-client-go/tfclient"
	"github.com/zclconf/go-cty/cty"
)

type ImportItem struct {
	// Azure resource Id
	AzureResourceID armid.ResourceId

	// The TF resource id
	TFResourceId string

	// Whether this azure resource failed to import into terraform (this might due to the TFResourceType doesn't match the resource)
	ImportError error

	// The terraform resource
	TFAddr tfaddr.TFAddr
}

type ImportCallback func(startTime time.Time, item ImportItem)

type OutputFileNames struct {
	// The filename for the generated "terraform.tf" (default)
	TerraformFileName string
	// The filename for the generated "provider.tf" (default)
	ProviderFileName string
	// The filename for the generated "main.tf" (default)
	MainFileName string
	// The filename for the generated "import.tf" (default)
	ImportBlockFileName string
}

type CommonConfig struct {
	Logger *slog.Logger
	// AuthConfig specifies the authentication config for provider
	// This doesn't impact the auth of the tool itself (e.g. listing resources), which is controlled by AzureSDKCredential field.
	AuthConfig AuthConfig
	// SubscriptionId specifies the user's Azure subscription id.
	SubscriptionId string
	// AzureSDKCredential specifies the Azure SDK token credential
	AzureSDKCredential azcore.TokenCredential
	// AzureSDKClientOption specifies the Azure SDK client option
	AzureSDKClientOption arm.ClientOptions
	// OutputDir specifies the Terraform working directory import resources and generate TF configs.
	OutputDir string
	// OutputFileNames specifies the output terraform filenames
	OutputFileNames OutputFileNames
	// ProviderVersion specifies the provider version used for importing. If this is not set, it will use `{azurerm|azapi}.ProviderSchemaInfo.Version` for importing in order to be consistent with tfadd.
	ProviderVersion string
	// DevProvider specifies whether users have configured the `dev_overrides` for the provider, which then uses a development provider built locally rather than using a version pinned provider from official Terraform registry.
	// Meanwhile, it will also avoid running `terraform init` during `Init()` for the import directories to avoid caculating the provider hash and populating the lock file (See: https://developer.hashicorp.com/terraform/language/files/dependency-lock). Though the init for the output directory is still needed for initializing the backend.
	DevProvider bool
	// ProviderName specifies the provider Name, which is either "azurerm" or "azapi.
	ProviderName string
	// ContinueOnError specifies whether continue the progress even hit an import error.
	ContinueOnError bool
	// BackendType specifies the Terraform backend type.
	BackendType string
	// BackendConfig specifies an array of Terraform backend configs.
	BackendConfig []string
	// ProviderConfig specifies key value pairs that will be expanded to the terraform-provider-{azurerm|azapi} settings (e.g. `azurerm {}` block)
	// Currently, only the attributes (rather than blocks) are supported.
	// This is not used directly by aztfexport as the provider configs can be set by environment variable already.
	// While it is useful for module users that want support multi-users scenarios in one process (in which case changing env vars affect the whole process).
	ProviderConfig map[string]cty.Value
	// FullConfig specifies whether to export all (non computed-only) Terarform properties when generating TF configs.
	FullConfig bool
	// MaskSensitive specifies whether to mask sensitive attributes when generating TF configs.
	MaskSensitive bool
	// Parallelism specifies the parallelism for the process
	Parallelism int
	// PreImportHook is called before each resource is imported during ParallelImport
	PreImportHook ImportCallback
	// PostImportHook is called after each resource is imported during ParallelImport
	PostImportHook ImportCallback
	// ModulePath specifies the path of the module (e.g. "module1.module2") where the resources will be imported and config generated.
	// Note that only modules whose "source" is local path is supported. By default, it is the root module.
	ModulePath string
	// HCLOnly is a strange field, which is only used internally by aztfexport to indicate whether to remove other files other than TF config at the end.
	// External Go modules should just ignore it.
	HCLOnly bool
	// TFClient is the terraform-client-go client used to replace terraform binary for importing resources.
	// This can only be used together with HCLOnly as tfclient can't replace terraform for state file management.
	TFClient tfclient.Client
	// TelemetryClient is a client to send telemetry
	TelemetryClient telemetry.Client
	// GenerateImportBlock controls whether the export process ends up with a import.tf file that contains the "import" blocks
	GenerateImportBlock bool
	// Azure resource ID patterns (regexp, case insensitive) to exclude
	ExcludeAzureResources []string
	// Terrraform resource types to exclude
	ExcludeTerraformResources []string
}

type Config struct {
	CommonConfig

	// Exactly one of below is specified

	// ResourceIds specifies the list of Azure resource ids, this indicates the resource mode.
	ResourceIds []string
	// ResourceGroupName specifies the name of the resource group, this indicates the resource group mode.
	ResourceGroupName string
	// ARGPredicate specifies the ARG where predicate, this indicates the query mode.
	ARGPredicate string
	// MappingFile specifies the path of mapping file, this indicates the map file mode.
	MappingFile string

	/////////////////////////
	// Scope: rg, res (multi), query

	// ResourceNamePattern specifies the resource name pattern
	ResourceNamePattern string

	/////////////////////////
	// Scope: rg, query

	// IncludeRoleAssignment specifies whether to include the role assginments assigned to the exported resources
	IncludeRoleAssignment bool

	/////////////////////////
	// Scope: res (single)

	// TFResourceName specifies the TF resource name
	TFResourceName string
	// TFResourceName specifies the TF resource type (if empty, will try to deduce the type)
	TFResourceType string

	/////////////////////////
	// Scope: query

	// RecursiveQuery specifies whether to recursively list the child/proxy resources of the ARG resulted resource list
	RecursiveQuery bool
	// IncludeResourceGroup specifies whether to include the resource groups that the exported resources belong to
	IncludeResourceGroup bool
	// ARGTable specifies the ARG table name, which defaults to the "Resources" table
	ARGTable string
	//  ARGAuthorizationScopeFilter specifies the AuthorizationScopeFilter parameter. Possible values are: "AtScopeAndBelow", "AtScopeAndAbove", "AtScopeAboveAndBelow" and "AtScopeExact"
	ARGAuthorizationScopeFilter string
}