GitHub actions (#8)

SebKay · web-flow · commit 64cfb2cac48c · 2022-12-09T16:57:07.000Z
* Create php.yml

* Install squizlabs/php_codesniffer via Composer

* Add Composer script for linting

* Add Composer script to fix PSR-12 issues

* Fix PSR-12 issues

* Create testing env file

* Remove unused ENV
diff --git a/.env.example b/.env.example
@@ -38,23 +38,3 @@ MAIL_PASSWORD=null
 MAIL_ENCRYPTION=null
 MAIL_FROM_ADDRESS="admin@laravel-inertia-template.test"
 MAIL_FROM_NAME="${APP_NAME}"
-
-AWS_ACCESS_KEY_ID=
-AWS_SECRET_ACCESS_KEY=
-AWS_DEFAULT_REGION=us-east-1
-AWS_BUCKET=
-AWS_USE_PATH_STYLE_ENDPOINT=false
-
-PUSHER_APP_ID=
-PUSHER_APP_KEY=
-PUSHER_APP_SECRET=
-PUSHER_HOST=
-PUSHER_PORT=443
-PUSHER_SCHEME=https
-PUSHER_APP_CLUSTER=mt1
-
-VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
-VITE_PUSHER_HOST="${PUSHER_HOST}"
-VITE_PUSHER_PORT="${PUSHER_PORT}"
-VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
-VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
diff --git a/.env.testing b/.env.testing
@@ -0,0 +1,32 @@
+APP_NAME="TEST – Laravel Inertia Template"
+APP_ENV=testing
+APP_KEY=base64:jpd/wy450S/8N0y6OfuRoZ8yS3AWEzrbkSgo08djF4w=
+APP_DEBUG=true
+APP_URL=http://laravel-inertia-template.test
+
+BCRYPT_ROUNDS=4
+
+SEED_ADMIN_EMAIL=admin@laravel-inertia-template.test
+
+LOG_CHANNEL=stack
+LOG_DEPRECATIONS_CHANNEL=null
+LOG_LEVEL=debug
+
+DB_CONNECTION=sqlite
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_DATABASE=":memory:"
+DB_USERNAME=root
+DB_PASSWORD=
+
+BROADCAST_DRIVER=log
+CACHE_DRIVER=array
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=sync
+SESSION_DRIVER=array
+SESSION_LIFETIME=120
+
+MAIL_DRIVER=log
+MAIL_MAILER=array
+MAIL_FROM_ADDRESS="admin@laravel-inertia-template.test"
+MAIL_FROM_NAME="${APP_NAME}"
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -0,0 +1,76 @@
+name: PHP
+
+on: [pull_request]
+
+jobs:
+  dependencies:
+    name: Install Dependencies
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Get Composer dependencies
+        id: cache-vendor
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: ${{ runner.os }}-vendor-dev-${{ hashFiles('**/composer.lock') }}
+
+      - name: Install Composer dependencies
+        if: steps.cache-vendor.outputs.cache-hit != 'true'
+        run: composer install --no-interaction
+
+  validate:
+    name: Lint
+    needs: dependencies
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Get Composer dependencies
+        id: cache-vendor
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: ${{ runner.os }}-vendor-dev-${{ hashFiles('**/composer.lock') }}
+
+      - name: Install Composer dependencies
+        if: steps.cache-vendor.outputs.cache-hit != 'true'
+        run: composer install --no-interaction
+
+      - name: Lint against PSR-12
+        run: composer lint
+
+  test:
+    name: Test
+    needs: dependencies
+    runs-on: ubuntu-latest
+    env:
+      APP_ENV: testing
+      DB_CONNECTION: sqlite
+      DB_DATABASE: ":memory:"
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Get Composer dependencies
+        id: cache-vendor
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: ${{ runner.os }}-vendor-dev-${{ hashFiles('**/composer.lock') }}
+
+      - name: Install Composer dependencies
+        if: steps.cache-vendor.outputs.cache-hit != 'true'
+        run: composer install --no-interaction
+
+      - name: Setup application
+        run: |
+          cp .env.testing .env
+          php artisan key:generate
+          php artisan migrate:fresh --seed --seeder=TestsSeeder
+
+      - name: Run tests
+        run: composer test:coverage
diff --git a/app/Console/Kernel.php b/app/Console/Kernel.php
@@ -25,7 +25,7 @@ protected function schedule(Schedule $schedule)
      */
     protected function commands()
     {
-        $this->load(__DIR__.'/Commands');
+        $this->load(__DIR__ . '/Commands');
 
         require base_path('routes/console.php');
     }
diff --git a/app/Http/Controllers/Controller.php b/app/Http/Controllers/Controller.php
@@ -9,5 +9,7 @@
 
 class Controller extends BaseController
 {
-    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
+    use AuthorizesRequests;
+    use DispatchesJobs;
+    use ValidatesRequests;
 }
diff --git a/composer.json b/composer.json
@@ -25,7 +25,8 @@
         "pestphp/pest-plugin-parallel": "^1.2",
         "phpunit/phpunit": "^9.5.26",
         "spatie/laravel-ignition": "^1.6.1",
-        "spatie/ray": "^1.36"
+        "spatie/ray": "^1.36",
+        "squizlabs/php_codesniffer": "^3.7"
     },
     "autoload": {
         "psr-4": {
@@ -53,6 +54,12 @@
             "npm run prod"
         ],
         "build:test": "composer install --no-interaction",
+        "lint": [
+            "./vendor/bin/phpcs ./ --extensions=php --standard=PSR12 --ignore=vendor/,tests/,storage/,cache/,database/migrations/,*.blade.php,public/index.php"
+        ],
+        "fix": [
+            "./vendor/bin/phpcbf ./ --extensions=php --standard=PSR12 --ignore=vendor/,tests/,storage/,cache/,database/migrations/,*.blade.php,public/index.php"
+        ],
         "test": "php artisan test --parallel --stop-on-failure",
         "test:coverage": "XDEBUG_MODE=coverage php artisan test --parallel --coverage --min=85",
         "post-autoload-dump": [
diff --git a/composer.lock b/composer.lock
diff --git a/config/broadcasting.php b/config/broadcasting.php
@@ -36,7 +36,7 @@
             'secret' => env('PUSHER_APP_SECRET'),
             'app_id' => env('PUSHER_APP_ID'),
             'options' => [
-                'host' => env('PUSHER_HOST') ?: 'api-'.env('PUSHER_APP_CLUSTER', 'mt1').'.pusher.com',
+                'host' => env('PUSHER_HOST') ?: 'api-' . env('PUSHER_APP_CLUSTER', 'mt1') . '.pusher.com',
                 'port' => env('PUSHER_PORT', 443),
                 'scheme' => env('PUSHER_SCHEME', 'https'),
                 'encrypted' => true,
diff --git a/config/cache.php b/config/cache.php
@@ -105,6 +105,6 @@
     |
     */
 
-    'prefix' => env('CACHE_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_cache_'),
+    'prefix' => env('CACHE_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_') . '_cache_'),
 
 ];
diff --git a/config/database.php b/config/database.php
@@ -125,7 +125,7 @@
 
         'options' => [
             'cluster' => env('REDIS_CLUSTER', 'redis'),
-            'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
+            'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_') . '_database_'),
         ],
 
         'default' => [
diff --git a/config/filesystems.php b/config/filesystems.php
@@ -39,7 +39,7 @@
         'public' => [
             'driver' => 'local',
             'root' => storage_path('app/public'),
-            'url' => env('APP_URL').'/storage',
+            'url' => env('APP_URL') . '/storage',
             'visibility' => 'public',
             'throw' => false,
         ],
diff --git a/config/logging.php b/config/logging.php
@@ -85,7 +85,7 @@
             'handler_with' => [
                 'host' => env('PAPERTRAIL_URL'),
                 'port' => env('PAPERTRAIL_PORT'),
-                'connectionString' => 'tls://'.env('PAPERTRAIL_URL').':'.env('PAPERTRAIL_PORT'),
+                'connectionString' => 'tls://' . env('PAPERTRAIL_URL') . ':' . env('PAPERTRAIL_PORT'),
             ],
         ],
 
