Tests: add @group Windows to more tests + mention in CONTRIBUTING #678
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
jrfnl force-pushed the feature/tests-add-windows-group-to-more-tests branch from 91ba125 to c5c0c9d Compare 
As part of PR 663, test runs on the Windows OS where introduced in CI/GH Actions. While, generally speaking, all tests should run and pass on Windows too (and they do), for the purposes of CI, a specific test group named `Windows` was introduced to allow for selectively only running the tests which _may_ have a different outcome on Windows. This group is used in the code coverage job to prevent the Windows builds taking forever. While most PHPCS code is OS agnostic, there are a number of places in the code base where OS-based conditions are used. This commit adds the `@group Windows` annotation to few more tests which hits these OS-based conditions to make sure those conditions are also hit in the code coverage builds.
This was in part already done in 663 and 677, but there was still one PHP 5.4-Windows build being run. This last one is now also excluded.
jrfnl force-pushed the feature/tests-add-windows-group-to-more-tests branch from c5c0c9d to eca6b24 Compare 1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Description
Follow up on #663
Tests: add
@group Windowsto more testsAs part of PR #663, test runs on the Windows OS where introduced in CI/GH Actions.
While, generally speaking, all tests should run and pass on Windows too (and they do), for the purposes of CI, a specific test group named
Windowswas introduced to allow for selectively only running the tests which may have a different outcome on Windows.This group is used in the code coverage job to prevent the Windows builds taking forever.
While most PHPCS code is OS agnostic, there are a number of places in the code base where OS-based conditions are used.
This commit adds the
@group Windowsannotation to few more tests which hits these OS-based conditions to make sure those conditions are also hit in the code coverage builds.CONTRIBUTING: document use of the
@group WindowsannotationGH Actions: exclude PHP 5.4-Windows combi everywhere
This was in part already done in #663 and #677, but there was still one PHP 5.4-Windows build being run.
This last one is now also excluded.
Suggested changelog entry
N/A