Initial commit

marickvantuil · marickvantuil · commit 6288c57640f4 · 2022-07-26T19:57:10.000+02:00
diff --git a/.github/ISSUE_TEMPLATE/issue-template.md b/.github/ISSUE_TEMPLATE/issue-template.md
@@ -0,0 +1,14 @@
+---
+name: Issue template
+about: Help you create an effective issue and know what to expect.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+Thank you for taking the time for reporting a bug, requesting a feature, or letting me know something else about the package.
+
+I create open-source packages for fun while working full-time and running my own business. That means I don't have as much time left to maintain these packages, build elaborate new features or investigate and fix bugs. If you wish to get a feature or bugfix merged it would be greatly appreciated if you can provide as much info as possible and preferably a Pull Request ready with automated tests. Realistically I check Github a few times a week, and take several days, weeks or sometimes months before finishing features/bugfixes (depending on their size of course).
+
+Thanks for understanding. 😁
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -0,0 +1,65 @@
+name: Run tests
+
+on:
+  pull_request:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  php-tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        db: ['mysql', 'pgsql']
+        payload:
+          - { queue: 'github-actions-laravel9-php81', laravel: '9.*', php: '8.1', 'testbench': '7.*'}
+          - { queue: 'github-actions-laravel9-php80', laravel: '9.*', php: '8.0', 'testbench': '7.*'}
+          - { queue: 'github-actions-laravel8-php81', laravel: '8.*', php: '8.1', 'testbench': '6.*'}
+          - { queue: 'github-actions-laravel8-php80', laravel: '8.*', php: '8.0', 'testbench': '6.*'}
+          - { queue: 'github-actions-laravel8-php74', laravel: '8.*', php: '7.4', 'testbench': '6.*'}
+          - { queue: 'github-actions-laravel7-php80', laravel: '7.*', php: '8.0', 'testbench': '5.*' }
+          - { queue: 'github-actions-laravel7-php74', laravel: '7.*', php: '7.4', 'testbench': '5.*' }
+          - { queue: 'github-actions-laravel6-php80', laravel: '6.*', php: '8.0', 'testbench': '4.*' }
+          - { queue: 'github-actions-laravel6-php74', laravel: '6.*', php: '7.4', 'testbench': '4.*' }
+
+    name: PHP ${{ matrix.payload.php }} - Laravel ${{ matrix.payload.laravel }} - DB ${{ matrix.db }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v1
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.payload.php }}
+          extensions: mbstring, dom, fileinfo
+          coverage: none
+
+      - name: Set up MySQL and PostgreSQL
+        run: |
+          MYSQL_PORT=3307 POSTGRES_PORT=5432 docker compose up ${{ matrix.db }} -d
+      - name: Install dependencies
+        run: |
+          composer require "laravel/framework:${{ matrix.payload.laravel }}" "orchestra/testbench:${{ matrix.payload.testbench }}" --no-interaction --no-update
+          composer update --prefer-stable --prefer-dist --no-interaction --no-suggest
+          if [ "${{ matrix.db }}" = "mysql" ]; then
+            while ! mysqladmin ping --host=127.0.0.1 --user=cloudtasks --port=3307 --password=cloudtasks --silent; do
+              echo "Waiting for MySQL..."
+              sleep 1
+            done
+          else
+            echo "Not waiting for MySQL."
+          fi
+      - name: Execute tests
+        env:
+          DB_DRIVER: ${{ matrix.db }}
+          CI_CLOUD_TASKS_PROJECT_ID: ${{ secrets.CI_CLOUD_TASKS_PROJECT_ID }}
+          CI_CLOUD_TASKS_QUEUE: ${{ secrets.CI_CLOUD_TASKS_QUEUE }}
+          CI_CLOUD_TASKS_LOCATION: ${{ secrets.CI_CLOUD_TASKS_LOCATION }}
+          CI_CLOUD_TASKS_SERVICE_ACCOUNT_EMAIL: ${{ secrets.CI_CLOUD_TASKS_SERVICE_ACCOUNT_EMAIL }}
+          CI_SERVICE_ACCOUNT_JSON_KEY: ${{ secrets.CI_SERVICE_ACCOUNT_JSON_KEY }}
+          CI_CLOUD_TASKS_CUSTOM_QUEUE: ${{ matrix.payload.queue }}
+        run: |
+          echo $CI_SERVICE_ACCOUNT_JSON_KEY > tests/Support/gcloud-key-valid.json
+          vendor/bin/phpunit
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+/vendor/
+composer.lock
+.idea/
+.phpunit.result.cache
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,11 @@
+# Releases
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## 1.0.0 - ????-??-??
+
+**Added**
+
+- Initial release of the package.
diff --git a/LICENCE b/LICENCE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Stackkit (info@stackkit.io)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1 @@
+This package is work in progress
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -0,0 +1,3 @@
+# Upgrading
+
+No contents yet.
diff --git a/assets/cloud-tasks-home.png b/assets/cloud-tasks-home.png
diff --git a/assets/dashboard.png b/assets/dashboard.png
diff --git a/assets/logo.png b/assets/logo.png
diff --git a/composer.json b/composer.json
@@ -0,0 +1,31 @@
+{
+    "name": "stackkit/laravel-google-cloud-logging",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Marick van Tuil",
+            "email": "info@marickvantuil.nl"
+        }
+    ],
+    "require": {
+        "google/cloud-logging": "^1.10"
+    },
+    "autoload": {
+        "psr-4": {
+            "Stackkit\\LaravelGoogleCloudLogging\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/",
+            "Factories\\": "factories/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Stackkit\\LaravelGoogleCloudLogging\\LoggingServiceProvider"
+            ]
+        }
+    }
+}
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,10 @@
+includes:
+    - ./vendor/nunomaduro/larastan/extension.neon
+    - ./vendor/thecodingmachine/phpstan-safe-rule/phpstan-safe-rule.neon
+parameters:
+    paths:
+        - src
+    level: 9
+    checkMissingIterableValueType: false
+    ignoreErrors:
+        - '/Cannot call method when\(\) on mixed/'
diff --git a/phpunit.xml b/phpunit.xml
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Testsuite">
+            <file>./tests/ConfigTest.php</file>
+            <file>./tests/TaskHandlerTest.php</file>
+            <file>./tests/CloudTasksApiTest.php</file>
+            <file>./tests/CloudTasksDashboardTest.php</file>
+        </testsuite>
+    </testsuites>
+    <php>
+        <env name="APP_DEBUG" value="1"/>
+        <env name="APP_ENV" value="testing"/>
+        <env name="APP_KEY" value="AckfSECXIvnK5r28GVIWUAxmbBSjTsmF"/>
+        <env name="CACHE_DRIVER" value="array"/>
+        <env name="SESSION_DRIVER" value="array"/>
+        <env name="MAIL_DRIVER" value="log"/>
+        <env name="GOOGLE_APPLICATION_CREDENTIALS" value="./tests/Support/gcloud-key-valid.json" />
+        <env name="QUEUE_DRIVER" value="cloudtasks"/>
+        <env name="DB_DRIVER" value="mysql" />
+    </php>
+</phpunit>
diff --git a/src/ViaGoogleCloudLogger.php b/src/ViaGoogleCloudLogger.php
@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stackkit\LaravelGoogleCloudLogging;
+
+use Google\Cloud\Logging\LoggingClient;
+use Google\Cloud\Logging\PsrLogger;
+
+class ViaGoogleCloudLogger
+{
+    public function __invoke(array $config): PsrLogger
+    {
+        $logger = LoggingClient::psrBatchLogger('app', [
+            'clientConfig' => [
+                'projectId' => $config['project_id'],
+            ],
+            'resource' => $this->resource($config),
+            'labels' => [
+                'source' => 'laravel-log',
+            ],
+        ]);
+
+        return $logger;
+    }
+
+    private function resource(array $config): array
+    {
+        if (env('K_SERVICE') && env('K_REVISION')) {
+            return [
+                'type' => 'cloud_run_revision',
+                'labels' => [
+                    'projectId' => $config['project_id'],
+                    'service_name' => env('K_SERVICE'),
+                    'revision_name' => env('K_REVISION'),
+                ]
+            ];
+        }
+
+        return [];
+    }
+}
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace Tests;
+
+class TestCase extends \Orchestra\Testbench\TestCase
+{
+    protected function getPackageProviders($app)
+    {
+        return [
+            \Stackkit\LaravelGoogleCloudLogging\LoggingServiceProvider::class,
+        ];
+    }
+
+    protected function defineDatabaseMigrations()
+    {
+        $this->loadMigrationsFrom(__DIR__ . '/../migrations');
+        $this->loadMigrationsFrom(__DIR__ . '/../vendor/orchestra/testbench-core/laravel/migrations');
+    }
+
+    protected function getEnvironmentSetUp($app)
+    {
+//        $app['config']->set('cloud-tasks.dashboard.enabled', false);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Upgrading`
	`2`	`+`
	`3`	`+No contents yet.`