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

fix(constraints): ensure constraints are non-null #556

Merged
merged 1 commit into from
Aug 28, 2024
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
6 changes: 4 additions & 2 deletions internal/provider/provider_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ package provider

import (
"context"
"fmt"
"os"
"runtime"
"testing"
Expand All @@ -17,6 +18,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/hashicorp/terraform-plugin-go/tfprotov6"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"github.com/juju/terraform-provider-juju/internal/juju"
)
Expand Down Expand Up @@ -172,9 +174,9 @@ func testAccPreCheck(t *testing.T) {
}
}
confResp := configureProvider(t, Provider)
assert.Equal(t, confResp.Diagnostics.HasError(), false)
require.Equal(t, confResp.Diagnostics.HasError(), false, fmt.Sprintf("provider configuration failed: %v", confResp.Diagnostics.Errors()))
testClient, ok := confResp.ResourceData.(*juju.Client)
assert.Truef(t, ok, "ResourceData, not of type juju client")
require.Truef(t, ok, "ResourceData, not of type juju client")
TestClient = testClient
}

Expand Down
18 changes: 13 additions & 5 deletions internal/provider/resource_application.go
Original file line number Diff line number Diff line change
Expand Up @@ -578,6 +578,9 @@ func (r *applicationResource) Create(ctx context.Context, req resource.CreateReq
r.trace(fmt.Sprintf("read application resource %q", createResp.AppName))

// Save plan into Terraform state

// Constraints do not apply to subordinate applications. If the application
// is subordinate, the constraints will be set to the empty string.
plan.Constraints = types.StringValue(readResp.Constraints.String())
plan.Placement = types.StringValue(readResp.Placement)
plan.Principal = types.BoolNull()
Expand Down Expand Up @@ -688,6 +691,7 @@ func (r *applicationResource) Read(ctx context.Context, req resource.ReadRequest
state.ModelName = types.StringValue(modelName)

// Use the response to fill in state

state.Placement = types.StringValue(response.Placement)
state.Principal = types.BoolNull()
state.UnitCount = types.Int64Value(int64(response.Units))
Expand All @@ -708,10 +712,10 @@ func (r *applicationResource) Read(ctx context.Context, req resource.ReadRequest
return
}

// constraints do not apply to subordinate applications.
if response.Principal {
state.Constraints = types.StringValue(response.Constraints.String())
}
// Constraints do not apply to subordinate applications. If the application
// is subordinate, the constraints will be set to the empty string.
state.Constraints = types.StringValue(response.Constraints.String())

exposeType := req.State.Schema.GetBlocks()[ExposeKey].(schema.ListNestedBlock).NestedObject.Type()
if response.Expose != nil {
exp := parseNestedExpose(response.Expose)
Expand Down Expand Up @@ -986,7 +990,11 @@ func (r *applicationResource) Update(ctx context.Context, req resource.UpdateReq
}
}

if !plan.Constraints.Equal(state.Constraints) {
// Do not use .Equal() here as we should consider null constraints the same
// as empty-string constraints. Terraform considers them different, so will
// incorrectly attempt to update the constraints, which can cause trouble
// for subordinate applications.
if plan.Constraints.ValueString() != state.Constraints.ValueString() {
appConstraints, err := constraints.Parse(plan.Constraints.ValueString())
if err != nil {
resp.Diagnostics.AddError("Conversion", fmt.Sprintf("Unable to parse plan constraints, got error: %s", err))
Expand Down
70 changes: 70 additions & 0 deletions internal/provider/resource_application_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
package provider

import (
"context"
"fmt"
"os"
"regexp"
Expand All @@ -20,6 +21,7 @@ import (
"github.com/juju/juju/rpc/params"
"github.com/juju/names/v5"

"github.com/juju/terraform-provider-juju/internal/juju"
internaljuju "github.com/juju/terraform-provider-juju/internal/juju"
internaltesting "github.com/juju/terraform-provider-juju/internal/testing"
)
Expand Down Expand Up @@ -156,6 +158,58 @@ func TestAcc_ResourceApplication_Updates(t *testing.T) {
})
}

func TestAcc_ResourceApplication_UpdateImportedSubordinate(t *testing.T) {
if testingCloud != LXDCloudTesting {
t.Skip(t.Name() + " only runs with LXD")
}

testAccPreCheck(t)

modelName := acctest.RandomWithPrefix("tf-test-application")

ctx := context.Background()

_, err := TestClient.Models.CreateModel(juju.CreateModelInput{
Name: modelName,
})
if err != nil {
t.Fatal(err)
}

_, err = TestClient.Applications.CreateApplication(ctx, &juju.CreateApplicationInput{
ApplicationName: "telegraf",
ModelName: modelName,
CharmName: "telegraf",
CharmChannel: "latest/stable",
CharmRevision: 73,
Units: 0,
})
if err != nil {
t.Fatal(err)
}

resource.ParallelTest(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
ProtoV6ProviderFactories: frameworkProviderFactories,
Steps: []resource.TestStep{
{
Config: testAccResourceApplicationSubordinate(modelName, 73),
ImportState: true,
ImportStateId: fmt.Sprintf("%s:telegraf", modelName),
ImportStatePersist: true,
ResourceName: "juju_application.telegraf",
},
{
Config: testAccResourceApplicationSubordinate(modelName, 75),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("juju_application.telegraf", "charm.0.name", "telegraf"),
resource.TestCheckResourceAttr("juju_application.telegraf", "charm.0.revision", "75"),
),
},
},
})
}

// TestAcc_ResourceApplication_UpdatesRevisionConfig will test the revision update that have new config parameters on
// the charm. The test will check that the config is updated and the revision is updated as well.
func TestAcc_ResourceApplication_UpdatesRevisionConfig(t *testing.T) {
Expand Down Expand Up @@ -801,6 +855,22 @@ resource "juju_application" "this" {
}
}

func testAccResourceApplicationSubordinate(modelName string, subordinateRevision int) string {
return fmt.Sprintf(`
resource "juju_application" "telegraf" {
model = %q
name = "telegraf"

charm {
name = "telegraf"
revision = %d
}

units = 0
}
`, modelName, subordinateRevision)
}

func testAccResourceApplicationConstraintsSubordinate(modelName string, constraints string) string {
return fmt.Sprintf(`
resource "juju_model" "this" {
Expand Down
Loading