migrate(file-json-utils): from cldf to cld (#251)

migrate json file utils from cld -> cldf

Author: ajaskolski

.changeset/wet-days-raise.md

@@ -0,0 +1,5 @@
+---
+"chainlink-deployments-framework": minor
+---
+
+refactor: adds files and json utils from cld

engine/cld/lib/fileutils/fileutils.go

@@ -0,0 +1,28 @@
+package fileutils
+
+import (
+	"os"
+	"path/filepath"
+)
+
+// WriteFileGitKeep writes a .gitkeep file to the path.
+func WriteFileGitKeep(path string) error {
+	file, err := os.Create(filepath.Join(path, ".gitkeep"))
+	if err != nil {
+		return err
+	}
+
+	defer file.Close()
+
+	return nil
+}
+
+// MkdirAllGitKeep creates a directory with a .gitkeep file. This will create all parent
+// directories if they do not already exist.
+func MkdirAllGitKeep(path string) error {
+	if err := os.MkdirAll(path, os.ModePerm); err != nil {
+		return err
+	}
+
+	return WriteFileGitKeep(path)
+}

engine/cld/lib/fileutils/fileutils_test.go

@@ -0,0 +1,80 @@
+package fileutils
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_WriteFileGitKeep(t *testing.T) {
+	t.Parallel()
+
+	rootDir := t.TempDir()
+
+	err := WriteFileGitKeep(rootDir)
+	require.NoError(t, err)
+
+	_, err = os.Stat(filepath.Join(rootDir, ".gitkeep"))
+	require.NoError(t, err)
+
+	err = os.MkdirAll(filepath.Join(rootDir, "subdir"), 0000)
+	require.NoError(t, err)
+
+	err = WriteFileGitKeep(filepath.Join(rootDir, "subdir"))
+	require.Error(t, err)
+	require.ErrorContains(t, err, "permission denied")
+}
+
+func Test_MkdirAllGitKeep(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		name       string
+		beforeFunc func(t *testing.T, rootDir string)
+		givePath   string
+		wantErr    string
+	}{
+		{
+			name:     "success",
+			givePath: "foo/bar",
+		},
+		{
+			name: "error when permissions are denied to create dir",
+			beforeFunc: func(t *testing.T, rootDir string) {
+				t.Helper()
+
+				err := os.MkdirAll(filepath.Join(rootDir, "subdir"), 0000)
+				require.NoError(t, err)
+			},
+			givePath: "subdir/foo/bar",
+			wantErr:  "permission denied",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			rootDir := t.TempDir()
+
+			if tt.beforeFunc != nil {
+				tt.beforeFunc(t, rootDir)
+			}
+
+			err := MkdirAllGitKeep(filepath.Join(rootDir, tt.givePath))
+
+			if tt.wantErr != "" {
+				require.Error(t, err)
+				assert.ErrorContains(t, err, tt.wantErr)
+			} else {
+				require.NoError(t, err)
+
+				_, err = os.Stat(filepath.Join(rootDir, tt.givePath, ".gitkeep"))
+				require.NoError(t, err)
+			}
+		})
+	}
+}

engine/cld/lib/jsonutils/jsonutils.go

@@ -0,0 +1,34 @@
+package jsonutils
+
+import (
+	"encoding/json"
+	"fmt"
+	"io/fs"
+	"os"
+)
+
+// WriteFile marshals data into pretty JSON and writes it at path.
+func WriteFile(path string, data any) error {
+	b, err := json.MarshalIndent(data, "", "  ")
+	if err != nil {
+		return err
+	}
+
+	return os.WriteFile(path, b, 0600)
+}
+
+// LoadFromFS loads a JSON file from the filesystem, instantiates and unmarshals it into T.
+func LoadFromFS[T any](fs fs.ReadFileFS, path string) (T, error) {
+	var v T
+
+	f, err := fs.ReadFile(path)
+	if err != nil {
+		return v, fmt.Errorf("failed to read %s: %w", path, err)
+	}
+
+	if err = json.Unmarshal(f, &v); err != nil {
+		return v, fmt.Errorf("failed to unmarshal JSON at path %s: %w", path, err)
+	}
+
+	return v, nil
+}

engine/cld/lib/jsonutils/jsonutils_test.go

@@ -0,0 +1,106 @@
+package jsonutils
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+	"testing/fstest"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_WriteFile(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		name     string
+		givePath string
+		giveObj  any
+		want     string
+		wantErr  string
+	}{
+		{
+			name:     "success",
+			givePath: "valid.json",
+			giveObj:  map[string]string{"key": "value"},
+			want:     `{"key":"value"}`,
+		},
+		{
+			name:     "failure: cannot marshal JSON",
+			givePath: "invalid.json",
+			giveObj:  make(chan int),
+			wantErr:  "json: unsupported type: chan int",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			rootDir := t.TempDir()
+
+			err := WriteFile(filepath.Join(rootDir, tt.givePath), tt.giveObj)
+
+			if tt.wantErr != "" {
+				require.Error(t, err)
+				assert.ErrorContains(t, err, tt.wantErr)
+			} else {
+				require.NoError(t, err)
+
+				b, err := os.ReadFile(filepath.Join(rootDir, tt.givePath))
+				require.NoError(t, err)
+
+				assert.JSONEq(t, tt.want, string(b))
+			}
+		})
+	}
+}
+
+func Test_LoadJSON(t *testing.T) {
+	t.Parallel()
+
+	fsys := fstest.MapFS{
+		"valid.json":   {Data: []byte(`{"key": "value"}`)},
+		"invalid.json": {Data: []byte(`invalid`)},
+	}
+
+	tests := []struct {
+		name    string
+		give    string
+		want    map[string]string
+		wantErr string
+	}{
+		{
+			name: "success",
+			give: "valid.json",
+			want: map[string]string{"key": "value"},
+		},
+		{
+			name:    "failure: cannot read path",
+			give:    "notfound.json",
+			wantErr: "failed to read notfound.json",
+		},
+		{
+			name:    "failure: cannot unmarshal JSON",
+			give:    "invalid.json",
+			wantErr: "failed to unmarshal JSON at path invalid.json",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			got, err := LoadFromFS[map[string]string](fsys, tt.give)
+
+			if tt.wantErr != "" {
+				require.Error(t, err)
+				assert.ErrorContains(t, err, tt.wantErr)
+			} else {
+				require.NoError(t, err)
+				require.Equal(t, tt.want, got)
+			}
+		})
+	}
+}

engine/cld/nodes/nodes.go

@@ -1,4 +1,4 @@
-package migrations
+package nodes
 
 import (
 	"encoding/json"

engine/cld/nodes/nodes_test.go

@@ -1,4 +1,4 @@
-package migrations
+package nodes
 
 import (
 	"encoding/json"