Skip to content

Test some ignoreChanges functionality #3175

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Test some ignoreChanges functionality #3175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
247d83f
Test some ignoreChanges functionality
corymhall Sep 4, 2025
7138520
updates
corymhall Sep 10, 2025
f9c420c
fixing tests
corymhall Sep 11, 2025
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
375 changes: 375 additions & 0 deletions pkg/tests/ignore_changes_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,375 @@
package tests

import (
"context"
"fmt"
"os"
"testing"

"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/pulumi/providertest/pulumitest"
"github.com/pulumi/pulumi/sdk/v3/go/auto/optpreview"
"github.com/pulumi/pulumi/sdk/v3/go/auto/optrefresh"
pulumirpc "github.com/pulumi/pulumi/sdk/v3/proto/go"
"github.com/stretchr/testify/require"
"gotest.tools/v3/assert"

"github.com/pulumi/pulumi-terraform-bridge/v3/pkg/internal/tests/pulcheck"
)

// Collection of tests that test ignoreChanges functionality _with_ core involved.
// Both core and bridge process ignoreChanges.
// These tests compliment the tests in `pkg/tfbridge/ignore_changes_test.go`
func TestIgnoreChanges_withCore(t *testing.T) {
t.Parallel()
testCases := []struct {
name string
itemsSchema *schema.Schema
cloudVal interface{}
programVal string
program2Val string
ignoreChanges string
expected map[string]*pulumirpc.PropertyDiff
expectedDiffChanges pulumirpc.DiffResponse_DiffChanges
expectedUpdateProps map[string]any
}{
{
name: "ListIndexNestedField",
itemsSchema: &schema.Schema{
Type: schema.TypeList,
Optional: true,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"weight": {Type: schema.TypeInt, Optional: true},
},
},
},
programVal: `[{"weight": 100 }]`,
cloudVal: []map[string]interface{}{{"weight": 200}},
ignoreChanges: `["items[0].weight"]`,
},
{
name: "SetIndexNestedField",
itemsSchema: &schema.Schema{
Type: schema.TypeSet,
Optional: true,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"weight": {Type: schema.TypeInt, Optional: true},
},
},
},
programVal: `[{"weight": 100 }, {"weight": 300 }]`,
cloudVal: []map[string]interface{}{{"weight": 200}, {"weight": 300}},
ignoreChanges: `["items[0].weight"]`,
},
{
name: "ListIndexNestedFieldWildcard",
itemsSchema: &schema.Schema{
Type: schema.TypeList,
Optional: true,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"weight": {Type: schema.TypeInt, Optional: true},
},
},
},
programVal: `[{"weight": 100 }]`,
cloudVal: []map[string]interface{}{{"weight": 200}},
// NOTE: Wildcards work when the Pulumi engine is involved!
ignoreChanges: `["items[*].weight"]`,
},
{
name: "SetIndexNestedFieldWildcard",
itemsSchema: &schema.Schema{
Type: schema.TypeSet,
Optional: true,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"weight": {Type: schema.TypeInt, Optional: true},
},
},
},
programVal: `[{"weight": 100 }]`,
cloudVal: []map[string]interface{}{{"weight": 200}},
// NOTE: Wildcards work when the Pulumi engine is involved!
ignoreChanges: `["items[*].weight"]`,
},
{
name: "ListIndexNestedFieldWildcardAddition",
itemsSchema: &schema.Schema{
Type: schema.TypeList,
Optional: true,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"weight": {Type: schema.TypeInt, Optional: true},
},
},
},
programVal: `[{"weight": 100}]`,
program2Val: `[{"weight": 100}, {"weight": 300}]`,
cloudVal: []map[string]interface{}{{"weight": 200}},
ignoreChanges: `["items[*].weight"]`,
// FIXME: ignoreChanges ignored!
// TODO[pulumi/pulumi#20447]
expectedDiffChanges: pulumirpc.DiffResponse_DIFF_SOME,
expected: map[string]*pulumirpc.PropertyDiff{
"items[0].weight": {Kind: pulumirpc.PropertyDiff_UPDATE},
"items[1]": {},
},
expectedUpdateProps: map[string]any{
"id": "id0",
"items": []interface{}{
map[string]any{"weight": float64(100)},
map[string]any{"weight": float64(300)},
},
},
},
{
name: "SetIndexNestedFieldWildcardAddition",
itemsSchema: &schema.Schema{
Type: schema.TypeSet,
Optional: true,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"weight": {Type: schema.TypeInt, Optional: true},
},
},
},
programVal: `[{"weight": 100}]`,
program2Val: `[{"weight": 100}, {"weight": 300}]`,
cloudVal: []map[string]interface{}{{"weight": 200}},
ignoreChanges: `["items[*].weight"]`,
// FIXME: ignoreChanges ignored!
// TODO[pulumi/pulumi#20447]
expectedDiffChanges: pulumirpc.DiffResponse_DIFF_SOME,
expected: map[string]*pulumirpc.PropertyDiff{
"items[0].weight": {Kind: pulumirpc.PropertyDiff_UPDATE},
"items[1]": {},
},
expectedUpdateProps: map[string]any{
"id": "id0",
"items": []interface{}{
map[string]any{"weight": float64(100)},
map[string]any{"weight": float64(300)},
},
},
},
{
name: "SetIndexNestedFieldAddition",
itemsSchema: &schema.Schema{
Type: schema.TypeSet,
Optional: true,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"weight": {Type: schema.TypeInt, Optional: true},
},
},
},
programVal: `[{"weight": 100}]`,
program2Val: `[{"weight": 100}, {"weight": 300}]`,
cloudVal: []map[string]interface{}{{"weight": 200}},
ignoreChanges: `["items[0].weight","items[1].weight"]`,
},
{
name: "ListNestedSetIndexNestedFieldAddition",
itemsSchema: &schema.Schema{
Type: schema.TypeList,
Required: true,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"forward": {
MaxItems: 1,
Optional: true,
Type: schema.TypeList,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"target_group": {
Required: true,
MinItems: 1,
Type: schema.TypeSet,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"arn": {Type: schema.TypeString, Required: true},
"weight": {Type: schema.TypeInt, Optional: true},
},
},
},
},
},
},
},
},
},
programVal: `[{"forward": {"targetGroups": [{"arn":"arn1","weight": 100}]}}]`,
program2Val: `[{"forward": {"targetGroups": [{"arn":"arn1","weight": 100}, {"arn":"arn2","weight": 0}]}}]`,
cloudVal: []map[string]interface{}{
{
"forward": []map[string]interface{}{
{
"target_group": []map[string]interface{}{
{
"arn": "arn1",
"weight": 200,
},
},
},
},
},
},
ignoreChanges: `["items[0].forward.targetGroups[0].weight", "items[0].forward.targetGroups[1].weight"]`,
expectedDiffChanges: pulumirpc.DiffResponse_DIFF_SOME,
expected: map[string]*pulumirpc.PropertyDiff{
"items[0].forward.targetGroups": {Kind: pulumirpc.PropertyDiff_UPDATE},
},
expectedUpdateProps: map[string]interface{}{
"id": "id0",
"items": []interface{}{
map[string]interface{}{
"forward": map[string]interface{}{
"targetGroups": []interface{}{
map[string]interface{}{"arn": "arn1", "weight": float64(200)},
map[string]interface{}{"arn": "arn2", "weight": nil},
},
},
},
},
},
},
{
name: "ObjectNestedFieldWildcard",
itemsSchema: &schema.Schema{
Type: schema.TypeMap,
Optional: true,
Elem: &schema.Schema{Type: schema.TypeInt},
},
programVal: `{"weight": 100, "other": 100}`,
cloudVal: map[string]interface{}{"weight": 200, "other": 200},
ignoreChanges: `["items.*"]`,
},
{
name: "ObjectNestedFieldWildcardAddition",
itemsSchema: &schema.Schema{
Type: schema.TypeMap,
Optional: true,
Elem: &schema.Schema{Type: schema.TypeInt},
},
programVal: `{"weight": 100, "other": 100}`,
program2Val: `{"weight": 100, "other": 100, "third": 300}`,
cloudVal: map[string]interface{}{"weight": 200, "other": 200},
ignoreChanges: `["items.*"]`,
},
}
for _, tc := range testCases {
opts := []pulcheck.BridgedProviderOpt{}

t.Run(tc.name, func(t *testing.T) {
t.Parallel()
resMap := map[string]*schema.Resource{
"prov_test": {
Schema: map[string]*schema.Schema{
"items": tc.itemsSchema,
},
ReadContext: func(_ context.Context, rd *schema.ResourceData, _ interface{}) diag.Diagnostics {
err := rd.Set("items", tc.cloudVal)
require.NoError(t, err)
return nil
},
CreateContext: func(_ context.Context, rd *schema.ResourceData, _ interface{}) diag.Diagnostics {
rd.SetId("id0")
return nil
},
},
}

tfp := &schema.Provider{ResourcesMap: resMap}
bridgedProvider := pulcheck.BridgedProvider(t, "prov", tfp, opts...)
program := fmt.Sprintf(`
name: test
runtime: yaml
resources:
mainRes:
type: prov:index:Test
options:
ignoreChanges: %s
properties:
items: %s
`, tc.ignoreChanges, tc.programVal)
pt := pulcheck.PulCheck(t, bridgedProvider, program)
pt.Up(t)
pt.Refresh(t, optrefresh.Diff(), optrefresh.ProgressStreams(os.Stdout), optrefresh.ErrorProgressStreams(os.Stderr))
if tc.program2Val != "" {
pt.WritePulumiYaml(t, fmt.Sprintf(`
name: test
runtime: yaml
resources:
mainRes:
type: prov:index:Test
options:
ignoreChanges: %s
properties:
items: %s
`, tc.ignoreChanges, tc.program2Val))
}
pt.Preview(t, optpreview.Diff(), optpreview.ProgressStreams(os.Stdout), optpreview.ErrorProgressStreams(os.Stderr))
diff := extractDiff(t, pt, "mainRes")
expected := tc.expected
if tc.expected == nil {
expected = map[string]*pulumirpc.PropertyDiff{}
}
expectedDiffChanges := pulumirpc.DiffResponse_DIFF_NONE
if tc.expectedDiffChanges != 0 {
expectedDiffChanges = tc.expectedDiffChanges
}
assert.Equal(t, diff.expectedDiffChanges, expectedDiffChanges)
if tc.expectedUpdateProps != nil {
require.Equal(t, tc.expectedUpdateProps, diff.updateProps)
}
require.Equal(t, expected, diff.expected)
})
}
}

