单元测试Google的Go API客户端

时间:2018-06-05 06:36:49

标签: unit-testing go google-api client google-api-client

我目前正在Go中编写一个使用Google API go client的工作流程。我对Go来说相对较新,并且无法对客户端服务进行单元测试。以下是在Google Cloud Project中启用API的示例方法。

func (gcloudService *GCloudService) EnableApi(projectId string, apiId string) error {
  service, err := servicemanagement.New(gcloudService.Client)
  if err != nil {
      return err
  }

  requestBody := &servicemanagement.EnableServiceRequest{
      ConsumerId: consumerId(projectId),
  }

  _, err = service.Services.Enable(apiId, requestBody).Do()
  if err != nil {
      return err
  }

  return nil
}

GCloudService是一个包含客户端的简单结构。

type GCloudService struct {
   Client *http.Client
}

这是我尝试测试此方法。

var (
  mux    *http.ServeMux
  client *http.Client
  server *httptest.Server
)

func setup() {
  // test server
  mux = http.NewServeMux()
  server = httptest.NewServer(mux)

  // client configured to use test server
  client = server.Client()
}

func teardown() {
  server.Close()
}

func TestGCloudService_EnableApi(t *testing.T) {
  setup()
  defer teardown()

  projectName := "test"
  apiId := "api"

  testGcloudService := &GCloudService{
     Client: client,
  }

  path := fmt.Sprintf("/v1/services/{%s}:enable", apiId)

  mux.HandleFunc(path,
    func(w http.ResponseWriter, r *http.Request) {
        // test things...
    })

  err := testGcloudService.EnableApi(projectName, apiId)
  if err != nil {
      t.Errorf("EnableApi returned error: %v", err)
  }
}

然而,当我运行此测试时,它仍然会访问真正的Google端点而不是我的localhost服务器,因为EnableApi使用配置了API的基本URL的服务管理服务。我如何重构这个来调用我的服务器而不是API?我希望尽可能避免嘲笑整个服务管理服务。

2 个答案:

答案 0 :(得分:0)

使您的服务管理服务中的基本URL可配置或可覆盖,如果这对您来说是隐藏的,那么您的代码不是为了测试方便而编写的,更改它,如果不可能,则向谁负责。如果这没有帮助,请深呼吸,并编写一个模拟服务,这通常不需要非常复杂

答案 1 :(得分:0)

我建议创建一个自己的界面,该界面包装google api客户端并提取您感兴趣的方法。

type MyWrapperClient interface {
   SomeMethodWithCorrectReturnType() 
} 

type myWrapperClient struct {
  *GCloudService.Client // or whatever 
}

然后在目录中运行:

mockery -name=MyWrapperClient在目录内(安装嘲笑之后)

,然后您可以访问模拟版本。然后在创建对象时,将模拟替换为客户端-接口和模拟具有可互换的相同方法。然后,您可以测试是否使用特定的参数调用方法-单独保留google api客户端代码。

有关嘲讽库的更多信息,请访问:https://github.com/vektra/mockery

本文解决了您的相同问题,并且在解释如何模拟和抽象您的顾虑方面绝对很棒。

https://medium.com/agrea-technogies/mocking-dependencies-in-go-bb9739fef008