History

Julien ca60d337e2 Generate TypedDict input types by default (#16704 ) With https://github.com/pulumi/pulumi/pull/15957 we introduced the schema setting `Languages.Python.InputTypes` to optionally generate TypedDict based input types side-by-side with Args classes. This setting defaulted to `classes`, meaning that only Args classes are generated. To enable the TypedDict types, SDK authors had to explicitly opt in by setting it to `classes-and-dicts`. We now flip this setting to generating TypedDict input types side-by-side with the Args classes, unless explicitly disabled by setting it to `classes`. Fixes https://github.com/pulumi/pulumi/issues/16375		2024-07-23 11:26:54 +00:00
..
README.md	Added README.md for SDKGen tests.	2023-03-01 08:39:36 -08:00
helpers.go	upgrade dotnet dependency to latest (#16353 )	2024-06-11 06:30:13 +00:00
program_driver.go	Enable l1-output-number conformance test for Go (#16753 )	2024-07-22 17:12:28 +00:00
program_driver_test.go	Enable perfsprint linter (#14813 )	2023-12-12 12:19:42 +00:00
sdk_driver.go	Generate TypedDict input types by default (#16704 )	2024-07-23 11:26:54 +00:00
testdata	Move codegen testdata (#15549 )	2024-03-06 20:36:50 +00:00
type_driver.go	Initial implementation of simplified invokes for dotnet and nodejs	2023-01-11 14:17:14 -08:00

README.md

SDK Codegen Tests

TestSDKCodegen runs the complete set of SDK code generation tests against a particular language's code generator. It also verifies that the generated code is structurally sound.

The test files live in pkg/codegen/testing/test/testdata and are registered in the following globals in pkg/codegen/testing/test.

sdk_driver.go: PulumiPulumiSDKTests
program_driver.go: PulumiPulumiProgramTests
program_driver.go: PulumiPulumiYAMLProgramTests

An SDK code generation test files consists of a schema and a set of expected outputs for each language. Each test is structured as a directory that contains that information:

 testdata/
     my-simple-schema/   # i.e. `simple-enum-schema`
         schema.(json|yaml)
         go/
         python/
         nodejs/
         dotnet/
         ...

The schema is the only piece that must be manually authored.

Once the schema has been written, the actual codegen outputs can be generated by running the following in pkg/codegen directory:

PULUMI_ACCEPT=true go test ./...

This will rebuild subfolders such as go/ from scratch and store the set of code-generated file names in go/codegen-manifest.json. To generate the code for a specific directory in testdata, run the following instead:

PULUMI_ACCEPT=true go test ./... -run TestGenerate/$dirName

If these outputs look correct, they need to be checked into git and will then serve as the expected values for the normal test runs:

$ go test ./...

That is, the normal test runs will fail if changes to codegen or schema lead to a diff in the generated file set. If the diff is intentional, it can be accepted again via PULUMI_ACCEPT=true.

Writing Program Tests on Generated Code

To support running unit tests over the generated code, the tests also support mixing in manually written $lang-extras files into the generated tree. For example, given the following input:

 testdata/
     my-simple-schema/
         schema.json
         go/
         go-extras/
             tests/
                 go_test.go

The system will copy go-extras/tests/go_test.go into go/tests/go_test.go before performing compilation and unit test checks over the project generated in go.