feat: normalize cortex agent show/describe output representations (#4786)

## Changes
* Use non-nil strings for comment and CortexAgentProfile for profile.
* Normalize agent_spec in SDK describe conversion to stable JSON.
* Update schemas, docs, and assertions to use profile as a nested block.
* Adjust acceptance/integration tests to assert typed profile and spec.
* Bump terraform-plugin-testing to v1.16.0.

Author: sfc-gh-kwasilewski

docs/data-sources/cortex_agents.md

@@ -185,10 +185,20 @@ Read-Only:
 - `default_version_name` (String)
 - `name` (String)
 - `owner` (String)
-- `profile` (String)
+- `profile` (List of Object) (see [below for nested schema](#nestedobjatt--cortex_agents--describe_output--profile))
 - `schema_name` (String)
 - `versions` (String)
 
+<a id="nestedobjatt--cortex_agents--describe_output--profile"></a>
+### Nested Schema for `cortex_agents.describe_output.profile`
+
+Read-Only:
+
+- `avatar` (String)
+- `color` (String)
+- `display_name` (String)
+
+
 
 <a id="nestedobjatt--cortex_agents--show_output"></a>
 ### Nested Schema for `cortex_agents.show_output`
@@ -200,5 +210,14 @@ Read-Only:
 - `database_name` (String)
 - `name` (String)
 - `owner` (String)
-- `profile` (String)
+- `profile` (List of Object) (see [below for nested schema](#nestedobjatt--cortex_agents--show_output--profile))
 - `schema_name` (String)
+
+<a id="nestedobjatt--cortex_agents--show_output--profile"></a>
+### Nested Schema for `cortex_agents.show_output.profile`
+
+Read-Only:
+
+- `avatar` (String)
+- `color` (String)
+- `display_name` (String)

docs/resources/cortex_agent.md

@@ -119,10 +119,20 @@ Read-Only:
 - `default_version_name` (String)
 - `name` (String)
 - `owner` (String)
-- `profile` (String)
+- `profile` (List of Object) (see [below for nested schema](#nestedobjatt--describe_output--profile))
 - `schema_name` (String)
 - `versions` (String)
 
+<a id="nestedobjatt--describe_output--profile"></a>
+### Nested Schema for `describe_output.profile`
+
+Read-Only:
+
+- `avatar` (String)
+- `color` (String)
+- `display_name` (String)
+
+
 
 <a id="nestedatt--show_output"></a>
 ### Nested Schema for `show_output`
@@ -134,9 +144,18 @@ Read-Only:
 - `database_name` (String)
 - `name` (String)
 - `owner` (String)
-- `profile` (String)
+- `profile` (List of Object) (see [below for nested schema](#nestedobjatt--show_output--profile))
 - `schema_name` (String)
 
+<a id="nestedobjatt--show_output--profile"></a>
+### Nested Schema for `show_output.profile`
+
+Read-Only:
+
+- `avatar` (String)
+- `color` (String)
+- `display_name` (String)
+
 ## Import
 
 Import is supported using the following syntax:

go.mod

@@ -14,7 +14,7 @@ require (
 	github.com/hashicorp/terraform-plugin-go v0.31.0
 	github.com/hashicorp/terraform-plugin-mux v0.23.1
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.40.0
-	github.com/hashicorp/terraform-plugin-testing v1.15.0
+	github.com/hashicorp/terraform-plugin-testing v1.16.0
 	github.com/jmoiron/sqlx v1.4.0
 	github.com/pelletier/go-toml/v2 v2.3.1
 	github.com/snowflakedb/gosnowflake/v2 v2.0.2
@@ -80,10 +80,10 @@ require (
 	github.com/hashicorp/go-plugin v1.8.0 // indirect
 	github.com/hashicorp/go-retryablehttp v0.7.8 // indirect
 	github.com/hashicorp/go-version v1.9.0 // indirect
-	github.com/hashicorp/hc-install v0.9.3 // indirect
+	github.com/hashicorp/hc-install v0.9.4 // indirect
 	github.com/hashicorp/hcl/v2 v2.24.0 // indirect
 	github.com/hashicorp/logutils v1.0.0 // indirect
-	github.com/hashicorp/terraform-exec v0.25.0 // indirect
+	github.com/hashicorp/terraform-exec v0.25.1 // indirect
 	github.com/hashicorp/terraform-plugin-log v0.10.0 // indirect
 	github.com/hashicorp/terraform-registry-address v0.4.0 // indirect
 	github.com/hashicorp/terraform-svchost v0.2.1 // indirect

go.sum

@@ -100,10 +100,10 @@ github.com/gabriel-vasile/mimetype v1.4.13 h1:46nXokslUBsAJE/wMsp5gtO500a4F3Nkz9
 github.com/gabriel-vasile/mimetype v1.4.13/go.mod h1:d+9Oxyo1wTzWdyVUPMmXFvp4F9tea18J8ufA774AB3s=
 github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI=
 github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic=
-github.com/go-git/go-billy/v5 v5.6.2 h1:6Q86EsPXMa7c3YZ3aLAQsMA0VlWmy43r6FHqa/UNbRM=
-github.com/go-git/go-billy/v5 v5.6.2/go.mod h1:rcFC2rAsp/erv7CMz9GczHcuD0D32fWzH+MJAU+jaUU=
-github.com/go-git/go-git/v5 v5.16.5 h1:mdkuqblwr57kVfXri5TTH+nMFLNUxIj9Z7F5ykFbw5s=
-github.com/go-git/go-git/v5 v5.16.5/go.mod h1:QOMLpNf1qxuSY4StA/ArOdfFR2TrKEjJiye2kel2m+M=
+github.com/go-git/go-billy/v5 v5.8.0 h1:I8hjc3LbBlXTtVuFNJuwYuMiHvQJDq1AT6u4DwDzZG0=
+github.com/go-git/go-billy/v5 v5.8.0/go.mod h1:RpvI/rw4Vr5QA+Z60c6d6LXH0rYJo0uD5SqfmrrheCY=
+github.com/go-git/go-git/v5 v5.18.0 h1:O831KI+0PR51hM2kep6T8k+w0/LIAD490gvqMCvL5hM=
+github.com/go-git/go-git/v5 v5.18.0/go.mod h1:pW/VmeqkanRFqR6AljLcs7EA7FbZaN5MQqO7oZADXpo=
 github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=
 github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
 github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
@@ -162,16 +162,16 @@ github.com/hashicorp/go-uuid v1.0.3 h1:2gKiV6YVmrJ1i2CKKa9obLvRieoRGviZFL26PcT/C
 github.com/hashicorp/go-uuid v1.0.3/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro=
 github.com/hashicorp/go-version v1.9.0 h1:CeOIz6k+LoN3qX9Z0tyQrPtiB1DFYRPfCIBtaXPSCnA=
 github.com/hashicorp/go-version v1.9.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA=
-github.com/hashicorp/hc-install v0.9.3 h1:1H4dgmgzxEVwT6E/d/vIL5ORGVKz9twRwDw+qA5Hyho=
-github.com/hashicorp/hc-install v0.9.3/go.mod h1:FQlQ5I3I/X409N/J1U4pPeQQz1R3BoV0IysB7aiaQE0=
+github.com/hashicorp/hc-install v0.9.4 h1:KKWOpUG0EqIV63Qk2GGFrZ0s275NVs5lKf9N5vjBNoc=
+github.com/hashicorp/hc-install v0.9.4/go.mod h1:4LRYeEN2bMIFfIv57ldMWt9awfuZhvpbRt0vWmv51WU=
 github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4=
 github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
 github.com/hashicorp/hcl/v2 v2.24.0 h1:2QJdZ454DSsYGoaE6QheQZjtKZSUs9Nh2izTWiwQxvE=
 github.com/hashicorp/hcl/v2 v2.24.0/go.mod h1:oGoO1FIQYfn/AgyOhlg9qLC6/nOJPX3qGbkZpYAcqfM=
 github.com/hashicorp/logutils v1.0.0 h1:dLEQVugN8vlakKOUE3ihGLTZJRB4j+M2cdTm/ORI65Y=
 github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64=
-github.com/hashicorp/terraform-exec v0.25.0 h1:Bkt6m3VkJqYh+laFMrWIpy9KHYFITpOyzRMNI35rNaY=
-github.com/hashicorp/terraform-exec v0.25.0/go.mod h1:dl9IwsCfklDU6I4wq9/StFDp7dNbH/h5AnfS1RmiUl8=
+github.com/hashicorp/terraform-exec v0.25.1 h1:PRutYRGM8pixV3B8812NYoBK5O+yuf3qcB/70KFKGiU=
+github.com/hashicorp/terraform-exec v0.25.1/go.mod h1:+izOYrs9sKMQK4OYvGDnrSSJHY/pm4e4eXFqSL2Q5mA=
 github.com/hashicorp/terraform-json v0.27.2 h1:BwGuzM6iUPqf9JYM/Z4AF1OJ5VVJEEzoKST/tRDBJKU=
 github.com/hashicorp/terraform-json v0.27.2/go.mod h1:GzPLJ1PLdUG5xL6xn1OXWIjteQRT2CNT9o/6A9mi9hE=
 github.com/hashicorp/terraform-plugin-framework v1.19.0 h1:q0bwyhxAOR3vfdgbk9iplv3MlTv/dhBHTXjQOtQDoBA=
@@ -186,8 +186,8 @@ github.com/hashicorp/terraform-plugin-mux v0.23.1 h1:B93b4hEj8cPKh24WJH2dJJAS3a5
 github.com/hashicorp/terraform-plugin-mux v0.23.1/go.mod h1:IwuivHNfDVeuDbVvg6fnAYEEEVx881STwJHsl/00UkQ=
 github.com/hashicorp/terraform-plugin-sdk/v2 v2.40.0 h1:MKS/2URqeJRwJdbOfcbdsZCq/IRrNkqJNN0GtVIsuGs=
 github.com/hashicorp/terraform-plugin-sdk/v2 v2.40.0/go.mod h1:PuG4P97Ju3QXW6c6vRkRadWJbvnEu2Xh+oOuqcYOqX4=
-github.com/hashicorp/terraform-plugin-testing v1.15.0 h1:/fimKyl0YgD7aAtJkuuAZjwBASXhCIwWqMbDLnKLMe4=
-github.com/hashicorp/terraform-plugin-testing v1.15.0/go.mod h1:bGXMw7bE95EiZhSBV3rM2W8TiffaPTDuLS+HFI/lIYs=
+github.com/hashicorp/terraform-plugin-testing v1.16.0 h1:GB97nGnJ1hESpDrCjqZig38RodSF0gdRzxlDupLXP38=
+github.com/hashicorp/terraform-plugin-testing v1.16.0/go.mod h1:eQPYAy9xFMV7xtIFX8Y+wJGtUB++HBl329zCF6PBMZk=
 github.com/hashicorp/terraform-registry-address v0.4.0 h1:S1yCGomj30Sao4l5BMPjTGZmCNzuv7/GDTDX99E9gTk=
 github.com/hashicorp/terraform-registry-address v0.4.0/go.mod h1:LRS1Ay0+mAiRkUyltGT+UHWkIqTFvigGn/LbMshfflE=
 github.com/hashicorp/terraform-svchost v0.2.1 h1:ubvrTFw3Q7CsoEaX7V06PtCTKG3wu7GyyobAoN4eF3Q=

pkg/acceptance/bettertestspoc/assert/objectassert/cortex_agent_desc_snowflake_ext.go

@@ -2,35 +2,13 @@ package objectassert
 
 import (
 	"fmt"
+	"reflect"
 	"testing"
 	"time"
 
 	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/sdk"
-	"github.com/stretchr/testify/require"
 )
 
-func (c *CortexAgentDetailsAssert) HasNoComment() *CortexAgentDetailsAssert {
-	c.AddAssertion(func(t *testing.T, o *sdk.CortexAgentDetails) error {
-		t.Helper()
-		if o.Comment != nil {
-			return fmt.Errorf("expected comment to be empty")
-		}
-		return nil
-	})
-	return c
-}
-
-func (c *CortexAgentDetailsAssert) HasNoProfile() *CortexAgentDetailsAssert {
-	c.AddAssertion(func(t *testing.T, o *sdk.CortexAgentDetails) error {
-		t.Helper()
-		if o.Profile != nil {
-			return fmt.Errorf("expected profile to be empty")
-		}
-		return nil
-	})
-	return c
-}
-
 func (c *CortexAgentDetailsAssert) HasCreatedOnNotEmpty() *CortexAgentDetailsAssert {
 	c.AddAssertion(func(t *testing.T, o *sdk.CortexAgentDetails) error {
 		t.Helper()
@@ -45,21 +23,8 @@ func (c *CortexAgentDetailsAssert) HasCreatedOnNotEmpty() *CortexAgentDetailsAss
 func (c *CortexAgentDetailsAssert) HasCortexAgentProfile(expected sdk.CortexAgentProfile) *CortexAgentDetailsAssert {
 	c.AddAssertion(func(t *testing.T, o *sdk.CortexAgentDetails) error {
 		t.Helper()
-		return assertCortexAgentProfileJsonEqual(o.Profile, expected)
-	})
-	return c
-}
-
-func (c *CortexAgentDetailsAssert) HasCortexAgentSpec(expected string) *CortexAgentDetailsAssert {
-	c.AddAssertion(func(t *testing.T, o *sdk.CortexAgentDetails) error {
-		t.Helper()
-		normalizedActual, err := sdk.NormalizeCortexAgentSpecification(o.AgentSpec)
-		require.NoError(t, err)
-		normalizedExpected, err := sdk.NormalizeCortexAgentSpecification(expected)
-		require.NoError(t, err)
-
-		if normalizedActual != normalizedExpected {
-			return fmt.Errorf("expected agent spec: %v; got: %v", normalizedExpected, normalizedActual)
+		if !reflect.DeepEqual(o.Profile, expected) {
+			return fmt.Errorf("expected profile: %+v; got: %+v", expected, o.Profile)
 		}
 		return nil
 	})

pkg/acceptance/bettertestspoc/assert/objectassert/cortex_agent_desc_snowflake_gen.go

@@ -9,28 +9,6 @@ import (
 	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/sdk"
 )
 
-func (c *CortexAgentAssert) HasNoComment() *CortexAgentAssert {
-	c.AddAssertion(func(t *testing.T, o *sdk.CortexAgent) error {
-		t.Helper()
-		if o.Comment != nil {
-			return fmt.Errorf("expected comment to be empty")
-		}
-		return nil
-	})
-	return c
-}
-
-func (c *CortexAgentAssert) HasNoProfile() *CortexAgentAssert {
-	c.AddAssertion(func(t *testing.T, o *sdk.CortexAgent) error {
-		t.Helper()
-		if o.Profile != nil {
-			return fmt.Errorf("expected profile to be empty")
-		}
-		return nil
-	})
-	return c
-}
-
 func (c *CortexAgentAssert) HasCreatedOnNotEmpty() *CortexAgentAssert {
 	c.AddAssertion(func(t *testing.T, o *sdk.CortexAgent) error {
 		t.Helper()
@@ -45,23 +23,10 @@ func (c *CortexAgentAssert) HasCreatedOnNotEmpty() *CortexAgentAssert {
 func (c *CortexAgentAssert) HasCortexAgentProfile(expected sdk.CortexAgentProfile) *CortexAgentAssert {
 	c.AddAssertion(func(t *testing.T, o *sdk.CortexAgent) error {
 		t.Helper()
-		return assertCortexAgentProfileJsonEqual(o.Profile, expected)
+		if !reflect.DeepEqual(o.Profile, expected) {
+			return fmt.Errorf("expected profile: %+v; got: %+v", expected, o.Profile)
+		}
+		return nil
 	})
 	return c
 }
-
-func assertCortexAgentProfileJsonEqual(profile *string, expected sdk.CortexAgentProfile) error {
-	if profile == nil {
-		return fmt.Errorf("expected profile to be non-nil")
-	}
-
-	actual, err := sdk.UnmarshalCortexAgentProfile(*profile)
-	if err != nil {
-		return fmt.Errorf("unmarshal cortex agent profile: %w", err)
-	}
-
-	if !reflect.DeepEqual(actual, &expected) {
-		return fmt.Errorf("expected profile %+v; got %+v", &expected, actual)
-	}
-	return nil
-}

pkg/acceptance/bettertestspoc/assert/objectassert/cortex_agent_snowflake_ext.go

@@ -2,9 +2,30 @@ package resourceshowoutputassert
 
 import (
 	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/acceptance/bettertestspoc/assert"
+	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/sdk"
 )
 
 func (c *CortexAgentDescribeOutputAssert) HasCreatedOnNotEmpty() *CortexAgentDescribeOutputAssert {
 	c.AddAssertion(assert.ResourceDescribeOutputValuePresent("created_on"))
 	return c
 }
+
+func (c *CortexAgentDescribeOutputAssert) HasProfile(expected sdk.CortexAgentProfile) *CortexAgentDescribeOutputAssert {
+	c.AddAssertion(assert.ResourceDescribeOutputValueSet("profile.#", "1"))
+	if expected.DisplayName != nil {
+		c.AddAssertion(assert.ResourceDescribeOutputValueSet("profile.0.display_name", *expected.DisplayName))
+	} else {
+		c.AddAssertion(assert.ResourceDescribeOutputValueSet("profile.0.display_name", ""))
+	}
+	if expected.Avatar != nil {
+		c.AddAssertion(assert.ResourceDescribeOutputValueSet("profile.0.avatar", *expected.Avatar))
+	} else {
+		c.AddAssertion(assert.ResourceDescribeOutputValueSet("profile.0.avatar", ""))
+	}
+	if expected.Color != nil {
+		c.AddAssertion(assert.ResourceDescribeOutputValueSet("profile.0.color", *expected.Color))
+	} else {
+		c.AddAssertion(assert.ResourceDescribeOutputValueSet("profile.0.color", ""))
+	}
+	return c
+}