go-sqlmock | Sql mock driver for golang to test database interactions | Unit Testing library

by DATA-DOG Go Version: v1.5.0 License: Non-SPDX

Download this library from

kandi X-RAY | go-sqlmock Summary

go-sqlmock is a Go library typically used in Testing, Unit Testing applications. go-sqlmock has no bugs, it has no vulnerabilities and it has medium support. However go-sqlmock has a Non-SPDX License. You can download it from GitHub.

Sql mock driver for golang to test database interactions

Support

Quality

Security

License

Reuse

kandi-support Support

go-sqlmock has a medium active ecosystem.
It has 3537 star(s) with 289 fork(s). There are 36 watchers for this library.
It had no major release in the last 12 months.
There are 41 open issues and 140 have been closed. On average issues are closed in 34 days. There are 8 open pull requests and 0 closed requests.
It has a neutral sentiment in the developer community.
The latest version of go-sqlmock is v1.5.0

go-sqlmock Support

Best in #Unit Testing

Average in #Unit Testing

go-sqlmock Support

Best in #Unit Testing

Average in #Unit Testing

quality kandi Quality

go-sqlmock has 0 bugs and 0 code smells.

go-sqlmock Quality

Best in #Unit Testing

Average in #Unit Testing

go-sqlmock Quality

Best in #Unit Testing

Average in #Unit Testing

security Security

go-sqlmock has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.
go-sqlmock code analysis shows 0 unresolved vulnerabilities.
There are 0 security hotspots that need review.

go-sqlmock Security

Best in #Unit Testing

Average in #Unit Testing

go-sqlmock Security

Best in #Unit Testing

Average in #Unit Testing

license License

go-sqlmock has a Non-SPDX License.
Non-SPDX licenses can be open source with a non SPDX compliant license, or non open source licenses, and you need to review them closely before use.

go-sqlmock License

Best in #Unit Testing

Average in #Unit Testing

go-sqlmock License

Best in #Unit Testing

Average in #Unit Testing

build Reuse

go-sqlmock releases are available to install and integrate.
Installation instructions are not available. Examples and code snippets are available.
It has 5359 lines of code, 290 functions and 44 files.
It has high code complexity. Code complexity directly impacts maintainability of the code.

go-sqlmock Reuse

Best in #Unit Testing

Average in #Unit Testing

go-sqlmock Reuse

Best in #Unit Testing

Average in #Unit Testing

Top functions reviewed by kandi - BETA

Coming Soon for all Libraries!

Currently covering the most popular Java, JavaScript and Python libraries. See a SAMPLE HERE.
kandi's functional review helps you automatically verify the functionalities of the libraries and avoid rework.

go-sqlmock Key Features

Sql mock driver for golang to test database interactions

go-sqlmock Examples and Code Snippets

See all related Code Snippets

Install

Copy

Download

go get github.com/DATA-DOG/go-sqlmock

Something you may want to test, assuming you use the

Copy

Download

package main

import (
	"database/sql"

	_ "github.com/go-sql-driver/mysql"
)

func recordStats(db *sql.DB, userID, productID int64) (err error) {
	tx, err := db.Begin()
	if err != nil {
		return
	}

	defer func() {
		switch err {
		case nil:
			err = tx.Commit()
		default:
			tx.Rollback()
		}
	}()

	if _, err = tx.Exec("UPDATE products SET views = views + 1"); err != nil {
		return
	}
	if _, err = tx.Exec("INSERT INTO product_viewers (user_id, product_id) VALUES (?, ?)", userID, productID); err != nil {
		return
	}
	return
}

func main() {
	// @NOTE: the real connection is not required for tests
	db, err := sql.Open("mysql", "root@/blog")
	if err != nil {
		panic(err)
	}
	defer db.Close()

	if err = recordStats(db, 1 /*some user id*/, 5 /*some product id*/); err != nil {
		panic(err)
	}
}

Tests with sqlmock

Copy

Download

package main

import (
	"fmt"
	"testing"

	"github.com/DATA-DOG/go-sqlmock"
)

// a successful case
func TestShouldUpdateStats(t *testing.T) {
	db, mock, err := sqlmock.New()
	if err != nil {
		t.Fatalf("an error '%s' was not expected when opening a stub database connection", err)
	}
	defer db.Close()

	mock.ExpectBegin()
	mock.ExpectExec("UPDATE products").WillReturnResult(sqlmock.NewResult(1, 1))
	mock.ExpectExec("INSERT INTO product_viewers").WithArgs(2, 3).WillReturnResult(sqlmock.NewResult(1, 1))
	mock.ExpectCommit()

	// now we execute our method
	if err = recordStats(db, 2, 3); err != nil {
		t.Errorf("error was not expected while updating stats: %s", err)
	}

	// we make sure that all expectations were met
	if err := mock.ExpectationsWereMet(); err != nil {
		t.Errorf("there were unfulfilled expectations: %s", err)
	}
}

// a failing test case
func TestShouldRollbackStatUpdatesOnFailure(t *testing.T) {
	db, mock, err := sqlmock.New()
	if err != nil {
		t.Fatalf("an error '%s' was not expected when opening a stub database connection", err)
	}
	defer db.Close()

	mock.ExpectBegin()
	mock.ExpectExec("UPDATE products").WillReturnResult(sqlmock.NewResult(1, 1))
	mock.ExpectExec("INSERT INTO product_viewers").
		WithArgs(2, 3).
		WillReturnError(fmt.Errorf("some error"))
	mock.ExpectRollback()

	// now we execute our method
	if err = recordStats(db, 2, 3); err == nil {
		t.Errorf("was expecting an error, but there was none")
	}

	// we make sure that all expectations were met
	if err := mock.ExpectationsWereMet(); err != nil {
		t.Errorf("there were unfulfilled expectations: %s", err)
	}
}

Customize SQL query matching

Copy

