docs: updates changelog

Add support for installing Pest into a Lumen application

.github/workflows/formats.yml

@@ -1,18 +1,19 @@
-name: Continuous Integration
+name: Formats
 
 on: ['push', 'pull_request']
 
 jobs:
   ci:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
 
     strategy:
       fail-fast: true
       matrix:
-        php: [7.3, 7.4]
+        os: [ubuntu-latest]
+        php: [7.4]
         dependency-version: [prefer-lowest, prefer-stable]
 
-    name: CI - PHP ${{ matrix.php }} (${{ matrix.dependency-version }})
+    name: Formats P${{ matrix.php }} - ${{ matrix.os }} - ${{ matrix.dependency-version }}
 
     steps:
 
@@ -43,9 +44,3 @@ jobs:
 
     - name: Type Checks
       run: vendor/bin/phpstan analyse --ansi
-
-    - name: Unit Tests
-      run: bin/pest --colors=always --exclude-group=integration
-
-    - name: Integration Tests
-      run: bin/pest --colors=always --group=integration

.github/workflows/tests.yml

@@ -0,0 +1,42 @@
+name: Tests
+
+on: ['push', 'pull_request']
+
+jobs:
+  ci:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        php: [7.3, 7.4]
+        dependency-version: [prefer-lowest, prefer-stable]
+
+    name: Tests P${{ matrix.php }} - ${{ matrix.os }} - ${{ matrix.dependency-version }}
+
+    steps:
+
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Cache dependencies
+      uses: actions/cache@v1
+      with:
+        path: ~/.composer/cache/files
+        key: dependencies-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
+
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.php }}
+        extensions: mbstring, zip
+        coverage: none
+
+    - name: Install Composer dependencies
+      run: composer update --${{ matrix.dependency-version }} --no-interaction --prefer-dist
+
+    - name: Unit Tests
+      run: bin/pest --colors=always --exclude-group=integration
+
+    - name: Integration Tests
+      run: bin/pest --colors=always --group=integration

CHANGELOG.md

