如何编写与外部 API 交互的集成测试？答案

【问题标题】：How are integration tests written for interacting with external API?如何编写与外部 API 交互的集成测试？
【发布时间】：2011-09-27 03:55:03
【问题描述】：

首先，我的知识在哪里：

单元测试是测试一小段代码（主要是单个方法）的测试。

集成测试是测试多个代码区域之间交互的测试（希望它们已经有自己的单元测试）。有时，部分被测代码需要其他代码以特定方式运行。这就是 Mocks & Stubs 的用武之地。因此，我们模拟/存根部分代码以非常具体地执行。这使我们的集成测试能够以可预测的方式运行而不会产生副作用。

所有测试都应该能够独立运行而无需数据共享。如果需要数据共享，则表明系统解耦不够。

接下来，我面临的情况：

当与外部 API（特别是 RESTful API 将通过 POST 请求修改实时数据）进行交互时，我知道我们可以（应该？）模拟与该 API 的交互（在this answer 中有更雄辩的说明）用于集成测试。我也知道我们可以对与该 API 交互的各个组件进行单元测试（构造请求、解析结果、抛出错误等）。我不知道如何实际去做。

所以，最后：我的问题。

如何测试我与具有副作用的外部 API 的交互？

一个完美的例子是Google's Content API for shopping。为了能够执行手头的任务，它需要大量的准备工作，然后执行实际请求，然后分析返回值。其中一些是without any 'sandbox' environment。

执行此操作的代码通常具有相当多的抽象层，例如：

<?php
class Request
{
    public function setUrl(..){ /* ... */ }
    public function setData(..){ /* ... */ }
    public function setHeaders(..){ /* ... */ }
    public function execute(..){
        // Do some CURL request or some-such
    }   
    public function wasSuccessful(){
        // some test to see if the CURL request was successful
    }   
}

class GoogleAPIRequest
{
    private $request;
    abstract protected function getUrl();
    abstract protected function getData();

    public function __construct() {
        $this->request = new Request();
        $this->request->setUrl($this->getUrl());
        $this->request->setData($this->getData());
        $this->request->setHeaders($this->getHeaders());
    }   

    public function doRequest() {
        $this->request->execute();
    }   
    public function wasSuccessful() {
        return ($this->request->wasSuccessful() && $this->parseResult());
    }   
    private function parseResult() {
        // return false when result can't be parsed
    }   

    protected function getHeaders() {
        // return some GoogleAPI specific headers
    }   
}

class CreateSubAccountRequest extends GoogleAPIRequest
{
    private $dataObject;

    public function __construct($dataObject) {
        parent::__construct();
        $this->dataObject = $dataObject;
    }   
    protected function getUrl() {
        return "http://...";
    }
    protected function getData() {
        return $this->dataObject->getSomeValue();
    }
}

class aTest
{
    public function testTheRequest() {
        $dataObject = getSomeDataObject(..);
        $request = new CreateSubAccountRequest($dataObject);
        $request->doRequest();
        $this->assertTrue($request->wasSuccessful());
    }
}
?>

注意：这是一个 PHP5 / PHPUnit 示例

鉴于testTheRequest 是测试套件调用的方法，该示例将执行实时请求。

现在，这个实时请求将（希望一切顺利）发出一个 POST 请求，它具有改变实时数据的副作用。

这可以接受吗？我有什么选择？我看不到模拟请求对象以进行测试的方法。即使我这样做了，这也意味着为 Google API 接受的每个可能的代码路径设置结果/入口点（在这种情况下，必须通过反复试验找到），但允许我使用固定装置。

进一步的扩展是当某些请求依赖于某些数据已经是 Live 时。再次以 Google Content API 为例，要将数据 Feed 添加到子帐户，该子帐户必须已经存在。

我能想到的一种方法是以下步骤；

在testCreateAccount
1. 创建子账号
2. 断言子帐户已创建
3. 删除子账号
testCreateDataFeed 依赖于testCreateAccount 没有任何错误
1. 在testCreateDataFeed 中，创建一个新帐户
2. 创建数据馈送
3. 断言数据馈送已创建
4. 删除数据馈送
5. 删除子账号

这就引出了另一个问题；如何测试帐户/数据馈送的删除？ testCreateDataFeed 让我觉得很脏 - 如果创建数据馈送失败怎么办？测试失败，因此子帐户永远不会被删除...我无法在不创建的情况下测试删除，所以我要编写另一个依赖于testCreateAccount 的测试（testDeleteAccount），然后再创建然后删除自己的帐户（因为数据不应该在测试之间共享）。

总结

如何测试与影响实时数据的外部 API 的交互？
如何在集成测试中模拟/存根对象，如果它们隐藏在抽象层后面？
当测试失败并且实时数据处于不一致状态时，我该怎么办？
我是如何在代码中真正开始做这一切的？