Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge "tests/api: Add missing documentation to class properties"

Browse source
This commit is contained in:
jenkins-bot 2024-09-12 23:24:46 +00:00 committed by Gerrit Code Review
commit 88f217a052
24 changed files with 37 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
tests/phpunit/includes/api/ApiBlockTest.php
View file

@ -10,6 +10,7 @@ use MediaWiki\MainConfigNames;
use MediaWiki\Permissions\Authority;
use MediaWiki\Permissions\UltimateAuthority;
use MediaWiki\Tests\Unit\Permissions\MockAuthorityTrait;
use MediaWiki\User\User;
use MediaWiki\User\UserRigorOptions;
use MediaWiki\Utils\MWTimestamp;
@ -23,7 +24,9 @@ use MediaWiki\Utils\MWTimestamp;
class ApiBlockTest extends ApiTestCase {
use MockAuthorityTrait;
/** @var User|null */
protected $mUser = null;
/** @var DatabaseBlockStore */
private $blockStore;
protected function setUp(): void {

1
tests/phpunit/includes/api/ApiComparePagesTest.php
View file

@ -21,6 +21,7 @@ class ApiComparePagesTest extends ApiTestCase {
use TempUserTestTrait;
/** @var array */
protected static $repl = [];
protected function addPage( $page, $text, $model = CONTENT_MODEL_WIKITEXT ) {

1
tests/phpunit/includes/api/ApiOptionsTest.php
View file

@ -34,6 +34,7 @@ class ApiOptionsTest extends ApiTestCase {
private $userOptionsManagerMock;
/** @var ApiOptions */
private $mTested;
/** @var array */
private $mSession;
/** @var DerivativeContext */
private $mContext;

2
tests/phpunit/includes/api/ApiParseTest.php
View file

@ -43,7 +43,9 @@ use SkinFallback;
class ApiParseTest extends ApiTestCase {
use DummyServicesTrait;
/** @var int */
protected static $pageId;
/** @var int[] */
protected static $revIds = [];
public function addDBDataOnce() {

2
tests/phpunit/includes/api/ApiResultTest.php
View file

@ -1422,6 +1422,7 @@ class ApiResultTest extends MediaWikiIntegrationTestCase {
}
class ApiResultTestStringifiableObject implements Stringable {
/** @var string */
private $ret;
public function __construct( $ret = 'Ok' ) {
@ -1435,6 +1436,7 @@ class ApiResultTestStringifiableObject implements Stringable {
#[AllowDynamicProperties]
class ApiResultTestSerializableObject implements Stringable {
/** @var string */
private $ret;
public function __construct( $ret ) {

1
tests/phpunit/includes/api/ApiRevisionDeleteTest.php
View file

@ -20,6 +20,7 @@ use MWCryptRand;
class ApiRevisionDeleteTest extends ApiTestCase {
use MockAuthorityTrait;
/** @var int[] */
public $revs = [];
protected function setUp(): void {

2
tests/phpunit/includes/api/ApiTestCase.php
View file

@ -27,8 +27,10 @@ use ReturnTypeWillChange;
abstract class ApiTestCase extends MediaWikiLangTestCase {
use MockAuthorityTrait;
/** @var string */
protected static $apiUrl;
/** @var ApiErrorFormatter|null */
protected static $errorFormatter = null;
/**

1
tests/phpunit/includes/api/MockApi.php
View file

@ -5,6 +5,7 @@ namespace MediaWiki\Tests\Api;
use ApiBase;
class MockApi extends ApiBase {
/** @var array */
public $warnings = [];
public function execute() {

1
tests/phpunit/includes/api/MockApiQueryBase.php
View file

@ -5,6 +5,7 @@ namespace MediaWiki\Tests\Api;
use ApiQueryBase;
class MockApiQueryBase extends ApiQueryBase {
/** @var string */
private $name;
public function execute() {

4
tests/phpunit/includes/api/RandomImageGenerator.php
View file

@ -23,9 +23,13 @@ use UnexpectedValueException;
* Can fetch a random image, or also write a number of them to disk with random filenames.
*/
class RandomImageGenerator {
/** @var int */
private $minWidth = 16;
/** @var int */
private $maxWidth = 16;
/** @var int */
private $minHeight = 16;
/** @var int */
private $maxHeight = 16;
public function __construct( $options = [] ) {

1
tests/phpunit/includes/api/format/ApiFormatBaseTest.php
View file

@ -19,6 +19,7 @@ use Wikimedia\TestingAccessWrapper;
*/
class ApiFormatBaseTest extends ApiFormatTestBase {
/** @inheritDoc */
protected $printerName = 'mockbase';
protected function setUp(): void {

1
tests/phpunit/includes/api/format/ApiFormatJsonTest.php
View file

@ -12,6 +12,7 @@ use MWException;
*/
class ApiFormatJsonTest extends ApiFormatTestBase {
/** @inheritDoc */
protected $printerName = 'json';
private static function addFormatVersion( $format, $arr ) {

1
tests/phpunit/includes/api/format/ApiFormatNoneTest.php
View file

@ -10,6 +10,7 @@ use ApiResult;
*/
class ApiFormatNoneTest extends ApiFormatTestBase {
/** @inheritDoc */
protected $printerName = 'none';
public static function provideGeneralEncoding() {

1
tests/phpunit/includes/api/format/ApiFormatPhpTest.php
View file

@ -10,6 +10,7 @@ use ApiResult;
*/
class ApiFormatPhpTest extends ApiFormatTestBase {
/** @inheritDoc */
protected $printerName = 'php';
private static function addFormatVersion( $format, $arr ) {

1
tests/phpunit/includes/api/format/ApiFormatRawTest.php
View file

@ -13,6 +13,7 @@ use MWException;
*/
class ApiFormatRawTest extends ApiFormatTestBase {
/** @inheritDoc */
protected $printerName = 'raw';
/**

1
tests/phpunit/includes/api/format/ApiFormatXmlTest.php
View file

@ -12,6 +12,7 @@ use MediaWiki\Title\Title;
*/
class ApiFormatXmlTest extends ApiFormatTestBase {
/** @inheritDoc */
protected $printerName = 'xml';
protected function setUp(): void {

2
tests/phpunit/includes/api/query/ApiQueryAllUsersTest.php
View file

@ -5,6 +5,7 @@ namespace MediaWiki\Tests\Api\Query;
use MediaWiki\Permissions\UltimateAuthority;
use MediaWiki\Tests\Api\ApiTestCase;
use MediaWiki\Tests\Unit\Permissions\MockAuthorityTrait;
use MediaWiki\User\User;
/**
* @group API
@ -18,6 +19,7 @@ class ApiQueryAllUsersTest extends ApiTestCase {
private const USER_PREFIX = 'ApiQueryAllUsersTest ';
/** @var User[] */
private static $usersAdded = [];
public function addDBDataOnce() {

1
tests/phpunit/includes/api/query/ApiQueryBasicTest.php
View file

@ -34,6 +34,7 @@ use MediaWiki\Title\Title;
* @covers \ApiQuery
*/
class ApiQueryBasicTest extends ApiQueryTestBase {
/** @var Exception|null */
protected $exceptionFromAddDBData;
/**

1
tests/phpunit/includes/api/query/ApiQueryContinue2Test.php
View file

@ -30,6 +30,7 @@ use Exception;
* @covers \ApiQuery
*/
class ApiQueryContinue2Test extends ApiQueryContinueTestBase {
/** @var Exception|null */
protected $exceptionFromAddDBData;
/**

1
tests/phpunit/includes/api/query/ApiQueryContinueTest.php
View file

@ -34,6 +34,7 @@ use Exception;
* @covers \ApiQuery
*/
class ApiQueryContinueTest extends ApiQueryContinueTestBase {
/** @var Exception|null */
protected $exceptionFromAddDBData;
/**

3
tests/phpunit/includes/api/query/ApiQueryImageInfoTest.php
View file

@ -8,6 +8,7 @@ use MediaWiki\Request\FauxRequest;
use MediaWiki\Tests\Api\ApiTestCase;
use MediaWiki\Tests\Unit\Permissions\MockAuthorityTrait;
use MediaWiki\Tests\User\TempUser\TempUserTestTrait;
use MediaWiki\User\UserIdentity;
use MediaWiki\User\UserIdentityValue;
use MediaWiki\Utils\MWTimestamp;
@ -37,7 +38,9 @@ class ApiQueryImageInfoTest extends ApiTestCase {
private const IMAGE_2_TIMESTAMP = '20230101000000';
private const IMAGE_2_SIZE = 12345;
/** @var UserIdentity */
private $testUser = null;
/** @var User */
private $tempUser = null;
public function addDBData() {

1
tests/phpunit/includes/api/query/ApiQuerySiteinfoTest.php
View file

@ -27,6 +27,7 @@ use Wikimedia\TestingAccessWrapper;
class ApiQuerySiteinfoTest extends ApiTestCase {
use TempUserTestTrait;
/** @var array[]|null */
private $originalRegistryLoaded = null;
protected function tearDown(): void {

3
tests/phpunit/includes/api/query/ApiQueryWatchlistIntegrationTest.php
View file

@ -27,8 +27,9 @@ class ApiQueryWatchlistIntegrationTest extends ApiTestCase {
// TODO: This test should use Authority, but can't due to User::saveSettings
// phpcs:ignore MediaWiki.Commenting.PropertyDocumentation.WrongStyle
/** @var User */
private $loggedInUser;
/** @var User */
private $notLoggedInUser;
protected function setUp(): void {

3
tests/phpunit/includes/api/query/ApiQueryWatchlistRawIntegrationTest.php
View file

@ -16,8 +16,9 @@ use MediaWiki\Watchlist\WatchedItemQueryService;
*/
class ApiQueryWatchlistRawIntegrationTest extends ApiTestCase {
// TODO: This test should use Authority, but can't due to User::saveSettings
// phpcs:ignore MediaWiki.Commenting.PropertyDocumentation.WrongStyle
/** @var User */
private $loggedInUser;
/** @var User */
private $notLoggedInUser;
protected function setUp(): void {