day 17 - 利用 interface 来mock外部回应

到目前为止所跑的测试都是利用 docker 在本机run scylla & redis 测试的,
今天利用Go interface 来把model的程序改成不需要依赖外部回应的方式。

Go有两种interface, 一个是资料型别, 一个是定义接口。

• 资料型别的interface 会像这样使用：

     // 宣告参数 interface{}
      var data interface{}
      // 传入参数 interface{}
     func Test(i interface{}) (r string) {}
     // 回传参数 interface{}
      func Test(i string) (r interface{}) {}
  

  它就跟int, string, bool一样, 用来表示资料的型态。

• 定义接口的interface 会是这样使用：

    type ITest interface{
       Create(seq int, data string) error
       Update(t *Test) error
    }
  

  在Go里面只要有一个 struct 满足 Create() 和 Update()两个接口条件,
  就可以透过将变数宣告为 ITest 来调用不同struct底下的接口。
  这个特性可以用在本机测试, 如果已知对接的接口或API回应格式, 就可以实作mock的API接口来测试。

• 修改model底下的程序, 调整为interface接口

  model
  ├── init.go
  └── limit.go
  

• 实作内容

  package coconut_model
  
  import (
      "github.com/syhlion/gocql"
  )
  
  // Init 
  func Init(cql *gocql.Session) {
      LimitSQL = &RealModel{
          cqlDB: cql,
      }
  }
  
  // InitMock 
  func InitMock() {
      LimitSQL = &MockModel{}
  }
  
  type IModel interface {
      GetLimit() (result map[string]int, err error)
  }
  
  var LimitSQL IModel
  
  type RealModel struct {
      cqlDB *gocql.Session
  }
  
  func (r *RealModel) GetLimit() (result map[string]int, err error) {
      var (
          level string
          limit int
      )
  
      result = make(map[string]int)
  
      sql := `select level, limit_point from coconut.settings`
      iter := r.cqlDB.Query(sql).Iter()
  
      for iter.Scan(&level, &limit) {
          result[level] = limit
      }
  
      if err := iter.Close(); err != nil {
          return nil, err
      }
  
      return
  }
  
  type MockModel struct{}
  
  func (m *MockModel) GetLimit() (result map[string]int, err error) {
      result = make(map[string]int, 0)
      result["0"] = 11111
      result["1"] = 2222
      result["2"] = 333
      result["3"] = 55
  
      return result, nil
  }
  
  

• 在config中加入一个参数config.Environment 决定要不要跑mock的环境

      if config.Environment == "local" {
          coconut_model.InitMock()
      } else {
          coconut_model.Init(session)
      }
  

• 调整 rpc.go

      limitSettings, err := coconut_model.LimitSQL.GetLimit()
  

Mock 在以前使用 Http API的时候比较能明显感受到它的便利性, 只要API格式确认之後就可以Mock出来开发,後来使用gRPC服务之後就有spec可以参考了, 所以目前比较常用来Mock的是对资料库或redis取资料的回应状况。