Download

	db, mock, err := sqlmock.New(sqlmock.QueryMatcherOption(sqlmock.QueryMatcherEqual))

Matching arguments like time.Time

Copy

Download

type AnyTime struct{}

// Match satisfies sqlmock.Argument interface
func (a AnyTime) Match(v driver.Value) bool {
	_, ok := v.(time.Time)
	return ok
}

func TestAnyTimeArgument(t *testing.T) {
	t.Parallel()
	db, mock, err := New()
	if err != nil {
		t.Errorf("an error '%s' was not expected when opening a stub database connection", err)
	}
	defer db.Close()

	mock.ExpectExec("INSERT INTO users").
		WithArgs("john", AnyTime{}).
		WillReturnResult(NewResult(1, 1))

	_, err = db.Exec("INSERT INTO users(name, created_at) VALUES (?, ?)", "john", time.Now())
	if err != nil {
		t.Errorf("error '%s' was not expected, while inserting a row", err)
	}

	if err := mock.ExpectationsWereMet(); err != nil {
		t.Errorf("there were unfulfilled expectations: %s", err)
	}
}

Run tests

Copy

Download

go test -race

Issue with go-sqlmock testing in the expected query part

Copy

Download

    package unit
    
    import (
        "encoding/json"
        "fmt"
        "math/rand"
        "net/http"
        "net/http/httptest"
        "regexp"
        "testing"
    
        "github.com/DATA-DOG/go-sqlmock"
        "github.com/SamiAlsubhi/go/controllers"
        "github.com/SamiAlsubhi/go/routes"
        "github.com/gin-gonic/gin"
        "github.com/stretchr/testify/assert"
        "github.com/stretchr/testify/require"
        "github.com/stretchr/testify/suite"
        "gorm.io/driver/postgres"
        "gorm.io/gorm"
    )
    
    type Suite struct {
        suite.Suite
        DB     *gorm.DB
        mock   sqlmock.Sqlmock
        router *gin.Engine
    }
    
    func (s *Suite) SetupSuite() {
        //t.Logf("setup start")
        conn, mock, err := sqlmock.New(sqlmock.QueryMatcherOption(sqlmock.QueryMatcherRegexp))
        if err != nil || conn == nil {
            panic(fmt.Sprintf("Failed to open mock sql db, got error: %v", err))
        }
        s.mock = mock
    
        dialector := postgres.New(postgres.Config{
            DSN:                  "sqlmock_db_0",
            DriverName:           "postgres",
            Conn:                 conn,
            PreferSimpleProtocol: true,
        })
    
        if db, err := gorm.Open(dialector, &gorm.Config{SkipDefaultTransaction: true}); err != nil || db == nil {
            panic(fmt.Sprintf("Failed to open gorm v2 db, got error: %v", err))
        } else {
            s.DB = db
        }
    
        api := &controllers.API{Db: s.DB, IsTesting: true}
        s.router = routes.SetupRouter(api)
    
    }
    
    func TestSetup(t *testing.T) {
    
        suite.Run(t, new(Suite))
    
    }
    
    // func (s *Suite) AfterTest(_, _ string) {
    //  require.NoError(s.T(), s.mock.ExpectationsWereMet())
    // }
    
    func (s *Suite) Test_GetOTP_Non_Existing_Phone() {
        /*
            This to test getting OTP for a phone number that does not exist in the otps table
        */
        phone := fmt.Sprintf("%v", 90000000+rand.Intn(99999999-90000000))
        s.mock.MatchExpectationsInOrder(false)
    
        s.mock.ExpectQuery(regexp.QuoteMeta(`SELECT count(*) FROM "otps" WHERE phone = $1 AND "otps"."deleted_at" IS NULL`)).
            WithArgs(phone).
            WillReturnRows(sqlmock.NewRows([]string{"count"}).
                AddRow(0))
    
        s.mock.ExpectQuery(regexp.QuoteMeta(
            `INSERT INTO "otps" ("created_at","updated_at","deleted_at","phone","code") VALUES ($1,$2,$3,$4,$5) RETURNING "id"`)).
            WithArgs(sqlmock.AnyArg(), sqlmock.AnyArg(), sqlmock.AnyArg(), phone, sqlmock.AnyArg()).
            WillReturnRows(sqlmock.NewRows([]string{"id"}).
                AddRow(1))
    
        w := httptest.NewRecorder()
        req, err := http.NewRequest("GET", "/api/auth/get-otp/"+phone, nil)
        require.NoError(s.T(), err)
    
        s.router.ServeHTTP(w, req)
        assert.Equal(s.T(), 200, w.Code)
        //parse response
        var response gin.H
        err = json.Unmarshal(w.Body.Bytes(), &response)
        require.NoError(s.T(), err)
        _, ok := response["expiry_in"]
        assert.True(s.T(), ok)
    
        require.NoError(s.T(), s.mock.ExpectationsWereMet())
    
    }

`could not match actual sql` error while mocking gorm `updates` using go-sqlmock?

Copy

Download

db, mock, err := sqlmock.New(sqlmock.QueryMatcherOption(sqlmock.QueryMatcherEqual))

How to mock gorm insert with go-sql (postgres)

Copy

Download

mock.ExpectBegin()
mock.ExpectExec(regexp.QuoteMeta("INSERT INTO \"tests\" (\"first_name\") VALUES (?)")).WithArgs("c").WillReturnResult(sqlmock.NewResult(1, 1))
mock.ExpectCommit()

See all related Code Snippets

Community Discussions

Trending Discussions on go-sqlmock

Issue with go-sqlmock testing in the expected query part
Creating a gorm database with go-sqlmock (runtime error)
DB Mocking in one Go test case is interfering with other test case
How to use go-sqlmock when I have concurrent query in my program?
Go sqlmock SELECT missing expected query
Testing Golang function containing call to sql.Open connection without a DB
`could not match actual sql` error while mocking gorm `updates` using go-sqlmock?
How to mock gorm insert with go-sql (postgres)

