Codebase updates:

- Add editorconfig - Add PHPCS/PHPCBF - Update code according to PSR-12 - Make test suite run inside Docker - Allow custom log level for errors
AzuraCast · Jul 1, 2024 · 8268a97 · 8268a97
1 parent a2e5ab4
commit 8268a97
Show file tree

Hide file tree

Showing 17 changed files with 233 additions and 200 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
diff --git a/.devcontainer/docker-compose.yml b/.devcontainer/docker-compose.yml
diff --git a/.editorconfig b/.editorconfig
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
diff --git a/.github/workflows/testsuite.yml b/.github/workflows/testsuite.yml
@@ -1,31 +1,27 @@
 name: Test Suite
 
-on: [ push, pull_request ]
-
+on:
+  push :
+  pull_request :
+  workflow_dispatch :
 jobs:
   test_suite:
     runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        php-version: [ '8.1', '8.2' ]
     steps:
       - uses: actions/checkout@v1
 
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          tools: composer:v2, cs2pr
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
 
-      - name : Run Composer install
-        run : |
-          composer install --no-interaction
-
-      - name : Run PHP Linter
-        run : |
-          vendor/bin/parallel-lint . --exclude vendor --checkstyle | cs2pr
+      - name: Build Test Image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          load: true
+          tags: azuracast_nowplaying:testing
+          cache-from: type=gha,mode=max
+          cache-to: type=gha,mode=max
 
-      - name : Run PHPStan
-        run : |
-          vendor/bin/phpstan analyze --error-format=checkstyle | cs2pr
+      - name: Run CI Test Suite
+        run: |
+          docker run --rm azuracast_nowplaying:testing composer run ci
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,15 @@
+FROM mlocati/php-extension-installer AS php-extension-installer
+
+FROM php:8.3-cli-alpine3.19 AS base
+
+ENV TZ=UTC
+
+COPY --from=php-extension-installer /usr/bin/install-php-extensions /usr/local/bin/
+
+RUN install-php-extensions @composer gd curl xml zip bcmath mbstring intl sockets
+
+RUN apk add --update --no-cache \
+    zip git curl bash \
+    su-exec
+
+WORKDIR /app
diff --git a/composer.json b/composer.json
@@ -18,16 +18,35 @@
         "roave/security-advisories": "dev-latest",
         "php-parallel-lint/php-console-highlighter": "^1",
         "php-parallel-lint/php-parallel-lint": "^1.3",
