Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reports: add end-to-end tests #3804

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jrfnl
Copy link
Contributor

@jrfnl jrfnl commented Apr 18, 2023

... for quite a few report types.

The Reports which PHPCS can generate, were until now not covered by tests and therefore had no safeguards/QA whatsoever.

This commit sets up an initial end-to-end test suite with tests for common report types.
It doesn't have an opinion on whether or not the reports as currently generated are formatted correctly.
For now, it just codifies the current functionality.

For lack of documentation about this format in the PHPUnit docs, the test docs for PHP Core are the closest available to explain the available sections and how to apply these: https://qa.php.net/phpt_details.php

With this initial setup done, it should be fairly straight-forward to expand this end-to-end test suite to cover more report types and to add tests for other command-line options as well.
Mind: these type of tests are generally slow, so unit tests/integration tests should be preferred.

... for quite a few report types.

The Reports which PHPCS can generate, were until now not covered by tests and therefore had no safeguards/QA whatsoever.

This commit sets up an initial end-to-end test suite with tests for common report types.
It doesn't have an opinion on whether or not the reports as currently generated are formatted correctly.
For now, it just codifies the current functionality.

For lack of documentation about this format in the PHPUnit docs, the test docs for PHP Core are the closest available to explain the available sections and how to apply these: https://qa.php.net/phpt_details.php

With this initial setup done, it should be fairly straight-forward to expand this end-to-end test suite to cover more report types and to add tests for other command-line options as well.
Mind: these type of tests are generally slow, so unit tests/integration tests should be preferred.
@jrfnl jrfnl force-pushed the feature/reports-add-tests branch from 028bbdb to a1873d7 Compare May 18, 2023 11:28
@jrfnl
Copy link
Contributor Author

jrfnl commented May 18, 2023

Rebased to get past merge conflict.

@jrfnl jrfnl marked this pull request as draft May 20, 2023 03:56
@jrfnl
Copy link
Contributor Author

jrfnl commented May 20, 2023

I'm moving this PR back to draft as it looks like these tests may need some adjustments to work with PHPUnit 8/9 and I'd rather give priority to PR #3803, which unlocks the use of PHPUnit 8/9 for PHPCS itself as well as for tests for external standards which are based on the PHPCS test framework.

I will remove the tests from PR #3810, so that PR is no longer blocked by this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant