bex / behat-rst-specification-locator-extension
This is an extension for Behat which allows loading specifications from reStructuredText documentation
Installs: 0
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Type:behat-extension
Requires
- php: >=7.1
- behat/behat: ^3.5.0
- doctrine/rst-parser: ^0.1.0
Requires (Dev)
- bex/behat-test-runner: ^1.3
- phpspec/phpspec: ^2.5
- phpunit/phpunit: ^8.5
This package is auto-updated.
Last update: 2024-10-23 00:30:31 UTC
README
BehatRSTSpecificationLocatorExtension is a Behat extension which allows loading specifications from reStructuredText documentation.
Installation
The recommended installation method is through Composer:
composer require --dev bex/behat-rst-specification-locator-extension
Documentation
The official documentation is available here.
TODO
- Add tests for running behat with file path as parameter
- Add tests for running behat with folder path as parameter
- Add tests for running behat without path parameter (cases: path configured in suite, path not configured)
- Make sure recursive file discovery works under any given path
- Add parse error reporting (proper error handling)
- Make sure dry-run prints the scenarios
- Fix line number reference when test fails (it should refer to the line number in the original document)
- Add the ability to run specific scenario by referring to line number (e.g.
bin/behat docs/my_doc.rst:12) - Ignore documentation files which doesn't contain gherkin code blocks
- Implement feature to ignore some code blocks from the document since probably not all scenario written in the document should be executed as automated test (note: probably can be done simply with tagging the scenario - options to just skip or exclude it entirely)
- Investigate: Is there a report generator extension already which could be used to enhance the documentation with the scenario status (passing/skipped/failed)?