Allow to skip long-running migration (#54)

Author: qwerty287

go.mod

@@ -3,15 +3,13 @@ module src.techknowlogick.com/xormigrate
 go 1.14
 
 require (
-	cloud.google.com/go v0.37.4 // indirect
 	github.com/denisenkom/go-mssqldb v0.10.0
 	github.com/go-sql-driver/mysql v1.6.0
 	github.com/goccy/go-json v0.9.11 // indirect
 	github.com/joho/godotenv v1.3.0
 	github.com/lib/pq v1.10.2
 	github.com/mattn/go-sqlite3 v1.14.9
 	github.com/stretchr/testify v1.7.0
-	google.golang.org/appengine v1.6.0 // indirect
 	xorm.io/builder v0.3.12 // indirect
 	xorm.io/xorm v1.3.2
 )

go.sum

@@ -1,3 +1,4 @@
+//go:build mysql
 // +build mysql
 
 package xormigrate

mysql_test.go

@@ -1,3 +1,4 @@
+//go:build postgresql
 // +build postgresql
 
 package xormigrate

postgresql_test.go

@@ -1,3 +1,4 @@
+//go:build sqlite
 // +build sqlite
 
 package xormigrate

sqlite_test.go

@@ -1,3 +1,4 @@
+//go:build sqlserver
 // +build sqlserver
 
 package xormigrate

sqlserver_test.go

@@ -30,13 +30,16 @@ type Migration struct {
 	Migrate MigrateFunc `xorm:"-"`
 	// Rollback will be executed on rollback. Can be nil.
 	Rollback RollbackFunc `xorm:"-"`
+	// Long marks the migration an non-required migration that will likely take a long time. Must use Xormigrate.AllowLong() to be enabled.
+	Long bool `xorm:"-"`
 }
 
 // Xormigrate represents a collection of all migrations of a database schema.
 type Xormigrate struct {
 	db         *xorm.Engine
 	migrations []*Migration
 	initSchema InitSchemaFunc
+	allowLong  bool
 }
 
 // ReservedIDError is returned when a migration is using a reserved ID
@@ -82,6 +85,7 @@ func New(db *xorm.Engine, migrations []*Migration) *Xormigrate {
 	return &Xormigrate{
 		db:         db,
 		migrations: migrations,
+		allowLong:  false,
 	}
 }
 
@@ -93,6 +97,18 @@ func (x *Xormigrate) InitSchema(initSchema InitSchemaFunc) {
 	x.initSchema = initSchema
 }
 
+// InitSchema sets a function that is run if no migration is found.
+// The idea is preventing to run all migrations when a new clean database
+// is being migratinx. In this function you should create all tables and
+// foreign key necessary to your application.
+func (x *Xormigrate) AllowLong(allow ...bool) {
+	allowLong := true
+	if len(allow) > 0 {
+		allowLong = allow[0]
+	}
+	x.allowLong = allowLong
+}
+
 // Migrate executes all migrations that did not run yet.
 func (x *Xormigrate) Migrate() error {
 	return x.migrate("")
@@ -128,6 +144,9 @@ func (x *Xormigrate) migrate(migrationID string) error {
 	}
 
 	for _, migration := range x.migrations {
+		if migration.Long && !x.allowLong {
+			continue
+		}
 		if err := x.runMigration(migration); err != nil {
 			return err
 		}

xormigrate.go

@@ -318,6 +318,43 @@ func TestEmptyMigrationList(t *testing.T) {
 	})
 }
 
+func TestAllowLong(t *testing.T) {
+	forEachDatabase(t, func(db *xorm.Engine) {
+		t.Run("without AllowLong", func(t *testing.T) {
+			m := New(db, []*Migration{{
+				ID:   "201608301430",
+				Long: true,
+				Migrate: func(tx *xorm.Engine) error {
+					return tx.Sync2(&Pet{})
+				},
+				Rollback: func(tx *xorm.Engine) error {
+					return tx.DropTables(&Pet{})
+				},
+			}})
+			err := m.Migrate()
+			assert.Nil(t, err)
+			assert.Equal(t, int64(0), tableCount(t, db))
+		})
+
+		t.Run("with AllowLong", func(t *testing.T) {
+			m := New(db, []*Migration{{
+				ID:   "201608301430",
+				Long: true,
+				Migrate: func(tx *xorm.Engine) error {
+					return tx.Sync2(&Pet{})
+				},
+				Rollback: func(tx *xorm.Engine) error {
+					return tx.DropTables(&Pet{})
+				},
+			}})
+			m.AllowLong(true)
+			err := m.Migrate()
+			assert.Nil(t, err)
+			assert.Equal(t, int64(1), tableCount(t, db))
+		})
+	})
+}
+
 func tableCount(t *testing.T, db *xorm.Engine) (count int64) {
 	count, err := db.Count(&Migration{})
 	assert.NoError(t, err)