diff --git a/config/session.php b/config/session.php
@@ -128,7 +128,7 @@
 
     'cookie' => env(
         'SESSION_COOKIE',
-        Str::slug(env('APP_NAME', 'laravel'), '_').'_session'
+        Str::slug(env('APP_NAME', 'laravel'), '_') . '_session'
     ),
 
     /*
diff --git a/phpunit.xml b/phpunit.xml
@@ -13,16 +13,4 @@
             <directory suffix=".php">./app</directory>
         </include>
     </coverage>
-    <php>
-        <env name="APP_NAME" value="Proposer (TEST)"/>
-        <env name="APP_ENV" value="testing"/>
-        <env name="BCRYPT_ROUNDS" value="4"/>
-        <env name="CACHE_DRIVER" value="array"/>
-        <env name="DB_CONNECTION" value="sqlite"/>
-        <env name="DB_DATABASE" value=":memory:"/>
-        <env name="MAIL_DRIVER" value="log"/>
-        <env name="MAIL_MAILER" value="array"/>
-        <env name="QUEUE_CONNECTION" value="sync"/>
-        <env name="SESSION_DRIVER" value="array"/>
-    </php>
 </phpunit>
diff --git a/resources/js/Pages/Index.vue b/resources/js/Pages/Index.vue
diff --git a/routes/web.php b/routes/web.php
@@ -6,44 +6,46 @@
 use App\Http\Controllers\RegisterController;
 use Illuminate\Support\Facades\Route;
 
-/**
- * Register
- */
 Route::middleware('guest')->group(function () {
+    /**
+     * Register
+     */
     Route::controller(RegisterController::class)->group(function () {
         Route::get('register', 'show')->name('register');
         Route::post('register', 'store')->name('register.store');
     });
 });
 
