open-southeners / phpunit-todo-markdown-printer
将失败的测试以Markdown格式作为待办事项列表打印出来
1.1.0
2022-12-21 13:30 UTC
Requires
- php: >=7.3
- phpunit/phpunit: ^8.0|^9.0
Requires (Dev)
- phpstan/phpstan: ^1.0
README
将失败的测试以Markdown格式作为待办事项列表打印出来
状态
入门
composer require open-southeners/phpunit-todo-markdown-printer
配置
将以下内容添加到您的 phpunit.xml
<listeners> <listener class="OpenSoutheners\PHPUnitTodoMarkdownPrinter\Printer"> <arguments> <string name="out">todo_failed_tests.md</string> <boolean name="reportRiskyTests">true</boolean> <boolean name="reportIncompleteTests">true</boolean> <boolean name="reportSkippedTests">true</boolean> </arguments> </listener> </listeners>
这样就完成了,从现在开始,您的 todo_failed_tests.md
将包含如下Markdown格式的内容。
示例输出
代码
# Failed tests A summary of tests that failed. **Total of 1 failed within 1 files**. ## CommentControllerTest - [ ] test_that_fails_mostly ``` Call to a member function getKey() on null at /Users/my_user/Projects/my_project/app/Notifications/Notification.php:34 ---------- #0 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/Framework/TestCase.php(904): PHPUnit\Framework\TestResult->run(Object(Tests\Integration\Http\Controllers\Api\CommentControllerTest)) #1 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/Framework/TestSuite.php(675): PHPUnit\Framework\TestCase->run(Object(PHPUnit\Framework\TestResult)) #2 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/Framework/TestSuite.php(675): PHPUnit\Framework\TestSuite->run(Object(PHPUnit\Framework\TestResult)) #3 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/Framework/TestSuite.php(675): PHPUnit\Framework\TestSuite->run(Object(PHPUnit\Framework\TestResult)) #4 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/TextUI/TestRunner.php(661): PHPUnit\Framework\TestSuite->run(Object(PHPUnit\Framework\TestResult)) #5 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/TextUI/Command.php(144): PHPUnit\TextUI\TestRunner->run(Object(PHPUnit\Framework\TestSuite), Array, Array, true) #6 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/TextUI/Command.php(97): PHPUnit\TextUI\Command->run(Array, true) #7 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/phpunit(98): PHPUnit\TextUI\Command::main() #8 {main} ```
预览
失败的测试
失败测试的摘要。 1个文件中有1个测试失败。
CommentControllerTest
- test_that_fails_mostly
Call to a member function getKey() on null
at /Users/my_user/Projects/my_project/app/Notifications/Notification.php:34
----------
#0 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/Framework/TestCase.php(904): PHPUnit\Framework\TestResult->run(Object(Tests\Integration\Http\Controllers\Api\CommentControllerTest))
#1 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/Framework/TestSuite.php(675): PHPUnit\Framework\TestCase->run(Object(PHPUnit\Framework\TestResult))
#2 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/Framework/TestSuite.php(675): PHPUnit\Framework\TestSuite->run(Object(PHPUnit\Framework\TestResult))
#3 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/Framework/TestSuite.php(675): PHPUnit\Framework\TestSuite->run(Object(PHPUnit\Framework\TestResult))
#4 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/TextUI/TestRunner.php(661): PHPUnit\Framework\TestSuite->run(Object(PHPUnit\Framework\TestResult))
#5 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/TextUI/Command.php(144): PHPUnit\TextUI\TestRunner->run(Object(PHPUnit\Framework\TestSuite), Array, Array, true)
#6 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/TextUI/Command.php(97): PHPUnit\TextUI\Command->run(Array, true)
#7 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/phpunit(98): PHPUnit\TextUI\Command::main()
#8 {main}