Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[sdk/go] ConfigFile doesn't respect SkipAwait argument #2710

Closed
EronWright opened this issue Dec 12, 2023 · 0 comments · Fixed by #2709
Closed

[sdk/go] ConfigFile doesn't respect SkipAwait argument #2710

EronWright opened this issue Dec 12, 2023 · 0 comments · Fixed by #2709
Assignees
Labels
area/yaml kind/bug Some behavior is incorrect or out of spec language/go resolution/fixed This issue was fixed

Comments

@EronWright
Copy link
Contributor

Problem description

The ConfigFile resource doesn't seem to apply the skipAwait logic.

Reproducing the issue

Define a ConfigFile with SkipAwait enabled, and observe that the skipAwait annotation is not applied to the object.

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err = yaml.NewConfigFile(ctx, "test", &yaml.ConfigFileArgs{
   			SkipAwait: true,
			File:            "./manifest.yaml",
		})
	}

Suggestions for a fix

The problem seems to be that the transformations variable that contains the SkipAwait transformer isn't passed to parseDecodeYamlFiles.

transformations := args.Transformations
if args.SkipAwait {
transformations = AddSkipAwaitTransformation(transformations)
}
// Parse and decode the YAML files.
parseOpts := append(opts, pulumi.Parent(configFile))
rs, err := parseDecodeYamlFiles(ctx, &ConfigGroupArgs{
Files: []string{args.File},
Transformations: args.Transformations,
ResourcePrefix: args.ResourcePrefix,
}, true, parseOpts...)

@EronWright EronWright added kind/bug Some behavior is incorrect or out of spec area/yaml language/go labels Dec 12, 2023
@EronWright EronWright changed the title [go/sdk] ConfigFile doesn't implement SkipAwait [go/sdk] ConfigFile doesn't respect SkipAwait argument Dec 13, 2023
@EronWright EronWright changed the title [go/sdk] ConfigFile doesn't respect SkipAwait argument [sdk/go] ConfigFile doesn't respect SkipAwait argument Dec 13, 2023
EronWright added a commit that referenced this issue Jan 3, 2024
<!--Thanks for your contribution. See [CONTRIBUTING](CONTRIBUTING.md)
    for Pulumi's contribution guidelines.

    Help us merge your changes more quickly by adding more details such
    as labels, milestones, and reviewers.-->

### Proposed changes
Epic: #2254
Fixes: #2710

This PR standardizes the option propagation logic for the component
resources in the pulumi-kubernetes Go SDK. The general approach is:
1. In the component resource constructor, compute the child options to
be propagated to any children. The child options consist of the
component as parent, and with `version` and `pluginDownloadURL` if
specified.
2. Compute the invoke options by copying the child options.

### Specification
The component resource is responsible for computing sub-options for
invokes and for child resource declarations. This table outlines the
expected behavior for each [resource
option](https://www.pulumi.com/docs/concepts/options/) when presented to
a component resource.

|  | Propagated | Remarks |
|---|---|---|
| `additionalSecretOutputs` | no | "does not apply to component
resources" |
| `aliases` | no | Inherited via parent-child relationship. |
| `customTimeouts` | no | "does not apply to component resources" |
| `deleteBeforeReplace` | no |  |
| `deletedWith` | no |  |
| `dependsOn` | no | The children implicitly wait for the dependency. |
| `ignoreChanges` | no | Nonsensical to apply directly to children (see
[discussion](pulumi/pulumi#8969)). |
| `import` | no |  |
| `parent` | **yes** | The component becomes the parent. |
| `protect` | no | Inherited (see [p/p
bug](pulumi/pulumi#12431)). |
| `provider` | no | Combined into providers map, then inherited via
parent-child relationship. |
| `providers` | no | Inherited. |
| `replaceOnChanges` | no | "does not apply to component resources" |
| `retainOnDelete` | no | "does not apply to component resources" |
| `transformations` | no | Inherited. |
| `version` | **yes** | Influences default provider selection logic
during invokes.<br/>Should propagate when child resource is from the
same provider type. |
| `pluginDownloadURL` | **yes** | Influences default provider selection
logic during invokes.<br/>Should propagate when child resource is from
the same provider type. |

### Testing
A new test case is provided ([test
case](https://github.com/pulumi/pulumi-kubernetes/blob/073b9dc64e32e4f14fa6691e1b11049007ca2db7/tests/sdk/go/go_test.go#L808),
[test
program](https://github.com/pulumi/pulumi-kubernetes/blob/073b9dc64e32e4f14fa6691e1b11049007ca2db7/tests/sdk/go/options/main.go))
that exercises option propagation across the component resources:
-
[kubernetes.helm.sh.v3.Chart](https://www.pulumi.com/registry/packages/kubernetes/api-docs/helm/v3/chart/)
-
[kubernetes.kustomize.Directory](https://www.pulumi.com/registry/packages/kubernetes/api-docs/kustomize/directory/)
-
[kubernetes.yaml.ConfigGroup](https://www.pulumi.com/registry/packages/kubernetes/api-docs/yaml/configgroup/)
-
[kubernetes.yaml.ConfigFile](https://www.pulumi.com/registry/packages/kubernetes/api-docs/yaml/configfile/)

Upgrade testing must be done manually, with an emphasis on avoiding
replacement due to reparenting.

### Related issues (optional)

The Go SDK doesn't allow for options to be mutated via the
"kubernetes-style" transformation function.
#2666

During testing it was observed that the `parent` field is occasionally
missing from `RegisterResource` RPC call.
pulumi/pulumi#14826

Here's some key related PRs for additional context:
- pulumi/pulumi#8796
- #1601
- #1919
- #2005
@pulumi-bot pulumi-bot added the resolution/fixed This issue was fixed label Jan 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/yaml kind/bug Some behavior is incorrect or out of spec language/go resolution/fixed This issue was fixed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants