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

Always recompute metadata when a release is updated #1097

Merged
merged 9 commits into from
Apr 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/1097.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
`helm/resource_release.go`: Always recompute metadata when a release is updated
```
26 changes: 22 additions & 4 deletions helm/resource_release.go
Original file line number Diff line number Diff line change
Expand Up @@ -828,6 +828,20 @@ func resourceDiff(ctx context.Context, d *schema.ResourceDiff, meta interface{})
return err
}

// Always recompute metadata if a new revision is going to be created
recomputeMetadataFields := []string{
"chart",
"repository",
"version",
"values",
"set",
"set_sensitive",
"set_list",
}
if d.HasChanges(recomputeMetadataFields...) {
d.SetNewComputed("metadata")
}

var chartPathOpts action.ChartPathOptions
cpo, chartName, err := chartPathOptions(d, m, &chartPathOpts)
if err != nil {
Expand Down Expand Up @@ -1033,9 +1047,13 @@ func setReleaseAttributes(d *schema.ResourceData, r *release.Release, meta inter
}

cloakSetValues(r.Config, d)
values, err := json.Marshal(r.Config)
if err != nil {
return err
values := "{}"
if r.Config != nil {
v, err := json.Marshal(r.Config)
if err != nil {
return err
}
values = string(v)
}

m := meta.(*Meta)
Expand All @@ -1055,7 +1073,7 @@ func setReleaseAttributes(d *schema.ResourceData, r *release.Release, meta inter
"chart": r.Chart.Metadata.Name,
"version": r.Chart.Metadata.Version,
"app_version": r.Chart.Metadata.AppVersion,
"values": string(values),
"values": values,
}})
}

Expand Down
82 changes: 82 additions & 0 deletions helm/resource_release_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1778,6 +1778,53 @@ func TestAccResourceRelease_OCI_login(t *testing.T) {
})
}

func TestAccResourceRelease_recomputeMetadata(t *testing.T) {
name := randName("basic")
namespace := createRandomNamespace(t)
defer deleteNamespace(t, namespace)

resource.Test(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
ProviderFactories: map[string]func() (*schema.Provider, error){
"helm": func() (*schema.Provider, error) {
return Provider(), nil
},
},
ExternalProviders: map[string]resource.ExternalProvider{
"local": {
Source: "hashicorp/local",
},
},
CheckDestroy: testAccCheckHelmReleaseDestroy(namespace),
Steps: []resource.TestStep{
{
Config: testAccHelmReleaseRecomputeMetadata(testResourceName, namespace, name),
Check: resource.ComposeAggregateTestCheckFunc(
resource.TestCheckResourceAttr("helm_release.test", "metadata.0.name", name),
resource.TestCheckResourceAttr("helm_release.test", "metadata.0.namespace", namespace),
resource.TestCheckResourceAttr("helm_release.test", "metadata.0.revision", "1"),
resource.TestCheckResourceAttr("helm_release.test", "status", release.StatusDeployed.String()),
resource.TestCheckResourceAttr("helm_release.test", "metadata.0.version", "2.0.0"),
resource.TestCheckResourceAttr("helm_release.test", "set.%", "0"),
),
},
{
Config: testAccHelmReleaseRecomputeMetadataSet(testResourceName, namespace, name),
Check: resource.ComposeAggregateTestCheckFunc(
resource.TestCheckResourceAttr("helm_release.test", "metadata.0.version", "2.0.0"),
resource.TestCheckResourceAttr("helm_release.test", "status", release.StatusDeployed.String()),
resource.TestCheckResourceAttr("helm_release.test", "set.0.name", "test"),
resource.TestCheckResourceAttr("helm_release.test", "set.0.value", "test"),
),
},
{
Config: testAccHelmReleaseRecomputeMetadataSet(testResourceName, namespace, name),
PlanOnly: true,
},
},
})
}

func testAccHelmReleaseConfig_OCI(resource, ns, name, repo, version string) string {
return fmt.Sprintf(`
resource "helm_release" "%s" {
Expand Down Expand Up @@ -2027,3 +2074,38 @@ func testAccHelmReleaseUpdateSetListValues(resource, ns, name string) string {
}
`, resource, name, ns)
}

func testAccHelmReleaseRecomputeMetadata(resource, ns, name string) string {
return fmt.Sprintf(`
resource "helm_release" "%s" {
name = %q
namespace = %q
chart = "./testdata/charts/test-chart-v2"
}

resource "local_file" "example" {
content = yamlencode(helm_release.test.metadata)
filename = "${path.module}/foo.bar"
}
`, resource, name, ns)
}

func testAccHelmReleaseRecomputeMetadataSet(resource, ns, name string) string {
return fmt.Sprintf(`
resource "helm_release" "%s" {
name = %q
namespace = %q
chart = "./testdata/charts/test-chart-v2"

set {
name = "test"
value = "test"
}
}

resource "local_file" "example" {
content = yamlencode(helm_release.test.metadata)
filename = "${path.module}/foo.bar"
}
`, resource, name, ns)
}