feat: do auto snapshot restore if snapshot is present

can be overriden using `--no-restore`

Author: radim

cmd/test.go

@@ -14,6 +14,7 @@ var (
 	testFormat     string
 	testOutputPath string
 	testCommit     bool
+	testNoRestore  bool
 
 	testCmd = &cobra.Command{
 		Use:   "test [flags]",
@@ -23,7 +24,7 @@ var (
 				fmt.Print(err.Error())
 				os.Exit(1)
 			}
-			regresql.Test(testCwd, testRunFilter, testFormat, testOutputPath, testCommit)
+			regresql.Test(testCwd, testRunFilter, testFormat, testOutputPath, testCommit, testNoRestore)
 		},
 	}
 )
@@ -36,4 +37,5 @@ func init() {
 	testCmd.Flags().StringVar(&testFormat, "format", "console", "Output format: console, pgtap, junit, json, github-actions")
 	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")
 }

regresql/config.go

@@ -34,6 +34,7 @@ type (
 		Migrations       string   `yaml:"migrations,omitempty"`        // directory of SQL migrations to apply
 		MigrationCommand string   `yaml:"migration_command,omitempty"` // external command to run migrations (e.g., goose, migrate)
 		Fixtures         []string `yaml:"fixtures,omitempty"`          // SQL/YAML fixture files for snapshot build
+		AutoRestore      *bool    `yaml:"auto_restore,omitempty"`      // restore snapshot before test (default: true if path is set)
 	}
 )
 

regresql/regresql.go

@@ -135,7 +135,7 @@ the regresql update command again to reset the expected output files.
 
 // 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 bool) {
+func Test(root, runFilter, formatName, outputPath string, commit, noRestore bool) {
 	config, err := ReadConfig(root)
 	ignorePatterns := []string{}
 	if err == nil {
@@ -153,6 +153,25 @@ func Test(root, runFilter, formatName, outputPath string, commit bool) {
 	// Cache config for plan quality analysis
 	SetGlobalConfig(config)
 
+	// Auto-restore snapshot before test
+	if !noRestore && ShouldAutoRestore(config.Snapshot) {
+		snapshotPath := GetSnapshotPath(config.Snapshot, root)
+		if _, err := os.Stat(snapshotPath); os.IsNotExist(err) {
+			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)
+		opts := RestoreOptions{
+			InputPath: snapshotPath,
+			Clean:     true,
+		}
+		if err := RestoreSnapshot(config.PgUri, opts); err != nil {
+			fmt.Printf("Error: failed to restore snapshot: %s\n", err)
+			os.Exit(1)
+		}
+		fmt.Println()
+	}
+
 	// Validate schema hasn't changed since last snapshot build
 	if err := ValidateSchemaHash(root); err != nil {
 		fmt.Printf("Error: %s\n", err)

regresql/snapshot.go

@@ -418,6 +418,16 @@ func GetSnapshotsDir(root string) string {
 	return filepath.Join(root, "snapshots")
 }
 
+func ShouldAutoRestore(cfg *SnapshotConfig) bool {
+	if cfg == nil || cfg.Path == "" {
+		return false
+	}
+	if cfg.AutoRestore == nil {
+		return true
+	}
+	return *cfg.AutoRestore
+}
+
 // RestoreSnapshot restores a database snapshot using pg_restore or psql
 func RestoreSnapshot(pguri string, opts RestoreOptions) error {
 	if _, err := os.Stat(opts.InputPath); os.IsNotExist(err) {