History

Fraser Waters d00528918e Add a conformance test for preserving map keys (#17350 ) This adds a conformance test checking we can use map keys like "MY_KEY" and maintain their casing through program gen. For Python we need to simplify the type passed to genObjectConsExpression so that we can reliably determine the target type and check if it's a `TypedDict` or not, otherwise we might treat it as a plain object and preserve the keys, instead of `PyName`ing them. This deletes the "typeddict" test from the codegen tests. Firstly this is now covered by these conformance tests, secondly it wasn't actually valid because the schema it was testing against wasn't a valid schema, and the program snapshot was only how it was because of a bug in programgen. That bug is now fixed in this change which fixes https://github.com/pulumi/pulumi/issues/17294. --------- Co-authored-by: Julien Poissonnier <julien@caffeine.lu>		2024-10-11 13:34:46 +00:00
..
README.md	Added README.md for SDKGen tests.	2023-03-01 08:39:36 -08:00
dotnet.go	Don't publish test code in `pkg/codegen` (#17517 )	2024-10-09 11:09:54 +00:00
generate.go	Don't publish test code in `pkg/codegen` (#17517 )	2024-10-09 11:09:54 +00:00
go.go	Don't publish test code in `pkg/codegen` (#17517 )	2024-10-09 11:09:54 +00:00
helpers.go	Upgrade pulumi-dotnet to 3.67.1 (#17262 )	2024-09-13 23:47:54 +00:00
nodejs.go	Don't publish test code in `pkg/codegen` (#17517 )	2024-10-09 11:09:54 +00:00
program_driver.go	Add a conformance test for preserving map keys (#17350 )	2024-10-11 13:34:46 +00:00
program_driver_test.go	Enable goheader rule and add missing license headers (#15473 )	2024-09-09 12:05:45 +00:00
python.go	Don't publish test code in `pkg/codegen` (#17517 )	2024-10-09 11:09:54 +00:00
sdk_driver.go	Don't publish test code in `pkg/codegen` (#17517 )	2024-10-09 11:09:54 +00:00
testdata	Move codegen testdata (#15549 )	2024-03-06 20:36:50 +00:00
type_driver.go	Enable goheader rule and add missing license headers (#15473 )	2024-09-09 12:05:45 +00: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.