如何用PHPUnit测试覆盖WordPress主题PHP文件中的HTML代码？

我在为WordPress子主题做代码覆盖率测试时，遇到了patterns目录下PHP文件无法被覆盖的问题，以patterns/header.php为例：

问题1：require引入文件触发PHPUnit风险警告 #

直接创建测试文件并通过require引入该文件时，会收到PHPUnit的风险警告：

There was 1 risky test:

1. headerTest::testheader
   This test executed code that is not listed as code to be covered or used:

• /opt/homebrew/var/www/wp-content/themes/flex/patterns/header.php:10
• /opt/homebrew/var/www/wp-content/themes/flex/patterns/header.php:11
• /opt/homebrew/var/www/wp-content/themes/flex/patterns/header.php:12
• /opt/homebrew/var/www/wp-content/themes/flex/patterns/header.php:13
• /opt/homebrew/var/www/wp-content/themes/flex/patterns/header.php:14
• /opt/homebrew/var/www/wp-content/themes/flex/patterns/header.php:15
• /opt/homebrew/var/www/wp-content/themes/flex/patterns/header.php:16
• /opt/homebrew/var/www/wp-content/themes/flex/patterns/header.php:29

/opt/homebrew/var/www/wp-content/tests/themes/patterns/headerTest.php:23

问题2：代码未计入覆盖率数据 #

查看覆盖率报告，这些代码行的执行计数为0，未被计入覆盖率：

<file name="/opt/homebrew/var/www/wp-content/themes/flex/patterns/header.php">
  <line num="10" type="stmt" count="0"/>
  <line num="11" type="stmt" count="0"/>
  <line num="12" type="stmt" count="0"/>
  <line num="13" type="stmt" count="0"/>
  <line num="14" type="stmt" count="0"/>
  <line num="15" type="stmt" count="0"/>
  <line num="16" type="stmt" count="0"/>
  <line num="29" type="stmt" count="0"/>
  <metrics loc="41" ncloc="35" classes="0" methods="0" coveredmethods="0" conditionals="0" coveredconditionals="0" statements="8" coveredstatements="0" elements="8" coveredelements="0"/>
</file>

问题3：AI生成的测试代码无效且触发提示 #

我们已经通过#[CoversFunction]和#[CoversClass]属性成功覆盖其他主题文件，但AI生成的测试代码既无法覆盖header代码，还触发了风险提示：

1. HeaderTest::testHeaderStructure
   This test does not define a code coverage target but is expected to do so

生成的测试代码如下：

<?php
use PHPUnit\Framework\TestCase;

class HeaderTest extends TestCase
{
  protected $headerContent;

  protected function setUp(): void
  {
    $this->headerContent = file_get_contents(__DIR__ . '/../../../themes/flex/patterns/header.php');
  }

  public function testHeaderStructure()
  {
    $this->assertStringContainsString('<div class="wp-block-group alignwide header-container', $this->headerContent, 'Header container not found.');
    $this->assertStringContainsString('<div class="wp-block-group alignfull logo-container', $this->headerContent, 'Logo container not found.');
    $this->assertStringContainsString('<div class="wp-block-group alignfull flex-navbar-wrapper', $this->headerContent, 'Navbar wrapper not found.');
  }
}

解决方法 #

1. 修正测试方式：执行PHP代码而非读取文件内容
   AI生成的代码只是读取文件内容做字符串校验，并未实际执行PHP代码，因此不会产生覆盖率。需要通过require或include加载文件，同时配置PHPUnit识别该文件为覆盖目标：

<?php
use PHPUnit\Framework\TestCase;

/**
 * @coversDefaultClass /opt/homebrew/var/www/wp-content/themes/flex/patterns/header.php
 */
class HeaderTest extends TestCase
{
  public function testHeaderRender()
  {
    // 输出缓冲区捕获渲染内容
    ob_start();
    require __DIR__ . '/../../../themes/flex/patterns/header.php';
    $output = ob_get_clean();

    // 验证渲染结果
    $this->assertStringContainsString('wp-block-group alignwide header-container', $output);
    $this->assertStringContainsString('wp-block-group alignfull logo-container', $output);
    $this->assertStringContainsString('wp-block-group alignfull flex-navbar-wrapper', $output);
  }
}

2. 配置PHPUnit的白名单
   确保phpunit.xml中包含patterns目录的文件，例如：

<coverage>
  <include>
    <directory suffix=".php">../themes/flex/</directory>
    <!-- 或者精确指定patterns目录 -->
    <directory suffix=".php">../themes/flex/patterns/</directory>
  </include>
</coverage>

3. 使用#[Covers]属性指定覆盖文件
   对于无类/函数的PHP模板文件，使用#[Covers]属性直接指定文件路径：

#[Covers('/opt/homebrew/var/www/wp-content/themes/flex/patterns/header.php')]
public function testHeaderRender()
{
  // ...测试逻辑
}

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