pulumi/tests/testdata/codegen/basic-unions-pp/go/basic-unions.go

33 lines
958 B
Go
Raw Permalink Normal View History

[program-gen/tests] Replace discriminated unions test program with a program from a synthetic schema of basic unions (#15771) # Description This PR replaces the test program `discriminated-unions` with a new program `basic-unions` that uses a synthetic schema that has basic union definitions. The former program was failing compilation with Go because of a **faulty** azure-native SDK (tests using v1.56.0). It didn't generate the extra types for union objects (those with suffix `Args`). Those missing extra types are added in newer versions of azure-native SDK but the shape of the same resource doesn't have unions anymore so we can't just upgrade the version of the azure-native sdk we are testing with. I decided not to depend on a specific azure-native SDK and instead use a synthetic schema with the sole purpose of showing that we can emit correct code for fields assigned to object which are bound to different union cases. The downside here is that we can't compile the example for any language since it is a synthetic schema with no generated SDK (conformance tests in Go would make this possible but we are far away from that 😢) Closes #10834 since the original issue was due to faulty SDK, not program-gen. ## Checklist - [ ] I have run `make tidy` to update any new dependencies - [ ] 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. --> - [ ] 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. -->
2024-03-28 10:49:27 +00:00
package main
import (
basicunions "github.com/pulumi/pulumi-basic-unions/sdk/v4/go/basic-unions"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// properties field is bound to union case ServerPropertiesForReplica
_, err := basicunions.NewExampleServer(ctx, "replica", &basicunions.ExampleServerArgs{
[go/program-gen] Fix union type type resolution in Go program generation (#16297) # Description Fixes https://github.com/pulumi/pulumi-azure-native/issues/1554 ### Context The problem here is that when we compute `InputType: model.Type` in `pcl.Resource`, we map the types of input properties of resources from `schema.Type` into `model.Type`. When one of these properties is a `schema.UnionType` (union of objects to be exact), we map that _as is_ to `model.UnionType` which trips up Go program-gen as it doesn't know how to reduce the type to the actual _selected_ object type based on the resource inputs. ### Resolution The way to fix this is not in Go program-gen, instead we _reduce_ the computed union types during the binding phase into the actual object types based on the resource inputs so that all program generators only work against explicit objects rather than having to deal with unions of objects ### Example: ```pcl resource "example" "azure-native:eventgrid:EventSubscription" { destination = { endpointType = "EventHub" resourceId = "example" } expirationTimeUtc = "example" scope = "example" } ``` Before: ```go pulumi.Run(func(ctx *pulumi.Context) error { _, err := eventgrid.NewEventSubscription(ctx, "example", &eventgrid.EventSubscriptionArgs{ Destination: eventgrid.EventHubEventSubscriptionDestination{ EndpointType: "EventHub", ResourceId: "example", }, ExpirationTimeUtc: pulumi.String("example"), Scope: pulumi.String("example"), }) if err != nil { return err } return nil }) ``` After: ```go pulumi.Run(func(ctx *pulumi.Context) error { _, err := eventgrid.NewEventSubscription(ctx, "example", &eventgrid.EventSubscriptionArgs{ Destination: &eventgrid.EventHubEventSubscriptionDestinationArgs{ EndpointType: pulumi.String("EventHub"), ResourceId: pulumi.String("example"), }, ExpirationTimeUtc: pulumi.String("example"), Scope: pulumi.String("example"), }) if err != nil { return err } return nil }) ``` ## 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 - [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. -->
2024-06-06 19:13:19 +00:00
Properties: &basicunions.ServerPropertiesForReplicaArgs{
CreateMode: pulumi.String("Replica"),
Version: pulumi.String("0.1.0-dev"),
[program-gen/tests] Replace discriminated unions test program with a program from a synthetic schema of basic unions (#15771) # Description This PR replaces the test program `discriminated-unions` with a new program `basic-unions` that uses a synthetic schema that has basic union definitions. The former program was failing compilation with Go because of a **faulty** azure-native SDK (tests using v1.56.0). It didn't generate the extra types for union objects (those with suffix `Args`). Those missing extra types are added in newer versions of azure-native SDK but the shape of the same resource doesn't have unions anymore so we can't just upgrade the version of the azure-native sdk we are testing with. I decided not to depend on a specific azure-native SDK and instead use a synthetic schema with the sole purpose of showing that we can emit correct code for fields assigned to object which are bound to different union cases. The downside here is that we can't compile the example for any language since it is a synthetic schema with no generated SDK (conformance tests in Go would make this possible but we are far away from that 😢) Closes #10834 since the original issue was due to faulty SDK, not program-gen. ## Checklist - [ ] I have run `make tidy` to update any new dependencies - [ ] 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. --> - [ ] 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. -->
2024-03-28 10:49:27 +00:00
},
})
if err != nil {
return err
}
// properties field is bound to union case ServerPropertiesForRestore
_, err = basicunions.NewExampleServer(ctx, "restore", &basicunions.ExampleServerArgs{
[go/program-gen] Fix union type type resolution in Go program generation (#16297) # Description Fixes https://github.com/pulumi/pulumi-azure-native/issues/1554 ### Context The problem here is that when we compute `InputType: model.Type` in `pcl.Resource`, we map the types of input properties of resources from `schema.Type` into `model.Type`. When one of these properties is a `schema.UnionType` (union of objects to be exact), we map that _as is_ to `model.UnionType` which trips up Go program-gen as it doesn't know how to reduce the type to the actual _selected_ object type based on the resource inputs. ### Resolution The way to fix this is not in Go program-gen, instead we _reduce_ the computed union types during the binding phase into the actual object types based on the resource inputs so that all program generators only work against explicit objects rather than having to deal with unions of objects ### Example: ```pcl resource "example" "azure-native:eventgrid:EventSubscription" { destination = { endpointType = "EventHub" resourceId = "example" } expirationTimeUtc = "example" scope = "example" } ``` Before: ```go pulumi.Run(func(ctx *pulumi.Context) error { _, err := eventgrid.NewEventSubscription(ctx, "example", &eventgrid.EventSubscriptionArgs{ Destination: eventgrid.EventHubEventSubscriptionDestination{ EndpointType: "EventHub", ResourceId: "example", }, ExpirationTimeUtc: pulumi.String("example"), Scope: pulumi.String("example"), }) if err != nil { return err } return nil }) ``` After: ```go pulumi.Run(func(ctx *pulumi.Context) error { _, err := eventgrid.NewEventSubscription(ctx, "example", &eventgrid.EventSubscriptionArgs{ Destination: &eventgrid.EventHubEventSubscriptionDestinationArgs{ EndpointType: pulumi.String("EventHub"), ResourceId: pulumi.String("example"), }, ExpirationTimeUtc: pulumi.String("example"), Scope: pulumi.String("example"), }) if err != nil { return err } return nil }) ``` ## 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 - [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. -->
2024-06-06 19:13:19 +00:00
Properties: &basicunions.ServerPropertiesForRestoreArgs{
CreateMode: pulumi.String("PointInTimeRestore"),
RestorePointInTime: pulumi.String("example"),
[program-gen/tests] Replace discriminated unions test program with a program from a synthetic schema of basic unions (#15771) # Description This PR replaces the test program `discriminated-unions` with a new program `basic-unions` that uses a synthetic schema that has basic union definitions. The former program was failing compilation with Go because of a **faulty** azure-native SDK (tests using v1.56.0). It didn't generate the extra types for union objects (those with suffix `Args`). Those missing extra types are added in newer versions of azure-native SDK but the shape of the same resource doesn't have unions anymore so we can't just upgrade the version of the azure-native sdk we are testing with. I decided not to depend on a specific azure-native SDK and instead use a synthetic schema with the sole purpose of showing that we can emit correct code for fields assigned to object which are bound to different union cases. The downside here is that we can't compile the example for any language since it is a synthetic schema with no generated SDK (conformance tests in Go would make this possible but we are far away from that 😢) Closes #10834 since the original issue was due to faulty SDK, not program-gen. ## Checklist - [ ] I have run `make tidy` to update any new dependencies - [ ] 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. --> - [ ] 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. -->
2024-03-28 10:49:27 +00:00
},
})
if err != nil {
return err
}
return nil
})
}