integration test suite (#13)

- adds a list of tests to execute in order
- fixing bugs that I find along the way
- the same test runs should work the same regardless of database type
- these call the compiled binary and make real database requests
- currently it requires a fresh database and won't do any cleanup
  - great for CI, annoying for developers 😢 
- currently writing the suite in Node.js... and it requires a globally installed package... 😭 
  - eventually the tests should be rewritten in idiomatic Go

Makefile

@@ -26,9 +26,18 @@ publish: build
 	git tag "v$(MIG_VERSION)"
 	git push origin main "v$(MIG_VERSION)"
 
+# unit tests
 test: build
 	go test -v ./...
 
+# integration tests
+#integration: build
+#	cd tests/postgres
+#	sh ../test.mjs
+#	cd ../mysql
+#	sh ../test.mjs
+#	cd ../..
+
 clean:
 	rm mig || true
 	rm mig-linux-amd64 || true

README.md

@@ -162,7 +162,15 @@ make
 
 ### Testing
 
-The following commands let you easily spin up databases within Docker for testing:
+There are some unit tests. Those can be run with the following command:
+
+```sh
+make test
+```
+
+However most of the tests are available as integration tests. Those require active databases.
+
+The following commands spin up databases within Docker for local testing:
 
 ```sh
 docker run --name some-postgres -p 5432:5432 \
@@ -172,3 +180,19 @@ docker run --name some-mysql -p 3306:3306 \
 ```
 
 The `tests/<DBMS>` directories contain config files and migrations to experiment with functionality.
+
+Run the following commands to run the different integration tests:
+
+```sh
+npm install -g zx
+
+pushd tests/postgres
+node ../test.mjs
+popd
+
+pushd tests/mysql
+node ../test.mjs
+popd
+```
+
+Unfortunately the integration tests currently require that Node.js also be installed. This will be fixed in the future.

commands/dispatch.go

@@ -9,9 +9,6 @@ import (
 
 func Dispatch(cfg config.MigConfig, subcommands []string) result.Response {
 	var res result.Response
-	if len(subcommands) == 0 {
-		res.SetError("usage: mig <command>", "command_usage")
-	}
 
 	switch subcommands[0] {
 	case "create":

commands/status.go

@@ -86,6 +86,7 @@ func CommandStatus(cfg config.MigConfig) result.Response {
 
 	if !existMigrations && !existLock {
 		res := result.NewError("The tables used for tracking migrations are missing.", "missing_tables")
+		res.ExitStatus = 9
 
 		res.AddErrorLn(color.WhiteString("This likely means that mig hasn't yet been initialized."))
 		res.AddErrorLn(color.WhiteString("This can be solved by running the following command:"))
@@ -96,6 +97,7 @@ func CommandStatus(cfg config.MigConfig) result.Response {
 
 	if !existMigrations {
 		res := *result.NewError("The 'migrations' table is missing but the 'migrations_lock' table is present!", "missing_migrations_table")
+		res.ExitStatus = 9
 		res.AddErrorLn("This might mean that data has been corrupted and that migration status is missing.")
 		res.AddErrorLn("Consider looking into the root cause of the problem.")
 		res.AddErrorLn("The quickest fix is to delete the lock table and initialize again:")
@@ -106,6 +108,7 @@ func CommandStatus(cfg config.MigConfig) result.Response {
 
 	if !existLock {
 		res := *result.NewError("The 'migrations' table is present but the 'migrations_lock' table is missing!", "missing_lock_table")
+		res.ExitStatus = 9
 		res.AddErrorLn("This might mean that data has been corrupted.")
 		res.AddErrorLn("Consider looking into the cause of the problem.")
 		res.AddErrorLn("The quickest fix is backup the migrations table data, initialize again, then restore the data:")

main.go

@@ -13,7 +13,9 @@ func main() {
 
 	var res result.Response
 
-	if err != nil && len(subcommands) == 1 && subcommands[0] == "version" {
+	if err != nil && len(subcommands) == 0 {
+		res.SetError("usage: mig <command>", "command_usage")
+	} else if err != nil && len(subcommands) == 1 && subcommands[0] == "version" {
 		res = commands.CommandVersion(cfg)
 	} else if err == nil {
 		res = commands.Dispatch(cfg, subcommands)