Mock

简介

Goravel 所有功能都使用 facades 实现，而所有的 facades 均由接口构成。因此配合 stretchr/testify 的 mock 功能，Goravel 可以提供优秀的测试体验。

Mock facades.Cache

  1. func Cache() string {
  2.     if err := facades.Cache.Put("name", "goravel", 1*time.Minute); err != nil {
  3.         fmt.Println("cache.put.error", err)
  4.     }
  6.     return facades.Cache.Get("name", "test").(string)
  7. }
  9. func TestCache(t *testing.T) {
  10.     mockCache := goravelmock.Cache()
  11.     mockCache.On("Put", "name", "goravel", mock.Anything).Return(nil).Once()
  12.     mockCache.On("Get", "name", "test").Return("hwb").Once()
  14.     res := Cache()
  15.     assert.Equal(t, res, "hwb")
  16. }

Mock facades.Config

  1. func Config() string {
  2.     return facades.Config.GetString("app.name", "test")
  3. }
  5. func TestConfig(t *testing.T) {
  6.     mockConfig := goravelmock.Config()
  7.     mockConfig.On("GetString", "app.name", "test").Return("hwb").Once()
  9.     res := Config()
  10.     assert.Equal(t, res, "hwb")
  11. }

Mock facades.Artisan

  1. func ArtisanCall() {
  2.     facades.Artisan.Call("list")
  3. }
  5. func TestArtisan(t *testing.T) {
  6.     mockArticle := goravelmock.Artisan()
  7.     mockArticle.On("Call", "list").Once()
  9.     assert.NotPanics(t, func() {
  10.         ArtisanCall()
  11.     })
  12. }

Mock facades.Orm

  1. func Orm() error {
  2.     if err := facades.Orm.Query().Create(&Test{}); err != nil {
  3.         return err
  4.     }
  6.     var test Test
  7.     return facades.Orm.Query().Where("id = ?", 1).Find(&test)
  8. }
  10. func TestOrm(t *testing.T) {
  11.     mockOrm, mockOrmDB, _ := goravelmock.Orm()
  12.     mockOrm.On("Query").Return(mockOrmDB)
  14.     mockOrmDB.On("Create", mock.Anything).Return(nil).Once()
  15.     mockOrmDB.On("Where", "id = ?", 1).Return(mockOrmDB).Once()
  16.     mockOrmDB.On("Find", mock.Anything).Return(nil).Once()
  18.     assert.Nil(t, Orm())
  19. }
  21. func Transaction() error {
  22.     return facades.Orm.Transaction(func(tx contractorm.Transaction) error {
  23.         var test Test
  24.         if err := tx.Create(&test); err != nil {
  25.             return err
  26.         }
  28.         var test1 Test
  29.         return tx.Where("id = ?", test.ID).Find(&test1)
  30.     })
  31. }
  33. func TestTransaction(t *testing.T) {
  34.     mockOrm, _, mockOrmTransaction := goravelmock.Orm()
  35.     mockOrm.On("Transaction", mock.Anything).Return(func(txFunc func(tx orm.Transaction) error) error {
  36.         return txFunc(mockOrmTransaction)
  37.     })
  39.     var test Test
  40.     mockOrmTransaction.On("Create", &test).Return(func(test2 interface{}) error {
  41.         test2.(*Test).ID = 1
  43.         return nil
  44.     }).Once()
  45.     mockOrmTransaction.On("Where", "id = ?", uint(1)).Return(mockOrmTransaction).Once()
  46.     mockOrmTransaction.On("Find", mock.Anything).Return(nil).Once()
  48.     assert.Nil(t, Transaction())
  49. }
  51. func Begin() error {
  52.     tx, _ := facades.Orm.Query().Begin()
  53.     user := models.User{Name: "Goravel"}
  54.     if err := tx.Create(&user); err != nil {
  55.         return tx.Rollback()
  56.     } else {
  57.         return tx.Commit()
  58.     }
  59. }

Mock facades.Event

  1. func Event() error {
  2.     return facades.Event.Job(&events.TestEvent{}, []contractevent.Arg{
  3.         {Type: "string", Value: "abcc"},
  4.         {Type: "int", Value: 1234},
  5.     }).Dispatch()
  6. }
  8. func TestEvent(t *testing.T) {
  9.     mockEvent, mockTask := goravelmock.Event()
  10.     mockEvent.On("Job", mock.Anything, mock.Anything).Return(mockTask).Once()
  11.     mockTask.On("Dispatch").Return(nil).Once()
  13.     assert.Nil(t, Event())
  14. }

Mock facades.Log

facades.Log 没有实现 mock，而是使用 fmt 代替了实际的日志输出，便于测试过程中调试。

  1. func Log() {
  2.     facades.Log.Debug("test")
  3. }
  5. func TestLog(t *testing.T) {
  6.     goravelmock.Log()
  8.     Log()
  9. }

Mock facades.Mail

  1. func Mail() error {
  2.     return facades.Mail.From(mail.From{Address: "example@example.com", Name: "example"}).
  3.         To([]string{"example@example.com"}).
  4.         Content(mail.Content{Subject: "Subject", Html: "<h1>Hello Goravel</h1>"}).
  5.         Send()
  6. }
  8. func TestMail(t *testing.T) {
  9.     mockMail := goravelmock.Mail()
  10.     mockMail.On("From", mail.From{Address: "example@example.com", Name: "example"}).Return(mockMail)
  11.     mockMail.On("To", []string{"example@example.com"}).Return(mockMail)
  12.     mockMail.On("Content", mail.Content{Subject: "Subject", Html: "<h1>Hello Goravel</h1>"}).Return(mockMail)
  13.     mockMail.On("Send").Return(nil)
  15.     assert.Nil(t, Mail())
  16. }

Mock facades.Queue

  1. func Queue() error {
  2.     return facades.Queue.Job(&jobs.TestSyncJob{}, []queue.Arg{}).Dispatch()
  3. }
  5. func TestQueue(t *testing.T) {
  6.     mockQueue, mockTask := goravelmock.Queue()
  7.     mockQueue.On("Job", mock.Anything, mock.Anything).Return(mockTask).Once()
  8.     mockTask.On("Dispatch").Return(nil).Once()
  10.     assert.Nil(t, Queue())
  11. }