[4.x] Migrate tests to Pest (#884)

* Add Pest dependencies

* Add base Pest file

* Convert test cases

* Remove non-compound imports

* Adopt expectation API

* Optimize uses

* Shift cleanup

* phpunit -> pest

* Fix tests in PR #884 PHPUnit to Pest Converter  (#885)

* fixed tests, remove method duplications, restore necessary inner classes

* Update CommandsTest.php

* temporary checks run on `shift-64622` on branch.

* fixed `TestSeeder` class not resolved

* fixed messed up names

* removed `uses` from individual files and add it in `Pest`

* extract tests to helpers

* use pest dataset

* Update AutomaticModeTest.php

* newline

* todo convention

* resolve reviews

* added `// todo@tests`

* remove shift branch from CI workflow

Co-authored-by: Samuel Štancl <samuel@archte.ch>

* check if I have write permission

* Convert newly added tests to Pest

Co-authored-by: Shift <shift@laravelshift.com>
Co-authored-by: Abrar Ahmad <abrar.dev99@gmail.com>

tests/PathIdentificationTest.php

@@ -2,8 +2,6 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\Tests;
-
 use Illuminate\Support\Facades\Route;
 use Stancl\Tenancy\Exceptions\RouteIsMissingTenantParameterException;
 use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedByPathException;
@@ -11,138 +9,117 @@ use Stancl\Tenancy\Middleware\InitializeTenancyByPath;
 use Stancl\Tenancy\Resolvers\PathTenantResolver;
 use Stancl\Tenancy\Tests\Etc\Tenant;
 
-class PathIdentificationTest extends TestCase
-{
-    public function setUp(): void
-    {
-        parent::setUp();
+beforeEach(function () {
+    PathTenantResolver::$tenantParameterName = 'tenant';
 
-        PathTenantResolver::$tenantParameterName = 'tenant';
-
-        Route::group([
-            'prefix' => '/{tenant}',
-            'middleware' => InitializeTenancyByPath::class,
-        ], function () {
-            Route::get('/foo/{a}/{b}', function ($a, $b) {
-                return "$a + $b";
-            });
+    Route::group([
+        'prefix' => '/{tenant}',
+        'middleware' => InitializeTenancyByPath::class,
+    ], function () {
+        Route::get('/foo/{a}/{b}', function ($a, $b) {
+            return "$a + $b";
         });
-    }
+    });
+});
 
-    public function tearDown(): void
-    {
-        parent::tearDown();
+afterEach(function () {
+    // Global state cleanup
+    PathTenantResolver::$tenantParameterName = 'tenant';
+});
 
-        // Global state cleanup
-        PathTenantResolver::$tenantParameterName = 'tenant';
-    }
+test('tenant can be identified by path', function () {
+    Tenant::create([
+        'id' => 'acme',
+    ]);
 
-    /** @test */
-    public function tenant_can_be_identified_by_path()
-    {
-        Tenant::create([
-            'id' => 'acme',
-        ]);
+    expect(tenancy()->initialized)->toBeFalse();
 
-        $this->assertFalse(tenancy()->initialized);
+    $this->get('/acme/foo/abc/xyz');
 
-        $this->get('/acme/foo/abc/xyz');
+    expect(tenancy()->initialized)->toBeTrue();
+    expect(tenant('id'))->toBe('acme');
+});
 
-        $this->assertTrue(tenancy()->initialized);
-        $this->assertSame('acme', tenant('id'));
-    }
+test('route actions dont get the tenant id', function () {
+    Tenant::create([
+        'id' => 'acme',
+    ]);
 
-    /** @test */
-    public function route_actions_dont_get_the_tenant_id()
-    {
-        Tenant::create([
-            'id' => 'acme',
-        ]);
+    expect(tenancy()->initialized)->toBeFalse();
 
-        $this->assertFalse(tenancy()->initialized);
+    $this
+        ->get('/acme/foo/abc/xyz')
+        ->assertContent('abc + xyz');
 
-        $this
-            ->get('/acme/foo/abc/xyz')
-            ->assertContent('abc + xyz');
+    expect(tenancy()->initialized)->toBeTrue();
+    expect(tenant('id'))->toBe('acme');
+});
 
-        $this->assertTrue(tenancy()->initialized);
-        $this->assertSame('acme', tenant('id'));
-    }
+test('exception is thrown when tenant cannot be identified by path', function () {
+    $this->expectException(TenantCouldNotBeIdentifiedByPathException::class);
 
-    /** @test */
-    public function exception_is_thrown_when_tenant_cannot_be_identified_by_path()
-    {
-        $this->expectException(TenantCouldNotBeIdentifiedByPathException::class);
+    $this
+        ->withoutExceptionHandling()
+        ->get('/acme/foo/abc/xyz');
 
-        $this
-            ->withoutExceptionHandling()
-            ->get('/acme/foo/abc/xyz');
+    expect(tenancy()->initialized)->toBeFalse();
+});
 
-        $this->assertFalse(tenancy()->initialized);
-    }
+test('onfail logic can be customized', function () {
+    InitializeTenancyByPath::$onFail = function () {
+        return 'foo';
+    };
 
-    /** @test */
-    public function onfail_logic_can_be_customized()
-    {
-        InitializeTenancyByPath::$onFail = function () {
-            return 'foo';
-        };
+    $this
+        ->get('/acme/foo/abc/xyz')
+        ->assertContent('foo');
+});
 
-        $this
-            ->get('/acme/foo/abc/xyz')
-            ->assertContent('foo');
-    }
-
-    /** @test */
-    public function an_exception_is_thrown_when_the_routes_first_parameter_is_not_tenant()
-    {
-        Route::group([
-            // 'prefix' => '/{tenant}', -- intentionally commented
-            'middleware' => InitializeTenancyByPath::class,
-        ], function () {
-            Route::get('/bar/{a}/{b}', function ($a, $b) {
-                return "$a + $b";
-            });
+test('an exception is thrown when the routes first parameter is not tenant', function () {
+    Route::group([
+        // 'prefix' => '/{tenant}', -- intentionally commented
+        'middleware' => InitializeTenancyByPath::class,
+    ], function () {
+        Route::get('/bar/{a}/{b}', function ($a, $b) {
+            return "$a + $b";
         });
+    });
 
-        Tenant::create([
-            'id' => 'acme',
-        ]);
+    Tenant::create([
+        'id' => 'acme',
+    ]);
 
-        $this->expectException(RouteIsMissingTenantParameterException::class);
+    $this->expectException(RouteIsMissingTenantParameterException::class);
 
-        $this
-            ->withoutExceptionHandling()
-            ->get('/bar/foo/bar');
-    }
+    $this
+        ->withoutExceptionHandling()
+        ->get('/bar/foo/bar');
+});
 
-    /** @test */
-    public function tenant_parameter_name_can_be_customized()
-    {
-        PathTenantResolver::$tenantParameterName = 'team';
+test('tenant parameter name can be customized', function () {
+    PathTenantResolver::$tenantParameterName = 'team';
 
-        Route::group([
-            'prefix' => '/{team}',
-            'middleware' => InitializeTenancyByPath::class,
-        ], function () {
-            Route::get('/bar/{a}/{b}', function ($a, $b) {
-                return "$a + $b";
-            });
+    Route::group([
+        'prefix' => '/{team}',
+        'middleware' => InitializeTenancyByPath::class,
+    ], function () {
+        Route::get('/bar/{a}/{b}', function ($a, $b) {
+            return "$a + $b";
         });
+    });
 
-        Tenant::create([
-            'id' => 'acme',
-        ]);
+    Tenant::create([
+        'id' => 'acme',
+    ]);
 
-        $this
-            ->get('/acme/bar/abc/xyz')
-            ->assertContent('abc + xyz');
+    $this
+        ->get('/acme/bar/abc/xyz')
+        ->assertContent('abc + xyz');
 
-        // Parameter for resolver is changed, so the /{tenant}/foo route will no longer work.
-        $this->expectException(RouteIsMissingTenantParameterException::class);
+    // Parameter for resolver is changed, so the /{tenant}/foo route will no longer work.
+    $this->expectException(RouteIsMissingTenantParameterException::class);
 
-        $this
-            ->withoutExceptionHandling()
-            ->get('/acme/foo/abc/xyz');
-    }
-}
+    $this
+        ->withoutExceptionHandling()
+        ->get('/acme/foo/abc/xyz');
+});