a28454477c
# Description This PR implements generating the generic variant of a go SDK from Pulumi schemas. Currently the idea is to generate a directory `x` inside the root directory of the go SDK which will contain the same SDK except using generics and generating far less code than its current counter part. Also implements an enum option `$.language.go.generics` which can be set to the following: - `none` is the default which maintains the current behavior that generates legacy types without generics - `side-by-side` generates the generics sdk variant alongside the current sdk under directory `x` - `generics-only` generates only the new sdk with generics at the root of the package Still a bunch of things to do: - [x] Generating `InvokeResult]Output` type from `Output[InvokeResult]` and generating accessor methods for it - [x] Generating default values for types and using the `pulumix` subpackage to do so - [x] Generating generic SDK variants for all test schemas we have and making sure they compile (currently only testing `simple-resource-schema` as shown below) - [x] Account for plain inputs for components - [x] Combine pulumix.Join with pulumix.Apply to generate resource accessor methods - [x] Problem with `GPtrOutput[T]` and `ArrayOutput[T]` being unwrapped to `Output[*T]` and `Output[[]T]` - [x] Remove excess untyped container types from generated enums - [x] Fix default values for resource methods with lifted single return value - [x] Secret properties Currently the following test schemas have opted for `generics: "side-by-side"`: - [x] output-funcs - [x] simple-enum-schema - [x] secrets - [x] simple-plain-schema - [x] plain-and-default ## Checklist - [ ] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [ ] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [x] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. --> |
||
|---|---|---|
| .. | ||
| testdata | ||
| README.md | ||
| helpers.go | ||
| program_driver.go | ||
| program_driver_test.go | ||
| sdk_driver.go | ||
| type_driver.go | ||
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.