-        "php-http/discovery": "^1.9"
+        "php-http/discovery": "^1.9",
+        "squizlabs/php_codesniffer": "^3.10",
+        "slevomat/coding-standard": "^8.15",
+        "staabm/annotate-pull-request-from-checkstyle": "^1.8"
     },
     "scripts": {
+        "cleanup-and-test": [
+          "@phpcbf",
+          "@dev-test"
+        ],
         "test": [
-            "@composer install",
-            "@phplint",
-            "@phpstan"
+          "@composer install",
+          "@dev-test"
+        ],
+        "dev-test": [
+          "@phplint",
+          "@phpstan",
+          "@phpcs"
         ],
+        "phpcbf": "phpcbf",
+        "phpcs": "phpcs",
         "phplint": "parallel-lint . --exclude vendor",
-        "phpstan": "phpstan analyze"
+        "phpstan": "phpstan analyze --memory-limit=-1",
+        "ci": [
+          "@composer install",
+          "parallel-lint . --exclude vendor --checkstyle | cs2pr",
+          "phpstan analyze --memory-limit=-1 --error-format=checkstyle | cs2pr",
+          "phpcs --report=checkstyle | cs2pr"
+        ]
     },
     "authors": [
         {
@@ -43,7 +62,8 @@
     "config": {
         "preferred-install": "dist",
         "allow-plugins": {
-            "php-http/discovery": true
+            "php-http/discovery": true,
+            "dealerdirect/phpcodesniffer-composer-installer": true
         }
     },
     "prefer-stable": true,

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,12 +1,8 @@
-version: '2.2'
-
 services:
   cli:
-    image: azuracast/azuracast_testing:latest
+    image: azuracast/nowplaying:latest
+    build:
+      context: .
     volumes:
       - ./:/app
-      - composer_data:/tmp
     command: composer test
-
-volumes:
-  composer_data: {}
diff --git a/phpcs.xml b/phpcs.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0"?>
+<ruleset name="AzuraCast">
+    <description>The AzuraCast PHP coding standard.</description>
+
+    <file>src</file>
+
+    <arg name="basepath" value="."/>
+    <arg name="extensions" value="php"/>
+    <arg name="colors"/>
+
+    <!-- relative path from PHPCS source location -->
+    <config name="installed_paths" value="../../slevomat/coding-standard"/>
+
+    <rule ref="PSR12"/>
+
+    <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingTraversableTypeHintSpecification">
+        <exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingTraversableTypeHintSpecification"/>
+    </rule>
+
+    <rule ref="SlevomatCodingStandard.Arrays.TrailingArrayComma"/>
+    <rule ref="SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses"/>
+    <rule ref="SlevomatCodingStandard.Namespaces.UseDoesNotStartWithBackslash"/>
+
+    <rule ref="SlevomatCodingStandard.TypeHints.DeclareStrictTypes">
+        <properties>
+            <property name="declareOnFirstLine" value="false"/>
+            <property name="linesCountBeforeDeclare" value="1"/>
+            <property name="linesCountAfterDeclare" value="1"/>
+            <property name="spacesCountAroundEqualsSign" value="0"/>
+        </properties>
+    </rule>
+</ruleset>
diff --git a/src/Adapter/AdapterAbstract.php b/src/Adapter/AdapterAbstract.php
@@ -16,6 +16,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\UriInterface;
 use Psr\Log\LoggerInterface;
+use Psr\Log\LogLevel;
 use SimpleXMLElement;
 
 abstract class AdapterAbstract implements AdapterInterface
@@ -33,7 +34,8 @@ public function __construct(
         protected RequestFactoryInterface $requestFactory,
         protected ClientInterface $client,
         protected LoggerInterface $logger,
-        UriInterface $baseUri
+        UriInterface $baseUri,
+        protected string $errorLogLevel = LogLevel::WARNING,
     ) {
         // Detect a username/password in the base URI itself.
         $uriUserInfo = $baseUri->getUserInfo();
@@ -130,12 +132,12 @@ protected function getUrl(RequestInterface $request): PromiseInterface
         return $this->client->sendAsync(
             $request,
             [
-                RequestOptions::HTTP_ERRORS => false
+                RequestOptions::HTTP_ERRORS => false,
             ]
         )->then(
-            function(ResponseInterface $response) use ($request) {
+            function (ResponseInterface $response) use ($request) {
                 if ($response->getStatusCode() !== 200) {
-                    $this->logger->error(
+                    $this->logError(
                         sprintf('Request returned status code %d.', $response->getStatusCode()),
                         [
                             'body' => (string)$request->getBody(),
@@ -169,7 +171,7 @@ protected function baseUriWithPathAndQuery(
 
         if ('' !== $path) {
             $uri = $uri->withPath(
-                rtrim($uri->getPath(), '/').$path
+                rtrim($uri->getPath(), '/') . $path
             );
         }
         if (0 !== count($query)) {
@@ -193,13 +195,13 @@ function ($promises) {
                     $exception = $promises[self::PROMISE_NOW_PLAYING]['reason'] ?? null;
 
                     if ($exception instanceof \Exception) {
-                        $this->logger->error(
+                        $this->logError(
                             sprintf(
                                 'NowPlaying request encountered an exception: %s',
                                 $exception->getMessage()
                             ),
                             [
-                                'exception' => $exception
+                                'exception' => $exception,
                             ]
                         );
                     }
@@ -276,7 +278,7 @@ protected function getSimpleXml(string $xmlString): ?SimpleXMLElement
 
             libxml_clear_errors();
 
-            $this->logger->error(
+            $this->logError(
                 'Error parsing XML response.',
                 [
                     'response' => $xmlString,
@@ -288,4 +290,20 @@ protected function getSimpleXml(string $xmlString): ?SimpleXMLElement
 
         return $xml;
     }
+
+    /**
+     * @param string|\Stringable $message
+     * @param mixed[] $context
+     * @return void
+     */
+    protected function logError(
+        string|\Stringable $message,
+        array $context = []
+    ): void {
+        $this->logger->log(
+            $this->errorLogLevel,
+            $message,
+            $context
+        );
+    }
 }