[10.x] Test Improvements (#48815)

* Test Improvements Signed-off-by: Mior Muhammad Zaki <[email protected]> * wip Signed-off-by: Mior Muhammad Zaki <[email protected]> * Apply fixes from StyleCI * wip Signed-off-by: Mior Muhammad Zaki <[email protected]> * wip Signed-off-by: Mior Muhammad Zaki <[email protected]> * wip Signed-off-by: Mior Muhammad Zaki <[email protected]> * Apply fixes from StyleCI * Update CacheMemcachedStoreTest.php * wip Signed-off-by: Mior Muhammad Zaki <[email protected]> * wip Signed-off-by: Mior Muhammad Zaki <[email protected]> * wip Signed-off-by: Mior Muhammad Zaki <[email protected]> * Apply fixes from StyleCI --------- Signed-off-by: Mior Muhammad Zaki <[email protected]> Co-authored-by: StyleCI Bot <[email protected]>
laravel · Oct 25, 2023 · 38e7183 · 38e7183
1 parent d900366
commit 38e7183
Show file tree

Hide file tree

Showing 9 changed files with 141 additions and 80 deletions.
diff --git a/tests/Auth/AuthPasswordBrokerTest.php b/tests/Auth/AuthPasswordBrokerTest.php
@@ -22,20 +22,16 @@ protected function tearDown(): void
     public function testIfUserIsNotFoundErrorRedirectIsReturned()
     {
         $mocks = $this->getMocks();
-        $broker = $this->getMockBuilder(PasswordBroker::class)
-            ->onlyMethods(['getUser'])
-            ->addMethods(['makeErrorRedirect'])
-            ->setConstructorArgs(array_values($mocks))
-            ->getMock();
-        $broker->expects($this->once())->method('getUser')->willReturn(null);
+        $broker = m::mock(PasswordBroker::class, array_values($mocks))->makePartial();
+        $broker->shouldReceive('getUser')->once()->andReturnNull();
 
         $this->assertSame(PasswordBrokerContract::INVALID_USER, $broker->sendResetLink(['credentials']));
     }
 
     public function testIfTokenIsRecentlyCreated()
     {
         $mocks = $this->getMocks();
-        $broker = $this->getMockBuilder(PasswordBroker::class)->addMethods(['emailResetLink', 'getUri'])->setConstructorArgs(array_values($mocks))->getMock();
+        $broker = m::mock(PasswordBroker::class, array_values($mocks))->makePartial();
         $mocks['users']->shouldReceive('retrieveByCredentials')->once()->with(['foo'])->andReturn($user = m::mock(CanResetPassword::class));
         $mocks['tokens']->shouldReceive('recentlyCreatedToken')->once()->with($user)->andReturn(true);
         $user->shouldReceive('sendPasswordResetNotification')->with('token');
@@ -65,7 +61,7 @@ public function testUserIsRetrievedByCredentials()
     public function testBrokerCreatesTokenAndRedirectsWithoutError()
     {
         $mocks = $this->getMocks();
-        $broker = $this->getMockBuilder(PasswordBroker::class)->addMethods(['emailResetLink', 'getUri'])->setConstructorArgs(array_values($mocks))->getMock();
+        $broker = m::mock(PasswordBroker::class, array_values($mocks))->makePartial();
         $mocks['users']->shouldReceive('retrieveByCredentials')->once()->with(['foo'])->andReturn($user = m::mock(CanResetPassword::class));
         $mocks['tokens']->shouldReceive('recentlyCreatedToken')->once()->with($user)->andReturn(false);
         $mocks['tokens']->shouldReceive('create')->once()->with($user)->andReturn('token');
@@ -99,12 +95,9 @@ public function testRedirectReturnedByRemindWhenRecordDoesntExistInTable()
     public function testResetRemovesRecordOnReminderTableAndCallsCallback()
     {
         unset($_SERVER['__password.reset.test']);
-        $broker = $this->getMockBuilder(PasswordBroker::class)
-            ->onlyMethods(['validateReset'])
-            ->addMethods(['getPassword', 'getToken'])
-            ->setConstructorArgs(array_values($mocks = $this->getMocks()))
-            ->getMock();
-        $broker->expects($this->once())->method('validateReset')->willReturn($user = m::mock(CanResetPassword::class));
+        $mocks = $this->getMocks();
+        $broker = m::mock(PasswordBroker::class, array_values($mocks))->makePartial()->shouldAllowMockingProtectedMethods();
+        $broker->shouldReceive('validateReset')->once()->andReturn($user = m::mock(CanResetPassword::class));
         $mocks['tokens']->shouldReceive('delete')->once()->with($user);
         $callback = function ($user, $password) {
             $_SERVER['__password.reset.test'] = compact('user', 'password');
@@ -125,7 +118,7 @@ public function testExecutesCallbackInsteadOfSendingNotification()
         };
 
         $mocks = $this->getMocks();
-        $broker = $this->getMockBuilder(PasswordBroker::class)->addMethods(['emailResetLink', 'getUri'])->setConstructorArgs(array_values($mocks))->getMock();
+        $broker = m::mock(PasswordBroker::class, array_values($mocks))->makePartial();
         $mocks['users']->shouldReceive('retrieveByCredentials')->once()->with(['foo'])->andReturn($user = m::mock(CanResetPassword::class));
         $mocks['tokens']->shouldReceive('recentlyCreatedToken')->once()->with($user)->andReturn(false);
         $mocks['tokens']->shouldReceive('create')->once()->with($user)->andReturn('token');

diff --git a/tests/Cache/CacheMemcachedStoreTest.php b/tests/Cache/CacheMemcachedStoreTest.php
@@ -7,7 +7,6 @@
 use Memcached;
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
-use stdClass;
 
 /**
  * @requires extension memcached
@@ -23,7 +22,7 @@ protected function tearDown(): void
 
     public function testGetReturnsNullWhenNotFound()
     {
-        $memcache = $this->getMockBuilder(stdClass::class)->addMethods(['get', 'getResultCode'])->getMock();
+        $memcache = $this->getMockBuilder(Memcached::class)->onlyMethods(['get', 'getResultCode'])->getMock();
         $memcache->expects($this->once())->method('get')->with($this->equalTo('foo:bar'))->willReturn(null);
         $memcache->expects($this->once())->method('getResultCode')->willReturn(1);
         $store = new MemcachedStore($memcache, 'foo');
@@ -32,7 +31,7 @@ public function testGetReturnsNullWhenNotFound()
 
     public function testMemcacheValueIsReturned()
     {
-        $memcache = $this->getMockBuilder(stdClass::class)->addMethods(['get', 'getResultCode'])->getMock();
+        $memcache = $this->getMockBuilder(Memcached::class)->onlyMethods(['get', 'getResultCode'])->getMock();
         $memcache->expects($this->once())->method('get')->willReturn('bar');
         $memcache->expects($this->once())->method('getResultCode')->willReturn(0);
         $store = new MemcachedStore($memcache);
@@ -41,7 +40,7 @@ public function testMemcacheValueIsReturned()
 
     public function testMemcacheGetMultiValuesAreReturnedWithCorrectKeys()
     {
-        $memcache = $this->getMockBuilder(stdClass::class)->addMethods(['getMulti', 'getResultCode'])->getMock();
+        $memcache = $this->getMockBuilder(Memcached::class)->onlyMethods(['getMulti', 'getResultCode'])->getMock();
         $memcache->expects($this->once())->method('getMulti')->with(
             ['foo:foo', 'foo:bar', 'foo:baz']
         )->willReturn([

diff --git a/tests/Database/DatabaseConcernsBuildsQueriesTraitTest.php b/tests/Database/DatabaseConcernsBuildsQueriesTraitTest.php
@@ -9,7 +9,11 @@ class DatabaseConcernsBuildsQueriesTraitTest extends TestCase
 {
     public function testTapCallbackInstance()
     {
-        $mock = $this->getMockForTrait(BuildsQueries::class);
+        $mock = new class
+        {
+            use BuildsQueries;
+        };
+
         $mock->tap(function ($builder) use ($mock) {
             $this->assertEquals($mock, $builder);
         });

diff --git a/tests/Database/DatabaseConnectionTest.php b/tests/Database/DatabaseConnectionTest.php
@@ -117,11 +117,11 @@ public function testSelectResultsetsReturnsMultipleRowset()
         $statement->expects($this->once())->method('bindValue')->with(1, 'foo', 2);
         $statement->expects($this->once())->method('execute');
         $statement->expects($this->atLeastOnce())->method('fetchAll')->willReturn(['boom']);
-        $statement->expects($this->atLeastOnce())->method('nextRowset')->will($this->returnCallback(function () {
+        $statement->expects($this->atLeastOnce())->method('nextRowset')->willReturnCallback(function () {
             static $i = 1;
 
             return ++$i <= 2;
-        }));
+        });
         $pdo->expects($this->once())->method('prepare')->with('CALL a_procedure(?)')->willReturn($statement);
         $mock = $this->getMockConnection(['prepareBindings'], $writePdo);
         $mock->setReadPdo($pdo);

diff --git a/tests/Foundation/Testing/DatabaseMigrationsTest.php b/tests/Foundation/Testing/DatabaseMigrationsTest.php
@@ -2,33 +2,36 @@
 
 namespace Illuminate\Tests\Foundation\Testing;
 
-use Illuminate\Contracts\Console\Kernel;
+use Illuminate\Foundation\Testing\Concerns\InteractsWithConsole;
 use Illuminate\Foundation\Testing\DatabaseMigrations;
 use Illuminate\Foundation\Testing\RefreshDatabaseState;
 use Mockery as m;
+use Orchestra\Testbench\Concerns\Testing;
+use Orchestra\Testbench\Foundation\Application as Testbench;
 use PHPUnit\Framework\TestCase;
 use ReflectionMethod;
 
+use function Orchestra\Testbench\package_path;
+
 class DatabaseMigrationsTest extends TestCase
 {
     protected $traitObject;
 
     protected function setUp(): void
     {
-        RefreshDatabaseState::$migrated = false;
+        $this->traitObject = m::mock(DatabaseMigrationsTestMockClass::class)->makePartial();
+        $this->traitObject->setUp();
+    }
 
-        $this->traitObject = $this->getMockForAbstractClass(DatabaseMigrationsTestMockClass::class, [], '', true, true, true, [
-            'artisan',
-            'beforeApplicationDestroyed',
-        ]);
+    protected function tearDown(): void
+    {
+        $this->traitObject->tearDown();
 
-        $kernelObj = m::mock();
-        $kernelObj->shouldReceive('setArtisan')
-            ->with(null);
+        if ($container = m::getContainer()) {
+            $this->addToAssertionCount($container->mockery_getExpectationCount());
+        }
 
-        $this->traitObject->app = [
-            Kernel::class => $kernelObj,
-        ];
+        m::close();
     }
 
     private function __reflectAndSetupAccessibleForProtectedTraitMethod($methodName)
@@ -44,8 +47,8 @@ private function __reflectAndSetupAccessibleForProtectedTraitMethod($methodName)
     public function testRefreshTestDatabaseDefault()
     {
         $this->traitObject
-            ->expects($this->once())
-            ->method('artisan')
+            ->shouldReceive('artisan')
+            ->once()
             ->with('migrate:fresh', [
                 '--drop-views' => false,
                 '--drop-types' => false,
@@ -62,8 +65,8 @@ public function testRefreshTestDatabaseWithDropViewsOption()
         $this->traitObject->dropViews = true;
 
         $this->traitObject
-            ->expects($this->once())
-            ->method('artisan')
+            ->shouldReceive('artisan')
+            ->once()
             ->with('migrate:fresh', [
                 '--drop-views' => true,
                 '--drop-types' => false,
@@ -80,8 +83,8 @@ public function testRefreshTestDatabaseWithDropTypesOption()
         $this->traitObject->dropTypes = true;
 
         $this->traitObject
-            ->expects($this->once())
-            ->method('artisan')
+            ->shouldReceive('artisan')
+            ->once()
             ->with('migrate:fresh', [
                 '--drop-views' => false,
                 '--drop-types' => true,
@@ -97,10 +100,43 @@ public function testRefreshTestDatabaseWithDropTypesOption()
 class DatabaseMigrationsTestMockClass
 {
     use DatabaseMigrations;
-
-    public $app;
+    use InteractsWithConsole;
+    use Testing;
 
     public $dropViews = false;
 
     public $dropTypes = false;
+
+    public function setUp()
+    {
+        RefreshDatabaseState::$migrated = false;
+
+        $this->app = $this->refreshApplication();
+        $this->withoutMockingConsoleOutput();
+    }
+
+    public function tearDown()
+    {
+        RefreshDatabaseState::$migrated = false;
+
+        $this->callBeforeApplicationDestroyedCallbacks();
+        $this->app?->flush();
+    }
+
+    protected function setUpTraits()
+    {
+        return [];
+    }
+
+    protected function setUpTheTestEnvironmentTraitToBeIgnored(string $use): bool
+    {
+        return true;
+    }
+
+    protected function refreshApplication()
+    {
+        return Testbench::create(
+            basePath: package_path('vendor/orchestra/testbench-core/laravel')
+        );
+    }
 }
diff --git a/tests/Foundation/Testing/RefreshDatabaseTest.php b/tests/Foundation/Testing/RefreshDatabaseTest.php
@@ -2,13 +2,17 @@
 
 namespace Illuminate\Tests\Foundation\Testing;
 
-use Illuminate\Contracts\Console\Kernel;
+use Illuminate\Foundation\Testing\Concerns\InteractsWithConsole;
 use Illuminate\Foundation\Testing\RefreshDatabase;
 use Illuminate\Foundation\Testing\RefreshDatabaseState;
 use Mockery as m;
+use Orchestra\Testbench\Concerns\Testing;
+use Orchestra\Testbench\Foundation\Application as Testbench;
 use PHPUnit\Framework\TestCase;
 use ReflectionMethod;
 
+use function Orchestra\Testbench\package_path;
+
 class RefreshDatabaseTest extends TestCase
 {
     protected $traitObject;
@@ -17,18 +21,19 @@ protected function setUp(): void
     {
         RefreshDatabaseState::$migrated = false;
 
-        $this->traitObject = $this->getMockForAbstractClass(RefreshDatabaseTestMockClass::class, [], '', true, true, true, [
-            'artisan',
-            'beginDatabaseTransaction',
-        ]);
+        $this->traitObject = m::mock(RefreshDatabaseTestMockClass::class)->makePartial();
+        $this->traitObject->setUp();
+    }
+
+    protected function tearDown(): void
+    {
+        $this->traitObject->tearDown();
 
-        $kernelObj = m::mock();
-        $kernelObj->shouldReceive('setArtisan')
-            ->with(null);
+        if ($container = m::getContainer()) {
+            $this->addToAssertionCount($container->mockery_getExpectationCount());
+        }
 
-        $this->traitObject->app = [
-            Kernel::class => $kernelObj,
-        ];
+        m::close();
     }
 
     private function __reflectAndSetupAccessibleForProtectedTraitMethod($methodName)
@@ -44,8 +49,8 @@ private function __reflectAndSetupAccessibleForProtectedTraitMethod($methodName)
     public function testRefreshTestDatabaseDefault()
     {
         $this->traitObject
-            ->expects($this->once())
-            ->method('artisan')
+            ->shouldReceive('artisan')
+            ->once()
             ->with('migrate:fresh', [
                 '--drop-views' => false,
                 '--drop-types' => false,
@@ -62,8 +67,8 @@ public function testRefreshTestDatabaseWithDropViewsOption()
         $this->traitObject->dropViews = true;
 
         $this->traitObject
-            ->expects($this->once())
-            ->method('artisan')
+            ->shouldReceive('artisan')
+            ->once()
             ->with('migrate:fresh', [
                 '--drop-views' => true,
                 '--drop-types' => false,
@@ -80,8 +85,8 @@ public function testRefreshTestDatabaseWithDropTypesOption()
         $this->traitObject->dropTypes = true;
 
         $this->traitObject
-            ->expects($this->once())
-            ->method('artisan')
+            ->shouldReceive('artisan')
+            ->once()
             ->with('migrate:fresh', [
                 '--drop-views' => false,
                 '--drop-types' => true,
@@ -96,11 +101,44 @@ public function testRefreshTestDatabaseWithDropTypesOption()
 
 class RefreshDatabaseTestMockClass
 {
+    use InteractsWithConsole;
     use RefreshDatabase;
-
-    public $app;
+    use Testing;
 
     public $dropViews = false;
 
     public $dropTypes = false;
+
+    public function setUp()
+    {
+        RefreshDatabaseState::$migrated = false;
+
+        $this->app = $this->refreshApplication();
+        $this->withoutMockingConsoleOutput();
+    }
+
+    public function tearDown()
+    {
+        RefreshDatabaseState::$migrated = false;
+
+        $this->callBeforeApplicationDestroyedCallbacks();
+        $this->app?->flush();
+    }
+
+    protected function setUpTraits()
+    {
+        return [];
+    }
+
+    protected function setUpTheTestEnvironmentTraitToBeIgnored(string $use): bool
+    {
+        return true;
+    }
+
+    public function refreshApplication()
+    {
+        return Testbench::create(
+            basePath: package_path('vendor/orchestra/testbench-core/laravel')
+        );
+    }
 }
diff --git a/tests/Foundation/Testing/Traits/CanConfigureMigrationCommandsTest.php b/tests/Foundation/Testing/Traits/CanConfigureMigrationCommandsTest.php
@@ -12,7 +12,7 @@ class CanConfigureMigrationCommandsTest extends TestCase
 
     protected function setUp(): void
     {
-        $this->traitObject = $this->getMockForAbstractClass(CanConfigureMigrationCommandsTestMockClass::class);
+        $this->traitObject = new CanConfigureMigrationCommandsTestMockClass();
     }
 
     private function __reflectAndSetupAccessibleForProtectedTraitMethod($methodName)