wiki.techinc.nl/tests/phpunit/MediaWikiCoversValidator.php
Daimona Eaytoy 7a494d1fa4 tests: Upgrade PHPUnit from 8.5+ to 9.5+
* DeprecatedHooksTest: Don't use assertContains().
* Replace uses of deprecated asserts:
  - assertFileNotExists() -> assertFileDoesNotExist()
* Update hierarchy of MediaWikiPHPUnitResultPrinter, since ResultPrinter
  is an interface in PHPUnit 9.
* Remove temporary forward-compat methods.
* Remove directories that don't exist from tests/phpunit/suite.xml, since
  they now make PHPUnit exit:
   - tests/phpunit/skins, it used to have SideBarTest, then moved to
     tests/phpunit/includes/skins
   - tests/phpunit/documentation, it used to have ReleaseNotesTest, then
     moved to tests/phpunit/unit/documentation
* Update configuration with --migrate-configuration and reformat.
* Avoid redefining getMockBuilder() in
  ActionModuleBasedHandlerTestTrait, use a @method annotation instead.
* In RCCacheEntryFactoryTest, avoid using internal PHPUnit logic for
  HTML validation, and use native PHP methods instead. The code was
  copied from Xml::load (moved to \Xml\Loader::load in PHPUnit 9) and
  simplified for this use case.

Bug: T243600
Bug: T262076
Change-Id: I851b9158b73d0cfc315eed9d63b15c54b05895e3
2022-10-08 02:03:55 +02:00

58 lines
2 KiB
PHP

<?php
/**
* Copyright (C) 2017 Kunal Mehta <legoktm@debian.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*/
use PHPUnit\Framework\CodeCoverageException;
use PHPUnit\Util\Test;
/**
* Check that `@covers` tags are valid. PHPUnit only does this when generating
* code coverage reports, which is slow and we generally don't do that when
* running tests during development and pre-merge in CI.
*
* @since 1.31
*/
trait MediaWikiCoversValidator {
/**
* Assert that all "test*" methods in the host class have valid `@covers` tags.
*
* Don't use a data provider here because this assertion will be run many
* thousands of times in CI, and the implicit overhead from PHPUnit with
* generating and executing a test case around each becomes rather significant
* at that scale. Also, when using a data provider, the setUp() and tearDown()
* of the host class would be re-run for every check, which becomes very
* expensive for integration tests that involve databases.
* @coversNothing
*/
public function testValidCovers() {
$class = static::class;
foreach ( get_class_methods( $this ) as $method ) {
if ( str_starts_with( $method, 'test' ) ) {
try {
Test::getLinesToBeCovered( $class, $method );
} catch ( CodeCoverageException $ex ) {
$this->fail( "$class::$method: " . $ex->getMessage() );
}
}
}
$this->addToAssertionCount( 1 );
}
}