1. Refactoring code

2. Expanded documentation
3. Added linters

Author: BorzdeG

.golangci.yml

@@ -56,6 +56,8 @@ linters:
     - wsl
     - ginkgolinter
     - interfacebloat
+    - sloglint
+    - nilnil
 
 linters-settings:
   varnamelen:

README.adoc

@@ -1,15 +1,67 @@
 = test utils
+:toc:
 ---
+
+
 image:https://img.shields.io/github/go-mod/go-version/itbasis/go-test-utils[GitHub go.mod Go version]
 image:https://img.shields.io/badge/godoc-reference-blue.svg[link=https://pkg.go.dev/github.com/itbasis/go-test-utils]
 image:https://img.shields.io/github/v/release/itbasis/go-test-utils[GitHub Release]
 https://goreportcard.com/report/github.com/itbasis/go-test-utils[image:https://goreportcard.com/badge/github.com/itbasis/go-test-utils[Go Report Card]]
 
-. Used by https://onsi.github.io/ginkgo/[Ginkgo] as test framework
-. Used by https://github.com/DATA-DOG/go-sqlmock[sqlmock] with https://gorm.io/gorm[GORM] for SQL testing
+* Used by link:https://onsi.github.io/ginkgo/[Ginkgo] as test framework
+* Used by link:https://github.com/DATA-DOG/go-sqlmock[sqlmock] and link:https://gorm.io/gorm[GORM] for SQL testing
 
-== Get module
+== Install module
 
 ```
-go get -u github.com/itbasis/go-test-utils/v2
+go get -u github.com/itbasis/go-test-utils/v4
 ```
+
+== File utils
+
+* link:files/files.go[] - checks if the path is a regular file and reads its contents
+
+== Database utils
+
+* link:db/sql.go[] - Getting a DB mock and SqlMock without SqlMock options (example option: link:https://github.com/DATA-DOG/go-sqlmock?tab=readme-ov-file#customize-sql-query-matching[QueryMatcherOptions])
+* link:db/gorm.go[] - Getting a GORM and SqlMock instances
+
+== Ginkgo utils
+
+* link:ginkgo/ginkgo.go[] - Adds slog support to tests and code under test
+
+[source,go]
+----
+package demo
+
+import (
+	"testing"
+
+	"github.com/itbasis/go-test-utils/v4/ginkgo"
+)
+
+func TestSuite(t *testing.T) {
+	ginkgo.InitGinkgoSuite(t, "Sample Suite")
+}
+----
+
+Custom slog options
+
+[source,go]
+----
+package demo
+
+import (
+	"log/slog"
+	"testing"
+
+	"github.com/itbasis/go-test-utils/v4/ginkgo"
+)
+
+func TestSuite(t *testing.T) {
+	ginkgo.InitGinkgoSuiteWithSlogOptions(t, "Sample Suite", &slog.HandlerOptions{
+		Level: slog.LevelDebug,
+		AddSource: false,
+	})
+}
+----

db/gorm.go

@@ -0,0 +1,23 @@
+package db
+
+import (
+	"github.com/DATA-DOG/go-sqlmock"
+	"github.com/onsi/gomega"
+	slogGorm "github.com/orandin/slog-gorm"
+	pg "gorm.io/driver/postgres"
+	"gorm.io/gorm"
+)
+
+func NewMockForGorm(dialector gorm.Dialector) *gorm.DB {
+	var gormDb, err = gorm.Open(dialector, &gorm.Config{Logger: slogGorm.New()})
+
+	gomega.Expect(err).To(gomega.Succeed())
+
+	return gormDb
+}
+
+func NewMockForGormPostgreSQL() (sqlmock.Sqlmock, *gorm.DB) {
+	var db, sqlMock = NewSQLMock()
+
+	return sqlMock, NewMockForGorm(pg.New(pg.Config{Conn: db}))
+}

db/mock-db.go

@@ -0,0 +1,16 @@
+package db
+
+import (
+	"database/sql"
+
+	goSqlMock "github.com/DATA-DOG/go-sqlmock"
+	"github.com/onsi/gomega"
+)
+
+func NewSQLMock() (*sql.DB, goSqlMock.Sqlmock) {
+	var db, sqlMock, err = goSqlMock.New()
+
+	gomega.Expect(err).To(gomega.Succeed())
+
+	return db, sqlMock
+}

db/sql.go

@@ -0,0 +1,32 @@
+package ginkgo
+
+import (
+	"log/slog"
+	"testing"
+
+	"github.com/dusted-go/logging/prettylog"
+	"github.com/onsi/ginkgo/v2"
+	"github.com/onsi/gomega"
+)
+
+func InitGinkgoSuite(t *testing.T, name string) {
+	InitGinkgoSuiteWithSlogOptions(
+		t, name,
+		&slog.HandlerOptions{
+			Level:     slog.LevelDebug,
+			AddSource: true,
+		},
+	)
+}
+
+func InitGinkgoSuiteWithSlogOptions(t *testing.T, name string, slogOptions *slog.HandlerOptions) {
+	gomega.RegisterFailHandler(ginkgo.Fail)
+
+	slog.SetDefault(
+		slog.New(
+			prettylog.New(slogOptions, prettylog.WithDestinationWriter(ginkgo.GinkgoWriter)),
+		),
+	)
+
+	ginkgo.RunSpecs(t, name)
+}

ginkgo.go

@@ -1,4 +1,4 @@
-module github.com/itbasis/go-test-utils/v3
+module github.com/itbasis/go-test-utils/v4
 
 go 1.22
 
@@ -7,7 +7,7 @@ require (
 	github.com/dusted-go/logging v1.3.0
 	github.com/onsi/ginkgo/v2 v2.20.0
 	github.com/onsi/gomega v1.34.1
-	github.com/orandin/slog-gorm v1.3.2
+	github.com/orandin/slog-gorm v1.4.0
 	gorm.io/driver/postgres v1.5.9
 	gorm.io/gorm v1.25.11
 )

ginkgo/ginkgo.go

@@ -35,8 +35,8 @@ github.com/onsi/ginkgo/v2 v2.20.0 h1:PE84V2mHqoT1sglvHc8ZdQtPcwmvvt29WLEEO3xmdZw
 github.com/onsi/ginkgo/v2 v2.20.0/go.mod h1:lG9ey2Z29hR41WMVthyJBGUBcBhGOtoPF2VFMvBXFCI=
 github.com/onsi/gomega v1.34.1 h1:EUMJIKUjM8sKjYbtxQI9A4z2o+rruxnzNvpknOXie6k=
 github.com/onsi/gomega v1.34.1/go.mod h1:kU1QgUvBDLXBJq618Xvm2LUX6rSAfRaFRTcdOeDLwwY=
-github.com/orandin/slog-gorm v1.3.2 h1:C0lKDQPAx/pF+8K2HL7bdShPwOEJpPM0Bn80zTzxU1g=
-github.com/orandin/slog-gorm v1.3.2/go.mod h1:MoZ51+b7xE9lwGNPYEhxcUtRNrYzjdcKvA8QXQQGEPA=
+github.com/orandin/slog-gorm v1.4.0 h1:FgA8hJufF9/jeNSYoEXmHPPBwET2gwlF3B85JdpsTUU=
+github.com/orandin/slog-gorm v1.4.0/go.mod h1:MoZ51+b7xE9lwGNPYEhxcUtRNrYzjdcKvA8QXQQGEPA=
 github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=