优化单元测试,用不同的参数测试相同的方法


Optimizing unit tests which testing same methods with different parameters

我有很多像这样的PHP类:

class Article
{
    public function fetchAll($params) {
        if ($params["client"] == "mobile") {
            return [
                "author" => "",
                "body" => ""
            ];
        }
        return [
            "author" => "",
            "body" => "",
            "publishedOn => """
        ];
    }
}

如您所见,fetchAll()方法根据$params["client"]返回不同的字段。我需要检查这些字段的存在性。我有三种选择来实现我的目标。

(注意:所有代码都简化了,不用担心语法错误。)

方法1:不同client s 的不同测试方法

class ArticleTest extends ...
{
    public function testFetchAll() {
        $params = [];
        $data = $article->fetchAll($params);
        $this->assertEqual(array_keys($data), ["author","body","publishedOn"]);
    }
    public function testFetchAll2() {
        $params = ["client" => "mobile"];
        $data = $article->fetchAll($params);
        $this->assertEqual(array_keys($data), ["author","body"]);
    }
}

缺点:一次又一次地使用相同的代码,这是一种非常糟糕的做法。无需解释。重构真的很难。此外,这种方法将导致数十种测试方法。

方法2:针对不同client s 使用for循环

class ArticleTest extends ...
{
    public function testFetchAll() {
        for ($i=0; $i<2; $i++) {
            $params = [];
            if ($i == 1) $params["client"] = "mobile";
            $data = $article->fetchAll($params);
            if ($i == 0)
                $this->assertEqual(array_keys($data), ["author","body","publishedOn"]);
            else
                $this->assertEqual(array_keys($data), ["author","body"]);
        }
    }
}

缺点:我不确定在PHPUnit测试中使用循环是否是个好主意。代码可读性也下降了。

方法3:不同client s 的不同测试用例/测试文件

// articleTest.php
class ArticleTest extends ...
{
    public function testFetchAll() {
        $params = [];
        $data = $article->fetchAll($params);
        $this->assertEqual(array_keys($data), ["author","body","publishedOn"]);
    }
}
// articleTest2.php
class ArticleTest2 extends ...
{
    public function testFetchAll() {
        $params = ["client" => "mobile"];
        $data = $article->fetchAll($params);
        $this->assertEqual(array_keys($data), ["author","body"]);
    }
}

缺点:这种方法导致了数十个测试文件,并一再使用相同的代码。重构真的很难。

性能比较

方法1:时间:127毫秒,内存:8.00Mb

方法2:时间:125毫秒,内存:8.00Mb

方法3:时间:96毫秒,内存:8.00Mb

我正试图了解有很多这样的类,哪种方法更好,并等待关于在这种情况下优化单元测试的讨论。

EDIT:即使您的问题集中在优化上,实际上您的案例也有一个广泛接受的最佳实践,所以这就是我在回答中所展示的。

只需使用数据提供程序。有了这些,您可以执行相同的测试,将参数传递给测试方法。参数可以是params或/和预期结果的变体。

所以你可以这样做:

public function fetchAllTestData() {
    return [
        // case 1
        [
             [],  // params
             ['author', 'body', 'publishedon'] // expectedKeys
        ],
        // case 2
        [
             ['client' => 'mobile'],  // params
             ['author', 'body'] // expectedKeys
        ],
    ];
}
/**
 * @dataProvider fetchAllTestData
 */
public function testFetchAll(array $params, array $expectedKeys) {        
    $data = $article->fetchAll($params);
    $this->assertEqual($expectedKeys, array_keys($data));
}

这样,测试将针对每个dataProvider行独立执行。这意味着,如果第一个案例失败,第二个案例将进行测试,这样你就可以知道它是否也失败了。如果在测试用例中使用循环,那么无论何时出现故障,都不会测试其余的用例。

看看dataProviders文档。

注意编写测试时,请注意断言方法参数的顺序。通常,预期的数据是第一位的。如果按相反的顺序传递,则错误消息将具有误导性,并且数组和对象的比较将表明缺少行,而实际上这些行不应该存在。