Merge pull request #2225 from WordPress/feature/allow-for-coverage-re…

…cording Tests: allow for recording code coverage + add `@covers` tags
WordPress · Apr 18, 2023 · de872bb · de872bb
2 parents 39ecc31 + 6172245
commit de872bb
Show file tree

Hide file tree

Showing 61 changed files with 158 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
-vendor
+vendor/
 composer.lock
+build/
 phpunit.xml
 phpcs.xml
 .phpcs.xml
diff --git a/WordPress/Tests/Arrays/ArrayDeclarationSpacingUnitTest.php b/WordPress/Tests/Arrays/ArrayDeclarationSpacingUnitTest.php
@@ -18,6 +18,8 @@
  *
  * @since   0.11.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\Arrays\ArrayDeclarationSpacingSniff
  */
 final class ArrayDeclarationSpacingUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/Arrays/ArrayIndentationUnitTest.php b/WordPress/Tests/Arrays/ArrayIndentationUnitTest.php
@@ -18,6 +18,8 @@
  *
  * @since   0.12.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\Arrays\ArrayIndentationSniff
  */
 final class ArrayIndentationUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/Arrays/ArrayKeySpacingRestrictionsUnitTest.php b/WordPress/Tests/Arrays/ArrayKeySpacingRestrictionsUnitTest.php
@@ -18,6 +18,8 @@
  *
  * @since   0.3.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\Arrays\ArrayKeySpacingRestrictionsSniff
  */
 final class ArrayKeySpacingRestrictionsUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/Arrays/CommaAfterArrayItemUnitTest.php b/WordPress/Tests/Arrays/CommaAfterArrayItemUnitTest.php
@@ -18,6 +18,8 @@
  *
  * @since   0.12.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\Arrays\CommaAfterArrayItemSniff
  */
 final class CommaAfterArrayItemUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/Arrays/MultipleStatementAlignmentUnitTest.php b/WordPress/Tests/Arrays/MultipleStatementAlignmentUnitTest.php
@@ -21,6 +21,8 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since   0.14.0
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\Arrays\MultipleStatementAlignmentSniff
  */
 final class MultipleStatementAlignmentUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/CodeAnalysis/AssignmentInTernaryConditionUnitTest.php b/WordPress/Tests/CodeAnalysis/AssignmentInTernaryConditionUnitTest.php
@@ -17,6 +17,8 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since   0.14.0
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\CodeAnalysis\AssignmentInTernaryConditionSniff
  */
 final class AssignmentInTernaryConditionUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/CodeAnalysis/EscapedNotTranslatedUnitTest.php b/WordPress/Tests/CodeAnalysis/EscapedNotTranslatedUnitTest.php
@@ -17,6 +17,8 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since   2.2.0
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\CodeAnalysis\EscapedNotTranslatedSniff
  */
 final class EscapedNotTranslatedUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/DB/DirectDatabaseQueryUnitTest.php b/WordPress/Tests/DB/DirectDatabaseQueryUnitTest.php
@@ -19,6 +19,9 @@
  * @since   0.3.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
  * @since   1.0.0  This sniff has been moved from the `VIP` category to the `DB` category.
+ *
+ * @covers \WordPressCS\WordPress\Helpers\RulesetPropertyHelper
+ * @covers \WordPressCS\WordPress\Sniffs\DB\DirectDatabaseQuerySniff
  */
 final class DirectDatabaseQueryUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/DB/PreparedSQLPlaceholdersUnitTest.php b/WordPress/Tests/DB/PreparedSQLPlaceholdersUnitTest.php
@@ -17,6 +17,8 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since   0.14.0
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\DB\PreparedSQLPlaceholdersSniff
  */
 final class PreparedSQLPlaceholdersUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/DB/PreparedSQLUnitTest.php b/WordPress/Tests/DB/PreparedSQLUnitTest.php
@@ -19,6 +19,9 @@
  * @since   0.8.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
  * @since   1.0.0  This sniff has been moved from the `WP` category to the `DB` category.