Trending Discussions on go-sqlmock

QUESTION

Issue with go-sqlmock testing in the expected query part

Asked 2022-Jan-24 at 08:37

I am using go-sqlmock for the first time and I am trying to write a test for post operation. I am using gorm and gin.

The test is giving me an error where s.mock.ExpectQuery(regexp.QuoteMeta(.... I am not what is the issue here. I have posted both the test and the output.
Also, (this has nothing to do with 1) in this test I really do not know what the code will be as it is randomly generated in the api controller. Is there a way to assign a generic number in the code field.

The test file

     package unit
    
     import (
        "net/http"
        "net/http/httptest"
        "regexp"
        "testing"
    
        "github.com/DATA-DOG/go-sqlmock"
        "github.com/SamiAlsubhi/go/controllers"
        "github.com/SamiAlsubhi/go/routes"
        "github.com/gin-gonic/gin"
        "github.com/stretchr/testify/assert"
        "github.com/stretchr/testify/require"
        "github.com/stretchr/testify/suite"
        "gorm.io/driver/postgres"
        "gorm.io/gorm"
     )
    
    type Suite struct {
        suite.Suite
        DB     *gorm.DB
        mock   sqlmock.Sqlmock
        router *gin.Engine
    }
    
    func (s *Suite) SetupSuite(t *testing.T) {
        conn, mock, err := sqlmock.New()
        if err != nil || conn == nil {
            t.Errorf("Failed to open mock sql db, got error: %v", err)
        }
        s.mock = mock
    
        dialector := postgres.New(postgres.Config{
            DSN:                  "sqlmock_db_0",
            DriverName:           "postgres",
            Conn:                 conn,
            PreferSimpleProtocol: true,
        })
    
        if db, err := gorm.Open(dialector, &gorm.Config{}); err != nil || db == nil {
            t.Errorf("Failed to open gorm v2 db, got error: %v", err)
        } else {
            s.DB = db
        }
        api := &controllers.API{Db: s.DB}
    
        s.router = routes.SetupRouter(api)
    
    }
    
    func TestSetup(t *testing.T) {
        suite.Run(t, new(Suite))
    
    }
    
    func (s *Suite) AfterTest(_, _ string) {
        require.NoError(s.T(), s.mock.ExpectationsWereMet())
    }
    
    func (s *Suite) Test_GetOTP() {
        var (
            phone = "99999999"
            code  = "123456"
        )
    
        s.mock.ExpectQuery(regexp.QuoteMeta(
            `INSERT INTO "otps" ("phone","code") VALUES ($1,$2) RETURNING "otps"."id"`)).
            WithArgs(phone, code).
            WillReturnRows(sqlmock.NewRows([]string{"id"}).
                AddRow(1))
    
        s.mock.ExpectCommit()
    
        w := httptest.NewRecorder()
        req, err := http.NewRequest("GET", "/api/auth/get-otp/"+phone, nil)
        require.NoError(s.T(), err)
    
        s.router.ServeHTTP(w, req)
        assert.Equal(s.T(), 200, w.Code)
    
        //require.Nil(s.T(), deep.Equal(&model.Person{ID: id, Name: name}, w.Body))
    }

the output.

    --- FAIL: TestSetup (0.00s)
        --- FAIL: TestSetup/Test_GetOTP (0.00s)
            /Users/sami/Desktop/SamiAlsubhi/go/test/unit/suite.go:63: test panicked: runtime error: invalid memory address or nil pointer dereference
                goroutine 26 [running]:
                runtime/debug.Stack()
                    /usr/local/go/src/runtime/debug/stack.go:24 +0x65
                github.com/stretchr/testify/suite.failOnPanic(0xc000001a00)
                    /Users/sami/Desktop/golang/pkg/mod/github.com/stretchr/testify@v1.7.0/suite/suite.go:63 +0x3e
                panic({0x49e96a0, 0x5193810})
                    /usr/local/go/src/runtime/panic.go:1038 +0x215
                github.com/SamiAlsubhi/go/test/unit.(*Suite).AfterTest(0x4abe61b, {0x4becfd0, 0xc000468940}, {0x0, 0x0})
                    /Users/sami/Desktop/SamiAlsubhi/go/test/unit/setup_test.go:60 +0x1c
                github.com/stretchr/testify/suite.Run.func1.1()
                    /Users/sami/Desktop/golang/pkg/mod/github.com/stretchr/testify@v1.7.0/suite/suite.go:137 +0x1b7
                panic({0x49e96a0, 0x5193810})
                    /usr/local/go/src/runtime/panic.go:1038 +0x215
                github.com/SamiAlsubhi/go/test/unit.(*Suite).Test_GetOTP(0xc000468940)
                    /Users/sami/Desktop/SamiAlsubhi/go/test/unit/setup_test.go:69 +0x4f
                reflect.Value.call({0xc000049140, 0xc000010308, 0x13}, {0x4abf50c, 0x4}, {0xc000080e70, 0x1, 0x1})
                    /usr/local/go/src/reflect/value.go:543 +0x814
                reflect.Value.Call({0xc000049140, 0xc000010308, 0xc000468940}, {0xc0003c9e70, 0x1, 0x1})
                    /usr/local/go/src/reflect/value.go:339 +0xc5
                github.com/stretchr/testify/suite.Run.func1(0xc000001a00)
                    /Users/sami/Desktop/golang/pkg/mod/github.com/stretchr/testify@v1.7.0/suite/suite.go:158 +0x4b6
                testing.tRunner(0xc000001a00, 0xc000162000)
                    /usr/local/go/src/testing/testing.go:1259 +0x102
                created by testing.(*T).Run
                    /usr/local/go/src/testing/testing.go:1306 +0x35a
    FAIL
    coverage: [no statements]
    FAIL    github.com/SamiAlsubhi/go/test/unit 0.912s
    FAIL

ANSWER

Answered 2022-Jan-24 at 08:37

Solution to the first issue:
when using testify/suite, There are bunch of methods if created for the Suite struct, they will be automatically executed when running the test. That being said, These methods will pass through an interface filter. In the case of .SetupSuite, it has to have NO arguments and No return, in order to run.

Solution to the second issue: There is a way in go-sqlmock to match any kind of data by using sqlmock.AnyArg().

Fixed code:

    package unit
    
    import (
        "encoding/json"
        "fmt"
        "math/rand"
        "net/http"
        "net/http/httptest"
        "regexp"
        "testing"
    
        "github.com/DATA-DOG/go-sqlmock"
        "github.com/SamiAlsubhi/go/controllers"
        "github.com/SamiAlsubhi/go/routes"
        "github.com/gin-gonic/gin"
        "github.com/stretchr/testify/assert"
        "github.com/stretchr/testify/require"
        "github.com/stretchr/testify/suite"
        "gorm.io/driver/postgres"
        "gorm.io/gorm"
    )
    
    type Suite struct {
        suite.Suite
        DB     *gorm.DB
        mock   sqlmock.Sqlmock
        router *gin.Engine
    }
    
    func (s *Suite) SetupSuite() {
        //t.Logf("setup start")
        conn, mock, err := sqlmock.New(sqlmock.QueryMatcherOption(sqlmock.QueryMatcherRegexp))
        if err != nil || conn == nil {
            panic(fmt.Sprintf("Failed to open mock sql db, got error: %v", err))
        }
        s.mock = mock
    
        dialector := postgres.New(postgres.Config{
            DSN:                  "sqlmock_db_0",
            DriverName:           "postgres",
            Conn:                 conn,
            PreferSimpleProtocol: true,
        })
    
        if db, err := gorm.Open(dialector, &gorm.Config{SkipDefaultTransaction: true}); err != nil || db == nil {
            panic(fmt.Sprintf("Failed to open gorm v2 db, got error: %v", err))
        } else {
            s.DB = db
        }
    
        api := &controllers.API{Db: s.DB, IsTesting: true}
        s.router = routes.SetupRouter(api)
    
    }
    
    func TestSetup(t *testing.T) {
    
        suite.Run(t, new(Suite))
    
    }
    
    // func (s *Suite) AfterTest(_, _ string) {
    //  require.NoError(s.T(), s.mock.ExpectationsWereMet())
    // }
    
    func (s *Suite) Test_GetOTP_Non_Existing_Phone() {
        /*
            This to test getting OTP for a phone number that does not exist in the otps table
        */
        phone := fmt.Sprintf("%v", 90000000+rand.Intn(99999999-90000000))
        s.mock.MatchExpectationsInOrder(false)
    
        s.mock.ExpectQuery(regexp.QuoteMeta(`SELECT count(*) FROM "otps" WHERE phone = $1 AND "otps"."deleted_at" IS NULL`)).
            WithArgs(phone).
            WillReturnRows(sqlmock.NewRows([]string{"count"}).
                AddRow(0))
    
        s.mock.ExpectQuery(regexp.QuoteMeta(
            `INSERT INTO "otps" ("created_at","updated_at","deleted_at","phone","code") VALUES ($1,$2,$3,$4,$5) RETURNING "id"`)).
            WithArgs(sqlmock.AnyArg(), sqlmock.AnyArg(), sqlmock.AnyArg(), phone, sqlmock.AnyArg()).
            WillReturnRows(sqlmock.NewRows([]string{"id"}).
                AddRow(1))
    
        w := httptest.NewRecorder()
        req, err := http.NewRequest("GET", "/api/auth/get-otp/"+phone, nil)
        require.NoError(s.T(), err)
    
        s.router.ServeHTTP(w, req)
        assert.Equal(s.T(), 200, w.Code)
        //parse response
        var response gin.H
        err = json.Unmarshal(w.Body.Bytes(), &response)
        require.NoError(s.T(), err)
        _, ok := response["expiry_in"]
        assert.True(s.T(), ok)
    
        require.NoError(s.T(), s.mock.ExpectationsWereMet())
    
    }

Source https://stackoverflow.com/questions/70821998

QUESTION

Creating a gorm database with go-sqlmock (runtime error)

Asked 2021-Oct-14 at 18:02

Summary

I'm trying to use go-sqlmock with gorm for testing. I want to write a test for the initial database migration, but I've hit a panic: runtime error: invalid memory address or nil pointer dereference and I've been having trouble figuring out why. Judging by the error stack, I think it's this statement that does it: db.AutoMigrate(&models.User{}). I'm not sure why, as db has allegedly started up successfully by this point and models.User is defined and instantiated as an argument to db.AutoMigrate. I have a feeling the error is in the mocks.NewDatabase function, but I'm at a loss.

Not sure if anyone has the time or will to take a peak at the relevant code and help me out? I've noted in the code where the failures occur (they're in the final two blocks of code). Let me know if any additional context would help.

Relevant Code

project/src/models/models.go

package models

import (
    "time"

    "github.com/google/uuid"
    "gorm.io/gorm"
)

type Base struct {
    ID        uuid.UUID      `json:"-" gorm:"primaryKey;type:uuid;not null"`
    CreatedAt time.Time      `json:"-" gorm:"autoCreateTime"`
    UpdatedAt time.Time      `json:"-" gorm:"autoUpdateTime"`
    DeletedAt gorm.DeletedAt `json:"-" gorm:"index"`
}

type User struct {
    Base
    Name     string `json:"-"`
    Email    string `json:"-" gorm:"unique_index:user_email_index"`
    Password string `json:"-" gorm:"size:72"`
}

project/src/mocks/database.go

package mocks

import (
    "project/src/models"
    "log"

    "github.com/DATA-DOG/go-sqlmock"
    "gorm.io/driver/mysql"
    "gorm.io/gorm"
)

func NewDatabase() (*gorm.DB, sqlmock.Sqlmock) {

    // get db and mock
    sqlDB, mock, err := sqlmock.New(
        sqlmock.QueryMatcherOption(sqlmock.QueryMatcherRegexp),
    )
    if err != nil {
        log.Fatalf("[sqlmock new] %s", err)
    }
    defer sqlDB.Close()

    // create dialector
    dialector := mysql.New(mysql.Config{
        Conn: sqlDB,
    DriverName: "mysql",
    })

    // a SELECT VERSION() query will be run when gorm opens the database
    // so we need to expect that here
    columns := []string{"version"}
    mock.ExpectQuery("SELECT VERSION()").WithArgs().WillReturnRows(
    mock.NewRows(columns).FromCSVString("1"),
    )

    // open the database
    db, err := gorm.Open(dialector, &gorm.Config{ PrepareStmt: true })
    if err != nil {
        log.Fatalf("[gorm open] %s", err)
    }

  return db, mock
}

project/src/database/init.go

package database

import (
    "project/src/models"

    "gorm.io/gorm"
)

// Init auto-migrates the DB.
func Init(db *gorm.DB) {
    // Migrate the schema
    // this panics with
    // panic: runtime error: invalid memory address or nil pointer dereference
    // User is defined and instantiated here
    db.AutoMigrate(&models.User{})
}

Now the test:

project/src/database/init_test.go

package database

import (
    "project/src/mocks"
    "testing"
)

func TestInitMigratesDB(t *testing.T) {
    db, mock := mocks.NewDatabase()
    mock.ExpectExec("CREATE TABLE users(.*)")
    mock.ExpectCommit()
    
    // fails here
    Init(db)
}

And the log

Running tool: /usr/local/go/bin/go test -timeout 30s -run ^TestInitMigratesDB$ project/src/database

--- FAIL: TestInitMigratesDB (0.00s)
panic: runtime error: invalid memory address or nil pointer dereference
    panic: runtime error: invalid memory address or nil pointer dereference [recovered]
    panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x0 pc=0x11ce22e]

