tests: integrate ansible playbooks with test suite

Author: xiam

.github/workflows/test.yml

@@ -26,11 +26,11 @@ jobs:
         with:
           go-version: ${{ matrix.go-version }}
 
-      - name: Set env vars
+      - name: Configure environment
         run: |
           echo "GOARCH=amd64" >> $GITHUB_ENV
           echo "DB_HOST=127.0.0.1" >> $GITHUB_ENV
           echo "UPPER_DB_LOG=ERROR" >> $GITHUB_ENV
 
-      - name: Run target
+      - name: Run tests
         run: make test

Makefile

@@ -1,43 +1,10 @@
-SHELL                 ?= bash
-CPU_CORES             ?= $(shell nproc)
-
-PARALLEL_FLAGS        ?= --halt-on-error 2 --jobs=$(CPU_CORES) -v -u
-
-TEST_FLAGS            ?= -v -failfast -race -timeout 20m
-
 UPPER_DB_LOG          ?= WARN
 
-export TEST_FLAGS
-export PARALLEL_FLAGS
 export UPPER_DB_LOG
 
-test: go-test-internal test-adapters
-
-benchmark: go-benchmark-internal
-
-go-benchmark-%:
+bench:
 	go test -v -benchtime=500ms -bench=. ./$*/...
 
-go-test-%:
-	go test -v ./$*/...
-
-test-adapters: \
-	test-adapter-postgresql \
-	test-adapter-cockroachdb \
-	test-adapter-mysql \
-	test-adapter-mssql \
-	test-adapter-sqlite \
-	test-adapter-ql \
-	test-adapter-mongo
-
-test-adapter-%:
-	($(MAKE) -C adapter/$* test-extended || exit 1)
-
-test-generic:
-	export TEST_FLAGS="-run TestGeneric"; \
-	$(MAKE) test-adapters
+test:
+	$(MAKE) -C tests
 
-goimports:
-	for FILE in $$(find -name "*.go" | grep -v vendor); do \
-		goimports -w $$FILE; \
-	done

tests/Makefile

@@ -1,13 +1,14 @@
 TEST_FLAGS ?=
 
+all: test-all
 
 test:
 	go test \
 		-failfast \
 		-timeout 30m \
 		-race \
-		$(TEST_FLAGS) \
-		-v
+		-v \
+		$(TEST_FLAGS)
 
 test-all:
 	TEST_FLAGS="-run ." $(MAKE) test

tests/adapter_config_test.go

