feat: skip snapshot restore if unchanged (mtime+size check)

Author: radim

cmd/test.go

@@ -9,12 +9,13 @@ import (
 )
 
 var (
-	testCwd        string
-	testRunFilter  string
-	testFormat     string
-	testOutputPath string
-	testCommit     bool
-	testNoRestore  bool
+	testCwd          string
+	testRunFilter    string
+	testFormat       string
+	testOutputPath   string
+	testCommit       bool
+	testNoRestore    bool
+	testForceRestore bool
 
 	testCmd = &cobra.Command{
 		Use:   "test [flags]",
@@ -24,7 +25,7 @@ var (
 				fmt.Print(err.Error())
 				os.Exit(1)
 			}
-			regresql.Test(testCwd, testRunFilter, testFormat, testOutputPath, testCommit, testNoRestore)
+			regresql.Test(testCwd, testRunFilter, testFormat, testOutputPath, testCommit, testNoRestore, testForceRestore)
 		},
 	}
 )
@@ -38,4 +39,5 @@ func init() {
 	testCmd.Flags().StringVarP(&testOutputPath, "output", "o", "", "Output file path (default: stdout)")
 	testCmd.Flags().BoolVar(&testCommit, "commit", false, "Commit transactions instead of rollback (use with caution)")
 	testCmd.Flags().BoolVar(&testNoRestore, "no-restore", false, "Skip snapshot restore before test")
+	testCmd.Flags().BoolVar(&testForceRestore, "force-restore", false, "Force snapshot restore even if unchanged")
 }

cmd/update.go

@@ -9,10 +9,11 @@ import (
 )
 
 var (
-	updateCwd       string
-	updateRunFilter string
-	updateCommit    bool
-	updateNoRestore bool
+	updateCwd          string
+	updateRunFilter    string
+	updateCommit       bool
+	updateNoRestore    bool
+	updateForceRestore bool
 
 	// updateCmd represents the update command
 	updateCmd = &cobra.Command{
@@ -23,7 +24,7 @@ var (
 				fmt.Print(err.Error())
 				os.Exit(1)
 			}
-			regresql.Update(updateCwd, updateRunFilter, updateCommit, updateNoRestore)
+			regresql.Update(updateCwd, updateRunFilter, updateCommit, updateNoRestore, updateForceRestore)
 		},
 	}
 )
@@ -35,4 +36,5 @@ func init() {
 	updateCmd.Flags().StringVar(&updateRunFilter, "run", "", "Run only queries matching regexp (matches file names and query names)")
 	updateCmd.Flags().BoolVar(&updateCommit, "commit", false, "Commit transactions instead of rollback (use with caution)")
 	updateCmd.Flags().BoolVar(&updateNoRestore, "no-restore", false, "Skip snapshot restore before update")
+	updateCmd.Flags().BoolVar(&updateForceRestore, "force-restore", false, "Force snapshot restore even if unchanged")
 }

regresql/regresql.go

@@ -3,6 +3,7 @@ package regresql
 import (
 	"fmt"
 	"os"
+	"time"
 )
 
 /*
@@ -92,7 +93,7 @@ case and add a value for each parameter. `)
 Update updates the expected files from the queries and their parameters.
 Each query runs in its own transaction that rolls back (unless commit is true).
 */
