如何为导入外部包中的函数编写单元测试的预期？

哈喽！大家好，很高兴又见面了，我是golang学习网的一名作者，今天由我给大家带来一篇《如何为导入外部包中的函数编写单元测试的预期？》，本文主要会讲到等等知识点，希望大家一起学习进步，也欢迎大家关注、点赞、收藏、转发! 下面就一起来看看吧！

我有一个我想测试的功能。我使用 testify 创建单元测试。

// calculate.go
import (
  "context"
  "errors"
  "testing"

  "github.com/jmoiron/sqlx"
)

func (u usecase) calculatetransaction(ctx context.context, id int64) (err error) {
  // tx has the type of `*sqlx.tx`, which i got from that imported package above
  tx, err := u.sqlrepo.begintx()
  if err != nil {
    return err
  }

  defer func() {
    if tx != nil {
    err = tx.rollback()
      if err != nil {
        return err
      }
    }
  }  


  err = tx.commit()
  if err != nil {
    return err
  }

  return nil
}

这应该是单元测试

// calculate_test.go
func testcalculate(t *testing.t) {
  var tx *sqlx.tx
  var expectederror string

  mocksql = new(mocks.sqlrepository)
  mocksql.on("begintx").return(tx, nil)

  // mock tx.commit() here
  // mock tx.rollback() here

  usecase := &calculationusecase{
    sqlrepo: mocksql
  }

  actualerror := usecase.calculatetransaction(context.background(), 1)
  require.equalerror(t, actualerror, expectederror)
}

我的问题是 tx.commit() 和 tx.rollback() 方法。如果我以这种方式运行它，我会得到一个 invalid 内存地址或 nil 指针取消引用 错误，这是有道理的，因为我还没有设置对这些方法调用的期望。

但我不知道如何创建它。这些方法本身是从外部包导入的，即 "github.com/jmoiron/sqlx"。我不确定是否需要为位于根目录的外部包创建一个模拟对象，或者是否有其他方法可以做到这一点而无需模拟它。

任何人都可以告诉我如何解决这个问题或如何设置期望？

我不知道我是否可以做到这一点，但我也尝试将单元测试（使用testify）与datadog的sqlmock结合起来，如下所示

// calculate_test.go
func TestCalculate(t *testing.T) {
  var tx *sqlx.Tx
  var expectedError string

  dbMock, mock, err := sqlmock.New()
  if err != nil {
    t.Fatalf("an error '%s' was not expected", err)
  }
  defer dbMock.Close()

  mockSQL = new(mocks.SQLRepository)
  mockSQL.On("BeginTX").Return(tx, nil)
  
  mock.ExpectCommit()
  mock.ExpectRollback()

  usecase := &calculationUsecase{
    sqlRepo: mockSQL
  }

  actualError := usecase.CalculateTransaction(context.Background(), 1)
  require.EqualError(t, actualError, expectedError)
}

但它也不起作用。它仍然在 err = tx.commit() 行给出 panic: 运行时错误：无效的内存地址或 nil 指针取消引用 错误。

正确答案

在您的测试中，您在数据库提供程序级别模拟数据库，无需再进行模拟。

没有多余模拟的测试：

func TestCalculate(t *testing.T) {
  
  // transaction is created inside `CalculateTransaction`, it will be started against mocked DB
  // var tx *sqlx.Tx
  var expectedError string

  dbMock, mock, err := sqlmock.New()
  if err != nil {
    t.Fatalf("an error '%s' was not expected", err)
  }
  defer dbMock.Close()

  // we use sql mock - no need to mock DB methods
  // mockSQL = new(mocks.SQLRepository)
  // mockSQL.On("BeginTX").Return(tx, nil)
  
  mock.ExpectCommit()

  // here you can add ExpectQuery or ExpectExec if usecase do any DB work

  mock.ExpectRollback()

  usecase := &calculationUsecase{
    sqlRepo: dbMock
  }

  actualError := usecase.CalculateTransaction(context.Background(), 1)
  require.EqualError(t, actualError, expectedError)

  // it is good practice to check is all expectations are met
  err = mock.ExpectationsWereMet()
  require.NoError(t, err)
}

本篇关于《如何为导入外部包中的函数编写单元测试的预期？》的介绍就到此结束啦，但是学无止境，想要了解学习更多关于Golang的相关知识，请关注golang学习网公众号！