-/**
- * Login
- */
 Route::middleware('guest')->group(function () {
+    /**
+     * Login
+     */
     Route::controller(LoginController::class)->group(function () {
         Route::get('login', 'show')->name('login');
         Route::post('login', 'store')->name('login.store');
     });
 });
 
-/**
- * Logout
- */
 Route::middleware(['auth'])->group(function () {
+    /**
+     * Logout
+     */
     Route::post('logout', [LoginController::class, 'destroy'])->name('logout');
 });
 
-/**
- * Home
- */
+
 Route::middleware('auth')->group(function () {
+    /**
+     * Home
+     */
     Route::get('/', [HomeController::class, 'index'])->name('home');
 });
 
-/**
- * Account
- */
+
 Route::middleware('auth')->group(function () {
+    /**
+     * Account
+     */
     Route::prefix('account')->group(function () {
         Route::controller(AccountController::class)->group(function () {
             Route::get('', 'edit')->name('account.edit');
diff --git a/tests/CreatesApplication.php b/tests/CreatesApplication.php
@@ -15,6 +15,8 @@ public function createApplication()
     {
         $app = require __DIR__.'/../bootstrap/app.php';
 
+        $app->loadEnvironmentFrom('.env.testing');
+
         $app->make(Kernel::class)->bootstrap();
 
         return $app;

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ protected function schedule(Schedule $schedule)`
`25`	`25`	`*/`
`26`	`26`	`protected function commands()`
`27`	`27`	`{`
`28`		`- $this->load(__DIR__.'/Commands');`
	`28`	`+ $this->load(__DIR__ . '/Commands');`
`29`	`29`
`30`	`30`	`require base_path('routes/console.php');`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,5 +9,7 @@`
`9`	`9`
`10`	`10`	`class Controller extends BaseController`
`11`	`11`	`{`
`12`		`- use AuthorizesRequests, DispatchesJobs, ValidatesRequests;`
	`12`	`+ use AuthorizesRequests;`
	`13`	`+ use DispatchesJobs;`
	`14`	`+ use ValidatesRequests;`
`13`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -105,6 +105,6 @@`
`105`	`105`	`\|`
`106`	`106`	`*/`
`107`	`107`
`108`		`- 'prefix' => env('CACHE_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_cache_'),`
	`108`	`+ 'prefix' => env('CACHE_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_') . '_cache_'),`
`109`	`109`
`110`	`110`	`];`