History

Brandon Pollack 49dbdbcafa Add the ability to generate aliased import prefixes to go generator. Previously, if there were nested arguments in schemas, generation of go code would simply use the go module name, but when imports are generated they are potentially aliased to avoid naming conflicts. This is taken into account at the top level since the aliases are checked directly, but when traversing downward the argument types are generated after conversions from the PCL schema data. This fix adds an optional map to pkgContext that contains the go module info, which contains the appropriate base path to check against aliases. We also add aliases to the map that are generated by the import system (and not just from other go package infos).		2024-09-30 17:11:00 +09:00
..
README.md	Added README.md for SDKGen tests.	2023-03-01 08:39:36 -08:00
helpers.go	Upgrade pulumi-dotnet to 3.67.1 (#17262 )	2024-09-13 23:47:54 +00:00
program_driver.go	Add the ability to generate aliased import prefixes to go generator.	2024-09-30 17:11:00 +09:00
program_driver_test.go	Enable goheader rule and add missing license headers (#15473 )	2024-09-09 12:05:45 +00:00
sdk_driver.go	Fully generate TypedDict input types by default (#17296 )	2024-09-20 17:16:14 +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.