fix: snaps.Update should apply and on snapshot create (#119)

gkampitakis · Jan 28, 2025 · 00f3055 · 00f3055
1 parent 560fde0
commit 00f3055
Show file tree

Hide file tree

Showing 12 changed files with 84 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -282,7 +282,7 @@ t.Run("snapshot tests", func(t *testing.T) {
   s := snaps.WithConfig(
     snaps.Dir("my_dir"),
     snaps.Filename("json_file"),
-    snaps.Ext(".json")
+    snaps.Ext(".json"),
     snaps.Update(false)
   )
 

diff --git a/snaps/matchJSON.go b/snaps/matchJSON.go
@@ -100,7 +100,7 @@ func matchJSON(c *Config, t testingT, input any, matchers ...match.JSONMatcher)
 	snapshot := takeJSONSnapshot(j)
 	prevSnapshot, line, err := getPrevSnapshot(testID, snapPath)
 	if errors.Is(err, errSnapNotFound) {
-		if isCI {
+		if !shouldCreate(c.update) {
 			handleError(t, err)
 			return
 		}

diff --git a/snaps/matchJSON_test.go b/snaps/matchJSON_test.go
@@ -171,6 +171,19 @@ func TestMatchJSON(t *testing.T) {
 		test.Equal(t, 1, testEvents.items[erred])
 	})
 
+	t.Run("if snaps.Update(false) should skip creating snapshot", func(t *testing.T) {
+		setupSnapshot(t, fileName, false)
+
+		mockT := test.NewMockTestingT(t)
+		mockT.MockError = func(args ...any) {
+			test.Equal(t, errSnapNotFound, args[0].(error))
+		}
+
+		WithConfig(Update(false)).MatchJSON(mockT, "{}")
+
+		test.Equal(t, 1, testEvents.items[erred])
+	})
+
 	t.Run("should update snapshot when 'shouldUpdate'", func(t *testing.T) {
 		snapPath := setupSnapshot(t, jsonFilename, false, true)
 

diff --git a/snaps/matchSnapshot.go b/snaps/matchSnapshot.go
@@ -63,7 +63,7 @@ func matchSnapshot(c *Config, t testingT, values ...any) {
 	snapshot := takeSnapshot(values)
 	prevSnapshot, line, err := getPrevSnapshot(testID, snapPath)
 	if errors.Is(err, errSnapNotFound) {
-		if isCI {
+		if !shouldCreate(c.update) {
 			handleError(t, err)
 			return
 		}

diff --git a/snaps/matchSnapshot_test.go b/snaps/matchSnapshot_test.go
@@ -92,6 +92,19 @@ func TestMatchSnapshot(t *testing.T) {
 		test.Equal(t, 1, testEvents.items[erred])
 	})
 
+	t.Run("if snaps.Update(false) should skip creating snapshot", func(t *testing.T) {
+		setupSnapshot(t, fileName, false)
+
+		mockT := test.NewMockTestingT(t)
+		mockT.MockError = func(args ...any) {
+			test.Equal(t, errSnapNotFound, args[0].(error))
+		}
+
+		WithConfig(Update(false)).MatchSnapshot(mockT, 10, "hello world")
+
+		test.Equal(t, 1, testEvents.items[erred])
+	})
+
 	t.Run("should return error when diff is found", func(t *testing.T) {
 		setupSnapshot(t, fileName, false)
 

diff --git a/snaps/matchStandaloneJSON.go b/snaps/matchStandaloneJSON.go
@@ -70,7 +70,7 @@ func matchStandaloneJSON(c *Config, t testingT, input any, matchers ...match.JSO
 	snapshot := takeJSONSnapshot(j)
 	prevSnapshot, err := getPrevStandaloneSnapshot(snapPath)
 	if errors.Is(err, errSnapNotFound) {
-		if isCI {
+		if !shouldCreate(c.update) {
 			handleError(t, err)
 			return
 		}

diff --git a/snaps/matchStandaloneJSON_test.go b/snaps/matchStandaloneJSON_test.go
@@ -173,6 +173,19 @@ func TestMatchStandaloneJSON(t *testing.T) {
 		test.Equal(t, 1, testEvents.items[erred])
 	})
 
+	t.Run("if snaps.Update(false) should skip creating snapshot", func(t *testing.T) {
+		setupSnapshot(t, fileName, false)
+
+		mockT := test.NewMockTestingT(t)
+		mockT.MockError = func(args ...any) {
+			test.Equal(t, errSnapNotFound, args[0].(error))
+		}
+
+		WithConfig(Update(false)).MatchStandaloneJSON(mockT, "{}")
+
+		test.Equal(t, 1, testEvents.items[erred])
+	})
+
 	t.Run("should update snapshot when 'shouldUpdate'", func(t *testing.T) {
 		snapPath := setupSnapshot(t, jsonStandaloneFilename, false, true)
 

diff --git a/snaps/matchStandaloneSnapshot.go b/snaps/matchStandaloneSnapshot.go
@@ -50,7 +50,7 @@ func matchStandaloneSnapshot(c *Config, t testingT, input any) {
 	snapshot := pretty.Sprint(input)
 	prevSnapshot, err := getPrevStandaloneSnapshot(snapPath)
 	if errors.Is(err, errSnapNotFound) {
-		if isCI {
+		if !shouldCreate(c.update) {
 			handleError(t, err)
 			return
 		}

diff --git a/snaps/matchStandaloneSnapshot_test.go b/snaps/matchStandaloneSnapshot_test.go
@@ -72,6 +72,19 @@ func TestMatchStandaloneSnapshot(t *testing.T) {
 		test.Equal(t, 1, testEvents.items[erred])
 	})
 
+	t.Run("if snaps.Update(false) should skip creating snapshot", func(t *testing.T) {
+		setupSnapshot(t, fileName, false)
+
+		mockT := test.NewMockTestingT(t)
+		mockT.MockError = func(args ...any) {
+			test.Equal(t, errSnapNotFound, args[0].(error))
+		}
+
+		WithConfig(Update(false)).MatchStandaloneSnapshot(mockT, "hello world")
+
+		test.Equal(t, 1, testEvents.items[erred])
+	})
+
 	t.Run("should return error when diff is found", func(t *testing.T) {
 		setupSnapshot(t, standaloneFilename, false)
 

diff --git a/snaps/matchYAML.go b/snaps/matchYAML.go
@@ -95,7 +95,7 @@ func matchYAML(c *Config, t testingT, input any, matchers ...match.YAMLMatcher)
 	snapshot := takeYAMLSnapshot(y)
 	prevSnapshot, line, err := getPrevSnapshot(testID, snapPath)
 	if errors.Is(err, errSnapNotFound) {
-		if isCI {
+		if !shouldCreate(c.update) {
 			handleError(t, err)
 			return
 		}

diff --git a/snaps/matchYAML_test.go b/snaps/matchYAML_test.go
@@ -172,6 +172,19 @@ items:
 			test.Equal(t, 1, testEvents.items[erred])
 		})
 
+		t.Run("if snaps.Update(false) should skip creating snapshot", func(t *testing.T) {
+			setupSnapshot(t, fileName, false)
+
+			mockT := test.NewMockTestingT(t)
+			mockT.MockError = func(args ...any) {
+				test.Equal(t, errSnapNotFound, args[0].(error))
+			}
+
+			WithConfig(Update(false)).MatchYAML(mockT, "")
+
+			test.Equal(t, 1, testEvents.items[erred])
+		})
+
 		t.Run("should update snapshot when 'shouldUpdate'", func(t *testing.T) {
 			snapPath := setupSnapshot(t, yamlFilename, false, true)
 			printerExpectedCalls := []func(received any){

diff --git a/snaps/utils.go b/snaps/utils.go
@@ -125,3 +125,16 @@ func shouldUpdate(u *bool) bool {
 
 	return updateVAR == "true"
 }
+
+// shouldCreate determines whether snapshots should be created
+func shouldCreate(u *bool) bool {
+	if isCI {
+		return false
+	}
+
+	if u != nil {
+		return *u
+	}
+
+	return true
+}