+ *
+ * @covers \WordPressCS\WordPress\Helpers\WPDBTrait
+ * @covers \WordPressCS\WordPress\Sniffs\DB\PreparedSQLSniff
  */
 final class PreparedSQLUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/DB/RestrictedClassesUnitTest.php b/WordPress/Tests/DB/RestrictedClassesUnitTest.php
@@ -20,6 +20,10 @@
  * @since   0.10.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
  * @since   3.0.0  Renamed the fixtures to create compatibility with PHPCS 4.x/PHPUnit >=8.
+ *
+ * @covers \WordPressCS\WordPress\AbstractClassRestrictionsSniff
+ * @covers \WordPressCS\WordPress\Helpers\RulesetPropertyHelper
+ * @covers \WordPressCS\WordPress\Sniffs\DB\RestrictedClassesSniff
  */
 final class RestrictedClassesUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/DB/RestrictedFunctionsUnitTest.php b/WordPress/Tests/DB/RestrictedFunctionsUnitTest.php
@@ -18,6 +18,8 @@
  *
  * @since   0.10.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\DB\RestrictedFunctionsSniff
  */
 final class RestrictedFunctionsUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/DB/SlowDBQueryUnitTest.php b/WordPress/Tests/DB/SlowDBQueryUnitTest.php
@@ -19,6 +19,9 @@
  * @since   0.3.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
  * @since   1.0.0  This sniff has been moved from the `VIP` category to the `DB` category.
+ *
+ * @covers \WordPressCS\WordPress\AbstractArrayAssignmentRestrictionsSniff
+ * @covers \WordPressCS\WordPress\Sniffs\DB\SlowDBQuerySniff
  */
 final class SlowDBQueryUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/DateTime/CurrentTimeTimestampUnitTest.php b/WordPress/Tests/DateTime/CurrentTimeTimestampUnitTest.php
@@ -17,6 +17,8 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since   2.2.0
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\DateTime\CurrentTimeTimestampSniff
  */
 final class CurrentTimeTimestampUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/DateTime/RestrictedFunctionsUnitTest.php b/WordPress/Tests/DateTime/RestrictedFunctionsUnitTest.php
@@ -17,6 +17,8 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since   2.2.0
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\DateTime\RestrictedFunctionsSniff
  */
 final class RestrictedFunctionsUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/Files/FileNameUnitTest.php b/WordPress/Tests/Files/FileNameUnitTest.php
@@ -19,6 +19,8 @@
  * @since   2013-06-11
  * @since   0.11.0     Actually added tests ;-)
  * @since   0.13.0     Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\Files\FileNameSniff
  */
 final class FileNameUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/NamingConventions/PrefixAllGlobalsUnitTest.php b/WordPress/Tests/NamingConventions/PrefixAllGlobalsUnitTest.php
@@ -18,6 +18,9 @@
  *
  * @since   0.12.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\Helpers\IsUnitTestTrait
+ * @covers \WordPressCS\WordPress\Sniffs\NamingConventions\PrefixAllGlobalsSniff
  */
 final class PrefixAllGlobalsUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/NamingConventions/ValidFunctionNameUnitTest.php b/WordPress/Tests/NamingConventions/ValidFunctionNameUnitTest.php
@@ -18,6 +18,9 @@
  *
  * @since   2013-06-11
  * @since   0.13.0     Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\Helpers\DeprecationHelper
+ * @covers \WordPressCS\WordPress\Sniffs\NamingConventions\ValidFunctionNameSniff
  */
 final class ValidFunctionNameUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/NamingConventions/ValidHookNameUnitTest.php b/WordPress/Tests/NamingConventions/ValidHookNameUnitTest.php
@@ -18,6 +18,9 @@
  *
  * @since   0.10.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\Helpers\WPHookHelper
+ * @covers \WordPressCS\WordPress\Sniffs\NamingConventions\ValidHookNameSniff
  */
 final class ValidHookNameUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/NamingConventions/ValidPostTypeSlugUnitTest.php b/WordPress/Tests/NamingConventions/ValidPostTypeSlugUnitTest.php