goroutine 35 [running]:
testing.tRunner.func1.2({0x1505320, 0x19bfb00})
    /usr/local/go/src/testing/testing.go:1209 +0x24e
testing.tRunner.func1()
    /usr/local/go/src/testing/testing.go:1212 +0x218
panic({0x1505320, 0x19bfb00})
    /usr/local/go/src/runtime/panic.go:1038 +0x215
database/sql.(*Rows).close(0x0, {0x0, 0x0})
    /usr/local/go/src/database/sql/sql.go:3267 +0x8e
database/sql.(*Rows).Close(0x1e)
    /usr/local/go/src/database/sql/sql.go:3263 +0x1d
panic({0x1505320, 0x19bfb00})
    /usr/local/go/src/runtime/panic.go:1038 +0x215
database/sql.(*Rows).Next(0x0)
    /usr/local/go/src/database/sql/sql.go:2944 +0x27
database/sql.(*Row).Scan(0xc0000afbd8, {0xc0000efb38, 0x11, 0x1})
    /usr/local/go/src/database/sql/sql.go:3333 +0xb4
gorm.io/gorm/migrator.Migrator.CurrentDatabase({{0x0, 0xc000483350, {0x1659c58, 0xc00041a0f0}}})
    /go/pkg/mod/gorm.io/gorm@v1.21.15/migrator/migrator.go:673 +0x8d
