如何用Data Provider测试多维数组不同层级的键不存在

我之前在处理大型多维数组的单元测试时，也碰到过和你一样的困扰——反向测试要验证深层键不存在时，常规方法太不灵活。后来我通过自定义断言函数+Data Provider的组合解决了这个问题，既能批量测试，又能轻松处理任意层级的键路径，分享给你具体的实现方案：

一、整体思路 #

1. 正向测试：继续用你提到的assertArraySubset结合Data Provider批量验证指定键存在且值符合预期。
2. 反向测试：自定义一个断言方法，支持传入键路径（比如字符串"a.e.f"或数组['a','e','f']），迭代检查多维数组中该路径对应的键是否不存在，再配合Data Provider批量执行测试用例。

二、具体代码实现 #

1. 测试类基础结构 #

先把对象初始化逻辑放在setUp方法里，避免重复写大量初始化代码：

use PHPUnit\Framework\TestCase;

class LargeArrayGeneratorTest extends TestCase
{
    /** @var YourArrayGeneratorClass */
    private $generator;

    protected function setUp(): void
    {
        // 这里放入你的对象初始化代码，参数多的话可以提前封装好
        $this->generator = new YourArrayGeneratorClass(
            $param1, $param2, ... // 你的所有初始化参数
        );
    }

    // 后续测试方法和Data Provider写在这里
}

2. 正向测试（验证键存在） #

用Data Provider批量传入要验证的键路径和对应子集，通过assertArraySubset完成验证：

/**
 * @dataProvider validKeyPathsProvider
 */
public function testArrayContainsExpectedKeys($expectedSubset)
{
    $generatedArray = $this->generator->generateLargeArray();
    $this->assertArraySubset($expectedSubset, $generatedArray);
}

public function validKeyPathsProvider(): array
{
    return [
        '顶层键a存在' => [['a' => []]], // 仅验证a键存在，值传子集即可
        '深层键a.e.f存在' => [['a' => ['e' => ['f' => 'expected-value']]]],
        '另一深层键b.c存在' => [['b' => ['c' => []]]],
    ];
}

3. 反向测试（验证键不存在） #

先实现自定义断言方法，再用Data Provider传入所有要检查的键路径：

/**
 * @dataProvider invalidKeyPathsProvider
 */
public function testArrayDoesNotContainInvalidKeys($keyPath)
{
    $generatedArray = $this->generator->generateLargeArray();
    $this->assertArrayKeyDoesNotExistInPath($generatedArray, $keyPath);
}

public function invalidKeyPathsProvider(): array
{
    return [
        '顶层键x不存在' => ['x'],
        '深层键a.g.h不存在' => ['a.g.h'], // 支持点分隔的字符串路径
        '另一深层键b.d.e不存在' => [['b', 'd', 'e']], // 也支持数组形式的路径
        '父键不存在的路径z.y不存在' => ['z.y'], // 父键不存在时，自动判定测试通过
    ];
}

/**
 * 自定义断言：验证多维数组中指定路径的键不存在
 */
private function assertArrayKeyDoesNotExistInPath(array $array, $keyPath): void
{
    // 统一处理字符串和数组形式的键路径
    $keys = is_string($keyPath) ? explode('.', $keyPath) : $keyPath;

    $currentLevel = $array;
    foreach ($keys as $index => $key) {
        // 如果当前层级不是数组，或当前键不存在，直接判定路径不存在
        if (!is_array($currentLevel) || !array_key_exists($key, $currentLevel)) {
            return;
        }

        // 如果走到最后一个键且存在，断言失败
        if ($index === count($keys) - 1) {
            $this->fail(sprintf('数组中存在意外的键路径：%s', implode('.', $keys)));
        }

        // 进入下一层级继续检查
        $currentLevel = $currentLevel[$key];
    }
}

三、方案优势 #

• 灵活性拉满：支持任意层级的键路径，不管是顶层还是a.e.f这种深层路径都能轻松验证。
• 批量测试高效：通过Data Provider一次性定义所有测试用例，不用重复编写测试方法。
• 边界情况覆盖：自动处理父键不存在的场景（比如验证z.y时，只要z不存在就直接通过测试）。
• 代码复用性高：自定义的assertArrayKeyDoesNotExistInPath方法可以抽成Trait，在其他测试类中复用。

内容的提问来源于stack exchange，提问作者Cave Johnson