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

Tests: Add ugly integration test for Reports\Full #664

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

Conversation

MatmaRex
Copy link
Contributor

The class does not really have individually testable components. Provide a big ugly real report data as the input, and a big ugly real generated report as the output. This is not great, but it's something.

The Full report ignores the $phpcsFile argument, so it's easy to mock. Other reports would require a more complicated setup to test.

The test data has been generated from a file simple.php as follows:

<?php

    // This is a space indented line.
    $a = 10;
	// This is a tab indented line.

…using the following command for the output:

phpcs simple.php --basepath=. --report=full --tab-width=4 --no-colors --standard=generic

…and adding this snippet in generateFileReport() for the input:

var_export($report);

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
    • This change is only breaking for integrators, not for external standards or end-users.
  • Documentation improvement

PR checklist

  • I have checked there is no other PR open for the same change.
  • I have read the Contribution Guidelines.
  • I grant the project the right to include and distribute the code under the BSD-3-Clause license (and I have the right to grant these rights).
  • I have added tests to cover my changes.
  • I have verified that the code complies with the projects coding standards.
  • [Required for new sniffs] I have added XML documentation for the sniff.

@MatmaRex
Copy link
Contributor Author

I could add some more test cases, but I thought I'd submit this first to see what you think about this kind of test.

The class does not really have individually testable components.
Provide a big ugly real report data as the input, and a big ugly real
generated report as the output. This is not great, but it's something.

The Full report ignores the $phpcsFile argument, so it's easy to mock.
Other reports would require a more complicated setup to test.

The test data has been generated from a file `simple.php` as follows:
```
<?php

    // This is a space indented line.
    $a = 10;
	// This is a tab indented line.
```
…using the following command for the output:
```
phpcs simple.php --basepath=. --report=full --tab-width=4 --no-colors --standard=generic
```
…and adding this snippet in generateFileReport() for the input:
```
echo var_export($report);
```
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