gorm.io/gorm/migrator.Migrator.HasTable.func1(0xc0000f8380)
    /go/pkg/mod/gorm.io/gorm@v1.21.15/migrator/migrator.go:265 +0x51
gorm.io/gorm/migrator.Migrator.RunWithValue({{0x80, 0xc000483260, {0x1659c58, 0xc00041a0f0}}}, {0x1512320, 0xc0004fe2a0}, 0xc0000efcb8)
    /go/pkg/mod/gorm.io/gorm@v1.21.15/migrator/migrator.go:50 +0x126
gorm.io/gorm/migrator.Migrator.HasTable({{0x0, 0xc000483260, {0x1659c58, 0xc00041a0f0}}}, {0x1512320, 0xc0004fe2a0})
    /go/pkg/mod/gorm.io/gorm@v1.21.15/migrator/migrator.go:264 +0xe8
gorm.io/gorm/migrator.Migrator.AutoMigrate({{0x0, 0xc000426f90, {0x1659c58, 0xc00041a0f0}}}, {0xc00040f690, 0x0, 0x0})
    /go/pkg/mod/gorm.io/gorm@v1.21.15/migrator/migrator.go:92 +0x127
gorm.io/gorm.(*DB).AutoMigrate(0x151a800, {0xc00040f690, 0x1, 0x1})
    /go/pkg/mod/gorm.io/gorm@v1.21.15/migrator.go:26 +0x43
project/src/database.Init(0xc00041c230)
    /Projects/project/src/database/init.go:12 +0x7b
project/src/database.TestInitMigratesDB(0x0)
    /Projects/project/src/database/init_test.go:12 +0x5a
testing.tRunner(0xc0003a21a0, 0x15b5328)
    /usr/local/go/src/testing/testing.go:1259 +0x102
created by testing.(*T).Run
    /usr/local/go/src/testing/testing.go:1306 +0x35a
FAIL    project/src/database    0.276s
FAIL

ANSWER

Answered 2021-Oct-14 at 18:02

Figured it out. It was a config option: &gorm.Config{ PrepareStmt: true }. While this works in production, it does not work with sqlmock. Fixed it by changing it to: &gorm.Config{}.

Source https://stackoverflow.com/questions/69565095

QUESTION

DB Mocking in one Go test case is interfering with other test case

Asked 2021-May-03 at 10:16

I have two Go test cases as shown below that test a gRPC function called MyEndpoint.

MyEndpoint is supposed to succeed when the database row it selects has Field1 == "A" and return an error otherwise.

I'm mocking out the database with the go-sqlmock package from Data-dog.

package mypackage_test

