tfgen

type ConversionError ¶ added in v3.34.0

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

A ConversionError occurs when convert.Convert yields a panic. This can be removed when https://github.com/pulumi/pulumi-terraform-bridge/issues/477 is resolved. ConversionError exposes the stacktrace of the panic so callers can choose to pass the trace along to the user or swallow it.

func (err *ConversionError) Error() string

func (err *ConversionError) StackTrace() string

func (err *ConversionError) Unwrap() error

type CoverageTracker ¶ added in v3.6.0

type CoverageTracker struct {
	ProviderName     string                        // Name of the provider
	ProviderVersion  string                        // Version of the provider
	EncounteredPages map[string]*DocumentationPage // Map linking page IDs to their data
}

Main overarching structure for storing coverage data on how many examples were processed, how many failed, and for what reason. At different stages, the code translator notifies the tracker of what is going on. Notifications are treated as an ordered sequence of events.

NOTIFICATION INTERFACE:

example := getOrCreateExample(pageName, hcl)

languageConversionSuccess(example, targetLanguage)

languageConversionWarning(example, targetLanguage, warningDiagnostics)

languageConversionFailure(example, targetLanguage, failureDiagnostics)

languageConversionPanic(example, targetLanguage, panicInfo)

type DocFile ¶ added in v3.61.0

type DocFile struct {
	Content  []byte
	FileName string
}

type DocKind ¶

type DocKind string

DocKind indicates what kind of entity's documentation is being requested.

const (
	// ResourceDocs indicates documentation pertaining to resource entities.
	ResourceDocs DocKind = "resources"
	// DataSourceDocs indicates documentation pertaining to data source entities.
	DataSourceDocs DocKind = "data-sources"
)

func (k DocKind) String() string

type DocsSource ¶ added in v3.61.0

type DocsSource interface {
	// contains filtered or unexported methods
}

A source of documentation bytes.

func NewGitRepoDocsSource(g *Generator) DocsSource

type DocumentationPage ¶ added in v3.12.0

type DocumentationPage struct {
	Name     string    // The unique ID of this documentation page
	Examples []Example // This page's examples, stored in the order they were found
}

A structure encompassing a single page, which contains one or more examples. This closely resembles the web pages seen in Pulumi/Terraform documentation.

type Example ¶ added in v3.12.0

type Example struct {
	OriginalHCL       string                               // Original HCL code that the example was found with
	ConversionResults map[string]*LanguageConversionResult // Mapping language names to their conversion results
}

Contains information about a single example, consisting of a block of HCL and one or more language conversion results.

type GenerateOptions ¶

type GenerateOptions struct {
	ModuleFormat string
}

type GenerateSchemaOptions ¶ added in v3.34.0

type GenerateSchemaOptions struct {
	ProviderInfo    tfbridge.ProviderInfo
	DiagnosticsSink diag.Sink
}

type GenerateSchemaResult ¶ added in v3.34.0

type GenerateSchemaResult struct {
	PackageSpec pschema.PackageSpec
}

func GenerateSchemaWithOptions(opts GenerateSchemaOptions) (*GenerateSchemaResult, error)

type Generator ¶

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

func NewGenerator(opts GeneratorOptions) (*Generator, error)

func (g *Generator) Generate() error

func (g *Generator) Sink() diag.Sink

func (g *Generator) UnstableGenerateFromSchema(genSchemaResult *GenerateSchemaResult) error

type GeneratorOptions ¶

type GeneratorOptions struct {
	Package            string
	Version            string
	Language           Language
	ProviderInfo       tfbridge.ProviderInfo
	Root               afero.Fs
	ProviderInfoSource il.ProviderInfoSource
	PluginHost         plugin.Host
	TerraformVersion   string
	Sink               diag.Sink
	Debug              bool
	SkipDocs           bool
	SkipExamples       bool
	CoverageTracker    *CoverageTracker
}

type GetRepoPathErr ¶ added in v3.61.0

type GetRepoPathErr struct {
	Expected   string
	Underlying error
}

An error that represents a missing repo path directory.

func (e GetRepoPathErr) Error() string

func (e GetRepoPathErr) Unwrap() error

type Language ¶

type Language string

const (
	Golang Language = "go"
	NodeJS Language = "nodejs"
	Python Language = "python"
	CSharp Language = "dotnet"
	Schema Language = "schema"
	PCL    Language = "pulumi"
)

type LanguageConversionResult ¶ added in v3.6.0

type LanguageConversionResult struct {
	FailureSeverity int    // This conversion's outcome: [Success, Warning, Failure, Fatal]
	FailureInfo     string // Additional in-depth information
	Program         string // Converted program

	// How many times this example has been converted to this language.
	// It is expected that this will be equal to 1.
	TranslationCount int
}

Individual language information concerning how successfully an example was converted to Pulumi