656cf29179
13251: [convert] Prefer output-versioned invokes in generated programs for nodejs and python r=Zaid-Ajaj a=Zaid-Ajaj ### Description This PR implements a new PCL bind option called `PreferOutputVersionedInvokes` which as the name suggests gives higher priority to using output-versioned invokes in generated programs if they exist* but only for python and nodejs. Previously we have enabled this for all languages but it breaks go and dotnet programs so here it is only applied to python and typescript. Binding component programs carry over this option if the main program has it too. This work is a continuation of #13051 <details> <summary>PCL program example</summary> ``` vpc = invoke("aws:ec2:getVpc", { default = true }) subnets = invoke("aws:ec2:getSubnetIds", { vpcId = vpc.id }) resource webSecurityGroup "aws:ec2:SecurityGroup" { vpcId = vpc.id egress = [{ protocol = "-1" fromPort = 0 toPort = 0 cidrBlocks = ["0.0.0.0/0"] }] ingress = [{ protocol = "tcp" fromPort = 80 toPort = 80 cidrBlocks = ["0.0.0.0/0"] }] } ``` </details> <details> <summary>Generated TypeScript Before</summary> ```typescript const vpc = aws.ec2.getVpc({ "default": true, }); const subnets = vpc.then(vpc => aws.ec2.getSubnetIds({ vpcId: vpc.id, })); const webSecurityGroup = new aws.ec2.SecurityGroup("webSecurityGroup", { vpcId: vpc.then(vpc => vpc.id), egress: [{ protocol: "-1", fromPort: 0, toPort: 0, cidrBlocks: ["0.0.0.0/0"], }], ingress: [{ protocol: "tcp", fromPort: 80, toPort: 80, cidrBlocks: ["0.0.0.0/0"], }], }); ``` </details> <details> <summary>Generated TypeScript After</summary> ```typescript const vpc = aws.ec2.getVpcOutput({ "default": true, }); const subnets = aws.ec2.getSubnetIdsOutput({ vpcId: vpc.id, }); const webSecurityGroup = new aws.ec2.SecurityGroup("webSecurityGroup", { vpcId: vpc.id, egress: [{ protocol: "-1", fromPort: 0, toPort: 0, cidrBlocks: ["0.0.0.0/0"], }], ingress: [{ protocol: "tcp", fromPort: 80, toPort: 80, cidrBlocks: ["0.0.0.0/0"], }], }); ``` </details> > * The existence of output-versioned invokes depends on whether they have any arguments. The idea is to change that later such that every function invoke emits an output-versioned invoke regardless of whether it has input args or not. ## 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. --> Co-authored-by: Zaid Ajaj <zaid.naom@gmail.com> |
||
|---|---|---|
| .. | ||
| 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.