-func Update(root string, runFilter string, commit, noRestore bool) {
+func Update(root string, runFilter string, commit, noRestore, forceRestore bool) {
 	config, err := ReadConfig(root)
 	ignorePatterns := []string{}
 	if err == nil {
@@ -107,7 +108,7 @@ func Update(root string, runFilter string, commit, noRestore bool) {
 		os.Exit(3)
 	}
 
-	autoRestore(config, root, noRestore)
+	autoRestore(config, root, noRestore, forceRestore)
 
 	if err := TestConnectionString(config.PgUri); err != nil {
 		fmt.Print(err.Error())
@@ -135,7 +136,7 @@ the regresql update command again to reset the expected output files.
  `)
 }
 
-func autoRestore(cfg config, root string, noRestore bool) {
+func autoRestore(cfg config, root string, noRestore, forceRestore bool) {
 	if noRestore || !ShouldAutoRestore(cfg.Snapshot) {
 		return
 	}
@@ -144,22 +145,53 @@ func autoRestore(cfg config, root string, noRestore bool) {
 		fmt.Printf("Error: snapshot file not found: %s\n\nRun 'regresql snapshot build' to create a snapshot, or use '--no-restore' to skip\n", snapshotPath)
 		os.Exit(1)
 	}
-	fmt.Printf("Restoring snapshot: %s\n", snapshotPath)
+
+	snapshotsDir := GetSnapshotsDir(root)
+	targetDB := cfg.Snapshot.RestoreDatabase
+
+	if !forceRestore {
+		needsRestore, reason := NeedsRestore(snapshotsDir, snapshotPath, targetDB)
+		if !needsRestore {
+			state, _ := ReadRestoreState(snapshotsDir)
+			fmt.Printf("Skipping restore: snapshot unchanged since %s (restored in %.1fs)\n\n",
+				state.RestoredAt.Local().Format("2006-01-02 15:04:05"),
+				float64(state.DurationMillis)/1000)
+			return
+		}
+		fmt.Printf("Restoring snapshot: %s (%s)\n", snapshotPath, reason)
+	} else {
+		fmt.Printf("Restoring snapshot: %s (forced)\n", snapshotPath)
+	}
+
+	start := time.Now()
 	opts := RestoreOptions{
 		InputPath:      snapshotPath,
 		Clean:          true,
-		TargetDatabase: cfg.Snapshot.RestoreDatabase,
+		TargetDatabase: targetDB,
 	}
 	if err := RestoreSnapshot(cfg.PgUri, opts); err != nil {
 		fmt.Printf("Error: failed to restore snapshot: %s\n", err)
 		os.Exit(1)
 	}
-	fmt.Println()
+	duration := time.Since(start)
+
+	stat, _ := os.Stat(snapshotPath)
+	state := &RestoreState{
+		SnapshotPath:   snapshotPath,
+		SnapshotMtime:  stat.ModTime(),
+		SnapshotSize:   stat.Size(),
+		Database:       targetDB,
+		RestoredAt:     time.Now().UTC(),
+		DurationMillis: duration.Milliseconds(),
+	}
+	WriteRestoreState(snapshotsDir, state)
+
+	fmt.Printf("Restored in %.1fs\n\n", duration.Seconds())
 }
 
 // Test runs regression tests for all queries.
 // Each query runs in its own transaction that rolls back (unless commit is true).
-func Test(root, runFilter, formatName, outputPath string, commit, noRestore bool) {
+func Test(root, runFilter, formatName, outputPath string, commit, noRestore, forceRestore bool) {
 	config, err := ReadConfig(root)
 	ignorePatterns := []string{}
 	if err == nil {
@@ -177,7 +209,7 @@ func Test(root, runFilter, formatName, outputPath string, commit, noRestore bool
 	// Cache config for plan quality analysis
 	SetGlobalConfig(config)
 
-	autoRestore(config, root, noRestore)
+	autoRestore(config, root, noRestore, forceRestore)
 
 	// Validate schema hasn't changed since last snapshot build
 	if err := ValidateSchemaHash(root); err != nil {

regresql/snapshot.go

@@ -36,6 +36,15 @@ type (
 		FixturesUsed         []string  `yaml:"fixtures_used,omitempty"`
 	}
 
+	RestoreState struct {
+		SnapshotPath   string    `yaml:"snapshot_path"`
+		SnapshotMtime  time.Time `yaml:"snapshot_mtime"`
+		SnapshotSize   int64     `yaml:"snapshot_size"`
+		Database       string    `yaml:"database"`
+		RestoredAt     time.Time `yaml:"restored_at"`
+		DurationMillis int64     `yaml:"duration_millis"`
+	}
+
 	SnapshotFormat string
 
 	SnapshotOptions struct {
@@ -77,6 +86,7 @@ const (
 	DefaultSnapshotPath   = "snapshots/default.dump"
 	DefaultSnapshotFormat = FormatCustom
 	SnapshotMetadataFile  = ".regresql-snapshot.yaml"
+	RestoreStateFile      = ".regresql-restore-state.yaml"
 )
 
 // RestoreTool returns the appropriate PostgreSQL tool for restoring this format.
@@ -430,6 +440,58 @@ func ShouldAutoRestore(cfg *SnapshotConfig) bool {
 	return *cfg.AutoRestore
 }
 
+func ReadRestoreState(snapshotsDir string) (*RestoreState, error) {
+	statePath := filepath.Join(snapshotsDir, RestoreStateFile)
+	data, err := os.ReadFile(statePath)
+	if err != nil {
+		return nil, err
+	}
+	var state RestoreState
+	if err := yaml.Unmarshal(data, &state); err != nil {
+		return nil, err
+	}
+	return &state, nil
+}
+
+func WriteRestoreState(snapshotsDir string, state *RestoreState) error {
+	statePath := filepath.Join(snapshotsDir, RestoreStateFile)
+	data, err := yaml.Marshal(state)
+	if err != nil {
+		return err
+	}
+	return os.WriteFile(statePath, data, 0o644)
+}
+
+func NeedsRestore(snapshotsDir, snapshotPath, targetDB string) (bool, string) {
+	state, err := ReadRestoreState(snapshotsDir)
+	if err != nil {
+		return true, "no previous restore state"
+	}
+
+	if state.SnapshotPath != snapshotPath {
+		return true, "snapshot path changed"
+	}
+
+	if state.Database != targetDB {
+		return true, "target database changed"
+	}
+
+	stat, err := os.Stat(snapshotPath)
+	if err != nil {
+		return true, "failed to stat snapshot"
+	}
+
+	if stat.Size() != state.SnapshotSize {
+		return true, "snapshot size changed"
+	}
+
+	if !stat.ModTime().Equal(state.SnapshotMtime) {
+		return true, "snapshot modified"
+	}
+
+	return false, ""
+}
+
 // replaceDatabase returns a new connection string with a different database
 func replaceDatabase(pguri, newDB string) (string, error) {
 	u, err := url.Parse(pguri)