@@ -0,0 +1,193 @@
+package db_test
+
+import (
+	"fmt"
+	"log"
+	"math/rand"
+	"net"
+	"os"
+	"strconv"
+	"time"
+
+	"github.com/stretchr/testify/suite"
+	"github.com/upper/db/v4"
+
+	"github.com/upper/db/v4/adapter/cockroachdb"
+	"github.com/upper/db/v4/adapter/mongo"
+	"github.com/upper/db/v4/adapter/mssql"
+	"github.com/upper/db/v4/adapter/mysql"
+	"github.com/upper/db/v4/adapter/postgresql"
+
+	cockroachdbtest "github.com/upper/db/v4/tests/cockroachdb"
+	mongotest "github.com/upper/db/v4/tests/mongo"
+	mssqltest "github.com/upper/db/v4/tests/mssql"
+	mysqltest "github.com/upper/db/v4/tests/mysql"
+	postgresqltest "github.com/upper/db/v4/tests/postgresql"
+)
+
+const (
+	defaultUsername = "upper_db_user"
+	defaultPassword = "upp3r//S3cr37"
+	defaultDatabase = "upper_db"
+	defaultHost     = "127.0.0.1"
+	defaultTimeZone = "Canada/Eastern"
+)
+
+const (
+	minPort = 40000
+	maxPort = 60000
+)
+
+const TimeZone = defaultTimeZone
+
+var defaultTimeLocation, _ = time.LoadLocation(TimeZone)
+
+type Helper interface {
+	Session() db.Session
+
+	Adapter() string
+
+	SetUp() error
+	TearDown() error
+}
+
+type Suite struct {
+	suite.Suite
+
+	Helper
+}
+
+func (s *Suite) AfterTest(suiteName, testName string) {
+	err := s.TearDown()
+	s.Require().NoError(err)
+}
+
+func (s *Suite) BeforeTest(suiteName, testName string) {
+	err := s.SetUp()
+	s.Require().NoError(err)
+}
+
+func init() {
+	defaultMap := map[string]string{
+		"DB_USERNAME": defaultUsername,
+		"DB_PASSWORD": defaultPassword,
+		"DB_NAME":     defaultDatabase,
+		"DB_HOST":     defaultHost,
+		"DB_TIMEZONE": defaultTimeZone,
+	}
+
+	for k, v := range defaultMap {
+		if os.Getenv(k) == "" {
+			os.Setenv(k, v)
+		}
+	}
+}
+
+func getRandomPort() int {
+	for i := 0; i < 5; i++ {
+		port := minPort + rand.Intn(maxPort-minPort)
+
+		li, err := net.Listen("tcp", defaultHost+":"+strconv.Itoa(port))
+		if err == nil {
+			li.Close()
+			return port
+		}
+	}
+
+	log.Fatalf("could not find a free port")
+
+	return 0
+}
+
+func newPostgreSQLTestHelper() func() (Helper, string, int) {
+	return func() (Helper, string, int) {
+		host, port := os.Getenv("DB_HOST"), getRandomPort()
+
+		connURL := postgresql.ConnectionURL{
+			Database: os.Getenv("DB_NAME"),
+			User:     os.Getenv("DB_USERNAME"),
+			Password: os.Getenv("DB_PASSWORD"),
+			Host:     host + ":" + fmt.Sprintf("%d", port),
+			Options: map[string]string{
+				"timezone": os.Getenv("DB_TIMEZONE"),
+			},
+		}
+
+		helper := postgresqltest.NewHelper(connURL)
+		return helper, host, port
+	}
+}
+
+func newMySQLTestHelper() func() (Helper, string, int) {
+	return func() (Helper, string, int) {
+		host, port := os.Getenv("DB_HOST"), getRandomPort()
+
+		connURL := mysql.ConnectionURL{
+			Database: os.Getenv("DB_NAME"),
+			User:     os.Getenv("DB_USERNAME"),
+			Password: os.Getenv("DB_PASSWORD"),
+			Host:     host + ":" + fmt.Sprintf("%d", port),
+			Options: map[string]string{
+				"parseTime": "true",
+				"time_zone": fmt.Sprintf(`'%s'`, TimeZone),
+				"loc":       TimeZone,
+			},
+		}
+
+		helper := mysqltest.NewHelper(connURL)
+		return helper, host, port
+	}
+}
+
+func newCockroachDBTestHelper() func() (Helper, string, int) {
+	return func() (Helper, string, int) {
+		host, port := os.Getenv("DB_HOST"), getRandomPort()
+
+		connURL := cockroachdb.ConnectionURL{
+			Database: os.Getenv("DB_NAME"),
+			User:     os.Getenv("DB_USERNAME"),
+			Password: os.Getenv("DB_PASSWORD"),
+			Host:     host + ":" + fmt.Sprintf("%d", port),
+			Options: map[string]string{
+				"timezone": os.Getenv("DB_TIMEZONE"),
+			},
+		}
+
+		helper := cockroachdbtest.NewHelper(connURL)
+		return helper, host, port
+	}
+}
+
+func newMSSQLTestHelper() func() (Helper, string, int) {
+	return func() (Helper, string, int) {
+		host, port := os.Getenv("DB_HOST"), getRandomPort()
+
+		connURL := mssql.ConnectionURL{
+			Database: os.Getenv("DB_NAME"),
+			User:     os.Getenv("DB_USERNAME"),
+			Password: os.Getenv("DB_PASSWORD"),
+			Host:     host + ":" + fmt.Sprintf("%d", port),
+			Options:  map[string]string{},
+		}
+
+		helper := mssqltest.NewHelper(connURL)
+		return helper, host, port
+	}
+}
+
+func newMongoDBTestHelper() func() (Helper, string, int) {
+	return func() (Helper, string, int) {
+		host, port := os.Getenv("DB_HOST"), getRandomPort()
+
+		connURL := mongo.ConnectionURL{
+			Database: os.Getenv("DB_NAME"),
+			User:     os.Getenv("DB_USERNAME"),
+			Password: os.Getenv("DB_PASSWORD"),
+			Host:     host + ":" + fmt.Sprintf("%d", port),
+			Options:  map[string]string{},
+		}
+
+		helper := mongotest.NewHelper(connURL)
+		return helper, host, port
+	}
+}