type diffResult struct {
expected map[string]*pulumirpc.PropertyDiff
expectedDiffChanges pulumirpc.DiffResponse_DiffChanges
updateProps map[string]any
}

func extractDiff(t *testing.T, pt *pulumitest.PulumiTest, name string) diffResult {
grpc := pt.GrpcLog(t)
updates, err := grpc.Updates()
require.NoError(t, err)
var updateProps map[string]any
for i := range updates {
u := &updates[i]
if u.Request.Name == name {
updateProps = u.Response.Properties.AsMap()
delete(updateProps, "__pulumi_raw_state_delta")
}
}
diffs, err := grpc.Diffs()
require.NoError(t, err)
for i := range diffs {
u := &diffs[i]
if u.Request.Name == name {
if u.Response.DetailedDiff == nil {
u.Response.DetailedDiff = map[string]*pulumirpc.PropertyDiff{}
} else {
// we only care about kind for the assertion
for k, v := range u.Response.DetailedDiff {
u.Response.DetailedDiff[k] = &pulumirpc.PropertyDiff{
Kind: v.Kind,
}
}
}
return diffResult{
expectedDiffChanges: u.Response.Changes,
expected: u.Response.DetailedDiff,
updateProps: updateProps,
}
}
}
return diffResult{}
}
Loading
Loading