tests: using pest

Author: yajra

.github/workflows/continuous-integration.yml

@@ -42,4 +42,4 @@ jobs:
           command: composer update --${{ matrix.stability }} --prefer-dist --no-interaction --no-progress
 
       - name: Execute tests
-        run: vendor/bin/phpunit
+        run: vendor/bin/pest

composer.json

@@ -22,7 +22,9 @@
         "livewire/livewire": "^2.11.2|^3.0.1",
         "openspout/openspout": "^4.12.1",
         "phpoffice/phpspreadsheet": "^1.27",
-        "yajra/laravel-datatables-buttons": "^11.0"
+        "yajra/laravel-datatables-buttons": "^11.0",
+        "pestphp/pest": "^2.34",
+        "pestphp/pest-plugin-laravel": "^2.3"
     },
     "require-dev": {
         "larastan/larastan": "^2.9.1",
@@ -41,7 +43,7 @@
         }
     },
     "scripts": {
-        "test": "./vendor/bin/phpunit",
+        "test": "./vendor/bin/pest",
         "pint": "./vendor/bin/pint",
         "rector": "./vendor/bin/rector",
         "stan": "./vendor/bin/phpstan analyse --memory-limit=2G --ansi --no-progress --no-interaction --configuration=phpstan.neon.dist",
@@ -55,7 +57,10 @@
     "config": {
         "preferred-install": "dist",
         "sort-packages": true,
-        "optimize-autoloader": true
+        "optimize-autoloader": true,
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
     },
     "extra": {
         "branch-alias": {

phpunit.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+>
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

src/Jobs/DataTableExportJob.php

@@ -45,11 +45,13 @@ class DataTableExportJob implements ShouldBeUnique, ShouldQueue
 
     /**
      * Create a new job instance.
-     *
-     * @param  int|string  $user
      */
-    public function __construct(array $dataTable, public array $request, public $user, public string $sheetName = 'Sheet1')
-    {
+    public function __construct(
+        array $dataTable,
+        public array $request,
+        public ?int $user,
+        public string $sheetName = 'Sheet1'
+    ) {
         $this->dataTable = $dataTable[0];
         $this->attributes = $dataTable[1];
     }
@@ -64,7 +66,7 @@ public function __construct(array $dataTable, public array $request, public $use
      * @throws \OpenSpout\Writer\Exception\WriterNotOpenedException
      * @throws \OpenSpout\Writer\Exception\InvalidSheetNameException
      */
-    public function handle()
+    public function handle(): void
     {
         if ($this->user) {
             Event::forget(Login::class);

tests/ExportTest.php

@@ -0,0 +1,10 @@
+<?php
+
+use Illuminate\Support\Facades\DB;
+
+test('it can export to excel', function () {
+    $this->get('/users')->assertOk();
+    $batchId = $this->getAjax('/users?action=exportQueue')->getContent();
+
+    $this->assertTrue(DB::table('job_batches')->where('id', $batchId)->exists());
+});

tests/Feature/ExportTest.php

@@ -0,0 +1,48 @@
+<?php
+
+/*
+|--------------------------------------------------------------------------
+| Test Case
+|--------------------------------------------------------------------------
+|
+| The closure you provide to your test functions is always bound to a specific PHPUnit test
+| case class. By default, that class is "PHPUnit\Framework\TestCase". Of course, you may
+| need to change it using the "uses()" function to bind a different classes or traits.
+|
+*/
+
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Yajra\DataTables\Exports\Tests\TestCase;
+
+uses(TestCase::class, RefreshDatabase::class)->in('Feature');
+
+/*
+|--------------------------------------------------------------------------
+| Expectations
+|--------------------------------------------------------------------------
+|
+| When you're writing tests, you often need to check that values meet certain conditions. The
+| "expect()" function gives you access to a set of "expectations" methods that you can use
+| to assert different things. Of course, you may extend the Expectation API at any time.
+|
+*/
+
+expect()->extend('toBeOne', function () {
+    return $this->toBe(1);
+});
+
+/*
+|--------------------------------------------------------------------------
+| Functions
+|--------------------------------------------------------------------------
+|
+| While Pest is very powerful out-of-the-box, you may have some testing code specific to your
+| project that you don't want to repeat in every file. Here you can also expose helpers as
+| global functions to help you to reduce the number of lines of code in your test files.
+|
+*/
+
+function something()
+{
+    // ..
+}

tests/Pest.php

@@ -3,9 +3,11 @@
 namespace Yajra\DataTables\Exports\Tests;
 
 use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\View;
 use Illuminate\Testing\TestResponse;
 use Orchestra\Testbench\TestCase as BaseTestCase;
+use Yajra\DataTables\Exports\Tests\DataTables\UsersDataTable;
 use Yajra\DataTables\Exports\Tests\Models\User;
 
 abstract class TestCase extends BaseTestCase
@@ -29,10 +31,16 @@ protected function setUp(): void
         $this->seedDatabase();
     }
 
+    protected function defineRoutes($router): void
+    {
+        $router->get('/users', function (UsersDataTable $dataTable) {
+            return $dataTable->render('tests::users');
+        });
+    }
+
     protected function migrateDatabase(): void
     {
-        /** @var \Illuminate\Database\Schema\Builder $schemaBuilder */
-        $schemaBuilder = $this->app['db']->connection()->getSchemaBuilder();
+        $schemaBuilder = DB::getSchemaBuilder();
         if (! $schemaBuilder->hasTable('users')) {
             $schemaBuilder->create('users', function (Blueprint $table) {
                 $table->increments('id');
@@ -83,7 +91,7 @@ protected function seedDatabase(): void
      *
      * @param  \Illuminate\Foundation\Application  $app
      */
-    protected function getEnvironmentSetUp($app)
+    protected function getEnvironmentSetUp($app): void
     {
         $app['config']->set('app.debug', true);
         $app['config']->set('queue.default', 'sync');