tests/ansible/ansible.cfg

@@ -1,2 +1,4 @@
 [defaults]
 inventory = ./inventory.yml
+strategy = free
+gather_facts = False

tests/ansible/inventory.yml

@@ -7,48 +7,34 @@ all:
     db_password: upp3r//S3cr37
     db_name: upper_db
     container_bind_ip: "127.0.0.1"
+    container_bind_port: "{{ lookup('env', 'CONTAINER_BIND_PORT') }}"
     container_name_prefix: "upper_db_"
     health_check_retries: 10
     health_check_delay: 3
-    postgresql_base_port: 5432
-    mysql_base_port: 3306
-    cockroachdb_base_port: 26257
-    mssql_base_port: 1433
-    mongodb_base_port: 27017
   hosts:
     postgresql-17:
       postgresql_version: "17"
-      container_bind_port: "{{ postgresql_base_port }}"
     postgresql-16:
       postgresql_version: "16"
-      container_bind_port: "{{ postgresql_base_port + 1 }}"
     postgresql-15:
       postgresql_version: "15"
-      container_bind_port: "{{ postgresql_base_port + 2 }}"
+    mysql-latest:
+      mysql_version: "latest"
     mysql-lts:
       mysql_version: "lts"
-      container_bind_port: "{{ mysql_base_port }}"
     mysql-5:
       mysql_version: "5"
-      container_bind_port: "{{ mysql_base_port + 1 }}"
     cockroachdb-v23:
       cockroachdb_version: "v23.2.6"
-      container_bind_port: "{{ cockroachdb_base_port }}"
     cockroachdb-v22:
       cockroachdb_version: "v22.2.19"
-      container_bind_port: "{{ cockroachdb_base_port + 1 }}"
     cockroachdb-v21:
       cockroachdb_version: "v21.2.17"
-      container_bind_port: "{{ cockroachdb_base_port + 2 }}"
     mssql-2022:
       mssql_version: "2022-latest"
-      container_bind_port: "{{ mssql_base_port }}"
     mssql-2019:
       mssql_version: "2019-latest"
-      container_bind_port: "{{ mssql_base_port + 1 }}"
     mongodb-8:
       mongodb_version: "8"
-      container_bind_port: "{{ mongodb_base_port }}"
     mongodb-7:
       mongodb_version: "7"
-      container_bind_port: "{{ mongodb_base_port + 1 }}"

tests/ansible/playbook.yml

@@ -1,6 +1,3 @@
-- hosts: "all"
-  strategy: free
-  become: true
 - hosts: "postgresql-*"
   roles:
     - role: postgresql

tests/ansible/roles/cockroachdb/tasks/main.yml

@@ -2,6 +2,7 @@
   set_fact:
     container_name: "{{ container_name_prefix }}cockroachdb_{{ cockroachdb_version }}"
     container_image: "{{ docker_public_registry }}cockroachdb/cockroach:{{ cockroachdb_version }}"
+    container_bind_port: "{{ 26257 if container_bind_port == '' else container_bind_port }}"
   tags:
     - up
     - down

tests/ansible/roles/mongodb/tasks/main.yml

@@ -2,6 +2,7 @@
   set_fact:
     container_name: "{{ container_name_prefix }}mongo_{{ mongodb_version }}"
     container_image: "{{ docker_public_registry }}mongo:{{ mongodb_version }}"
+    container_bind_port: "{{ 27017 if container_bind_port == '' else container_bind_port }}"
   tags:
     - up
     - down

tests/ansible/roles/mssql/tasks/main.yml

@@ -2,6 +2,7 @@
   set_fact:
     container_name: "{{ container_name_prefix }}mssql_{{ mssql_version }}"
     container_image: "mcr.microsoft.com/mssql/server:{{ mssql_version }}"
+    container_bind_port: "{{ 1433 if container_bind_port == '' else container_bind_port }}"
   tags:
     - up
     - down