Skip to content

Commit 878718c

Browse files
r2k1r2k1
committed
add backward compat tests
1 parent 00a6dee commit 878718c

File tree

3 files changed

+244
-0
lines changed

3 files changed

+244
-0
lines changed

‎aks-node-controller/pkg/nodeconfigutils/backward_compat_test.go‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
package nodeconfigutils
2+
3+
import (
4+
"os"
5+
"os/exec"
6+
"path/filepath"
7+
"strings"
8+
"testing"
9+
10+
aksnodeconfigv1 "github.com/Azure/agentbaker/aks-node-controller/pkg/gen/aksnodeconfig/v1"
11+
"github.com/stretchr/testify/require"
12+
)
13+
14+
// TestBackwardCompatibility tests that old code can unmarshal configs generated by current code.
15+
func TestBackwardCompatibility(t *testing.T) {
16+
t.Parallel()
17+
targetCommit := os.Getenv("COMPAT_COMMIT")
18+
if targetCommit == "" {
19+
// We aim to support VHDs released in the last 6 months.
20+
// This commit is from 2025-11-08. Around the time first version of Config is released.
21+
// Adjust as needed in the future. But no sooner than 6 months.
22+
// CAREFUL, TEST FAILURE MAY HIGHLIGHT POTENTIAL BACKWARD COMPATIBILITY ISSUES.
23+
// Please investigate before updating this commit.
24+
targetCommit = "c4ddd55f7dd72bfb541313fe586f586dfa7bd114"
25+
}
26+
27+
t.Logf("Testing backward compatibility with commit: %s", targetCommit)
28+
29+
// Step 1: Generate JSON with current code
30+
cfg := &aksnodeconfigv1.Configuration{}
31+
PopulateAllFields(cfg)
32+
33+
currentJSON, err := MarshalConfigurationV1(cfg)
34+
require.NoError(t, err)
35+
t.Logf("Generated %d bytes of JSON with current code", len(currentJSON))
36+
37+
// Step 2: Create git worktree at target commit
38+
worktreePath := t.TempDir()
39+
cmd := exec.Command("git", "worktree", "add", worktreePath, targetCommit)
40+
output, err := cmd.CombinedOutput()
41+
require.NoError(t, err, "Failed to create worktree: %s", output)
42+
43+
t.Cleanup(func() {
44+
exec.Command("git", "worktree", "remove", "--force", worktreePath).Run()
45+
})
46+
47+
// Get commit info
48+
cmd = exec.Command("git", "log", "-1", "--oneline", targetCommit)
49+
commitInfo, _ := cmd.CombinedOutput()
50+
t.Logf("Testing against: %q", strings.TrimSpace(string(commitInfo)))
51+
52+
// Step 3: Write JSON to worktree
53+
pkgPath := filepath.Join(worktreePath, "aks-node-controller", "pkg", "nodeconfigutils")
54+
jsonPath := filepath.Join(pkgPath, "test_compat.json")
55+
require.NoError(t, os.WriteFile(jsonPath, currentJSON, 0644))
56+
57+
// Step 4: Create test file to unmarshal with old code
58+
testCode := `package nodeconfigutils
59+
import (
60+
"os"
61+
"testing"
62+
"github.com/stretchr/testify/require"
63+
)
64+
func TestUnmarshalCompat(t *testing.T) {
65+
data, err := os.ReadFile("test_compat.json")
66+
require.NoError(t, err)
67+
cfg, err := UnmarshalConfigurationV1(data)
68+
require.NoError(t, err, "Old code should unmarshal current JSON")
69+
require.NotNil(t, cfg)
70+
t.Logf("✓ Successfully unmarshaled %d bytes", len(data))
71+
}
72+
`
73+
testFile := filepath.Join(pkgPath, "compat_test.go")
74+
require.NoError(t, os.WriteFile(testFile, []byte(testCode), 0644))
75+
76+
// Step 5: Run test with old code
77+
cmd = exec.Command("go", "test", "-v", "-run", "TestUnmarshalCompat", "./pkg/nodeconfigutils")
78+
cmd.Dir = filepath.Join(worktreePath, "aks-node-controller")
79+
output, err = cmd.CombinedOutput()
80+
81+
t.Logf("Old code output:\n%s", output)
82+
83+
if err != nil {
84+
t.Errorf("❌ BACKWARD COMPATIBILITY BROKEN: Old code (%s) cannot unmarshal current JSON", targetCommit)
85+
} else {
86+
t.Logf("✅ BACKWARD COMPATIBLE with %s", targetCommit)
87+
}
88+
}

