feat: add Update option on config

gkampitakis · Sep 28, 2023 · 6c77096 · 6c77096
1 parent 1b2c33a
commit 6c77096
Show file tree

Hide file tree

Showing 6 changed files with 110 additions and 92 deletions.
diff --git a/snaps/matchJSON.go b/snaps/matchJSON.go
@@ -123,7 +123,7 @@ func matchJSON(c *config, t testingT, input interface{}, matchers ...match.JSONM
 		return
 	}
 
-	if !shouldUpdateSingle(t.Name()) {
+	if !shouldUpdate(c.update) {
 		handleError(t, diff)
 		return
 	}

diff --git a/snaps/matchSnapshot.go b/snaps/matchSnapshot.go
@@ -90,7 +90,7 @@ func matchSnapshot(c *config, t testingT, values ...interface{}) {
 		return
 	}
 
-	if !shouldUpdateSingle(t.Name()) {
+	if !shouldUpdate(c.update) {
 		handleError(t, diff)
 		return
 	}

diff --git a/snaps/matchSnapshot_test.go b/snaps/matchSnapshot_test.go
@@ -38,18 +38,18 @@ func setupSnapshot(t *testing.T, file string, ci bool, update ...bool) string {
 	dir, _ := os.Getwd()
 	snapPath := filepath.Join(dir, "__snapshots__", file)
 	isCI = ci
-	shouldUpdatePrev := shouldUpdate
-	shouldUpdate = false
-	if len(update) > 0 {
-		shouldUpdate = update[0]
+	updateVARPrev := updateVAR
+	updateVAR = ""
+	if len(update) > 0 && update[0] {
+		updateVAR = "true"
 	}
 
 	t.Cleanup(func() {
 		os.Remove(snapPath)
 		testsRegistry = newRegistry()
 		testEvents = newTestEvents()
 		isCI = ciinfo.IsCI
-		shouldUpdate = shouldUpdatePrev
+		updateVAR = updateVARPrev
 	})
 
 	_, err := os.Stat(snapPath)
@@ -148,45 +148,89 @@ func TestMatchSnapshot(t *testing.T) {
 		test.Equal(t, 1, testEvents.items[erred])
 	})
 
-	t.Run("should update snapshot when 'shouldUpdate'", func(t *testing.T) {
-		snapPath := setupSnapshot(t, fileName, false, true)
-
-		printerExpectedCalls := []func(received interface{}){
-			func(received interface{}) { test.Equal(t, addedMsg, received.(string)) },
-			func(received interface{}) { test.Equal(t, updatedMsg, received.(string)) },
-		}
-		mockT := test.MockTestingT{
-			MockHelper: func() {},
-			MockName: func() string {
-				return "mock-name"
-			},
-			MockError: func(args ...interface{}) {
-				test.NotCalled(t)
-			},
-			MockLog: func(args ...interface{}) {
-				printerExpectedCalls[0](args[0])
-
-				// shift
-				printerExpectedCalls = printerExpectedCalls[1:]
-			},
-		}
-
-		// First call for creating the snapshot
-		MatchSnapshot(mockT, 10, "hello world")
-		test.Equal(t, 1, testEvents.items[added])
-
-		// Resetting registry to emulate the same MatchSnapshot call
-		testsRegistry = newRegistry()
-
-		// Second call with different params
-		MatchSnapshot(mockT, 100, "bye world")
-
-		test.Equal(
-			t,
-			"\n[mock-name - 1]\nint(100)\nbye world\n---\n",
-			test.GetFileContent(t, snapPath),
-		)
-		test.Equal(t, 1, testEvents.items[updated])
+	t.Run("should update snapshot", func(t *testing.T) {
+		t.Run("when 'updateVAR==true'", func(t *testing.T) {
+			snapPath := setupSnapshot(t, fileName, false, true)
+
+			printerExpectedCalls := []func(received interface{}){
+				func(received interface{}) { test.Equal(t, addedMsg, received.(string)) },
+				func(received interface{}) { test.Equal(t, updatedMsg, received.(string)) },
+			}
+			mockT := test.MockTestingT{
+				MockHelper: func() {},
+				MockName: func() string {
+					return "mock-name"
+				},
+				MockError: func(args ...interface{}) {
+					test.NotCalled(t)
+				},
+				MockLog: func(args ...interface{}) {
+					printerExpectedCalls[0](args[0])
+
+					// shift
+					printerExpectedCalls = printerExpectedCalls[1:]
+				},
+			}
+
+			// First call for creating the snapshot
+			MatchSnapshot(mockT, 10, "hello world")
+			test.Equal(t, 1, testEvents.items[added])
+
+			// Resetting registry to emulate the same MatchSnapshot call
+			testsRegistry = newRegistry()
+
+			// Second call with different params
+			MatchSnapshot(mockT, 100, "bye world")
+
+			test.Equal(
+				t,
+				"\n[mock-name - 1]\nint(100)\nbye world\n---\n",
+				test.GetFileContent(t, snapPath),
+			)
+			test.Equal(t, 1, testEvents.items[updated])
+		})
+
+		t.Run("when config update", func(t *testing.T) {
+			snapPath := setupSnapshot(t, fileName, false, false)
+
+			printerExpectedCalls := []func(received interface{}){
+				func(received interface{}) { test.Equal(t, addedMsg, received.(string)) },
+				func(received interface{}) { test.Equal(t, updatedMsg, received.(string)) },
+			}
+			mockT := test.MockTestingT{
+				MockHelper: func() {},
+				MockName: func() string {
+					return "mock-name"
+				},
+				MockError: func(args ...interface{}) {
+					test.NotCalled(t)
+				},
+				MockLog: func(args ...interface{}) {
+					printerExpectedCalls[0](args[0])
+
+					// shift
+					printerExpectedCalls = printerExpectedCalls[1:]
+				},
+			}
+
+			s := WithConfig(Update(true))
+			// First call for creating the snapshot
+			s.MatchSnapshot(mockT, 10, "hello world")
+			test.Equal(t, 1, testEvents.items[added])
+
+			// Resetting registry to emulate the same MatchSnapshot call
+			testsRegistry = newRegistry()
+
+			// Second call with different params
+			s.MatchSnapshot(mockT, 100, "bye world")
+
+			test.Equal(
+				t,
+				"\n[mock-name - 1]\nint(100)\nbye world\n---\n",
+				test.GetFileContent(t, snapPath),
+			)
+			test.Equal(t, 1, testEvents.items[updated])
+		})
 	})
 
 	t.Run("should print warning if no params provided", func(t *testing.T) {

diff --git a/snaps/snapshot.go b/snaps/snapshot.go
@@ -27,6 +27,14 @@ var (
 type config struct {
 	filename string
 	snapsDir string
+	update   *bool
+}
+
+// Control if snapshots should be updated, it respects if running on CI.
+func Update(u bool) func(*config) {
+	return func(c *config) {
+		c.update = &u
+	}
 }
 
 // Specify folder name where snapshots are stored

diff --git a/snaps/utils.go b/snaps/utils.go
@@ -17,9 +17,8 @@ import (
 var (
 	errSnapNotFound = errors.New("snapshot not found")
 	isCI            = ciinfo.IsCI
-	envVar          = os.Getenv("UPDATE_SNAPS")
-	shouldUpdate    = envVar == "true" && !isCI
-	shouldClean     = shouldUpdate || envVar == "clean" && !isCI
+	updateVAR       = os.Getenv("UPDATE_SNAPS")
+	shouldClean     = (updateVAR == "true" || updateVAR == "clean") && !isCI
 	defaultConfig   = config{
 		snapsDir: "__snapshots__",
 	}
@@ -113,9 +112,14 @@ func snapshotScanner(r io.Reader) *bufio.Scanner {
 	return s
 }
 
-// shouldUpdateSingle returns if a single should be updated or not
-//
-// it depends on the general should update or if the given name on `UPDATE_SNAPS` matches the current test.
-func shouldUpdateSingle(tName string) bool {
-	return shouldUpdate || (!isCI && envVar != "" && strings.HasPrefix(tName, envVar))
+func shouldUpdate(u *bool) bool {
+	if isCI {
+		return false
+	}
+
+	if u != nil {
+		return *u
+	}
+
+	return updateVAR == "true"
 }
diff --git a/snaps/utils_test.go b/snaps/utils_test.go
@@ -44,41 +44,3 @@ func TestBaseCaller(t *testing.T) {
 		TestBaseCallerNested(t)
 	})
 }
-
-func TestShouldUpdateSingle(t *testing.T) {
-	setup := func() {
-		shouldUpdate = false
-		isCI = false
-		envVar = ""
-	}
-
-	t.Run("should be true if shouldUpdate", func(t *testing.T) {
-		setup()
-
-		shouldUpdate = true
-		test.True(t, shouldUpdateSingle(""))
-	})
-
-	t.Run("should be true if specific test provided from envVar", func(t *testing.T) {
-		setup()
-		envVar = "mock-test/"
-		shouldUpdate = false
-
-		test.True(t, shouldUpdateSingle("mock-test/should_pass - 1"))
-		test.False(t, shouldUpdateSingle("mock-test-2/should_pass - 1"))
-	})
-
-	t.Run("should be false if running on CI", func(t *testing.T) {
-		setup()
-		envVar = "mock-test/"
-		isCI = true
-
-		test.False(t, shouldUpdateSingle("mock-test/should_pass - 1"))
-	})
-
-	t.Run("should be false if not envVar provided", func(t *testing.T) {
-		setup()
-
-		test.False(t, shouldUpdateSingle("mock-test"))
-	})
-}