Merge pull request #10 from stackkit/bugfix/failing-tests

Prefer psr/log 1.0 for older PHP support

Author: marickvantuil

.github/workflows/run-tests.yml

@@ -1,7 +1,7 @@
 name: Run tests
 
 on:
-  push:
+  pull_request:
   schedule:
     - cron: '0 0 * * *'
 
@@ -11,7 +11,7 @@ jobs:
 
     strategy:
       matrix:
-        php: [8.0, 7.4, 7.3]
+        php: [8.1, 8.0, 7.4, 7.3]
         laravel: [8.*, 7.*, 6.*, 5.8.*, 5.7.*, 5.6.*]
         os: [ubuntu-latest]
         include:
@@ -40,6 +40,16 @@ jobs:
             php: 8.0
           - laravel: 5.6.*
             php: 8.0
+          - laravel: 5.6.*
+            php: 8.1
+          - laravel: 5.7.*
+            php: 8.1
+          - laravel: 5.8.*
+            php: 8.1
+          - laravel: 6.*
+            php: 8.1
+          - laravel: 7.*
+            php: 8.1
 
     name: PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }}
 
@@ -57,6 +67,6 @@ jobs:
       - name: Install dependencies
         run: |
           composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
-          composer update --prefer-stable --prefer-dist --no-interaction --no-suggest --ignore-platform-reqs
+          composer update --prefer-stable --prefer-dist --no-interaction --ignore-platform-reqs
       - name: Execute tests
         run: vendor/bin/phpunit

composer.json

@@ -17,7 +17,8 @@
         "mockery/mockery": "^1.2",
         "orchestra/testbench": "^3.5 || ^3.6 || ^3.7 || ^3.8 || ^4.0 || ^5.0",
         "symfony/console": "^4.4|^5.0",
-        "timacdonald/log-fake": "^1.6"
+        "psr/log": "^1.0",
+        "spatie/macroable": "^1.0"
     },
     "autoload": {
         "psr-4": {

tests/GooglePublicKeyTest.php

@@ -8,7 +8,6 @@
 use Illuminate\Cache\Events\CacheHit;
 use Illuminate\Cache\Events\CacheMissed;
 use Illuminate\Cache\Events\KeyWritten;
-use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Facades\Event;
 use Mockery;
 use phpseclib\Crypt\RSA;

tests/TaskHandlerTest.php

@@ -12,16 +12,15 @@
 use Illuminate\Container\Container;
 use Illuminate\Contracts\Console\Kernel;
 use Illuminate\Http\Request;
+use Illuminate\Log\LogManager;
 use Illuminate\Support\Facades\Event;
-use Illuminate\Support\Facades\Log;
 use Mockery;
 use phpseclib\Crypt\RSA;
 use Stackkit\LaravelGoogleCloudScheduler\CloudSchedulerException;
 use Stackkit\LaravelGoogleCloudScheduler\Command;
 use Stackkit\LaravelGoogleCloudScheduler\OpenIdVerificator;
 use Stackkit\LaravelGoogleCloudScheduler\TaskHandler;
 use Throwable;
-use TiMacDonald\Log\LogFake;
 
 class TaskHandlerTest extends TestCase
 {
@@ -31,6 +30,16 @@ class TaskHandlerTest extends TestCase
     private $request;
     private $jwt;
 
+    /**
+     * @var LogManager
+     */
+    private $laravelLogger = null;
+
+    /**
+     * @var Mockery\Mock
+     */
+    private $log;
+
     public function setUp(): void
     {
         parent::setUp();
@@ -66,6 +75,26 @@ public function setUp(): void
             app(Schedule::class),
             Container::getInstance()
         );
+
+        $this->registerLogFake();
+    }
+
+    /**
+     * Mock the Laravel logger so we can assert the commands are or aren't called.
+     *
+     * @return void
+     */
+    private function registerLogFake()
+    {
+        if (is_null($this->laravelLogger)) {
+            $this->laravelLogger = app('log');
+        }
+
+        $this->log = Mockery::mock($this->laravelLogger);
+
+        $this->app->singleton('log', function () {
+            return $this->log;
+        });
     }
 
     /** @test */
@@ -180,21 +209,28 @@ public function it_prevents_overlapping_if_the_command_is_scheduled_without_over
 
         cache()->clear();
 
-        Log::shouldReceive('debug')->twice();
-
         $this->taskHandler->handle();
 
+        $this->log->shouldHaveReceived('debug')->once();
+
         $expression = '* * * * *';
         $command = ConsoleApplication::formatCommandString('test:command');
         $mutex = 'framework'.DIRECTORY_SEPARATOR.'schedule-'.sha1($expression.$command);
 
         cache()->add($mutex, true, 60);
+        $this->registerLogFake();
 
         $this->taskHandler->handle();
 
+        $this->log->shouldNotHaveReceived('debug');
+
         cache()->delete($mutex);
 
+        $this->registerLogFake();
+
         $this->taskHandler->handle();
+
+        $this->log->shouldNotHaveReceived('debug');
     }
 
     /** @test */
@@ -205,13 +241,11 @@ public function it_runs_the_before_and_after_callbacks()
         $this->openId->shouldReceive('getKidFromOpenIdToken')->andReturnNull();
         $this->openId->shouldReceive('decodeOpenIdToken')->andReturnNull();
 
-        Log::swap(new LogFake());
-
         $this->taskHandler->handle();
 
-        Log::assertLoggedMessage('info', 'log after');
-        Log::assertLoggedMessage('warning', 'log before');
-        Log::assertLoggedMessage('debug', 'did something testy');
+        $this->log->shouldHaveReceived()->info('log after')->once();
+        $this->log->shouldHaveReceived()->warning('log before')->once();
+        $this->log->shouldHaveReceived()->debug('did something testy')->once();
     }
 
     /** @test */
@@ -238,13 +272,11 @@ public function it_can_run_the_schedule_run_command()
         $this->openId->shouldReceive('getKidFromOpenIdToken')->andReturnNull();
         $this->openId->shouldReceive('decodeOpenIdToken')->andReturnNull();
 
-        Log::swap(new LogFake());
-
         $this->taskHandler->handle();
 
-        Log::assertLoggedMessage('info', 'log after');
-        Log::assertLoggedMessage('warning', 'log before');
-        Log::assertLoggedMessage('info', 'log call');
+        $this->log->shouldHaveReceived()->info('log after')->once();
+        $this->log->shouldHaveReceived()->warning('log before')->once();
+        $this->log->shouldHaveReceived()->info('log call')->once();
 
         // @todo - can't test commands run from schedule:run because testbench has no artisan binary.
         // Log::assertLoggedMessage('debug', 'did something testy');