README

PHPUnit\TestListeners\TestDox

已结束生命周期

请注意：此项目将不再接收更新或修复，并在packagist.org上被标记为“废弃”。

然而，如果您以任何方式发现此代码有用，请随意分支、更改并重新发布它。适用MIT许可证。

描述

一个PHPUnit测试监听器，可以创建带有分组数据集输出的testdox markdown文件

要求

• PHP >= 7.1
• PHPUnit >= 7.0

安装

composer require --dev hollodotme/phpunit-testdox-markdown

使用方法

如果您使用PSR-4自动加载，请将以下内容添加到您的 phpunit.xml

<phpunit ...>
    <listeners>
        <listener class="hollodotme\PHPUnit\TestListeners\TestDox\Markdown">
            <arguments>
                <string name="environment">Development</string>
                <string name="outputFile">build/logs/TestDox.md</string>
            </arguments>
        </listener>
    </listeners>
</phpunit>

如果您没有使用PSR-4自动加载，也请将类的文件路径添加到 <listener> 标签中

<phpunit ...>
    <listeners>
        <listener class="hollodotme\PHPUnit\TestListeners\TestDox\Markdown" 
                  file="/path/to/vendor/hollodotme/phpunit-testdox-markdown/src/Markdown.php">
            <arguments>
                <string name="environment">Development</string>
                <string name="outputFile">build/logs/TestDox.md</string>
            </arguments>
        </listener>
    </listeners>
</phpunit>

可用的监听器参数

包含所有可用参数的示例

<phpunit ...>
    <listeners>
        <listener class="hollodotme\PHPUnit\TestListeners\TestDox\Markdown">
            <arguments>
                <string name="environment">Development</string>
                <string name="outputFile">build/logs/TestDox.md</string>
                <string name="baseNamespace">YourVendor\YourProject\Tests</string>
                <array name="testStatusMap">
                    <element key="Passed">
                        <string>💚</string>
                    </element>
                    <element key="Error">
                        <string>💔</string>
                    </element>
                    <element key="Failure">
                        <string>💔</string>
                    </element>
                    <element key="Warning">
                        <string>🧡</string>
                    </element>
                    <element key="Risky">
                        <string>💛</string>
                    </element>
                    <element key="Incomplete">
                        <string>💙</string>
                    </element>
                    <element key="Skipped">
                        <string>💜</string>
                    </element>
                </array>
            </arguments>
        </listener>
    </listeners>
</phpunit>

输出示例

💚 Passed | 💔 Error | 💔 Failure | 🧡 Warning | 💛 Risky | 💙 Incomplete | 💜 Skipped

# Test suite: Unit-Test-Suite

* Environment: `Testing`  
* Base namespace: `hollodotme\PHPUnit`  

## UnitTest

- [x] Can Have Single Test (💚 1)
- [ ] Can Have Test With Data Sets (💚 3, 💛 3, 💜 3, 💙 3, 🧡 3, 💔 3)
  > 3: DataSet is risky.  
  > 4: DataSet is risky.  
  > 5: DataSet is risky.  
  > 6: DataSet was skipped.  
  > 7: DataSet was skipped.  
  > 8: DataSet was skipped.  
  > 9: DataSet is incomplete.  
  > 10: DataSet is incomplete.  
  > 11: DataSet is incomplete.  
  > 12: DataSet creates warning.  
  > 13: DataSet creates warning.  
  > 14: DataSet creates warning.  
  > 15: DataSet fails.  
  > 16: DataSet errors out.  
  > 17: DataSet errors out.  


---

Report created at 2018-05-21 22:23:12 (UTC)

💚 通过 | 💔 错误 | 💔 失败 | 🧡 警告 | 💛 风险 | 💙 不完整 | 💜 跳过

测试套件：Unit-Test-Suite

• 环境：Testing
• 基础命名空间：hollodotme\PHPUnit

UnitTest

• 可以有单个测试（💚 1）
• 可以有具有数据集的测试（💚 3, 💛 3, 💜 3, 💙 3, 🧡 3, 💔 3）

  3：数据集是风险的。
  4：数据集是风险的。
  5：数据集是风险的。
  6：数据集被跳过。
  7：数据集被跳过。
  8：数据集被跳过。
  9：数据集是不完整的。
  10：数据集是不完整的。
  11：数据集是不完整的。
  12：数据集产生警告。
  13：数据集产生警告。
  14：数据集产生警告。
  15：数据集失败。
  16: 数据集出错。
  17: 数据集出错。

报告创建于 2018-05-21 22:23:12 (UTC)

贡献

欢迎贡献，并将获得全额认可。请参阅贡献指南以获取详细信息。