import (
    "github.com/DATA-DOG/go-sqlmock"
    "github.com/stretchr/testify/require"
)


type MyEntity struct {
    Id                     sql.NullInt32 `db:"id"`  
    Field1                 sql.NullString `db:"field1"`
    Field2                 sql.NullString `db:"field2"`
    Field3                 sql.NullString `db:"field3"`
}

var Columns = []string{
    "id",
    "field_1",
    "field_2",
    "field_3"
}



var dbRow = []driver.Value{int32(999), "A", "B", "C"]


func TestMyTestA(t *testing.T) {
    t.Run("Verify MyEndpoint Fails when mocked Database row has Field1 != A", func(t *testing.T) {
        api, err := getMyAPI()
        require.Nil(t, err)
        defer api.Close()

        api.DBMock.ExpectBegin()
        api.DBMock.MatchExpectationsInOrder(false)

        modifiedDBRow := dbRow
        modifiedDBRow[0] = "Z"
        api.DBMock.ExpectQuery("SELECT").
            WithArgs(int32(999)).WillReturnRows(sqlmock.NewRows(Columns).AddRow(modifiedDBRow...))
        api.DBMock.ExpectCommit()
        
        _, err = ... // Call MyEndpoint with parameter Id: int32(999)
        api.DBMock.ExpectClose()
        require.NotNil(t, err)
    })
}

func TestMyTestB(t *testing.T) {
    t.Run("Verify MyEndpoint succeeds when mocked Database row has Field1 == A", func(t *testing.T) {
        api, err := getMyAPI()
        require.Nil(t, err)
        defer api.Close()

        api.DBMock.ExpectBegin()
        api.DBMock.MatchExpectationsInOrder(false)

        api.DBMock.ExpectQuery("SELECT").
            WithArgs(int32(999)).WillReturnRows(sqlmock.NewRows(Columns).AddRow(dbRow...))
        api.DBMock.ExpectCommit()
        
        _, err = ... // Call MyEndpoint with parameter Id: int32(999)
        api.DBMock.ExpectClose()
        require.Nil(t, err)
    })
}

When I run these two test cases individually, they both pass.

But when I run them together, TestMyTestB fails because it thinks Field1 == "Z". So clearly TestMyTestA is interfering with TestMyTestB. Why?

It seems that the mocking done in TestMyTestA case is still in effect when it gets to TestMyTestB and the mocking I'm doing in TestMyTestB case is completely ignored.

How can I mock these two test cases out independently of one another?

ANSWER

Answered 2021-May-03 at 10:16

It's because of an incorrect assignment to modifiedDBRow slice in your first test. Remember that a slice does not store any data, it just describes a section of an underlying array.

So when you modified modifiedDBRow in the first test, you've inherently modified the underlying array containing value at [0], from A to Z, which persists when you read the dbRow in your next test. Either reset the value at the end of the first test or have a different set of variables to use across tests.

Source https://stackoverflow.com/questions/67366237

QUESTION

Go sqlmock SELECT missing expected query

Asked 2020-Sep-25 at 14:22

Go here. Trying to figure out how to use SQL mock v2.

Here's my interface:

type OrderPersister interface {
    FetchOrderById(string) (*Order, error)
}

And my implementation of that interface:

type DbPersister struct {
    Config config.DbConfig
    GormDB *gorm.DB
}

func (op DbPersister) FetchOrderById(orderId string) (*Order, error) {
    Order := &Order{}

    orderUuid, err := uuid.Parse(orderId)
    if err != nil {
        return nil, err
    }

    if err := op.GormDB.Table("orders").
        Select(`orders.order_id,
            orders.user_id,
            orders.quantity,
            orders.status
            addresses.line_1,
            users.email`).
        Joins("join addresses on addresses.address_id = orders.address_id").
        Joins("join users on users.user_id = orders.user_id").
        Where("orders.order_id = ?", orderUuid).
        First(Order).Error; err != nil {
        return nil, err
    }

    return Order, nil
}

And my unit test (including setup/init):

import (
    "database/sql"
    "testing"

    "github.com/google/uuid"
    "github.com/jinzhu/gorm"
    "github.com/stretchr/testify/require"
    "github.com/stretchr/testify/suite"
    "gopkg.in/DATA-DOG/go-sqlmock.v2"
)

type Suite struct {
    suite.Suite
    DB   *gorm.DB
    mock sqlmock.Sqlmock

    dbPersister OrderPersister
}

func (s *Suite) SetupSuite() {
    var (
        db  *sql.DB
        err error
    )

    db, s.mock, err = sqlmock.New()
    require.NoError(s.T(), err)

    s.DB, err = gorm.Open("postgres", db)
    require.NoError(
        s.T(), err)

    s.DB.LogMode(true)

    s.dbPersister = DbPersister{
        Config: config.DbConfig{
            DbHost:     "",
            DbPort:     "",
            DbName:     "",
            DbUsername: "",
            DbPassword: "",
        },
        GormDB: s.DB,
    }
}

func (s *Suite) BeforeTest(_, _ string) {
    var (
        db  *sql.DB
        err error
    )

    db, s.mock, err = sqlmock.New()
    require.NoError(s.T(), err)

    s.DB, err = gorm.Open("postgres", db)
    require.NoError(s.T(), err)

    s.DB.LogMode(true)
}

func (s *Suite) AfterTest(_, _ string) {
    require.NoError(s.T(), s.mock.ExpectationsWereMet())
}

func TestInit(t *testing.T) {
    suite.Run(t, new(Suite))
}

