terraform

Documentation

Overview

Package terraform provides a test harness for tf2pulumi. It is a thin wrapper on top of the Pulumi CLI's integration test framework while supplying a "compile step" for Terraform code that we'll then convert to Pulumi code.

Index

• func RunTest(t *testing.T, dir string, opts ...TestOptionsFunc)
• type ConvertOptions
  • func (c ConvertOptions) With(other ConvertOptions) ConvertOptions
• type Test
  • func (test Test) Run(t *testing.T)
• type TestOptionsFunc
  • func AllowChanges() TestOptionsFunc
  • func Compile(value bool) TestOptionsFunc
  • func FilterName(value string) TestOptionsFunc
  • func NoParallel() TestOptionsFunc
  • func Python(opts ...TestOptionsFunc) TestOptionsFunc
  • func Skip(reason string) TestOptionsFunc
  • func SkipPython() TestOptionsFunc
  • func SkipTypeScript(reason string) TestOptionsFunc
  • func TypeScript(opts ...TestOptionsFunc) TestOptionsFunc

Functions

func RunTest

func RunTest(t *testing.T, dir string, opts ...TestOptionsFunc)

RunTest defines a new test case residing in the given directory. It takes zero or more options which can be used to further configure the test harness.

Types

type ConvertOptions

type ConvertOptions struct {
	Compile    *bool  // If true, run pulumi on the generated code. Defaults to true.
	FilterName string // If non-empty, filter out properties with the given name.
	Skip       string // If non-empty, skip the current test with the given message.
}

ConvertOptions are options controlling the behavior of tf2pulumi. Its arguments are generally converted to command-line flags.

func (ConvertOptions) With

func (c ConvertOptions) With(other ConvertOptions) ConvertOptions

With constructs a new ConvertOptions out of a base set of options and a set of options that will override fields that are not set in the base.

type Test

type Test struct {
	ProjectName string
	Options     ConvertOptions                  // Base options for tf2pulumi, inherited by all targets.
	RunOptions  *integration.ProgramTestOptions // Options for running the generated Pulumi code
	Python      *ConvertOptions                 // Python-specific options overriding the base options
	TypeScript  *ConvertOptions                 // TypeScript-specific options overriding the base options
}

Test represents a single test case. It consists of Terraform input and optionally a "baseline" file that will be diffed against the output of tf2pulumi. Each test case is run on every target unless the target specifically opts out.

func (Test) Run

func (test Test) Run(t *testing.T)

Run executes this test, spawning subtests for each supported target.

type TestOptionsFunc

type TestOptionsFunc func(*testing.T, *Test)

TestOptionsFunc is a function that can be used as an option to `RunTest`.

func AllowChanges

func AllowChanges() TestOptionsFunc

AllowChanges allows changes on the empty preview and update for the given test.

func Compile

func Compile(value bool) TestOptionsFunc

Compile sets whether or not this test case should be executed by Pulumi after being processed by tf2pulumi. Defaults to true if not provided.

func FilterName

func FilterName(value string) TestOptionsFunc

FilterName sets whether or not tf2pulumi should filter properties with the given name for this test case. Defaults to the empty string, which will cause no properties to be filtered.

func NoParallel

func NoParallel() TestOptionsFunc

Sets the NoParallel flag on the test to run

func Python

func Python(opts ...TestOptionsFunc) TestOptionsFunc

Python sets up a new context that also accepts any number of test options, but applies those test options only when running with the Python target. Options that affect the Pulumi CLI integration test framework are ignored.

func Skip

func Skip(reason string) TestOptionsFunc

Skip skips the test for the given reason.

func SkipPython

func SkipPython() TestOptionsFunc

SkipPython skips the Python target for the given test.

func SkipTypeScript

func SkipTypeScript(reason string) TestOptionsFunc

SkipTypeScript skips the TypeScript target for the given test.

func TypeScript

func TypeScript(opts ...TestOptionsFunc) TestOptionsFunc

TypeScript sets up a new context that also accepts any number of test options, but applies those test options only when running with the TypeScript target. Options that affect the Pulumi CLI integration test framework are ignored.