@@ -6,6 +6,25 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [v0.1.5 (2020-05-24)](https://github.com/pestphp/pest/compare/v0.1.4...v0.1.5)
+### Fixed
+- Missing default decorated output on coverage ([88d2391(https://github.com/pestphp/pest/commit/88d2391d2e6fe9c9416462734b9b523cb418f469))
+
+## [v0.1.4 (2020-05-24)](https://github.com/pestphp/pest/compare/v0.1.3...v0.1.4)
+### Added
+- Support to Lumen on artisan commands ([#18](https://github.com/pestphp/pest/pull/18))
+
+### Fixed
+- Mockery tests without assertions being considered risky ([415f571](https://github.com/pestphp/pest/commit/415f5719101b30c11d87f74810a71686ef2786c6))
+
+## [v0.1.3 (2020-05-21)](https://github.com/pestphp/pest/compare/v0.1.2...v0.1.3)
+### Added
+- `Plugin::uses()` method for making traits globally available ([6c4be01](https://github.com/pestphp/pest/commit/6c4be0190e9493702a976b996bbbf5150cc6bb53))
+
+## [v0.1.2 (2020-05-15)](https://github.com/pestphp/pest/compare/v0.1.1...v0.1.2)
+### Added
+- Support to custom helpers ([#7](https://github.com/pestphp/pest/pull/7))
+
 ## [v0.1.1 (2020-05-14)](https://github.com/pestphp/pest/compare/v0.1.0...v0.1.1)
 ### Added
 - `test` function without any arguments returns the current test case ([6fc55be](https://github.com/pestphp/pest/commit/6fc55becc8aecff685a958617015be1a4c118b01))

README.md

@@ -1,17 +1,18 @@
 <p align="center">
-    <img src="https://next.pestphp.com/assets/img/og.png" width="600" alt="PEST Preview">
+    <img src="https://raw.githubusercontent.com/pestphp/art/master/readme.png" width="600" alt="PEST">
     <p align="center">
-        <a href="https://github.com/pestphp/pest/actions"><img src="https://github.com/pest/pestphp/workflows/tests/badge.svg" alt="Build Status"></a>
-        <a href="https://packagist.org/packages/pestphp/pest"><img src="https://poser.pugx.org/pestphp/pest/d/total.svg" alt="Total Downloads"></a>
-        <a href="https://packagist.org/packages/pestphp/pest"><img src="https://poser.pugx.org/pestphp/pest/v/stable.svg" alt="Latest Version"></a>
-        <a href="https://packagist.org/packages/pestphp/pest"><img src="https://poser.pugx.org/pestphp/pest/license.svg" alt="License"></a>
+        <a href="https://github.com/pestphp/pest/actions"><img alt="GitHub Workflow Status (master)" src="https://img.shields.io/github/workflow/status/pestphp/pest/Continuous Integration/master"></a>
+        <a href="https://packagist.org/packages/pestphp/pest"><img alt="Total Downloads" src="https://img.shields.io/packagist/dt/pestphp/pest"></a>
+        <a href="https://packagist.org/packages/pestphp/pest"><img alt="Latest Version" src="https://img.shields.io/packagist/v/pestphp/pest"></a>
+        <a href="https://packagist.org/packages/pestphp/pest"><img alt="License" src="https://img.shields.io/packagist/l/pestphp/pest"></a>
     </p>
 </p>
 
 ------
-**Pest** it's an elegant PHP Testing Framework with a focus on simplicity. It was carefully crafted to bring the joy of testing to PHP.
+**Pest** is an elegant PHP Testing Framework with a focus on simplicity. It was carefully crafted to bring the joy of testing to PHP.
 
 - Explore the docs: **[pestphp.com »](https://pestphp.com)**
-- Join the Discord Server: **[discord.gg/4UMHUb5 »](https://discord.gg/4UMHUb5)**
+- Follow us on Twitter: **[@pestphp »](https://twitter.com/pestphp)**
+- Join us on the Discord Server: **[discord.gg/bMAJv82 »](https://discord.gg/bMAJv82)**
 
-Pest was created by **[Nuno Maduro](https://twitter.com/enunomaduro)** and is open-sourced software licensed under the **[MIT license](https://opensource.org/licenses/MIT)**.
+Pest was created by **[Nuno Maduro](https://twitter.com/enunomaduro)** under the **[Sponsorware license](https://github.com/sponsorware/docs)**. It got open-sourced and is now licensed under the **[MIT license](https://opensource.org/licenses/MIT)**.

bin/pest

@@ -27,5 +27,5 @@ use Symfony\Component\Console\Output\ConsoleOutput;
 
     ValidatesEnvironment::in($testSuite);
 
-    exit((new Command($testSuite, new ConsoleOutput()))->run($_SERVER['argv']));
+    exit((new Command($testSuite, new ConsoleOutput(ConsoleOutput::VERBOSITY_NORMAL, true)))->run($_SERVER['argv']));
 })();

composer.json

@@ -34,7 +34,10 @@
     "autoload-dev": {
         "psr-4": {
             "Tests\\": "tests/PHPUnit/"
-        }
+        },
+        "files": [
+            "tests/Autoload.php"
+        ]
     },
     "require-dev": {
         "ergebnis/phpstan-rules": "^0.14.4",

src/Actions/LoadStructure.php

@@ -22,6 +22,7 @@ final class LoadStructure
      */
     private const STRUCTURE = [
         'Datasets.php',
+        'Helpers.php',
         'Pest.php',
         'Datasets',
     ];

src/Laravel/Commands/PestInstallCommand.php

@@ -7,6 +7,7 @@ namespace Pest\Laravel\Commands;
 use Illuminate\Console\Command;
 use Illuminate\Support\Facades\File;
 use Pest\Exceptions\InvalidConsoleArgument;
+use Pest\Support\Str;
 
 /**
  * @internal
@@ -33,18 +34,39 @@ final class PestInstallCommand extends Command
     public function handle(): void
     {
         /* @phpstan-ignore-next-line */
-        $target = base_path('tests/Pest.php');
+        $pest    = base_path('tests/Pest.php');
+        /* @phpstan-ignore-next-line */
+        $helpers = base_path('tests/Helpers.php');
+        $stubs   = $this->isLumen() ? 'stubs/Lumen' : 'stubs/Laravel';
 
-        if (File::exists($target)) {
-            throw new InvalidConsoleArgument(sprintf('%s already exist', $target));
+        foreach ([$pest, $helpers] as $file) {
+            if (File::exists($file)) {
+                throw new InvalidConsoleArgument(sprintf('%s already exist', $file));
+            }
         }
 
         File::copy(implode(DIRECTORY_SEPARATOR, [
             dirname(__DIR__, 3),
-            'stubs',
+            $stubs,
             'Pest.php',
-        ]), $target);
+        ]), $pest);
+
+        File::copy(implode(DIRECTORY_SEPARATOR, [
+            dirname(__DIR__, 3),
+            $stubs,
+            'Helpers.php',
+        ]), $helpers);
 
         $this->output->success('`tests/Pest.php` created successfully.');
+        $this->output->success('`tests/Helpers.php` created successfully.');
+    }
+
+    /**
+     * Determine if this is a Lumen application.
+     */
+    private function isLumen(): bool
+    {
+        /* @phpstan-ignore-next-line */
+        return Str::startsWith(app()->version(), 'Lumen');
     }
 }

src/Plugin.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest;
+
+final class Plugin
+{
+    /**
+     * The lazy callables to be executed
+     * once the test suite boots.
+     *
+     * @var array<int, callable>
+     *
+     * @internal
+     */
+    public static $callables = [];
+
+    /**
+     * Lazy loads an `uses` call on the context of plugins.
+     */
+    public static function uses(string ...$traits): void
+    {
+        self::$callables[] = function () use ($traits): void {
+            uses(...$traits)->in(TestSuite::getInstance()->rootPath . DIRECTORY_SEPARATOR . 'tests');
+        };
+    }
+}

src/Repositories/AfterEachRepository.php

@@ -41,6 +41,12 @@ final class AfterEachRepository
 
         return ChainableClosure::from(function (): void {
             if (class_exists(Mockery::class)) {
+                /* @phpstan-ignore-next-line */
+                if ($container = Mockery::getContainer()) {
+                    /* @phpstan-ignore-next-line */
+                    $this->addToAssertionCount($container->mockery_getExpectationCount());
+                }
+
                 Mockery::close();
             }
         }, $afterEach);

src/TestSuite.php

@@ -106,7 +106,13 @@ final class TestSuite
     public static function getInstance(string $rootPath = null): TestSuite
     {
         if (is_string($rootPath)) {
-            return self::$instance ?? self::$instance = new TestSuite($rootPath);
+            self::$instance = new TestSuite($rootPath);
+
+            foreach (Plugin::$callables as $callable) {
+                $callable();
+            }
+
+            return self::$instance;
         }
 
         if (self::$instance === null) {

src/globals.php

@@ -13,7 +13,7 @@ use Pest\TestSuite;
 use PHPUnit\Framework\TestCase;
 
 /**
- * Runs the given closure after all tests in the current file.
+ * Runs the given closure before all tests in the current file.
  */
 function beforeAll(Closure $closure): void
 {

stubs/Laravel/Helpers.php

@@ -0,0 +1,12 @@
+<?php
+
+use Illuminate\Contracts\Auth\Authenticatable;
+use Tests\TestCase;
+
+/**
+ * Set the currently logged in user for the application.
+ */
+function actingAs(Authenticatable $user, string $driver = null): TestCase
+{
+    return test()->actingAs($user, $driver);
+}

stubs/Lumen/Helpers.php

@@ -0,0 +1,11 @@
+<?php
+
+use Illuminate\Contracts\Auth\Authenticatable;
+
+/**
+ * Set the currently logged in user for the application.
+ */
+function actingAs(Authenticatable $user, string $driver = null): TestCase
+{
+    return test()->actingAs($user, $driver);
+}

stubs/Lumen/Pest.php

@@ -0,0 +1,3 @@
+<?php
+
+uses(TestCase::class)->in(__DIR__);

stubs/Lumen/phpunit.xml

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

tests/.snapshots/success.txt

@@ -70,7 +70,7 @@
   s it skips with message → skipped because bar
   s it skips with truthy closure condition
   ✓ it do not skips with falsy closure condition
-  s it skips with condition and messsage → skipped because foo
+  s it skips with condition and message → skipped because foo
 
    PASS  Tests\Features\Test
   ✓ a test
@@ -95,6 +95,9 @@
    PASS  Tests\Playground
   ✓ basic
 
+   PASS  Tests\Plugins\Traits
+  ✓ it allows global uses
+
    PASS  Tests\Unit\Actions\AddsCoverage
   ✓ it adds coverage if --coverage exist
   ✓ it adds coverage if --min exist
@@ -132,5 +135,5 @@
    WARN  Tests\Visual\Success
   s visual snapshot of test suite on success
 
-  Tests:  6 skipped, 69 passed
-  Time:   2.63s
+  Tests:  6 skipped, 70 passed
+  Time:   2.68s

tests/Autoload.php

@@ -3,3 +3,13 @@
 if (class_exists(NunoMaduro\Collision\Provider::class)) {
     (new NunoMaduro\Collision\Provider())->register();
 }
+
+trait PluginTrait
+{
+    public function assertPluginTraitGotRegistered(): void
+    {
+        assertTrue(true);
+    }
+}
+
+Pest\Plugin::uses(PluginTrait::class);

tests/Features/Mocks.php

@@ -6,10 +6,10 @@ interface Foo
 }
 
 it('has bar', function () {
-    $mock = Mockery::mock(Foo::class);
+    $mock = mock(Foo::class);
     $mock->shouldReceive('bar')
         ->times(1)
         ->andReturn(2);
 
-    assertEquals(2, $mock->bar());
+    $mock->bar();
 });

tests/Features/Skip.php

@@ -24,6 +24,6 @@ it('do not skips with falsy closure condition')
     ->skip(function () { return false; })
     ->assertTrue(true);
 
-it('skips with condition and messsage')
+it('skips with condition and message')
     ->skip(true, 'skipped because foo')
     ->assertTrue(false);

tests/Helpers.php

@@ -0,0 +1,8 @@
+<?php
+
+use Mockery\MockInterface;
+
+function mock(string $class): MockInterface
+{
+    return Mockery::mock($class);
+}

tests/Plugins/Traits.php

@@ -0,0 +1,3 @@
+<?php
+
+it('allows global uses')->assertPluginTraitGotRegistered();