Add internal test exports and improve golangci-lint configuration

.github/workflows/codeql.yml

@@ -82,7 +82,7 @@ jobs:
                 # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
                 # queries: security-extended,security-and-quality
 
-          # If the analyze step fails for one of the languages you are analyzing with
+          # If the analyze-step fails for one of the languages you are analyzing with
           # "We were unable to automatically build your code", modify the matrix above
           # to set the build mode to "manual" for that language. Then modify this step
           # to build your code.

.golangci.yaml

@@ -1,3 +1,6 @@
+# Copyright the dmorph contributors.
+# SPDX-License-Identifier: MPL-2.0
+
 # Configuration file for golangci-lint
 # See https://golangci-lint.run/usage/configuration/ for more information
 
@@ -9,25 +12,83 @@ run:
 
 linters:
     default: all
-    #enable:
-    #    # Default linters
-    #    - errcheck
-    #    - govet
-    #    - ineffassign
-    #    - staticcheck
-    #    - unused
-    #    # Additional linters
-    #    - gosec
-    #    - misspell
-    #    - revive
-    #    - bodyclose
-    #    - noctx
+
+    disable:
+        - exhaustruct
+        - forbidigo
+        - noinlineerr
+        - nonamedreturns
+        - wsl
+        - wsl_v5
 
     exclusions:
+        warn-unused: true
+
         rules:
-            - path: main_test.go
+            - path: _test\.go
               linters:
-                  - gosec
+                  - cyclop
+                  - dupl
+                  - dupword
+                  - err113
+                  - funlen
+                  - gocognit
+                  - maintidx
+                  - nestif
+
+            - path: examples/
+              linters:
+                  - err113
+
+    settings:
+        cyclop:
+            max-complexity: 25
+
+        depguard:
+            rules:
+                main:
+                    files:
+                        - $all
+                        - "!$test"
+                        - "!**/examples/**/*"
+                    allow:
+                        - $gostd
+                        - gopkg.in/yaml.v3
+                        - github.com/Masterminds/sprig/v3
+                test:
+                    files:
+                        - $test
+                        - "**/examples/**/*"
+                    allow:
+                        - $gostd
+                        - gopkg.in/yaml.v3
+                        - github.com/Masterminds/sprig/v3
+                        - github.com/stretchr/testify/assert
+                        - github.com/AlphaOne1/dmorph
+                        - modernc.org/sqlite
+
+        exhaustive:
+            default-signifies-exhaustive: true
+
+        mnd:
+            ignored-numbers:
+                - "2"
+
+        paralleltest:
+            ignore-missing: true
+
+        perfsprint:
+            errorf: false
+
+        testpackage:
+            skip-regexp: internal_test\.go
+
+        varnamelen:
+            max-distance: 10
+
+        whitespace:
+            multi-if: true
+            multi-func: true
 
 issues:
     max-issues-per-linter: 0

dialects.go

