Restructure and make it to an installable command

cmd/migrator/main.go

@@ -0,0 +1,8 @@
+// Package main initiate db migrator command
+package main
+
+import migrator "github.com/olbrichattila/godbmigrator_cmd/internal"
+
+func main() {
+	migrator.Init()
+}

internal/connection_types.go

@@ -0,0 +1,14 @@
+package migrator
+
+const (
+	driverTypeSqLite = "sqlite3"
+	driverTypeMysql  = "mysql"
+
+	providerSqLiteDataType   = "sqlite"
+	providerPgSQLDataType    = "pgsql"
+	providerMySQLDataType    = "mysql"
+	providerFirebirdDataType = "firebird"
+
+	providerTypeJSON = "json"
+	providerTypeDB   = "db"
+)

firebird_connection.go → internal/firebird_connection.go

@@ -1,13 +1,15 @@
-package main
+// Package migrator wraps around migrator package and exposes as a CLI tool
+package migrator
 
 import (
 	"database/sql"
 	"fmt"
 
+	// This needs to be blank imported as not directly referenced, but required
 	_ "github.com/nakagami/firebirdsql"
 )
 
-func NewFirebirdStore(
+func newFirebirdStore(
 	host string,
 	port int,
 	user,

migration_adapter.go → internal/migration_adapter.go

@@ -1,4 +1,4 @@
-package main
+package migrator
 
 import (
 	"database/sql"
@@ -9,7 +9,7 @@ import (
 type migrationAdapter struct {
 }
 
-func NewMigrationAdapter() *migrationAdapter {
+func newMigrationAdapter() *migrationAdapter {
 	return &migrationAdapter{}
 }
 
@@ -25,8 +25,8 @@ func (a *migrationAdapter) Refresh(db *sql.DB, provider migrator.MigrationProvid
 	return migrator.Refresh(db, provider, migrationPath)
 }
 
-func (a *migrationAdapter) AddNewMigrationFiles(migrationPath string, customText string) {
-	migrator.AddNewMigrationFiles(migrationPath, customText)
+func (a *migrationAdapter) AddNewMigrationFiles(migrationPath string, customText string) error {
+	return migrator.AddNewMigrationFiles(migrationPath, customText)
 }
 
 func (a *migrationAdapter) Report(db *sql.DB, provider migrator.MigrationProvider, migrationPath string) (string, error) {

migration_init.go → internal/migration_init.go

@@ -1,4 +1,4 @@
-package main
+package migrator
 
 import (
 	"database/sql"
@@ -9,6 +9,14 @@ import (
 	migrator "github.com/olbrichattila/godbmigrator"
 )
 
+const (
+	envDBHost     = "DB_HOST"
+	envDBUserName = "DB_USERNAME"
+	envDBPassword = "DB_PASSWORD"
+	envDBDatabase = "DB_DATABASE"
+	envDBPort     = "DB_PORT"
+)
+
 type migrationInitInterface interface {
 	migrationInit(args []string) (*sql.DB, migrator.MigrationProvider, int, error)
 }
@@ -43,51 +51,51 @@ func (m *migrationInit) connection() (*sql.DB, error) {
 	dbConnection := os.Getenv("DB_CONNECTION")
 
 	switch dbConnection {
-	case "sqlite":
-		db, err := NewSqliteStore(os.Getenv("DB_DATABASE"))
+	case providerSqLiteDataType:
+		db, err := newSqliteStore(os.Getenv(envDBDatabase))
 		return db, err
-	case "pgsql":
+	case providerPgSQLDataType:
 		sslMode, err := m.getPostgresSSLMode()
 		if err != nil {
 			return nil, err
 		}
-		port, err := strconv.Atoi(os.Getenv("DB_PORT"))
+		port, err := strconv.Atoi(os.Getenv(envDBPort))
 		if err != nil {
 			return nil, err
 		}
-		db, err := NewPostgresStore(
-			os.Getenv("DB_HOST"),
+		db, err := newPostgresStore(
+			os.Getenv(envDBHost),
 			port,
-			os.Getenv("DB_USERNAME"),
-			os.Getenv("DB_PASSWORD"),
-			os.Getenv("DB_DATABASE"),
+			os.Getenv(envDBUserName),
+			os.Getenv(envDBPassword),
+			os.Getenv(envDBDatabase),
 			sslMode,
 		)
 		return db, err
-	case "mysql":
-		port, err := strconv.Atoi(os.Getenv("DB_PORT"))
+	case providerMySQLDataType:
+		port, err := strconv.Atoi(os.Getenv(envDBPort))
 		if err != nil {
 			return nil, err
 		}
-		db, err := NewMysqlStore(
-			os.Getenv("DB_HOST"),
+		db, err := newMysqlStore(
+			os.Getenv(envDBHost),
 			port,
-			os.Getenv("DB_USERNAME"),
-			os.Getenv("DB_PASSWORD"),
-			os.Getenv("DB_DATABASE"),
+			os.Getenv(envDBUserName),
+			os.Getenv(envDBPassword),
+			os.Getenv(envDBDatabase),
 		)
 		return db, err
-	case "firebird":
-		port, err := strconv.Atoi(os.Getenv("DB_PORT"))
+	case providerFirebirdDataType:
+		port, err := strconv.Atoi(os.Getenv(envDBPort))
 		if err != nil {
 			return nil, err
 		}
-		db, err := NewFirebirdStore(
-			os.Getenv("DB_HOST"),
+		db, err := newFirebirdStore(
+			os.Getenv(envDBHost),
 			port,
-			os.Getenv("DB_USERNAME"),
-			os.Getenv("DB_PASSWORD"),
-			os.Getenv("DB_DATABASE"),
+			os.Getenv(envDBUserName),
+			os.Getenv(envDBPassword),
+			os.Getenv(envDBDatabase),
 		)
 		return db, err
 	default:
@@ -99,10 +107,10 @@ func (m *migrationInit) provider(db *sql.DB) (migrator.MigrationProvider, error)
 	migrationProvider := os.Getenv("MIGRATOR_MIGRATION_PROVIDER")
 
 	switch migrationProvider {
-	case "db", "":
-		return migrator.NewMigrationProvider("db", db)
-	case "json":
-		return migrator.NewMigrationProvider("json", nil)
+	case providerTypeDB, "":
+		return migrator.NewMigrationProvider(providerTypeDB, db)
+	case providerTypeJSON:
+		return migrator.NewMigrationProvider(providerTypeJSON, nil)
 	default:
 		return nil, fmt.Errorf("migration provider for type %s does not exists", migrationProvider)
 	}
@@ -121,17 +129,17 @@ func (m *migrationInit) getPostgresSSLMode() (string, error) {
 
 	switch envSSLMOde {
 	case "disable", "":
-		return PgsSslMode.Disable, nil
+		return pgsSSLMode.Disable, nil
 	case "require":
-		return PgsSslMode.Require, nil
+		return pgsSSLMode.Require, nil
 	case "verify-ca":
-		return PgsSslMode.VerifyCa, nil
+		return pgsSSLMode.VerifyCa, nil
 	case "verify-full":
-		return PgsSslMode.VerifyFull, nil
+		return pgsSSLMode.VerifyFull, nil
 	case "prefer":
-		return PgsSslMode.Prefer, nil
+		return pgsSSLMode.Prefer, nil
 	case "allow":
-		return PgsSslMode.Allow, nil
+		return pgsSSLMode.Allow, nil
 
 	default:
 		return "", fmt.Errorf(`the provided DB_SSLMODE environment variable is invalid '%s'.,

migration_init_spy.go → internal/migration_init_spy.go

@@ -1,4 +1,4 @@
-package main
+package migrator
 
 import (
 	"database/sql"
@@ -15,7 +15,7 @@ func newMigrationInitSpy() *migrationInitSpy {
 }
 
 func (m *migrationInitSpy) migrationInit(args []string) (*sql.DB, migrator.MigrationProvider, int, error) {
-	conn, err := sql.Open("sqlite3", ":memory:")
+	conn, err := sql.Open(driverTypeSqLite, ":memory:")
 	if err != nil {
 		return nil, nil, 0, err
 	}

migration_provider_spy.go → internal/migration_provider_spy.go

@@ -1,4 +1,4 @@
-package main
+package migrator
 
 type migrationProviderSpy struct {
 }

migration_test.go → internal/migration_test.go

@@ -1,4 +1,4 @@
-package main
+package migrator
 
 import (
 	"testing"

main.go → internal/migrator.go

@@ -1,4 +1,4 @@
-package main
+package migrator
 
 import (
 	"database/sql"
@@ -9,26 +9,27 @@ import (
 	migrator "github.com/olbrichattila/godbmigrator"
 )
 
-const defaultMigrationPath = "./migrations"
-
-type providerInterface interface {
-}
+const (
+	defaultMigrationPath = "./migrations"
+	messageRollingBack   = "Rolling back"
+)
 
 type migratorInterface interface {
 	Migrate(*sql.DB, migrator.MigrationProvider, string, int) error
 	Rollback(*sql.DB, migrator.MigrationProvider, string, int) error
 	Refresh(*sql.DB, migrator.MigrationProvider, string) error
 	Report(*sql.DB, migrator.MigrationProvider, string) (string, error)
-	AddNewMigrationFiles(string, string)
+	AddNewMigrationFiles(string, string) error
 }
 
-func main() {
+// Init starts migration command, reads .env and command line arguments, and execute what was requested
+func Init() {
 	if err := loadEnv(); err != nil {
 		fmt.Println("Error loading .env file:", err)
 		return
 	}
 
-	migrationAdapter := NewMigrationAdapter()
+	migrationAdapter := newMigrationAdapter()
 	migrationInit := newMigrationInit()
 	if err := routeCommandLineParameters(os.Args, migrationAdapter, migrationInit); err != nil {
 		displayUsage()
@@ -74,7 +75,7 @@ func migrate(args []string, migrationAdapter migratorInterface, migrationInit mi
 }
 
 func rollback(args []string, migrationAdapter migratorInterface, migrationInit migrationInitInterface) {
-	fmt.Println("Rolling back")
+	fmt.Println(messageRollingBack)
 	conn, provider, count, err := migrationInit.migrationInit(args)
 	if err != nil {
 		fmt.Println(err)
@@ -89,7 +90,7 @@ func rollback(args []string, migrationAdapter migratorInterface, migrationInit m
 }
 
 func refresh(args []string, migrationAdapter migratorInterface, migrationInit migrationInitInterface) {
-	fmt.Println("Rolling back")
+	fmt.Println(messageRollingBack)
 	conn, provider, _, err := migrationInit.migrationInit(args)
 	if err != nil {
 		fmt.Println(err)
@@ -128,7 +129,10 @@ func add(args []string, migrationAdapter migratorInterface) {
 	}
 
 	migrationPath := migrationPath()
-	migrationAdapter.AddNewMigrationFiles(migrationPath, customText)
+	err := migrationAdapter.AddNewMigrationFiles(migrationPath, customText)
+	if err != nil {
+		fmt.Println(err)
+	}
 }
 
 func displayUsage() {

migrator_spy.go → internal/migrator_spy.go

@@ -1,4 +1,4 @@
-package main
+package migrator
 
 import (
 	"database/sql"
@@ -20,26 +20,27 @@ func newSpyMigrator() *spyMigrator {
 	return &spyMigrator{}
 }
 
-func (a *spyMigrator) Migrate(db *sql.DB, provider migrator.MigrationProvider, migrationPath string, count int) error {
+func (a *spyMigrator) Migrate(_ *sql.DB, _ migrator.MigrationProvider, _ string, count int) error {
 	a.migrateCalled++
 	a.lastCount = count
 	return nil
 }
 
-func (a *spyMigrator) Rollback(db *sql.DB, provider migrator.MigrationProvider, migrationPath string, count int) error {
+func (a *spyMigrator) Rollback(_ *sql.DB, _ migrator.MigrationProvider, _ string, count int) error {
 	a.rollbackCalled++
 	a.lastCount = count
 	return nil
 }
 
-func (a *spyMigrator) Refresh(db *sql.DB, provider migrator.MigrationProvider, migrationPath string) error {
+func (a *spyMigrator) Refresh(_ *sql.DB, _ migrator.MigrationProvider, _ string) error {
 	a.refreshCalled++
 	return nil
 }
 
-func (a *spyMigrator) AddNewMigrationFiles(migrationPath string, customText string) {
+func (a *spyMigrator) AddNewMigrationFiles(_ string, customText string) error {
 	a.lastAddCustomText = customText
 	a.addCalled++
+	return nil
 }
 
 func (a *spyMigrator) Report(*sql.DB, migrator.MigrationProvider, string) (string, error) {

mysql_connection.go → internal/mysql_connection.go

@@ -1,13 +1,14 @@
-package main
+package migrator
 
 import (
 	"database/sql"
 	"fmt"
 
+	// This needs to be blank imported as not directly referenced, but required
 	_ "github.com/go-sql-driver/mysql"
 )
 
-func NewMysqlStore(
+func newMysqlStore(
 	host string,
 	port int,
 	user,

postgres_connection.go → internal/postgres_connection.go

@@ -1,13 +1,14 @@
-package main
+package migrator
 
 import (
 	"database/sql"
 	"fmt"
 
+	// This needs to be blank imported as not directly referenced, but required
 	_ "github.com/lib/pq"
 )
 
-type pgsSslMode struct {
+type pgsSSLModeTypes struct {
 	Disable    string
 	Require    string
 	VerifyCa   string
@@ -16,7 +17,7 @@ type pgsSslMode struct {
 	Allow      string
 }
 
-var PgsSslMode = &pgsSslMode{
+var pgsSSLMode = &pgsSSLModeTypes{
 	Disable:    "disable",
 	Require:    "require",
 	VerifyCa:   "verify-ca",
@@ -25,7 +26,7 @@ var PgsSslMode = &pgsSslMode{
 	Allow:      "allow",
 }
 
-func NewPostgresStore(
+func newPostgresStore(
 	host string,
 	port int,
 	user,