Package com.pulumi.test

Interface PulumiTest

All Known Implementing Classes:

PulumiTestInternal

public interface PulumiTest

Provides a test Pulumi runner and exposes various internals for the testing purposes.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PulumiTest.API	Pulumi test entrypoint operations.

Method Summary

Static Methods

Modifier and Type	Method	Description
static void	cleanup()	Cleanup internal test state.
static <T> T	extractValue(Output<T> output)	Extract the value from an Output blocking.
static <T> CompletableFuture<T>	extractValueAsync(Output<T> output)	Extract the future value from an Output asynchronously.
static TestResult	runTest(Consumer<Context> stack)	Run a Pulumi test stack callback, wait for result and return TestResult.
static CompletableFuture<TestResult>	runTestAsync(Consumer<Context> stack)	Run a Pulumi test stack callback asynchronously and return TestResult.
static PulumiTest.API	withMocks(Mocks mocks)	Use Mocks in this test.
static PulumiTest.API	withOptions(TestOptions options)	Use TestOptions in this test.

Method Details

runTest

static TestResult runTest(Consumer<Context> stack)

Run a Pulumi test stack callback, wait for result and return TestResult.

Parameters:

stack - the stack to run in Pulumi test runtime

Returns:

a TestResult from Pulumi test runtime after running the stack

See Also:

• runTestAsync(Consumer)
• withOptions(TestOptions)
• withMocks(Mocks)

runTestAsync

static CompletableFuture<TestResult> runTestAsync(Consumer<Context> stack)

Run a Pulumi test stack callback asynchronously and return TestResult.

Parameters:

stack - the stack to run in Pulumi test runtime

Returns:

a future TestResult from Pulumi test runtime after running the stack

See Also:

• runTest(Consumer)
• withOptions(TestOptions)
• withMocks(Mocks)

withOptions

static PulumiTest.API withOptions(TestOptions options)

Use TestOptions in this test.

Parameters:

options - the TestOptions to use

Returns:

a Pulumi test program entrypoint with given TestOptions

See Also:

• runTest(Consumer)
• runTestAsync(Consumer)
• withMocks(Mocks)

withMocks

static PulumiTest.API withMocks(Mocks mocks)

Use Mocks in this test.

Parameters:

mocks - the Monitor mocks to use

Returns:

a Pulumi test program entrypoint with given TestOptions

See Also:

• runTest(Consumer)
• runTestAsync(Consumer)
• withOptions(TestOptions)

cleanup

static void cleanup()

Cleanup internal test state. Must be called after every run of a Pulumi test program.

extractValue

@Nullable
static <T> T extractValue(Output<T> output)

Extract the value from an Output blocking.

Parameters:

output - the Output to extract value from

Returns:

the underlying value of the given Output

extractValueAsync

static <T> CompletableFuture<T> extractValueAsync(Output<T> output)

Extract the future value from an Output asynchronously.

Parameters:

output - the Output to extract future value from

Returns:

the underlying future value of the given Output