mirrors
/
pulumi
mirror of https://github.com/pulumi/pulumi.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pulumi/pkg/codegen/testing/test
History
Kyle Dixler 13e584ba91
[sdkgen/python] revert changes introducing `_configure` (#14427) 
<!--- 
Thanks so much for your contribution! If this is your first time
contributing, please ensure that you have read the
[CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md)
documentation.
-->

# Description

<!--- Please include a summary of the change and which issue is fixed.
Please also include relevant motivation and context. -->

Fixes https://github.com/pulumi/pulumi/issues/14418
Reopens https://github.com/pulumi/pulumi/issues/12546

This removes the `_configure()` ResourceArgs helper method as it has
caused a number of issues (linked below).

`_configure()` was added in order to support initializing default values
sdk side for python. This has led to the following PRs being merged to
address unexpected bugs.

## Overview of fixes:

It will be quite hard to demonstrate without examples, so I will give an
example of the code and describe its short comings:

---
- https://github.com/pulumi/pulumi/issues/14418

```python
args = MyArgs() # fails as required argument foo not provided
args.foo = "Hello, World!"
```

---
- https://github.com/pulumi/pulumi/pull/14235
Supporting `imageName` and `image_name`
```python
def _configure(...
        image_name, # required
        ...):
    ...

# This should not error, but errors.
_configure(imageName="debian")
```

---
- https://github.com/pulumi/pulumi/pull/14281

```python
def _configure(...
        image_name, # required
        ...
        **kwargs):
    ...

# This should not fail, but fails as `image_name` is not provided
_configure(imageName="debian")
```

---
- https://github.com/pulumi/pulumi/pull/14014

```python
class Thing:
    def __init__(self,
                ...
                # Optional
                certmanager=None,
                ...):
        ...
        Thing._configure(
                ...
                certmanager=None,
                ...)
        ...
    def _configure(...):
        ...
            # This block runs when certmanager = None, but should not.
            if not isinstance(certmanager, ProviderCertmanagerArgs):
                certmanager = certmanager or {}
                def _setter(key, value):
                    certmanager[key] = value
                ProviderCertmanagerArgs._configure(_setter, **certmanager)
        ...
Provider()
```

---
- https://github.com/pulumi/pulumi/pull/14321

```python
registry_info=accessToken.apply(get_registry_info)

# Build and publish the image.
image = Image(
    'my-image',
    build=DockerBuildArgs(
        context='app',
    ),
    image_name=image_name,
    # Note that this is an Output.
    registry=registry_info,
)

            # registry is not None and it is not an instance of RegistryArgs, so we fall into the if, thinking it is a dict, but it is an Output.

            if registry is not None and not isinstance(registry, RegistryArgs):
                registry = registry or {}
                def _setter(key, value):
                    registry[key] = value
                RegistryArgs._configure(_setter, **registry)
            __props__.__dict__["registry"] = registry
```

---
- https://github.com/pulumi/pulumi/pull/14318

```python
            # foo.core.v1.PodArgs may be an external type and may not be upgraded to have _configure() and will fail, but should not.
            if pod is not None and not isinstance(pod, foo.core.v1.PodArgs):
                pod = pod or {}
                def _setter(key, value):
                    pod[key] = value
                pulumi_kubernetes.core.v1.PodArgs._configure(_setter, **pod)
```

## Checklist

- [x] I have run `make tidy` to update any new dependencies
- [x] I have run `make lint` to verify my code passes the lint check
  - [x] I have formatted my code using `gofumpt`

<!--- Please provide details if the checkbox below is to be left
unchecked. -->
- [ ] 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. -->
 		2023-10-27 22:28:41 +00:00
..
testdata [sdkgen/python] revert changes introducing `_configure` (#14427) 2023-10-27 22:28:41 +00:00
README.md Added README.md for SDKGen tests. 2023-03-01 08:39:36 -08:00
helpers.go Merge #12347 2023-03-03 19:30:12 +00:00
program_driver.go codegen/go: output correct array type (#14299) 2023-10-20 16:12:25 +00:00
program_driver_test.go Use `assert.NoError` rather than `assert.Nil` (#14233) 2023-10-13 09:46:07 +00:00
sdk_driver.go [sdkgen/python] revert changes introducing `_configure` (#14427) 2023-10-27 22:28:41 +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.