mirror of
https://github.com/coder/coder.git
synced 2026-06-02 20:48:20 +00:00
test: move TestConvertStateGolden to only linux + mac (#20901)
Windows runners are flaky for golden files closes https://github.com/coder/internal/issues/1141
This commit is contained in:
Steven Masley
@@ -0,0 +1,129 @@
|
||||
//go:build linux || darwin
|
||||
|
||||
package terraform_test
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"slices"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
tfjson "github.com/hashicorp/terraform-json"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"cdr.dev/slog/sloggers/slogtest"
|
||||
"github.com/coder/coder/v2/provisioner/terraform"
|
||||
"github.com/coder/coder/v2/testutil"
|
||||
)
|
||||
|
||||
// TestConvertStateGolden compares the output of ConvertState to a golden
|
||||
// file to prevent regressions. If the logic changes, update the golden files
|
||||
// accordingly.
|
||||
//
|
||||
// This was created to aid in refactoring `ConvertState`.
|
||||
func TestConvertStateGolden(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
testResourceDirectories := filepath.Join("testdata", "resources")
|
||||
entries, err := os.ReadDir(testResourceDirectories)
|
||||
require.NoError(t, err)
|
||||
|
||||
for _, testDirectory := range entries {
|
||||
if !testDirectory.IsDir() {
|
||||
continue
|
||||
}
|
||||
|
||||
testFiles, err := os.ReadDir(filepath.Join(testResourceDirectories, testDirectory.Name()))
|
||||
require.NoError(t, err)
|
||||
|
||||
// ConvertState works on both a plan file and a state file.
|
||||
// The test should create a golden file for both.
|
||||
for _, step := range []string{"plan", "state"} {
|
||||
srcIdc := slices.IndexFunc(testFiles, func(entry os.DirEntry) bool {
|
||||
return strings.HasSuffix(entry.Name(), fmt.Sprintf(".tf%s.json", step))
|
||||
})
|
||||
dotIdx := slices.IndexFunc(testFiles, func(entry os.DirEntry) bool {
|
||||
return strings.HasSuffix(entry.Name(), fmt.Sprintf(".tf%s.dot", step))
|
||||
})
|
||||
|
||||
// If the directory is missing these files, we cannot run ConvertState
|
||||
// on it. So it's skipped.
|
||||
if srcIdc == -1 || dotIdx == -1 {
|
||||
continue
|
||||
}
|
||||
|
||||
t.Run(step+"_"+testDirectory.Name(), func(t *testing.T) {
|
||||
t.Parallel()
|
||||
testDirectoryPath := filepath.Join(testResourceDirectories, testDirectory.Name())
|
||||
planFile := filepath.Join(testDirectoryPath, testFiles[srcIdc].Name())
|
||||
dotFile := filepath.Join(testDirectoryPath, testFiles[dotIdx].Name())
|
||||
|
||||
ctx := testutil.Context(t, testutil.WaitMedium)
|
||||
logger := slogtest.Make(t, nil)
|
||||
|
||||
// Gather plan
|
||||
tfStepRaw, err := os.ReadFile(planFile)
|
||||
require.NoError(t, err)
|
||||
|
||||
var modules []*tfjson.StateModule
|
||||
switch step {
|
||||
case "plan":
|
||||
var tfPlan tfjson.Plan
|
||||
err = json.Unmarshal(tfStepRaw, &tfPlan)
|
||||
require.NoError(t, err)
|
||||
|
||||
modules = []*tfjson.StateModule{tfPlan.PlannedValues.RootModule}
|
||||
if tfPlan.PriorState != nil {
|
||||
modules = append(modules, tfPlan.PriorState.Values.RootModule)
|
||||
}
|
||||
case "state":
|
||||
var tfState tfjson.State
|
||||
err = json.Unmarshal(tfStepRaw, &tfState)
|
||||
require.NoError(t, err)
|
||||
modules = []*tfjson.StateModule{tfState.Values.RootModule}
|
||||
default:
|
||||
t.Fatalf("unknown step: %s", step)
|
||||
}
|
||||
|
||||
// Gather graph
|
||||
dotFileRaw, err := os.ReadFile(dotFile)
|
||||
require.NoError(t, err)
|
||||
|
||||
// expectedOutput is `any` to support errors too. If `ConvertState` returns an
|
||||
// error, that error is the golden file output.
|
||||
var expectedOutput any
|
||||
state, err := terraform.ConvertState(ctx, modules, string(dotFileRaw), logger)
|
||||
if err == nil {
|
||||
sortResources(state.Resources)
|
||||
sortExternalAuthProviders(state.ExternalAuthProviders)
|
||||
deterministicAppIDs(state.Resources)
|
||||
expectedOutput = state
|
||||
} else {
|
||||
// Write the error to the file then. Track errors as much as valid paths.
|
||||
expectedOutput = err.Error()
|
||||
}
|
||||
|
||||
expPath := filepath.Join(testDirectoryPath, fmt.Sprintf("converted_state.%s.golden", step))
|
||||
if *updateGoldenFiles {
|
||||
gotBytes, err := json.MarshalIndent(expectedOutput, "", " ")
|
||||
require.NoError(t, err, "marshaling converted state to JSON")
|
||||
// Newline at end of file for git purposes
|
||||
err = os.WriteFile(expPath, append(gotBytes, '\n'), 0o600)
|
||||
require.NoError(t, err)
|
||||
return
|
||||
}
|
||||
|
||||
gotBytes, err := json.Marshal(expectedOutput)
|
||||
require.NoError(t, err, "marshaling converted state to JSON")
|
||||
|
||||
expBytes, err := os.ReadFile(expPath)
|
||||
require.NoError(t, err)
|
||||
|
||||
require.JSONEq(t, string(expBytes), string(gotBytes), "converted state")
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -8,7 +8,6 @@ import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"slices"
|
||||
"sort"
|
||||
"strings"
|
||||
"testing"
|
||||
@@ -33,115 +32,6 @@ func ctxAndLogger(t *testing.T) (context.Context, slog.Logger) {
|
||||
return context.Background(), testutil.Logger(t)
|
||||
}
|
||||
|
||||
// TestConvertStateGolden compares the output of ConvertState to a golden
|
||||
// file to prevent regressions. If the logic changes, update the golden files
|
||||
// accordingly.
|
||||
//
|
||||
// This was created to aid in refactoring `ConvertState`.
|
||||
func TestConvertStateGolden(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
testResourceDirectories := filepath.Join("testdata", "resources")
|
||||
entries, err := os.ReadDir(testResourceDirectories)
|
||||
require.NoError(t, err)
|
||||
|
||||
for _, testDirectory := range entries {
|
||||
if !testDirectory.IsDir() {
|
||||
continue
|
||||
}
|
||||
|
||||
testFiles, err := os.ReadDir(filepath.Join(testResourceDirectories, testDirectory.Name()))
|
||||
require.NoError(t, err)
|
||||
|
||||
// ConvertState works on both a plan file and a state file.
|
||||
// The test should create a golden file for both.
|
||||
for _, step := range []string{"plan", "state"} {
|
||||
srcIdc := slices.IndexFunc(testFiles, func(entry os.DirEntry) bool {
|
||||
return strings.HasSuffix(entry.Name(), fmt.Sprintf(".tf%s.json", step))
|
||||
})
|
||||
dotIdx := slices.IndexFunc(testFiles, func(entry os.DirEntry) bool {
|
||||
return strings.HasSuffix(entry.Name(), fmt.Sprintf(".tf%s.dot", step))
|
||||
})
|
||||
|
||||
// If the directory is missing these files, we cannot run ConvertState
|
||||
// on it. So it's skipped.
|
||||
if srcIdc == -1 || dotIdx == -1 {
|
||||
continue
|
||||
}
|
||||
|
||||
t.Run(step+"_"+testDirectory.Name(), func(t *testing.T) {
|
||||
t.Parallel()
|
||||
testDirectoryPath := filepath.Join(testResourceDirectories, testDirectory.Name())
|
||||
planFile := filepath.Join(testDirectoryPath, testFiles[srcIdc].Name())
|
||||
dotFile := filepath.Join(testDirectoryPath, testFiles[dotIdx].Name())
|
||||
|
||||
ctx := testutil.Context(t, testutil.WaitMedium)
|
||||
logger := slogtest.Make(t, nil)
|
||||
|
||||
// Gather plan
|
||||
tfStepRaw, err := os.ReadFile(planFile)
|
||||
require.NoError(t, err)
|
||||
|
||||
var modules []*tfjson.StateModule
|
||||
switch step {
|
||||
case "plan":
|
||||
var tfPlan tfjson.Plan
|
||||
err = json.Unmarshal(tfStepRaw, &tfPlan)
|
||||
require.NoError(t, err)
|
||||
|
||||
modules = []*tfjson.StateModule{tfPlan.PlannedValues.RootModule}
|
||||
if tfPlan.PriorState != nil {
|
||||
modules = append(modules, tfPlan.PriorState.Values.RootModule)
|
||||
}
|
||||
case "state":
|
||||
var tfState tfjson.State
|
||||
err = json.Unmarshal(tfStepRaw, &tfState)
|
||||
require.NoError(t, err)
|
||||
modules = []*tfjson.StateModule{tfState.Values.RootModule}
|
||||
default:
|
||||
t.Fatalf("unknown step: %s", step)
|
||||
}
|
||||
|
||||
// Gather graph
|
||||
dotFileRaw, err := os.ReadFile(dotFile)
|
||||
require.NoError(t, err)
|
||||
|
||||
// expectedOutput is `any` to support errors too. If `ConvertState` returns an
|
||||
// error, that error is the golden file output.
|
||||
var expectedOutput any
|
||||
state, err := terraform.ConvertState(ctx, modules, string(dotFileRaw), logger)
|
||||
if err == nil {
|
||||
sortResources(state.Resources)
|
||||
sortExternalAuthProviders(state.ExternalAuthProviders)
|
||||
deterministicAppIDs(state.Resources)
|
||||
expectedOutput = state
|
||||
} else {
|
||||
// Write the error to the file then. Track errors as much as valid paths.
|
||||
expectedOutput = err.Error()
|
||||
}
|
||||
|
||||
expPath := filepath.Join(testDirectoryPath, fmt.Sprintf("converted_state.%s.golden", step))
|
||||
if *updateGoldenFiles {
|
||||
gotBytes, err := json.MarshalIndent(expectedOutput, "", " ")
|
||||
require.NoError(t, err, "marshaling converted state to JSON")
|
||||
// Newline at end of file for git purposes
|
||||
err = os.WriteFile(expPath, append(gotBytes, '\n'), 0o600)
|
||||
require.NoError(t, err)
|
||||
return
|
||||
}
|
||||
|
||||
gotBytes, err := json.Marshal(expectedOutput)
|
||||
require.NoError(t, err, "marshaling converted state to JSON")
|
||||
|
||||
expBytes, err := os.ReadFile(expPath)
|
||||
require.NoError(t, err)
|
||||
|
||||
require.JSONEq(t, string(expBytes), string(gotBytes), "converted state")
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestConvertResources(t *testing.T) {
|
||||
t.Parallel()
|
||||
// nolint:dogsled
|
||||
|
||||
Reference in New Issue
Block a user