func (s *Suite) TestFetchOrderById() {

  // given
    orderId := uuid.New()
  quantity := 1
  status := "ready"
    line1 := "201"
  email := "jsmith@example.com"

  // s.mock.ExpectBegin()
    s.mock.ExpectQuery(`SELECT`).
        WillReturnRows(sqlmock.NewRows([]string{"orders.order_id","orders.user_id","orders.quantity","orders.status",
                "addresses.line_1","user_logins.email"}).
            AddRow(sqlmock.AnyArg(), sqlmock.AnyArg(), quantity, status, totalExclTax, shippingExclTax,
                totalTaxAmt, line1, state, zip, locality, upc, email, firstName, lastName))
    _, err := s.dbPersister.FetchOrderById(orderId.String())
  s.mock.ExpectCommit()
    require.NoError(s.T(), err)
}

When this runs the test fails for the following reason:

--- FAIL: TestInit (0.00s)
  --- FAIL: TestInit/TestFetchOrderById (0.00s)
    db_test.go:67: 
        Error Trace:    db_test.go:67
                                suite.go:137
                                panic.go:969
                                rows.go:134
                                db_test.go:99
        Error:          Received unexpected error:
                        there is a remaining expectation which was not matched: ExpectedQuery => expecting Query, QueryContext or QueryRow which:
                          - matches sql: 'SELECT'
                          - is without arguments
        Test:           TestInit/TestFetchOrderById

All I'm trying to do is confirm that the GormDB instance was queried with the SELECT statement specified in the FetchOrderById function.

Does anybody know what I need to do to achieve this and get the test to pass?

ANSWER

Answered 2020-Sep-25 at 14:22

I decided to Go (no pun intended) with Java instead.

Source https://stackoverflow.com/questions/63939463

QUESTION

Testing Golang function containing call to sql.Open connection without a DB

Asked 2020-Jun-29 at 00:11

So I'm just getting to grips with Golang. I'm writing an application for funsies just to understand stuff and get my head around it.

I have a whole bunch of functions that will interact with a DB where I pass in *SQL.DB for the function to use. I can test those easily enough using a mocked interface from sqlmock.

No problem there.

I'm now writing the Initialisation function for the application which will initiate the DB connection which will be attached to a struct and from there passed into utility functions.

However, I am struggling to find a way to easily test that connection without having the hassle of setting up an actual database.

So I guessing that I have probably either badly structured my app, or I've missed something, potentially pretty obvious.

So here is some example code to illustrate my predicament.

util.go

package main
import (
    "log"
    "database/sql"
    "github.com/go-sql-driver/mysql"
)

func DoDBStuff(db *sql.DB) {
    rows, err := db.Query("SELECT column1, column2 FROM example")
    if err != nil {
       log.Error(err)
    }
    // do stuff with rows
}

util_test.go

package main

import (
    "testing"
    "github.com/DATA-DOG/go-sqlmock"
)

func TestDoDBStuff(t *testing.T) {
    db, mock, err := sqlmock.New()
    if err != nil {
        t.Fatalf("An error '%s' was not expected when opening a stub database connection", err)
    }
    defer db.Close()

    rows := sqlmock.NewRows([]string{"col1", "col2"})
    rows.AddRow("val1", "val2")
    rows.AddRow("val3", "val4")

    mock.ExpectQuery("^SELECT column1, column2 from example$").WillReturnRows(rows)

    DoDBStuff(db)

    if err := mock.ExpectationsWereMet(); err != nil {
        t.Errorf("there were unfulfilled expectations: %s", err)
    }

}

That all works fine, I can test my DB queries.

However Now I want to test Initialising the App.

package main

import (
    "database/sql"
    "github.com/go-sql-driver/mysql"
)

type App {
    DB *sql.DB
    // some other data structures
}

func (a *App) InitApp(connectionString string) {
    a.DB = sql.Open("mysql", connectionString)
    // other init stuff
}

But as I can't pass in the SQL I don't think it can be mocked, certainly not easily. So I'm struggling a bit on how to move forward.

I am intending for this to sit behind a rest API, so on startup, the app will need to initialize before being able to process any requests.

Ideally, I'd like to be able to test the REST interface without having to set up a database, delay testing with real data until I can feed the code into a Dev environment.

So really I want to know:

Is what I'm intending possible? Is there a better approach?

If not what am I missing? Poor test design or poor code set up?

Edit:

Folling @peter's comment I just want to clarify.

I want to test the functionality of the InitDB() function but with the sql.Open call I would need to have a Database for it to connect to, If I don't then I the call would fail and I could not effectively test the function.

ANSWER

Answered 2020-Jun-29 at 00:11

There is Dockertest which creates a Docker container running whatever you want (i.e. MySQL), and you can test against that. It's designed for being able to do proper integration testing, so it should be able to do what you want (you wont need sqlmock anymore too).

Source https://stackoverflow.com/questions/62623174

QUESTION

`could not match actual sql` error while mocking gorm `updates` using go-sqlmock?

Asked 2020-Apr-03 at 13:06

repository.go

func (repo *Repository) Update(info *model.Requests) error{
   if info == nil{
      return nil
   }
   columnChanges := map[string]interface{}{
      status:       “completed",
   }
   if err := repo.db.Table(“requests").Model(info).Where(fmt.Sprintf("%s = ? AND  %s = ? AND %s = ? AND %s = ?",
      requestID, systemID, requestType, status),info.RequestID, info.SystemID, info.RequestType,”progress").Updates(columnChanges).Error; err != nil {
      return err
   }
   return nil
}

Mock

repository_test.go

