Laravel functional tests (#3)

* Test runner

* Change path detection

Added in PHPT test for asserting a real world laravel application behaves as expected with this package

L5.8 for lols

Actually use different laravel versions

ignore platform reqs

L6 and above only

Remove big swears

* Maybe fix test

* change branch name

* remove --no-suggests from composer. Fix branch for new workflow

* Maybe fix tests

Author: Mitchell Macpherson

.github/workflows/code-coverage.yaml

@@ -21,7 +21,7 @@ on:
 jobs:
   code-cov:
     runs-on: ubuntu-latest
-    name: Code coverage peport
+    name: Code coverage report
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -36,7 +36,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          composer install --no-plugins --no-scripts --no-suggest --no-interaction --no-progress --prefer-dist
+          composer install --no-plugins --no-scripts --no-interaction --no-progress --prefer-dist
 
       - name: Execute tests
         run: vendor/bin/phpunit --coverage-clover coverage.xml

.github/workflows/laravel-test.yaml

@@ -0,0 +1,72 @@
+name: Laravel IRL tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  laravel-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php: [ 7.2, 7.3, 7.4 ]
+        #laravel: [~5.6.0, ~5.7.0, ~5.8.0, ~5.9.0, ^6.0, ^7.0, ^8.0]
+        laravel: [ ^6.0, ^7.0, ^8.0 ]
+        exclude:
+          - php: 7.2
+            laravel: ^8.0
+
+    name: PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          path: 'console-logg-package'
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, curl, libxml, mbstring, zip
+          tools: composer:v2
+          coverage: none
+
+      - name: Install console-logg dependencies
+        run: |
+          cd console-logg-package
+          composer install --no-plugins --no-scripts --no-interaction --no-progress --prefer-dist
+
+      - name: Setup Laravel application
+        run: |
+          composer create-project --prefer-dist laravel/laravel:${{ matrix.laravel }} laravel-app
+          cd laravel-app
+
+      - name: Add local path composer dependency
+        run: |
+          cd laravel-app
+          jq '.repositories[0].type="path"' composer.json > composer.temp.json
+          jq '.repositories[0].url="../console-logg-package"' composer.json > composer.temp.json
+          jq '.require."devthis/console-logg"="*"' composer.json > composer.temp.json
+          mv composer.temp.json composer.json
+          composer update --no-interaction --no-progress --ignore-platform-reqs
+
+      - name: Copy fixtures into Laravel app
+        run: |
+          mkdir -p laravel-app/app/Console/Commands
+          cp console-logg-package/tests/Fixtures/ArtisanCommand.php laravel-app/app/Console/Commands/
+          cp console-logg-package/tests/Fixtures/ServiceThatLoggs.php laravel-app/app/
+
+      - name: Run Laravel package discovery
+        run: |
+          cd laravel-app
+          php artisan package:discover --ansi
+          php artisan clear-compiled
+
+      - name: Run PHPT
+        run: |
+          cd console-logg-package
+          vendor/bin/phpunit tests/PhpTestCase/ --testdox

.github/workflows/tests.yaml renamed to .github/workflows/phpunit-tests.yaml

@@ -19,7 +19,7 @@ on:
       - 'composer.*'
 
 jobs:
-  tests:
+  phpunit-tests:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -47,13 +47,11 @@ jobs:
 
       - name: Install dependencies
         run: |
-          composer require "illuminate/contracts=${{ matrix.laravel }}" --no-plugins --no-scripts --no-suggest --no-interaction --no-progress --prefer-dist
-          composer update --no-plugins --no-scripts --no-suggest --no-interaction --no-progress --prefer-dist
+          composer require "illuminate/contracts=${{ matrix.laravel }}" --no-plugins --no-scripts --no-interaction --no-progress --prefer-dist
+          composer update --no-plugins --no-scripts --no-interaction --no-progress --prefer-dist
 
       - name: Configure matchers
         uses: mheap/phpunit-matcher-action@v1
 
       - name: Execute tests
         run: vendor/bin/phpunit --teamcity
-        env:
-          STRIPE_SECRET: ${{ secrets.STRIPE_SECRET }}

CHANGELOG.md

@@ -10,6 +10,10 @@
         <testsuite name="unit">
             <directory>tests/Unit</directory>
         </testsuite>
+        <testsuite name="phpt">
+            <directory>tests/PhpTestCase</directory>
+            <directory suffix=".phpt">test</directory>
+        </testsuite>
     </testsuites>
 
     <filter>

phpunit.xml

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Console\Commands;
+
+use App\ServiceThatLoggs;
+use Illuminate\Console\Command;
+
+class ArtisanCommand extends Command
+{
+    /**
+     * The console command description.
+     */
+    protected $description = '';
+
+    /**
+     * The name and signature of the console command.
+     */
+    protected $signature = 'console-logg:test';
+
+    public function handle(ServiceThatLoggs $service): int
+    {
+        return 0;
+    }
+}

tests/Fixtures/ArtisanCommand.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App;
+
+use Psr\Log\LoggerInterface;
+
+class ServiceThatLoggs
+{
+    public function __construct(LoggerInterface $logger)
+    {
+        $logger->emergency('nice');
+        $logger->info('and');
+        $logger->alert('cool');
+    }
+}

tests/Fixtures/ServiceThatLoggs.php

@@ -0,0 +1,13 @@
+--TEST--
+artisan command log output without verbosity
+--FILE--
+<?php declare(strict_types=1);
+$_SERVER['argv'][0] = 'artisan';
+$_SERVER['argv'][1] = 'console-logg:test';
+
+require __DIR__ . '/../../../laravel-app/artisan';
+
+--EXPECT--
+#!/usr/bin/env php
+[emergency] nice
+[alert] cool

tests/PhpTestCase/artisan-command-output.phpt

@@ -77,4 +77,19 @@ public function testRegisterDoesNothingForNonConsole(): void
             $app->get(FilterableConsoleLoggerFactoryInterface::class)
         );
     }
+
+    public function testRegisterSetsFakeLoggingChannel(): void
+    {
+        $app = new ApplicationFake();
+        $serviceProvider = new ConsoleLoggServiceProvider($app);
+        $expectationBefore = null;
+        $expectationAfter = ['logging.channels.console-logg' => ['driver' => 'console-logg']];
+        $actualBefore = $app['config'] ?? null;
+        $serviceProvider->register();
+
+        $result = $app['config'] ?? null;
+
+        self::assertSame($expectationAfter, $result);
+        self::assertSame($expectationBefore, $actualBefore);
+    }
 }