Merge pull request #20038 from terabytesoftw/remove-deprecated-method-set-method

Remove deprecated method `setMethod()` in tests.

Author: bizley

tests/framework/BaseYiiTest.php

@@ -8,6 +8,7 @@
 namespace yiiunit\framework;
 
 use Yii;
+use yii\base\InvalidConfigException;
 use yii\BaseYii;
 use yii\di\Container;
 use yii\log\Logger;
@@ -90,28 +91,24 @@ public function testCreateObjectCallable(): void
         // Test passing in of normal params combined with DI params.
         $this->assertTrue(Yii::createObject(fn(Singer $singer, $a) => $a === 'a', ['a']));
 
-
         $singer = new Singer();
         $singer->firstName = 'Bob';
         $this->assertTrue(Yii::createObject(fn(Singer $singer, $a) => $singer->firstName === 'Bob', [$singer, 'a']));
-
-
         $this->assertTrue(Yii::createObject(fn(Singer $singer, $a = 3) => true));
-
         $this->assertTrue(Yii::createObject(new CallableClass()));
     }
 
     public function testCreateObjectEmptyArrayException(): void
     {
-        $this->expectException('yii\base\InvalidConfigException');
+        $this->expectException(InvalidConfigException::class);
         $this->expectExceptionMessage('Object configuration must be an array containing a "class" or "__class" element.');
 
         Yii::createObject([]);
     }
 
     public function testCreateObjectInvalidConfigException(): void
     {
-        $this->expectException('yii\base\InvalidConfigException');
+        $this->expectException(InvalidConfigException::class);
         $this->expectExceptionMessage('Unsupported configuration type: ' . gettype(null));
 
         Yii::createObject(null);
@@ -154,9 +151,9 @@ public function testSetupLogger(): void
      */
     public function testLog(): void
     {
-        $logger = $this->getMockBuilder('yii\\log\\Logger')
-            ->setMethods(['log'])
-            ->getMock();
+        $logger = $this->createMock(Logger::class);
+        $logger->onlyMethods(['log']);
+
         BaseYii::setLogger($logger);
 
         $logger->expects($this->exactly(6))

tests/framework/behaviors/CacheableWidgetBehaviorTest.php

@@ -2,9 +2,10 @@
 
 namespace yiiunit\framework\behaviors;
 
-use PHPUnit_Framework_MockObject_MockObject;
+use PHPUnit\Framework\MockObject\MockObject;
 use yii\base\Widget;
 use yii\behaviors\CacheableWidgetBehavior;
+use yii\caching\ArrayCache;
 use yiiunit\TestCase;
 
 /**
@@ -17,17 +18,13 @@ class CacheableWidgetBehaviorTest extends TestCase
 {
     /**
      * Default-initialized simple cacheable widget mock.
-     *
-     * @var PHPUnit_Framework_MockObject_MockObject|SimpleCacheableWidget|CacheableWidgetBehavior
      */
-    private $simpleWidget;
+    private MockObject|SimpleCacheableWidget|CacheableWidgetBehavior|null $simpleWidget = null;
 
     /**
      * Default-initialized dynamic cacheable widget mock.
-     *
-     * @var PHPUnit_Framework_MockObject_MockObject|DynamicCacheableWidget|CacheableWidgetBehavior
      */
-    private $dynamicWidget;
+    private MockObject|SimpleCacheableWidget|CacheableWidgetBehavior|null $dynamicWidget = null;
 
     /**
      * {@inheritdoc}
@@ -91,7 +88,7 @@ private function initializeApplicationMock(): void
         $this->mockApplication([
             'components' => [
                 'cache' => [
-                    'class' => '\yii\caching\ArrayCache',
+                    'class' => ArrayCache::class,
                 ],
             ],
             'params' => [
@@ -113,18 +110,14 @@ private function initializeWidgetMocks(): void
 
     /**
      * Returns a widget mock.
-     * @param $widgetClass
-     * @return PHPUnit_Framework_MockObject_MockObject
      */
-    private function getWidgetMock(string $widgetClass)
+    private function getWidgetMock(string $widgetClass): MockObject
     {
-        $widgetMock = $this->getMockBuilder($widgetClass)
-            ->setMethods(['run'])
+        return $this->getMockBuilder($widgetClass)
+            ->onlyMethods(['run'])
             ->enableOriginalConstructor()
             ->enableProxyingToOriginalMethods()
             ->getMock();
-
-        return $widgetMock;
     }
 }
 
@@ -159,7 +152,7 @@ public function test()
     public function behaviors()
     {
         return [
-            'cacheable' => 'yii\behaviors\CacheableWidgetBehavior',
+            'cacheable' => CacheableWidgetBehavior::class,
         ];
     }
 }

