govendor add github.com/go-gormigrate/gormigrate

2025-01-01 13:12:45 +08:00 · 2017-11-16 14:01:33 +01:00 · 2017-11-16 14:01:33 +01:00 · f33326db4d
commit f33326db4d
parent c5d00728d0
6 changed files with 553 additions and 0 deletions
--- a/vendor/github.com/go-gormigrate/gormigrate/LICENSE
+++ b/vendor/github.com/go-gormigrate/gormigrate/LICENSE
@ -0,0 +1,8 @@
+MIT License
+Copyright (c) 2016 Andrey Nering
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
--- a/vendor/github.com/go-gormigrate/gormigrate/README.md
+++ b/vendor/github.com/go-gormigrate/gormigrate/README.md
@ -0,0 +1,170 @@
+[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://github.com/go-gormigrate/gormigrate/blob/master/LICENSE)
+[![GoDoc](https://godoc.org/gopkg.in/gormigrate.v1?status.svg)](https://godoc.org/gopkg.in/gormigrate.v1)
+[![Go Report Card](https://goreportcard.com/badge/gopkg.in/gormigrate.v1)](https://goreportcard.com/report/gopkg.in/gormigrate.v1)
+[![Build Status](https://travis-ci.org/go-gormigrate/gormigrate.svg?branch=master)](https://travis-ci.org/go-gormigrate/gormigrate)
+
+# Gormigrate
+
+[![Join the chat at https://gitter.im/go-gormigrate/gormigrate](https://badges.gitter.im/go-gormigrate/gormigrate.svg)](https://gitter.im/go-gormigrate/gormigrate?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+Gormigrate is a migration helper for [Gorm][gorm].
+Gorm already have useful [migrate functions][gormmigrate], just misses
+proper schema versioning and rollback cababilities.
+
+## Supported databases
+
+It supports the databases [Gorm supports][gormdatabases]:
+
+- PostgreSQL
+- MySQL
+- SQLite
+- Microsoft SQL Server
+
+## Installing
+
+```bash
+go get -u gopkg.in/gormigrate.v1
+```
+
+## Usage
+
+```go
+package main
+
+import (
+	"log"
+
+	"gopkg.in/gormigrate.v1"
+	"github.com/jinzhu/gorm"
+	_ "github.com/jinzhu/gorm/dialects/sqlite"
+)
+
+func main() {
+	db, err := gorm.Open("sqlite3", "mydb.sqlite3")
+	if err != nil {
+		log.Fatal(err)
+	}
+	if err = db.DB().Ping(); err != nil {
+		log.Fatal(err)
+	}
+
+	db.LogMode(true)
+
+	m := gormigrate.New(db, gormigrate.DefaultOptions, []*gormigrate.Migration{
+		// create persons table
+		{
+			ID: "201608301400",
+			Migrate: func(tx *gorm.DB) error {
+				// it's a good pratice to copy the struct inside the function,
+				// so side effects are prevented if the original struct changes during the time
+				type Person struct {
+					gorm.Model
+					Name string
+				}
+				return tx.AutoMigrate(&Person{}).Error
+			},
+			Rollback: func(tx *gorm.DB) error {
+				return tx.DropTable("people").Error
+			},
+		},
+		// add age column to persons
+		{
+			ID: "201608301415",
+			Migrate: func(tx *gorm.DB) error {
+				// when table already exists, it just adds fields as columns
+				type Person struct {
+					Age int
+				}
+				return tx.AutoMigrate(&Person{}).Error
+			},
+			Rollback: func(tx *gorm.DB) error {
+				return tx.Table("people").DropColumn("age").Error
+			},
+		},
+		// add pets table
+		{
+			ID: "201608301430",
+			Migrate: func(tx *gorm.DB) error {
+				type Pet struct {
+					gorm.Model
+					Name     string
+					PersonID int
+				}
+				return tx.AutoMigrate(&Pet{}).Error
+			},
+			Rollback: func(tx *gorm.DB) error {
+				return tx.DropTable("pets").Error
+			},
+		},
+	})
+
+	if err = m.Migrate(); err != nil {
+		log.Fatalf("Could not migrate: %v", err)
+	}
+	log.Printf("Migration did run successfully")
+}
+```
+
+## Having a separated function for initializing the schema
+
+If you have a lot of migrations, it can be a pain to run all them, as example,
+when you are deploying a new instance of the app, in a clean database.
+To prevent this, you can set a function that will run if no migration was run
+before (in a new clean database). Remember to create everything here, all tables,
+foreign keys and what more you need in your app.
+
+```go
+type Person struct {
+	gorm.Model
+	Name string
+	Age int
+}
+
+type Pet struct {
+	gorm.Model
+	Name     string
+	PersonID int
+}
+
+m := gormigrate.New(db, gormigrate.DefaultOptions, []*gormigrate.Migration{
+    // you migrations here
+})
+
+m.InitSchema(func(tx *gorm.DB) error {
+	err := tx.AutoMigrate(
+		&Person{},
+		&Pet{},
+		// all other tables of you app
+	)
+	if err != nil {
+		return err
+	}
+
+	if err := tx.Model(Pet{}).AddForeignKey("person_id", "people (id)", "RESTRICT", "RESTRICT").Error; err != nil {
+		return err
+	}
+	// all other foreign keys...
+	return nil
+})
+```
+
+## Options
+
+This is the options struct, in case you don't want the defaults:
+
+```go
+type Options struct {
+	// Migrations table name. Default to "migrations".
+	TableName string
+	// The of the column that stores the id of migrations. Defaults to "id".
+	IDColumnName string
+	// UseTransaction makes Gormigrate execute migrations inside a single transaction.
+	// Keep in mind that not all databases support DDL commands inside transactions.
+	// Defaults to false.
+	UseTransaction bool
+}
+```
+
+[gorm]: http://jinzhu.me/gorm/
+[gormmigrate]: http://jinzhu.me/gorm/database.html#migration
+[gormdatabases]: http://jinzhu.me/gorm/database.html#connecting-to-a-database
--- a/vendor/github.com/go-gormigrate/gormigrate/Taskfile.yml
+++ b/vendor/github.com/go-gormigrate/gormigrate/Taskfile.yml
@ -0,0 +1,16 @@
+# https://github.com/go-task/task
+
+dl-deps:
+  desc: Downloads cli dependencies
+  cmds:
+    - go get -u github.com/golang/lint/golint
+
+lint:
+  desc: Runs golint on this project
+  cmds:
+    - golint .
+
+test:
+  desc: Runs automated tests for this project
+  cmds:
+    - go test -v .
--- a/vendor/github.com/go-gormigrate/gormigrate/doc.go
+++ b/vendor/github.com/go-gormigrate/gormigrate/doc.go
@ -0,0 +1,68 @@
+// Package gormigrate is a migration helper for Gorm (http://jinzhu.me/gorm/).
+// Gorm already have useful migrate functions
+// (http://jinzhu.me/gorm/database.html#migration), just misses
+// proper schema versioning and rollback cababilities.
+//
+// Example:
+//
+//  package main
+//
+//  import (
+//      "log"
+//
+//      "github.com/go-gormigrate/gormigrate"
+//      "github.com/jinzhu/gorm"
+//      _ "github.com/jinzhu/gorm/dialects/sqlite"
+//  )
+//
+//  type Person struct {
+//      gorm.Model
+//      Name string
+//  }
+//
+//  type Pet struct {
+//      gorm.Model
+//      Name     string
+//      PersonID int
+//  }
+//
+//  func main() {
+//      db, err := gorm.Open("sqlite3", "mydb.sqlite3")
+//      if err != nil {
+//          log.Fatal(err)
+//      }
+//      if err = db.DB().Ping(); err != nil {
+//          log.Fatal(err)
+//      }
+//
+//      db.LogMode(true)
+//
+//      m := gormigrate.New(db, gormigrate.DefaultOptions, []*gormigrate.Migration{
+//          {
+//              ID: "201608301400",
+//              Migrate: func(tx *gorm.DB) error {
+//                  return tx.AutoMigrate(&Person{}).Error
+//              },
+//              Rollback: func(tx *gorm.DB) error {
+//                  return tx.DropTable("people").Error
+//              },
+//          },
+//          {
+//              ID: "201608301430",
+//              Migrate: func(tx *gorm.DB) error {
+//                  return tx.AutoMigrate(&Pet{}).Error
+//              },
+//              Rollback: func(tx *gorm.DB) error {
+//                  return tx.DropTable("pets").Error
+//              },
+//          },
+//      })
+//
+//      err = m.Migrate()
+//      if err == nil {
+//          log.Printf("Migration did run successfully")
+//      } else {
+//          log.Printf("Could not migrate: %v", err)
+//      }
+//  }
+package gormigrate
--- a/vendor/github.com/go-gormigrate/gormigrate/gormigrate.go
+++ b/vendor/github.com/go-gormigrate/gormigrate/gormigrate.go
@ -0,0 +1,285 @@
+package gormigrate
+
+import (
+	"errors"
+	"fmt"
+
+	"github.com/jinzhu/gorm"
+)
+
+// MigrateFunc is the func signature for migrating.
+type MigrateFunc func(*gorm.DB) error
+
+// RollbackFunc is the func signature for rollbacking.
+type RollbackFunc func(*gorm.DB) error
+
+// InitSchemaFunc is the func signature for initializing the schema.
+type InitSchemaFunc func(*gorm.DB) error
+
+// Options define options for all migrations.
+type Options struct {
+	// TableName is the migration table.
+	TableName string
+	// IDColumnName is the name of column where the migration id will be stored.
+	IDColumnName string
+	// IDColumnSize is the length of the migration id column
+	IDColumnSize int
+	// UseTransaction makes Gormigrate execute migrations inside a single transaction.
+	// Keep in mind that not all databases support DDL commands inside transactions.
+	UseTransaction bool
+}
+
+// Migration represents a database migration (a modification to be made on the database).
+type Migration struct {
+	// ID is the migration identifier. Usually a timestamp like "201601021504".
+	ID string
+	// Migrate is a function that will br executed while running this migration.
+	Migrate MigrateFunc
+	// Rollback will be executed on rollback. Can be nil.
+	Rollback RollbackFunc
+}
+
+// Gormigrate represents a collection of all migrations of a database schema.
+type Gormigrate struct {
+	db         *gorm.DB
+	tx         *gorm.DB
+	options    *Options
+	migrations []*Migration
+	initSchema InitSchemaFunc
+}
+
+// DuplicatedIDError is returned when more than one migration have the same ID
+type DuplicatedIDError struct {
+	ID string
+}
+
+func (e *DuplicatedIDError) Error() string {
+	return fmt.Sprintf(`Duplicated migration ID: "%s"`, e.ID)
+}
+
+var (
+	// DefaultOptions can be used if you don't want to think about options.
+	DefaultOptions = &Options{
+		TableName:      "migrations",
+		IDColumnName:   "id",
+		IDColumnSize:   255,
+		UseTransaction: false,
+	}
+
+	// ErrRollbackImpossible is returned when trying to rollback a migration
+	// that has no rollback function.
+	ErrRollbackImpossible = errors.New("It's impossible to rollback this migration")
+
+	// ErrNoMigrationDefined is returned when no migration is defined.
+	ErrNoMigrationDefined = errors.New("No migration defined")
+
+	// ErrMissingID is returned when the ID od migration is equal to ""
+	ErrMissingID = errors.New("Missing ID in migration")
+
+	// ErrNoRunnedMigration is returned when any runned migration was found while
+	// running RollbackLast
+	ErrNoRunnedMigration = errors.New("Could not find last runned migration")
+)
+
+// New returns a new Gormigrate.
+func New(db *gorm.DB, options *Options, migrations []*Migration) *Gormigrate {
+	if options.TableName == "" {
+		options.TableName = DefaultOptions.TableName
+	}
+	if options.IDColumnName == "" {
+		options.IDColumnName = DefaultOptions.IDColumnName
+	}
+	if options.IDColumnSize == 0 {
+		options.IDColumnSize = DefaultOptions.IDColumnSize
+	}
+	return &Gormigrate{
+		db:         db,
+		options:    options,
+		migrations: migrations,
+	}
+}
+
+// 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 migrating. In this function you should create all tables and
+// foreign key necessary to your application.
+func (g *Gormigrate) InitSchema(initSchema InitSchemaFunc) {
+	g.initSchema = initSchema
+}
+
+// Migrate executes all migrations that did not run yet.
+func (g *Gormigrate) Migrate() error {
+	if err := g.checkDuplicatedID(); err != nil {
+		return err
+	}
+
+	if err := g.createMigrationTableIfNotExists(); err != nil {
+		return err
+	}
+
+	g.begin()
+
+	if g.initSchema != nil && g.isFirstRun() {
+		if err := g.runInitSchema(); err != nil {
+			g.rollback()
+			return err
+		}
+		return g.commit()
+	}
+
+	for _, migration := range g.migrations {
+		if err := g.runMigration(migration); err != nil {
+			g.rollback()
+			return err
+		}
+	}
+
+	return g.commit()
+}
+
+func (g *Gormigrate) checkDuplicatedID() error {
+	lookup := make(map[string]struct{}, len(g.migrations))
+	for _, m := range g.migrations {
+		if _, ok := lookup[m.ID]; ok {
+			return &DuplicatedIDError{ID: m.ID}
+		}
+		lookup[m.ID] = struct{}{}
+	}
+	return nil
+}
+
+// RollbackLast undo the last migration
+func (g *Gormigrate) RollbackLast() error {
+	if len(g.migrations) == 0 {
+		return ErrNoMigrationDefined
+	}
+
+	lastRunnedMigration, err := g.getLastRunnedMigration()
+	if err != nil {
+		return err
+	}
+
+	if err := g.RollbackMigration(lastRunnedMigration); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (g *Gormigrate) getLastRunnedMigration() (*Migration, error) {
+	for i := len(g.migrations) - 1; i >= 0; i-- {
+		migration := g.migrations[i]
+		if g.migrationDidRun(migration) {
+			return migration, nil
+		}
+	}
+	return nil, ErrNoRunnedMigration
+}
+
+// RollbackMigration undo a migration.
+func (g *Gormigrate) RollbackMigration(m *Migration) error {
+	if m.Rollback == nil {
+		return ErrRollbackImpossible
+	}
+
+	g.begin()
+
+	if err := m.Rollback(g.tx); err != nil {
+		return err
+	}
+
+	sql := fmt.Sprintf("DELETE FROM %s WHERE %s = ?", g.options.TableName, g.options.IDColumnName)
+	if err := g.db.Exec(sql, m.ID).Error; err != nil {
+		g.rollback()
+		return err
+	}
+
+	return g.commit()
+}
+
+func (g *Gormigrate) runInitSchema() error {
+	if err := g.initSchema(g.tx); err != nil {
+		return err
+	}
+
+	for _, migration := range g.migrations {
+		if err := g.insertMigration(migration.ID); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func (g *Gormigrate) runMigration(migration *Migration) error {
+	if len(migration.ID) == 0 {
+		return ErrMissingID
+	}
+
+	if !g.migrationDidRun(migration) {
+		if err := migration.Migrate(g.tx); err != nil {
+			return err
+		}
+
+		if err := g.insertMigration(migration.ID); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+func (g *Gormigrate) createMigrationTableIfNotExists() error {
+	if g.db.HasTable(g.options.TableName) {
+		return nil
+	}
+
+	sql := fmt.Sprintf("CREATE TABLE %s (%s VARCHAR(%d) PRIMARY KEY)", g.options.TableName, g.options.IDColumnName, g.options.IDColumnSize)
+	if err := g.db.Exec(sql).Error; err != nil {
+		return err
+	}
+	return nil
+}
+
+func (g *Gormigrate) migrationDidRun(m *Migration) bool {
+	var count int
+	g.db.
+		Table(g.options.TableName).
+		Where(fmt.Sprintf("%s = ?", g.options.IDColumnName), m.ID).
+		Count(&count)
+	return count > 0
+}
+
+func (g *Gormigrate) isFirstRun() bool {
+	var count int
+	g.db.
+		Table(g.options.TableName).
+		Count(&count)
+	return count == 0
+}
+
+func (g *Gormigrate) insertMigration(id string) error {
+	sql := fmt.Sprintf("INSERT INTO %s (%s) VALUES (?)", g.options.TableName, g.options.IDColumnName)
+	return g.tx.Exec(sql, id).Error
+}
+
+func (g *Gormigrate) begin() {
+	if g.options.UseTransaction {
+		g.tx = g.db.Begin()
+	} else {
+		g.tx = g.db
+	}
+}
+
+func (g *Gormigrate) commit() error {
+	if g.options.UseTransaction {
+		if err := g.tx.Commit().Error; err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+func (g *Gormigrate) rollback() {
+	if g.options.UseTransaction {
+		g.tx.Rollback()
+	}
+}
--- a/vendor/vendor.json
+++ b/vendor/vendor.json
@ -20,6 +20,12 @@
 			"revision": "0c9c3575f476a0c2779aafb89d1838ca4ab7ac16",
 			"revisionTime": "2017-11-01T23:11:58Z"
 		},
+		{
+			"checksumSHA1": "fI9spYCCgBl19GMD/JsW+znBHkw=",
+			"path": "github.com/go-gormigrate/gormigrate",
+			"revision": "21b0b93e8253d575d9185974835423f98d30158d",
+			"revisionTime": "2017-07-12T16:00:52Z"
+		},
 		{
 			"checksumSHA1": "os4jdoOUjr86qvOwri8Ut1rXDrg=",
 			"path": "github.com/go-sql-driver/mysql",