Python 单元测试模拟 API 键

Question

我正在为 client.py 的 Client class 编写单元测试，它查询 API。每个测试都使用 c = client.Client("apikey") 实例化客户端。运行一次一个测试工作正常，但运行所有测试（例如 py.test）我得到 401："Exception: Response 401: Unauthorized Access. Requests must contain a valid api-key."

我有一个有效的 API 密钥，但这不应该包含在单元测试中。我将不胜感激解释为什么 "apikey" 仅适用于一个查询。更具体地说，我如何模拟对 API 的调用？下面是一个示例单元测试：

def testGetContextReturnFields(self):
  c = client.Client("apikey")
  contexts = c.getContext("foo")

  assert(isinstance(contexts[0]["context_label"], str))
  assert(contexts[0]["context_id"] == 0)

Answer 1

将 API 调用和 Client.getContext() 方法的测试分开。为了显式测试 API 调用，修补请求对象...

import client
import httpretty
import requests
from mock import Mock, patch
...
def testGetQueryToAPI(self):
  """
  Tests the client can send a 'GET' query to the API, asserting we receive
  an HTTP status code reflecting successful operation.
  """
  # Arrange: patch the request in client.Client._queryAPI().
  with patch.object(requests, 'get') as mock_get:
    mock_get.return_value = mock_response = Mock()
    mock_response.status_code = 200

    # Act:
    c = client.Client()
    response = c._queryAPI("path", 'GET', {}, None, {})

    # Assert:
    self.assertEqual(response.status_code, 200)

# Repeat the same test for 'POST' queries.

为了测试 getContext()，使用 httpretty 模拟 HTTP...

@httpretty.activate
def testGetContextReturnFields(self):
  """
  Tests client.getContext() for a sample term.
  Asserts the returned object contains the corrcet fields and have contents as
  expected.
  """
  # Arrange: mock JSON response from API, mock out the API endpoint we expect
  # to be called.
  mockResponseString = getMockApiData("context_foo.json")
  httpretty.register_uri(httpretty.GET,
                         "http://this.is.the.url/query",
                         body=mockResponseString,
                         content_type="application/json")

  # Act: create the client object we'll be testing.
  c = client.Client()
  contexts = c.getContext("foo")

  # Assert: check the result object.
  self.assertTrue(isinstance(contexts, list),
    "Returned object is not of type list as expected.")
  self.assertTrue(("context_label" and "context_id") in contexts[0], 
    "Data structure returned by getContext() does not contain"
    " the required fields.")
  self.assertTrue(isinstance(contexts[0]["context_label"], str),
    "The \'context_label\' field is not of type string.")
  self.assertEqual(contexts[0]["context_id"], 0,
    "The top context does not have ID of zero.")

Python 单元测试模拟 API 键

Python unittest mock an API key

python

mocking

api-key

python-unittest