‎aks-node-controller/pkg/nodeconfigutils/testutil.go‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
package nodeconfigutils
2+
3+
import (
4+
"fmt"
5+
6+
"google.golang.org/protobuf/proto"
7+
"google.golang.org/protobuf/reflect/protoreflect"
8+
)
9+
10+
// PopulateAllFields recursively populates all fields in a protobuf message with non-zero test values.
11+
// This is useful for testing to ensure all fields can be marshaled/unmarshaled correctly.
12+
func PopulateAllFields(msg proto.Message) {
13+
populateMessage(msg.ProtoReflect(), 0)
14+
}
15+
16+
func populateMessage(msg protoreflect.Message, depth int) {
17+
// Prevent infinite recursion for deeply nested structures
18+
if depth > 10 {
19+
return
20+
}
21+
22+
// Iterate over all field descriptors (including unset ones)
23+
fields := msg.Descriptor().Fields()
24+
for i := 0; i < fields.Len(); i++ {
25+
fd := fields.Get(i)
26+
setFieldValue(msg, fd, depth)
27+
}
28+
}
29+
30+
func setFieldValue(msg protoreflect.Message, fd protoreflect.FieldDescriptor, depth int) {
31+
if fd.IsList() {
32+
// Handle repeated fields - add 2 elements
33+
list := msg.Mutable(fd).List()
34+
for j := 0; j < 2; j++ {
35+
if fd.Kind() == protoreflect.MessageKind {
36+
// For repeated message fields, create new message and populate it
37+
elem := list.NewElement()
38+
populateMessage(elem.Message(), depth+1)
39+
list.Append(elem)
40+
} else {
41+
val := getDefaultValueForField(fd, fmt.Sprintf("item%d", j), depth)
42+
list.Append(val)
43+
}
44+
}
45+
} else if fd.IsMap() {
46+
// Handle map fields - add 2 entries
47+
mapVal := msg.Mutable(fd).Map()
48+
for j := 0; j < 2; j++ {
49+
key := getDefaultKeyForKind(fd.MapKey().Kind(), j)
50+
if fd.MapValue().Kind() == protoreflect.MessageKind {
51+
// For map values that are messages, create and populate
52+
val := mapVal.NewValue()
53+
populateMessage(val.Message(), depth+1)
54+
mapVal.Set(key, val)
55+
} else {
56+
val := getDefaultValueForMapValue(fd.MapValue(), j, depth)
57+
mapVal.Set(key, val)
58+
}
59+
}
60+
} else if fd.Kind() == protoreflect.MessageKind {
61+
// Handle singular message fields - use Mutable to get/create the message
62+
nestedMsg := msg.Mutable(fd).Message()
63+
populateMessage(nestedMsg, depth+1)
64+
} else {
65+
// Handle singular primitive fields
66+
val := getDefaultValueForField(fd, "", depth)
67+
msg.Set(fd, val)
68+
}
69+
}
70+
71+
func getDefaultValueForField(fd protoreflect.FieldDescriptor, suffix string, depth int) protoreflect.Value {
72+
switch fd.Kind() {
73+
case protoreflect.BoolKind:
74+
return protoreflect.ValueOfBool(true)
75+
case protoreflect.Int32Kind, protoreflect.Sint32Kind, protoreflect.Sfixed32Kind:
76+
return protoreflect.ValueOfInt32(42)
77+
case protoreflect.Int64Kind, protoreflect.Sint64Kind, protoreflect.Sfixed64Kind:
78+
return protoreflect.ValueOfInt64(42)
79+
case protoreflect.Uint32Kind, protoreflect.Fixed32Kind:
80+
return protoreflect.ValueOfUint32(42)
81+
case protoreflect.Uint64Kind, protoreflect.Fixed64Kind:
82+
return protoreflect.ValueOfUint64(42)
83+
case protoreflect.FloatKind:
84+
return protoreflect.ValueOfFloat32(42.0)
85+
case protoreflect.DoubleKind:
86+
return protoreflect.ValueOfFloat64(42.0)
87+
case protoreflect.StringKind:
88+
fieldName := string(fd.Name())
89+
if suffix != "" {
90+
return protoreflect.ValueOfString(fmt.Sprintf("test-%s-%s", fieldName, suffix))
91+
}
92+
return protoreflect.ValueOfString(fmt.Sprintf("test-%s-value", fieldName))
93+
case protoreflect.BytesKind:
94+
return protoreflect.ValueOfBytes([]byte(fmt.Sprintf("test-bytes-%s", fd.Name())))
95+
case protoreflect.EnumKind:
96+
// Use the last enum value (latest/most recent)
97+
enumDesc := fd.Enum()
98+
lastIndex := enumDesc.Values().Len() - 1
99+
if lastIndex >= 0 {
100+
return protoreflect.ValueOfEnum(enumDesc.Values().Get(lastIndex).Number())
101+
}
102+
return protoreflect.ValueOfEnum(0)
103+
case protoreflect.MessageKind:
104+
// Message fields should be handled in setFieldValue using Mutable
105+
// This shouldn't be called for message fields
106+
return protoreflect.Value{}
107+
default:
108+
return protoreflect.Value{}
109+
}
110+
}
111+
112+
func getDefaultKeyForKind(kind protoreflect.Kind, index int) protoreflect.MapKey {
113+
switch kind {
114+
case protoreflect.StringKind:
115+
return protoreflect.ValueOfString(fmt.Sprintf("test-key-%d", index)).MapKey()
116+
case protoreflect.Int32Kind:
117+
return protoreflect.ValueOfInt32(int32(index + 1)).MapKey()
118+
case protoreflect.Int64Kind:
119+
return protoreflect.ValueOfInt64(int64(index + 1)).MapKey()
120+
case protoreflect.Uint32Kind:
121+
return protoreflect.ValueOfUint32(uint32(index + 1)).MapKey()
122+
case protoreflect.Uint64Kind:
123+
return protoreflect.ValueOfUint64(uint64(index + 1)).MapKey()
124+
case protoreflect.BoolKind:
125+
return protoreflect.ValueOfBool(index == 0).MapKey()
126+
default:
127+
return protoreflect.ValueOfString(fmt.Sprintf("key-%d", index)).MapKey()
128+
}
129+
}
130+
131+
func getDefaultValueForMapValue(fd protoreflect.FieldDescriptor, index int, depth int) protoreflect.Value {
132+
suffix := fmt.Sprintf("map%d", index)
133+
return getDefaultValueForField(fd, suffix, depth)
134+
}

‎aks-node-controller/pkg/nodeconfigutils/testutil_test.go‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
package nodeconfigutils
2+
3+
import (
4+
"testing"
5+
6+
aksnodeconfigv1 "github.com/Azure/agentbaker/aks-node-controller/pkg/gen/aksnodeconfig/v1"
7+
"github.com/stretchr/testify/assert"
8+
)
9+
10+
func TestPopulateAllFields(t *testing.T) {
11+
cfg := &aksnodeconfigv1.Configuration{}
12+
PopulateAllFields(cfg)
13+
14+
// Verify a few key fields are populated
15+
assert.NotEmpty(t, cfg.Version)
16+
assert.NotEmpty(t, cfg.VmSize)
17+
assert.NotNil(t, cfg.ClusterConfig)
18+
assert.NotEmpty(t, cfg.ClusterConfig.Location)
19+
20+
// Verify enum is set to non-zero value
21+
assert.NotEqual(t, aksnodeconfigv1.WorkloadRuntime_WORKLOAD_RUNTIME_UNSPECIFIED, cfg.WorkloadRuntime)
22+
}

0 commit comments

Comments
 (0)