@@ -17,6 +17,8 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since   2.2.0
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\NamingConventions\ValidPostTypeSlugSniff
  */
 final class ValidPostTypeSlugUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/NamingConventions/ValidVariableNameUnitTest.php b/WordPress/Tests/NamingConventions/ValidVariableNameUnitTest.php
@@ -18,6 +18,9 @@
  *
  * @since   0.9.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\Helpers\SnakeCaseHelper
+ * @covers \WordPressCS\WordPress\Sniffs\NamingConventions\ValidVariableNameSniff
  */
 final class ValidVariableNameUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/PHP/DevelopmentFunctionsUnitTest.php b/WordPress/Tests/PHP/DevelopmentFunctionsUnitTest.php
@@ -18,6 +18,8 @@
  *
  * @since   0.11.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\PHP\DevelopmentFunctionsSniff
  */
 final class DevelopmentFunctionsUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/PHP/DiscouragedPHPFunctionsUnitTest.php b/WordPress/Tests/PHP/DiscouragedPHPFunctionsUnitTest.php
@@ -18,6 +18,8 @@
  *
  * @since   0.11.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\PHP\DiscouragedPHPFunctionsSniff
  */
 final class DiscouragedPHPFunctionsUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/PHP/DontExtractUnitTest.php b/WordPress/Tests/PHP/DontExtractUnitTest.php
@@ -19,6 +19,8 @@
  * @since   0.10.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
  * @since   1.0.0  This sniff has been moved from the `Functions` category to the `PHP` category.
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\PHP\DontExtractSniff
  */
 final class DontExtractUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/PHP/IniSetUnitTest.php b/WordPress/Tests/PHP/IniSetUnitTest.php
@@ -17,6 +17,8 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since 2.1.0
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\PHP\IniSetSniff
  */
 final class IniSetUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/PHP/NoSilencedErrorsUnitTest.php b/WordPress/Tests/PHP/NoSilencedErrorsUnitTest.php
@@ -17,6 +17,8 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since   1.1.0
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\PHP\NoSilencedErrorsSniff
  */
 final class NoSilencedErrorsUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/PHP/POSIXFunctionsUnitTest.php b/WordPress/Tests/PHP/POSIXFunctionsUnitTest.php
@@ -18,6 +18,8 @@
  *
  * @since   0.10.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\PHP\POSIXFunctionsSniff
  */
 final class POSIXFunctionsUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/PHP/PregQuoteDelimiterUnitTest.php b/WordPress/Tests/PHP/PregQuoteDelimiterUnitTest.php
@@ -17,6 +17,8 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since   1.0.0
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\PHP\PregQuoteDelimiterSniff
  */
 final class PregQuoteDelimiterUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/PHP/RestrictedPHPFunctionsUnitTest.php b/WordPress/Tests/PHP/RestrictedPHPFunctionsUnitTest.php
@@ -17,6 +17,8 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since   0.14.0
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\PHP\RestrictedPHPFunctionsSniff
  */
 final class RestrictedPHPFunctionsUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/PHP/StrictInArrayUnitTest.php b/WordPress/Tests/PHP/StrictInArrayUnitTest.php
@@ -18,6 +18,9 @@
  *
  * @since   0.9.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\AbstractFunctionParameterSniff
+ * @covers \WordPressCS\WordPress\Sniffs\PHP\StrictInArraySniff
  */
 final class StrictInArrayUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/PHP/TypeCastsUnitTest.php b/WordPress/Tests/PHP/TypeCastsUnitTest.php
@@ -17,6 +17,8 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since 1.2.0
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\PHP\TypeCastsSniff
  */
 final class TypeCastsUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/PHP/YodaConditionsUnitTest.php b/WordPress/Tests/PHP/YodaConditionsUnitTest.php