@@ -11,7 +11,7 @@ import (
 
 // BaseDialect is a convenience type for databases that manage the necessary operations solely using
 // queries. Defining the CreateTemplate, AppliedTemplate and RegisterTemplate enables the BaseDialect to
-// perform all the necessary operation to fulfill the Dialect interface.
+// perform all the necessary operations to fulfill the Dialect interface.
 type BaseDialect struct {
 	CreateTemplate   string // statement ensuring the existence of the migration table
 	AppliedTemplate  string // statement getting applied migrations ordered by application date
@@ -32,11 +32,13 @@ func (b BaseDialect) EnsureMigrationTableExists(db *sql.DB, tableName string) er
 
 	if execErr != nil {
 		rollbackErr := tx.Rollback()
+
 		return errors.Join(execErr, rollbackErr)
 	}
 
 	if err := tx.Commit(); err != nil {
 		rollbackErr := tx.Rollback()
+
 		return errors.Join(err, rollbackErr)
 	}
 

dialects_test.go

@@ -1,7 +1,7 @@
 // Copyright the DMorph contributors.
 // SPDX-License-Identifier: MPL-2.0
 
-package dmorph
+package dmorph_test
 
 import (
 	"database/sql"
@@ -10,6 +10,8 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+
+	"github.com/AlphaOne1/dmorph"
 )
 
 // TestDialectStatements verifies that each database dialect has valid and
@@ -19,15 +21,15 @@ func TestDialectStatements(t *testing.T) {
 	// that the statements for the databases are somehow filled
 	tests := []struct {
 		name   string
-		caller func() BaseDialect
+		caller func() dmorph.BaseDialect
 	}{
-		{name: "CSVQ", caller: DialectCSVQ},
-		{name: "DB2", caller: DialectDB2},
-		{name: "MSSQL", caller: DialectMSSQL},
-		{name: "MySQL", caller: DialectMySQL},
-		{name: "Oracle", caller: DialectOracle},
-		{name: "Postgres", caller: DialectPostgres},
-		{name: "SQLite", caller: DialectSQLite},
+		{name: "CSVQ", caller: dmorph.DialectCSVQ},
+		{name: "DB2", caller: dmorph.DialectDB2},
+		{name: "MSSQL", caller: dmorph.DialectMSSQL},
+		{name: "MySQL", caller: dmorph.DialectMySQL},
+		{name: "Oracle", caller: dmorph.DialectOracle},
+		{name: "Postgres", caller: dmorph.DialectPostgres},
+		{name: "SQLite", caller: dmorph.DialectSQLite},
 	}
 
 	re := regexp.MustCompile("%s")
@@ -77,17 +79,17 @@ func TestCallsOnClosedDB(t *testing.T) {
 	}
 
 	assert.Error(t,
-		DialectSQLite().EnsureMigrationTableExists(db, "irrelevant"),
+		dmorph.DialectSQLite().EnsureMigrationTableExists(db, "irrelevant"),
 		"expected error on closed database")
 
-	_, err := DialectSQLite().AppliedMigrations(db, "irrelevant")
+	_, err := dmorph.DialectSQLite().AppliedMigrations(db, "irrelevant")
 	assert.Error(t, err, "expected error on closed database")
 }
 
 // TestEnsureMigrationTableExistsSQLError tests the EnsureMigrationTableExists function
 // for handling SQL errors during execution.
 func TestEnsureMigrationTableExistsSQLError(t *testing.T) {
-	d := BaseDialect{
+	d := dmorph.BaseDialect{
 		CreateTemplate: `
             CRATE TABLE test (
                 id        VARCHAR(255) PRIMARY KEY,
@@ -114,9 +116,10 @@ func TestEnsureMigrationTableExistsSQLError(t *testing.T) {
 	assert.Error(t, d.EnsureMigrationTableExists(db, "test"), "expected error")
 }
 
-// TestEnsureMigrationTableExistsCommitError tests the behavior of EnsureMigrationTableExists when a commit error occurs.
+// TestEnsureMigrationTableExistsCommitError tests the behavior of EnsureMigrationTableExists
+// when a commit error occurs.
 func TestEnsureMigrationTableExistsCommitError(t *testing.T) {
-	d := BaseDialect{
+	d := dmorph.BaseDialect{
 		CreateTemplate: `
 			CREATE TABLE t0 (
 			    id INTEGER PRIMARY KEY

exports_internal_test.go

@@ -0,0 +1,15 @@
+package dmorph
+
+import "database/sql"
+
+// The exported names in this file are only used for internal testing and are not part of the public API.
+
+var (
+	TapplyStepsStream    = applyStepsStream
+	TmigrationFromFileFS = migrationFromFileFS
+	TmigrationOrder      = migrationOrder
+)
+
+func (m *Morpher) TapplyMigrations(db *sql.DB, lastMigration string) error {
+	return m.applyMigrations(db, lastMigration)
+}

file_migration.go

@@ -72,6 +72,7 @@ func WithMigrationsFromFS(d fs.ReadDirFS) MorphOption {
 		if err == nil {
 			for _, entry := range dirEntry {
 				morpher.Log.Info("entry", slog.String("name", entry.Name()))
+
 				if entry.Type().IsRegular() {
 					morpher.Migrations = append(morpher.Migrations,
 						migrationFromFileFS(entry.Name(), d, morpher.Log))
@@ -83,7 +84,7 @@ func WithMigrationsFromFS(d fs.ReadDirFS) MorphOption {
 	}
 }
 
-// migrationFromFileFS creates a FileMigration instance for a specific migration file from an fs.FS directory.
+// migrationFromFileFS creates a FileMigration instance for a specific migration file from a fs.FS directory.
 func migrationFromFileFS(name string, dir fs.FS, log *slog.Logger) FileMigration {
 	return FileMigration{
 		Name: name,
@@ -105,8 +106,8 @@ func migrationFromFileFS(name string, dir fs.FS, log *slog.Logger) FileMigration
 // applyStepsStream executes database migration steps read from an io.Reader, separated by semicolons, in a transaction.
 // Returns the corresponding error if any step execution fails. Also, as some database drivers or engines seem to not
 // support comments, leading comments are removed. This function does not undertake efforts to scan the SQL to find
-// other comments. So leading comments telling what a step is going to do, work. But comments in the middle of a
-// statement will not be removed. At least with SQLite this will lead to hard to find errors.
+// other comments. Such leading comments telling what a step is going to do, work. But comments in the middle of a
+// statement will not be removed. At least with SQLite this will lead to hard-to-find errors.
 func applyStepsStream(tx *sql.Tx, r io.Reader, id string, log *slog.Logger) error {
 	buf := bytes.Buffer{}
 
@@ -138,7 +139,7 @@ func applyStepsStream(tx *sql.Tx, r io.Reader, id string, log *slog.Logger) erro
 		}
 	}
 
-	// cleanup after, for final statement without the closing ; on a new line
+	// cleanup after, for the final statement without the closing `;` on a new line
 	if buf.Len() > 0 {
 		log.Info("migration step",
 			slog.String("id", id),

file_migration_test.go

@@ -1,7 +1,7 @@
 // Copyright the DMorph contributors.
 // SPDX-License-Identifier: MPL-2.0
 
-package dmorph
+package dmorph_test
 
 import (
 	"bytes"
@@ -12,6 +12,8 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+
+	"github.com/AlphaOne1/dmorph"
 )
 
 func TestWithMigrationFromFile(t *testing.T) {
@@ -31,9 +33,9 @@ func TestWithMigrationFromFile(t *testing.T) {
 		defer func() { _ = db.Close() }()
 	}
 
-	runErr := Run(db,
-		WithDialect(DialectSQLite()),
-		WithMigrationFromFile("testData/01_base_table.sql"))
+	runErr := dmorph.Run(db,
+		dmorph.WithDialect(dmorph.DialectSQLite()),
+		dmorph.WithMigrationFromFile("testData/01_base_table.sql"))
 
 	assert.NoError(t, runErr, "did not expect an error")
 }
@@ -55,21 +57,22 @@ func TestWithMigrationFromFileError(t *testing.T) {
 		defer func() { _ = db.Close() }()
 	}
 
-	runErr := Run(db,
-		WithDialect(DialectSQLite()),
-		WithMigrationFromFile("testData/00_non_existent.sql"))
+	runErr := dmorph.Run(db,
+		dmorph.WithDialect(dmorph.DialectSQLite()),
+		dmorph.WithMigrationFromFile("testData/00_non_existent.sql"))
 
 	var pathErr *fs.PathError
 	assert.ErrorAs(t, runErr, &pathErr, "unexpected error")
 }
 
-// TestMigrationFromFileFSError validates that migrationFromFileFS returns an error when the specified file does not exist.
+// TestMigrationFromFileFSError validates that migrationFromFileFS returns an error
+// when the specified file does not exist.
 func TestMigrationFromFileFSError(t *testing.T) {
 	dir, dirErr := os.OpenRoot("testData")
 
 	assert.NoError(t, dirErr, "could not open test data directory")
 
-	mig := migrationFromFileFS("nonexistent", dir.FS(), slog.Default())
+	mig := dmorph.TmigrationFromFileFS("nonexistent", dir.FS(), slog.Default())
 
 	err := mig.Migrate(nil)
 
@@ -101,7 +104,7 @@ func TestApplyStepsStreamError(t *testing.T) {
 
 	assert.NoError(t, txErr, "expected no tx error")
 
-	err := applyStepsStream(tx, &buf, "test", slog.Default())
+	err := dmorph.TapplyStepsStream(tx, &buf, "test", slog.Default())
 
 	assert.Error(t, err, "expected error")
 
@@ -114,7 +117,7 @@ func TestApplyStepsStreamError(t *testing.T) {
 	buf.Reset()
 	buf.WriteString("utter nonsense\n;")
 
-	err = applyStepsStream(tx, &buf, "test", slog.Default())
+	err = dmorph.TapplyStepsStream(tx, &buf, "test", slog.Default())
 
 	assert.Error(t, err, "expected error")