func TestRepository_Update(t *testing.T) {
   type testData struct {
      input     *model.Requests
      queryString string
      queryArgs   []driver.Value
      updateErr   error
      hasErr    bool
   }

   db, mock, _ := sqlmock.New()
   defer db.Close()
   dbInstance, _ := gorm.Open("postgres", db)

   testDataList := []testData{
        {
   input: &model.Requests{
      RequestID: 4,
      SystemID: 2,
      RequestType: “mobile",
      Status: “completed",
   },
   queryString: `UPDATE "requests" SET "status" = $1 WHERE (“request_id" = $2 AND “system_id" = $3 AND “request_type" = $4 AND "status" = $5) `,
   queryArgs:   []driver.Value{“completed", 2, 4, “mobile", “progress"},
   updateErr:   nil,
   hasErr: false,
},
}

    for _, data := range testDataList {
      repo := Repository(zerolog.Nop(), dbInstance)

      if data.queryString != "" {
         mock.ExpectBegin()
         m := mock.ExpectExec(data.queryString).WithArgs(data.queryArgs...)
         if data.hasErr {
            m.WillReturnError(data.updateErr)
         } else {
            m.WillReturnResult(sqlmock.NewResult(1, 1))
         }
         mock.ExpectCommit()
      }

      resultErr := repo.Requests(data.input)

      if data.hasErr {
         assert.NotNil(t, resultErr)
      } else {
         assert.Nil(t, resultErr) //Error thrown in this line 
      }

      if err := mock.ExpectationsWereMet(); err != nil {
         t.Errorf("there were unfulfilled expectations: %s", err)
      }
   }
}

Error I’m getting

ExecQuery: could not match actual sql: "UPDATE "requests" SET "status" = $1 WHERE (request_id = $2 AND system_id = $3 AND request_type = $4 AND status = $5)" with expected regexp "UPDATE "requests" SET "status" = $1 WHERE ("request_id" = $2 AND "system_id" = $3 AND "request_type" = $4 AND "status" = $5)”



            Error Trace:    repository_test.go:<line number>
            Error:          Expected nil, but got: &errors.errorString{s:"ExecQuery: could not match actual sql: \"UPDATE \"requests\" SET \"status\" = $1 WHERE (request_id = $2 AND system_id = $3 AND request_type = $4 AND status = $5)\" with expected regexp \"UPDATE \"requests\" SET \"status\" = $1 WHERE (\”request_id\" = $2 AND \”system_id\" = $3 AND \”request_type\" = $4 AND \"status\" = $5)\""}
            Test:           Repository_Update
    repository_test.go:<lineNumber>: there were unfulfilled expectations: there is a remaining expectation which was not matched: ExpectedExec => expecting Exec or ExecContext which:
          - matches sql: 'UPDATE "requests" SET "status" = $1 WHERE (“request_id" = $2 AND “system_id" = $3 AND “request_type" = $4 AND "status" = $5) '
          - is with arguments:
            0 - success
            1 - 2
            2 - 4
            3 - image
            4 - pending
          - should return Result having:
              LastInsertId: 1
              RowsAffected: 1

When I set gorm log level true, this is the actual SQL I see

UPDATE "requests" SET "status" = ‘completed'  WHERE (request_id = 5 AND  system_id = 1 AND request_type = ‘mobile' AND status = ‘progress')

I tried, changing ExpectExec to ExpectPrepare().ExpectExec or mock.ExpectQuery(regexp.QuoteMeta and other options mentioned in go-sqlmock issues by other tickets. None of them worked. Struck with this for 2 days. Please help.

ANSWER

Answered 2020-Apr-03 at 13:06

the reason is that you are not escaping your regular expression of query string. Sqlmock expects regular expression in your expectation.

Now in case if you want to match exact query string, not parts of it. You can specify an sqlmock mock option, like this:

db, mock, err := sqlmock.New(sqlmock.QueryMatcherOption(sqlmock.QueryMatcherEqual))

The answer was in the documentation, if you would read the api docs once, this could save your time.

Source https://stackoverflow.com/questions/61011456

QUESTION

How to mock gorm insert with go-sql (postgres)

Asked 2020-Feb-25 at 20:16

I'm using Gorm with the postgresql driver. I try to mock a database insert with go-sqlmock:

type Test struct {
    FirstName string `json:"first_name"`
}

func (db *DB) CreateTest() (*Test, error) {
    test := Test{"c"}
    if result := db.Create(&test); result.Error != nil {
        return nil, result.Error
    }

    return &test, nil
}


func TestCreateUser(t *testing.T) {
    _, mock, _ := sqlmock.NewWithDSN("sqlmock_db_0")

    mockedGorm, _ := gorm.Open("sqlmock", "sqlmock_db_0")
    defer mockedGorm.Close()
    myDB := &DB{mockedGorm}

    mock.ExpectExec("INSERT INTO test").WithArgs("c").WillReturnResult(sqlmock.NewResult(1, 1))
    myDB.Exec("INSERT INTO test(first_name) VALUES (?)", "c")


    if _, err := myDB.CreateTest(); err != nil {
        t.Errorf("error was not expected: %s", err)
    }

    if err := mock.ExpectationsWereMet(); err != nil {
        t.Errorf("there were unfulfilled expectations: %s", err)
    }
}

Unfortunately, this gives me an error:

error was not expected: all expectations were already fulfilled, call to database transaction Begin was not expected

How do I test an insert with gorm, postgresql and sql-mock properly?

ANSWER

Answered 2020-Feb-11 at 23:44

There were a couple of issues with my code:

1) As @flimzy pointed out rightfully, there has to be a ExpectBegin() (and ExpectCommit()) statement. This gets more obvious if one turns on the GORM debugger that shows what exactly GORM is doing.

2) ExpectExec("INSERT INTO test").WithArgs("c") does quite obviously not match myDB.Exec("INSERT INTO test(first_name) VALUES (?)", "c")

3) One has to escape the statement, as go-sqlmock takes a regex, here Go's https://godoc.org/regexp#QuoteMeta comes in handy.

Working code:

mock.ExpectBegin()
mock.ExpectExec(regexp.QuoteMeta("INSERT INTO \"tests\" (\"first_name\") VALUES (?)")).WithArgs("c").WillReturnResult(sqlmock.NewResult(1, 1))
mock.ExpectCommit()

Source https://stackoverflow.com/questions/60155628

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install go-sqlmock

You can download it from GitHub.

Support

Visit godoc for general examples and public api reference. See .travis.yml for supported go versions. Different use case, is to functionally test with a real database - go-txdb all database related actions are isolated within a single transaction so the database can remain in the same state.