@@ -18,6 +18,8 @@
  *
  * @since   0.3.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\PHP\YodaConditionsSniff
  */
 final class YodaConditionsUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/Security/EscapeOutputUnitTest.php b/WordPress/Tests/Security/EscapeOutputUnitTest.php
@@ -19,6 +19,8 @@
  * @since   2013-06-11
  * @since   0.13.0     Class name changed: this class is now namespaced.
  * @since   1.0.0      This sniff has been moved from the `XSS` category to the `Security` category.
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\Security\EscapeOutputSniff
  */
 final class EscapeOutputUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/Security/NonceVerificationUnitTest.php b/WordPress/Tests/Security/NonceVerificationUnitTest.php
@@ -19,6 +19,8 @@
  * @since   0.5.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
  * @since   1.0.0  This sniff has been moved from the `CSRF` category to the `Security` category.
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\Security\NonceVerificationSniff
  */
 final class NonceVerificationUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/Security/PluginMenuSlugUnitTest.php b/WordPress/Tests/Security/PluginMenuSlugUnitTest.php
@@ -19,6 +19,8 @@
  * @since   0.3.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
  * @since   1.0.0  This sniff has been moved from the `VIP` category to the `Security` category.
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\Security\PluginMenuSlugSniff
  */
 final class PluginMenuSlugUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/Security/SafeRedirectUnitTest.php b/WordPress/Tests/Security/SafeRedirectUnitTest.php
@@ -17,6 +17,8 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since   1.0.0
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\Security\SafeRedirectSniff
  */
 final class SafeRedirectUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/Security/ValidatedSanitizedInputUnitTest.php b/WordPress/Tests/Security/ValidatedSanitizedInputUnitTest.php
@@ -19,6 +19,9 @@
  * @since   0.3.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
  * @since   1.0.0  This sniff has been moved from the `VIP` category to the `Security` category.
+ *
+ * @covers \WordPressCS\WordPress\Helpers\VariableHelper
+ * @covers \WordPressCS\WordPress\Sniffs\Security\ValidatedSanitizedInputSniff
  */
 final class ValidatedSanitizedInputUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/Utils/I18nTextDomainFixerUnitTest.php b/WordPress/Tests/Utils/I18nTextDomainFixerUnitTest.php
@@ -18,6 +18,8 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since   1.2.0
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\Utils\I18nTextDomainFixerSniff
  */
 final class I18nTextDomainFixerUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/WP/AlternativeFunctionsUnitTest.php b/WordPress/Tests/WP/AlternativeFunctionsUnitTest.php
@@ -18,6 +18,9 @@
  *
  * @since   0.11.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\Helpers\MinimumWPVersionTrait
+ * @covers \WordPressCS\WordPress\Sniffs\WP\AlternativeFunctionsSniff
  */
 final class AlternativeFunctionsUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/WP/CapabilitiesUnitTest.php b/WordPress/Tests/WP/CapabilitiesUnitTest.php
@@ -17,6 +17,8 @@
  *
  * @package WPCS\WordPressCodingStandards
  * @since   3.0.0
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\WP\CapabilitiesSniff
  */
 final class CapabilitiesUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/WP/CapitalPDangitUnitTest.php b/WordPress/Tests/WP/CapitalPDangitUnitTest.php
@@ -18,6 +18,8 @@
  *
  * @since   0.12.0
  * @since   0.13.0 Class name changed: this class is now namespaced.
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\WP\CapitalPDangitSniff
  */
 final class CapitalPDangitUnitTest extends AbstractSniffUnitTest {
 

diff --git a/WordPress/Tests/WP/ClassNameCaseUnitTest.php b/WordPress/Tests/WP/ClassNameCaseUnitTest.php
@@ -17,6 +17,8 @@
  * @package WPCS\WordPressCodingStandards
  *
  * @since 3.0.0
+ *
+ * @covers \WordPressCS\WordPress\Sniffs\WP\ClassNameCaseSniff
  */
 final class ClassNameCaseUnitTest extends AbstractSniffUnitTest {