Handle unknowns in Helm Release

[EronWright]

Proposed changes

This PR improves support for preview mode in the Helm Release, specifically the handling of unknown inputs.

The specific improvements are:

1. Ensure that the Helm provider handles the RPC requests (Check, Diff, Create, Update, and Read); previously, when unknowns were present, the kube provider itself handled some requests (with undefined behavior, see Helm Release skips preview logic during Update #2679).
2. When decoding the inputs into an internal Release struct for further processing, render the unknown values as null. Previously, decodeRelease would panic.
3. When encoding the Release back to a property map, recover the unknownness of the properties.
4. In Check, perform the roundtrip of inputs-to-Release-to-outputs in all cases. This has the effect of stabilizing the checked inputs.
5. In Diff, detect the edge case of a property becoming a computed value.
6. In preview mode, emit unknown values for the output-only properties status and resourceNames.

Some focus areas for testing:

1. Roundtrip of unknown properties, e.g. description.
2. Roundtrip of unknown values in the values property.
3. Handling of an unknown name (i.e. the release name), which should cause replacement.
4. Cluster-unreachable mode, including skip-update. The main provider handled some of the logic.
5. Handling of values.yaml files.

Note: the handling of unknowns works best with allowNullValues: true.

Related issues (optional)

Closes #2660
Closes #2679

Demos

Based on the following program:

import * as pulumi from "@pulumi/pulumi";
import * as kubernetes from "@pulumi/kubernetes";
import * as random from "@pulumi/random";
import {FileAsset} from "@pulumi/pulumi/asset";

const someNamespace = new kubernetes.core.v1.Namespace('some-namespace', {
    metadata: {
        name: 'some-namespace'
    }
});

const name = new random.RandomString("name", {length: 8, special: false, upper: false, numeric: false});
const desc = new random.RandomString("desc", {length: 200, special: false});
const replicas = new random.RandomInteger("replicas", {min: 1, max: 5});

const release = new kubernetes.helm.v3.Release('some-chart', {
    allowNullValues: true,
    chart: pulumi.secret('oci://ghcr.io/dirien/charts/minecraft-exporter'),
    version: '0.11.1',
    name: name.result,
    namespace: someNamespace.metadata.name,
    description: pulumi.secret(desc.result),
    values: {
        replicaCount: replicas.result,
        dsd: 1,
        sds: 12,
    },
    valueYamlFiles: [new FileAsset("./metrics.yml")],
}, {});

export const helmChart = release.chart;
export const helmDescription = release.description;
export const helmStatus = release.status;

With metrics.yml:

metrics:
  enabled: true

Unknown Properties

In this case, the description (which was marked as a secret) is changing to an unknown value.

p up --replace 'urn:pulumi:dev2::issue-2660::random:index/randomString:RandomString::desc' --diff

Before:

    ~ kubernetes:helm.sh/v3:Release: (update)
        [id=some-namespace/oazlcjeb]
        [urn=urn:pulumi:dev2::issue-2660::kubernetes:helm.sh/v3:Release::some-chart]
        [provider=urn:pulumi:dev2::issue-2660::pulumi:providers:kubernetes::default_4_7_1::cf17d60b-0012-426e-85fe-d88f741df5bf]
      - apiVersion              : <null>
      + compat                  : "true"
      - createNamespace         : false
      - dependencyUpdate        : false
      ~ description             : [secret] => output<string>
      - devel                   : false
      - disableCRDHooks         : false
      - disableOpenapiValidation: false
      - disableWebhooks         : false
      - forceUpdate             : false
      - keyring                 : ""
      - kind                    : <null>
      - lint                    : false
      - postrender              : ""
      - recreatePods            : false
      - renderSubchartNotes     : false
      - replace                 : false
      - resetValues             : false
      - reuseValues             : false
      - skipAwait               : false
      - skipCrds                : false
      + valueYamlFiles          : [
      +     [0]: asset(file:88220c0) { /Users/eronwright/Pulumi/pulumi-hacking/kubernetes/issue-2660/metrics.yml }
        ]
      ~ values                  : {
          - metrics: {
              - enabled: true
            }
        }
      - verify                  : false
      - waitForJobs             : false

After:

    ~ kubernetes:helm.sh/v3:Release: (update)
        [id=some-namespace/oazlcjeb]
        [urn=urn:pulumi:dev2::issue-2660::kubernetes:helm.sh/v3:Release::some-chart]
        [provider=urn:pulumi:dev2::issue-2660::pulumi:providers:kubernetes::default_4_7_1::cf17d60b-0012-426e-85fe-d88f741df5bf]
      ~ description: [secret] => output<string>

Unknown Values

p up --replace 'urn:pulumi:dev2::issue-2660::random:index/randomInteger:RandomInteger::replicas' --diff

Before:

    ~ kubernetes:helm.sh/v3:Release: (update)
        [id=some-namespace/oazlcjeb]
        [urn=urn:pulumi:dev2::issue-2660::kubernetes:helm.sh/v3:Release::some-chart]
        [provider=urn:pulumi:dev2::issue-2660::pulumi:providers:kubernetes::default_4_7_1::cf17d60b-0012-426e-85fe-d88f741df5bf]
      - apiVersion              : <null>
      - atomic                  : false
      - cleanupOnFail           : false
      + compat                  : "true"
      - createNamespace         : false
      - dependencyUpdate        : false
      - devel                   : false
      - disableCRDHooks         : false
      - disableOpenapiValidation: false
      - disableWebhooks         : false
      - forceUpdate             : false
      - keyring                 : ""
      - kind                    : <null>
      - lint                    : false
      - postrender              : ""
      - recreatePods            : false
      - renderSubchartNotes     : false
      - replace                 : false
      - resetValues             : false
      - reuseValues             : false
      - skipAwait               : false
      - skipCrds                : false
      + valueYamlFiles          : [
      +     [0]: asset(file:88220c0) { ./metrics.yml }
        ]
      ~ values                  : {
          - metrics     : {
              - enabled: true
            }
          ~ replicaCount: 3 => output<string>
        }
      - verify                  : false
      - waitForJobs             : false

After:

    ~ kubernetes:helm.sh/v3:Release: (update)
        [id=some-namespace/oazlcjeb]
        [urn=urn:pulumi:dev2::issue-2660::kubernetes:helm.sh/v3:Release::some-chart]
        [provider=urn:pulumi:dev2::issue-2660::pulumi:providers:kubernetes::default_4_7_1::cf17d60b-0012-426e-85fe-d88f741df5bf]
      ~ values: {
          ~ replicaCount: 3 => output<string>
        }

Unknown Release Name

In this case, we expect replacement because the release name is changing.

p up --replace 'urn:pulumi:dev2::issue-2660::random:index/randomString:RandomString::name' --diff

Before:

    ~ kubernetes:helm.sh/v3:Release: (update)
        [id=some-namespace/oazlcjeb]
        [urn=urn:pulumi:dev2::issue-2660::kubernetes:helm.sh/v3:Release::some-chart]
        [provider=urn:pulumi:dev2::issue-2660::pulumi:providers:kubernetes::default_4_7_1::cf17d60b-0012-426e-85fe-d88f741df5bf]
      - apiVersion              : <null>
      + compat                  : "true"
      - createNamespace         : false
      - dependencyUpdate        : false
      - devel                   : false
      - disableCRDHooks         : false
      - disableOpenapiValidation: false
      - disableWebhooks         : false
      - forceUpdate             : false
      - keyring                 : ""
      - kind                    : <null>
      - lint                    : false
      ~ name                    : "oazlcjeb" => output<string>
      - postrender              : ""
      - recreatePods            : false
      - renderSubchartNotes     : false
      - replace                 : false
      - resetValues             : false
      - reuseValues             : false
      - skipAwait               : false
      - skipCrds                : false
      + valueYamlFiles          : [
      +     [0]: asset(file:88220c0) { /Users/eronwright/Pulumi/pulumi-hacking/kubernetes/issue-2660/metrics.yml }
        ]
      ~ values                  : {
          - metrics: {
              - enabled: true
            }
        }
      - verify                  : false
      - waitForJobs             : false

After:

    +-kubernetes:helm.sh/v3:Release: (replace)
        [id=some-namespace/oazlcjeb]
        [urn=urn:pulumi:dev2::issue-2660::kubernetes:helm.sh/v3:Release::some-chart]
        [provider=urn:pulumi:dev2::issue-2660::pulumi:providers:kubernetes::default_4_7_1::cf17d60b-0012-426e-85fe-d88f741df5bf]
      ~ name: "oazlcjeb" => output<string>

[github-actions]

Does the PR have any schema changes?

Looking good! No breaking changes found.
No new resources/functions.

[codecov]

Codecov Report

Attention: 43 lines in your changes are missing coverage. Please review.

Comparison is base (6370a3b) 24.64% compared to head (8da7d25) 25.48%.
Report is 1 commits behind head on master.

Files	Patch %	Lines
provider/pkg/provider/helm_release.go	0.00%	28 Missing ⚠️
provider/pkg/provider/provider.go	42.30%	14 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2822      +/-   ##
==========================================
+ Coverage   24.64%   25.48%   +0.84%     
==========================================
  Files          48       48              
  Lines        9710     7526    -2184     
==========================================
- Hits         2393     1918     -475     
+ Misses       7160     5450    -1710     
- Partials      157      158       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[lblackstone]

Just a few small comments. This looks great, overall!

[rquitales]

LGTM