tests/framework/console/controllers/AssetControllerTest.php

@@ -7,8 +7,11 @@
 
 namespace yiiunit\framework\console\controllers;
 
+use Exception;
 use Yii;
+use yii\base\Module;
 use yii\console\controllers\AssetController;
+use yii\console\Exception as ConsoleException;
 use yii\helpers\ArrayHelper;
 use yii\helpers\FileHelper;
 use yii\helpers\StringHelper;
@@ -26,11 +29,11 @@ class AssetControllerTest extends TestCase
     /**
      * @var string path for the test files.
      */
-    protected $testFilePath = '';
+    protected string $testFilePath = '';
     /**
      * @var string test assets path.
      */
-    protected $testAssetsBasePath = '';
+    protected string $testAssetsBasePath = '';
 
     public function setUp(): void
     {
@@ -72,8 +75,8 @@ protected function removeDir($dirName)
      */
     protected function createAssetController()
     {
-        $module = $this->getMockBuilder('yii\\base\\Module')
-            ->setMethods(['fake'])
+        $module = $this->getMockBuilder(Module::class)
+            ->addMethods(['fake'])
             ->setConstructorArgs(['console'])
             ->getMock();
         $assetController = new AssetControllerMock('asset', $module);
@@ -456,7 +459,7 @@ public function testDetectCircularDependency(): void
 
         // Assert :
         $expectedExceptionMessage = ": {$namespace}\AssetA -> {$namespace}\AssetB -> {$namespace}\AssetC -> {$namespace}\AssetA";
-        $this->expectException('yii\console\Exception');
+        $this->expectException(ConsoleException::class);
         $this->expectExceptionMessage($expectedExceptionMessage);
 
         // When :

tests/framework/console/controllers/BaseMessageControllerTest.php

@@ -8,7 +8,9 @@
 namespace yiiunit\framework\console\controllers;
 
 use Yii;
+use yii\base\Module;
 use yii\console\controllers\MessageController;
+use yii\console\Exception;
 use yii\helpers\FileHelper;
 use yii\helpers\VarDumper;
 use yiiunit\TestCase;
@@ -61,8 +63,8 @@ public function tearDown(): void
      */
     protected function createMessageController()
     {
-        $module = $this->getMockBuilder('yii\\base\\Module')
-            ->setMethods(['fake'])
+        $module = $this->getMockBuilder(Module::class)
+            ->addMethods(['fake'])
             ->setConstructorArgs(['console'])
             ->getMock();
         $messageController = new MessageControllerMock('message', $module);
@@ -162,7 +164,7 @@ public function testActionConfigSubDir(): void
 
     public function testConfigFileNotExist(): void
     {
-        $this->expectException('yii\\console\\Exception');
+        $this->expectException(Exception::class);
         $this->runMessageControllerAction('extract', ['not_existing_file.php']);
     }
 

tests/framework/console/controllers/HelpControllerTest.php

@@ -7,6 +7,7 @@
 
 namespace yiiunit\framework\console\controllers;
 
+use yii\base\Module;
 use yii\console\controllers\HelpController;
 use yii\helpers\Console;
 use yiiunit\TestCase;
@@ -32,8 +33,8 @@ public function setUp(): void
      */
     protected function createController()
     {
-        $module = $this->getMockBuilder('yii\\base\\Module')
-            ->setMethods(['fake'])
+        $module = $this->getMockBuilder(Module::class)
+            ->addMethods(['fake'])
             ->setConstructorArgs(['console'])
             ->getMock();
         return new BufferedHelpController('help', $module);

tests/framework/console/controllers/MigrateControllerTestTrait.php

@@ -8,6 +8,7 @@
 namespace yiiunit\framework\console\controllers;
 
 use Yii;
+use yii\base\Module;
 use yii\console\controllers\BaseMigrateController;
 use yii\console\ExitCode;
 use yii\helpers\FileHelper;
@@ -78,8 +79,8 @@ abstract protected function getMigrationHistory();
      */
     protected function createMigrateController(array $config = [])
     {
-        $module = $this->getMockBuilder('yii\\base\\Module')
-            ->setMethods(['fake'])
+        $module = $this->getMockBuilder(Module::class)
+            ->addMethods(['fake'])
             ->setConstructorArgs(['console'])
             ->getMock();
         $class = $this->migrateControllerClass;

tests/framework/filters/AccessRuleTest.php

@@ -10,7 +10,9 @@
 use Closure;
 use Yii;
 use yii\base\Action;
+use yii\base\InvalidConfigException;
 use yii\filters\AccessRule;
+use yii\rbac\BaseManager;
 use yii\web\Controller;
 use yii\web\Request;
 use yii\web\User;
@@ -33,26 +35,16 @@ protected function setUp(): void
         $this->mockWebApplication();
     }
 
-    /**
-     * @param string $method
-     * @return Request
-     */
-    protected function mockRequest($method = 'GET')
+    protected function mockRequest(string $method = 'GET'): Request
     {
         /** @var Request $request */
-        $request = $this->getMockBuilder('\yii\web\Request')
-            ->setMethods(['getMethod'])
-            ->getMock();
+        $request = $this->createPartialMock(Request::class, ['getMethod']);
         $request->method('getMethod')->willReturn($method);
 
         return $request;
     }
 
-    /**
-     * @param string $userid optional user id
-     * @return User
-     */
-    protected function mockUser($userid = null)
+    protected function mockUser(string $userid = null): User
     {
         $user = new User([
             'identityClass' => UserIdentity::class,
@@ -65,19 +57,13 @@ protected function mockUser($userid = null)
         return $user;
     }
 
-    /**
-     * @return Action
-     */
-    protected function mockAction()
+    protected function mockAction(): Action
     {
         $controller = new Controller('site', Yii::$app);
         return new Action('test', $controller);
     }
 
-    /**
-     * @return \yii\rbac\BaseManager
-     */
-    protected function mockAuthManager()
+    protected function mockAuthManager(): BaseManager
     {
         $auth = new MockAuthManager();
         // add "createPost" permission
@@ -302,7 +288,7 @@ public function testMatchRoleWithoutUser(): void
             'roles' => ['@'],
         ]);
 
-        $this->expectException('yii\base\InvalidConfigException');
+        $this->expectException(InvalidConfigException::class);
         $rule->allows($action, false, $request);
     }
 
@@ -335,7 +321,7 @@ public function testMatchRoleSpecial(): void
     public function testMatchRolesAndPermissions(): void
     {
         $action = $this->mockAction();
-        $user = $this->getMockBuilder('\yii\web\User')->getMock();
+        $user = $this->createMock('\yii\web\User');
         $user->identityCLass = UserIdentity::class;
 
         $rule = new AccessRule([

tests/framework/filters/AjaxFilterTest.php

@@ -10,6 +10,7 @@
 use Yii;
 use yii\base\Action;
 use yii\filters\AjaxFilter;
+use yii\web\BadRequestHttpException;
 use yii\web\Controller;
 use yii\web\Request;
 use yiiunit\TestCase;
@@ -19,16 +20,10 @@
  */
 class AjaxFilterTest extends TestCase
 {
-    /**
-     * @param bool $isAjax
-     * @return Request
-     */
-    protected function mockRequest($isAjax)
+    protected function mockRequest(bool $isAjax = false): Request
     {
         /** @var Request $request */
-        $request = $this->getMockBuilder('\yii\web\Request')
-            ->setMethods(['getIsAjax'])
-            ->getMock();
+        $request = $this->createPartialMock(Request::class, ['getIsAjax']);
         $request->method('getIsAjax')->willReturn($isAjax);
 
         return $request;
@@ -45,7 +40,7 @@ public function testFilter(): void
         $this->assertTrue($filter->beforeAction($action));
 
         $filter->request = $this->mockRequest(false);
-        $this->expectException('yii\web\BadRequestHttpException');
+        $this->expectException(BadRequestHttpException::class);
         $filter->beforeAction($action);
     }
 }

tests/framework/filters/auth/AuthMethodTest.php

@@ -11,6 +11,7 @@
 use yii\base\Action;
 use yii\filters\auth\AuthMethod;
 use yii\web\Controller;
+use yii\web\UnauthorizedHttpException;
 use yiiunit\framework\filters\stubs\UserIdentity;
 use yiiunit\TestCase;
 
@@ -36,9 +37,7 @@ protected function setUp(): void
      */
     protected function createFilter($authenticateCallback)
     {
-        $filter = $this->getMockBuilder(AuthMethod::class)
-            ->setMethods(['authenticate'])
-            ->getMock();
+        $filter = $this->createPartialMock(AuthMethod::class, ['authenticate']);
         $filter->method('authenticate')->willReturnCallback($authenticateCallback);
 
         return $filter;
@@ -65,7 +64,7 @@ public function testBeforeAction(): void
         $this->assertTrue($filter->beforeAction($action));
 
         $filter = $this->createFilter(fn() => null);
-        $this->expectException('yii\web\UnauthorizedHttpException');
+        $this->expectException(UnauthorizedHttpException::class);
         $this->assertTrue($filter->beforeAction($action));
     }