Added tests and CI checks

elbformat · Dec 20, 2023 · 2d8b2f5 · 2d8b2f5
1 parent 701cf18
commit 2d8b2f5
Show file tree

Hide file tree

Showing 21 changed files with 239 additions and 40 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  - pull_request
+  - push
+
+jobs:
+  php-cs-fixer:
+    name: CS Fixer
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/elbformat/php-cs-fixer:edge-php8.2
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Check src
+        run: php-cs-fixer fix --dry-run src
+      - name: Check tests
+        run: php-cs-fixer fix --dry-run tests
+
+  phpunit:
+    name: Unittest
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/elbformat/ibexa-icon-fieldtype/php
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install dependencies
+        run: composer install
+      - name: Run tests
+        run: vendor/bin/phpunit
+
+  phpstan:
+    name: Static code analysis
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/elbformat/ibexa-icon-fieldtype/php
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install dependencies
+        run: composer install
+      - name: Analyse
+        run: vendor/bin/phpstan
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,6 @@
 /.idea
-vendor/
+/build
+/vendor
+.phpunit.result.cache
 composer.lock
 docker-compose.override.yml
diff --git a/composer.json b/composer.json
@@ -17,7 +17,8 @@
   ],
   "autoload": {
     "psr-4": {
-      "Elbformat\\IconBundle\\": "src/"
+      "Elbformat\\IconBundle\\": "src/",
+      "Elbformat\\IconBundle\\Test\\": "tests/"
     }
   },
   "require": {
@@ -27,7 +28,8 @@
     "symfony/finder": "^5.4|^6.4"
   },
   "require-dev": {
-    "phpunit/phpunit": "^9.5"
+    "phpstan/phpstan": "^1.10",
+    "phpunit/phpunit": "^9.6"
   },
   "config": {
     "sort-packages": true,

diff --git a/doc/development.md b/doc/development.md
@@ -16,6 +16,17 @@ Run tests
 vendor/bin/phpunit
 ```
 
+Run static code analysis
+```bash
+vendor/bin/phpstan
+```
+
+Fix styles (from outside the container)
+```bash
+docker-compose run phpcsfixer fix src
+docker-compose run phpcsfixer fix tests
+```
+
 ## In-Place development
 If you want to test out how it integrates into ibexa, it's the easiest way to integrate the bundle into your project directly.
 By adding it as "vcs" your are able to push the changes you made right from your vendor folder.

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -4,3 +4,7 @@ services:
     image: ghcr.io/elbformat/ibexa-icon-fieldtype/php
     volumes:
       - ./:/var/www
+  phpcsfixer:
+    image: ghcr.io/elbformat/php-cs-fixer:edge-php8.2
+    volumes:
+      - ./:/code
diff --git a/docker/Dockerfile b/docker/Dockerfile
@@ -23,13 +23,12 @@ RUN apk add --no-cache --virtual .build-deps autoconf g++ make linux-headers &&
     apk del .build-deps && \
     rm -rf /tmp/*
 
-# ext-gd
-RUN apk add --no-cache libpng libjpeg-turbo freetype && \
-    apk add --no-cache --virtual .build-deps libpng-dev libjpeg-turbo-dev freetype-dev && \
-    docker-php-ext-configure gd && \
-    docker-php-ext-install gd && \
+# pcov
+RUN apk add --no-cache --virtual .build-deps autoconf g++ make && \
+    pecl install pcov-1.0.11 && \
     apk del .build-deps && \
-    rm -rf /tmp/*
+    rm -rf /tmp/* &&\
+    docker-php-ext-enable pcov
 
 RUN rmdir /var/www/html
 WORKDIR /var/www
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,4 @@
+parameters:
+  level: max
+  paths:
+    - src
diff --git a/phpunit.xml b/phpunit.xml
@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" backupGlobals="true" backupStaticAttributes="false" colors="false" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" forceCoversAnnotation="false" processIsolation="false" stopOnError="false" stopOnFailure="false" stopOnIncomplete="false" stopOnSkipped="false" stopOnRisky="false" verbose="false">
+  <coverage processUncoveredFiles="false">
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+    <report>
+      <clover outputFile="build/clover.xml"/>
+      <html outputDirectory="build/coverage/html" lowUpperBound="35" highLowerBound="70"/>
+    </report>
+  </coverage>
+  <testsuites>
+    <testsuite name="unit">
+      <directory>tests/</directory>
+    </testsuite>
+  </testsuites>
+  <logging>
+    <!--        <log type="coverage-php" target="/tmp/coverage.serialized"/>-->
+    <!--        <log type="coverage-text" target="php://stdout" showUncoveredFiles="false"/>-->
+    <junit outputFile="build/junit.xml"/>
+    <!--        <log type="testdox-html" target="/tmp/testdox.html"/>-->
+    <!--        <log type="testdox-text" target="/tmp/testdox.txt"/>-->
+  </logging>
+</phpunit>
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Elbformat\IconBundle\DependencyInjection;
@@ -11,7 +12,7 @@ class Configuration implements ConfigurationInterface
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('elbformat_icon');
-
+        /** @phpstan-ignore-next-line */
         $treeBuilder->getRootNode()
             ->arrayPrototype() // Name of the set
                 ->normalizeKeys(false)
@@ -29,4 +30,4 @@ public function getConfigTreeBuilder(): TreeBuilder
 
         return $treeBuilder;
     }
-}
+}
diff --git a/src/DependencyInjection/ElbformatIconExtension.php b/src/DependencyInjection/ElbformatIconExtension.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Elbformat\IconBundle\DependencyInjection;
@@ -13,6 +14,7 @@
 
 class ElbformatIconExtension extends Extension implements PrependExtensionInterface
 {
+    /** @param array<mixed> $configs */
     public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../../config/'));
@@ -28,8 +30,12 @@ public function load(array $configs, ContainerBuilder $container): void
     public function prepend(ContainerBuilder $container): void
     {
         // Add template for rendering
-        $configFile = __DIR__.'/../../config/ezplatform.yaml';
-        $config = Yaml::parse(file_get_contents($configFile));
+        $configFile = file_get_contents(__DIR__.'/../../config/ezplatform.yaml');
+        if (false === $configFile) {
+            throw new \RuntimeException(sprintf('%s not found or not readable', __DIR__.'/../../config/ezplatform.yaml'));
+        }
+        /** @var array{'ezplatform':array<string,mixed>} $config */
+        $config = Yaml::parse($configFile);
         $container->prependExtensionConfig('ezpublish', $config['ezplatform']);
 
         // Register namespace (as this is not done automatically. Maybe the missing "bundle" in path?)
@@ -39,4 +45,4 @@ public function prepend(ContainerBuilder $container): void
         $container->prependExtensionConfig('framework', ['translator' => ['paths' => [__DIR__.'/../../translations']]]);
 
     }
-}
+}
diff --git a/src/ElbformatIconBundle.php b/src/ElbformatIconBundle.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Elbformat\IconBundle;
@@ -9,7 +10,7 @@ class ElbformatIconBundle extends Bundle
 {
     public function getPath(): string
     {
-        return realpath(__DIR__.'/..');
+        return dirname(__DIR__.'/..');
     }
 
-}
+}
diff --git a/src/FieldType/Icon/Type.php b/src/FieldType/Icon/Type.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Elbformat\IconBundle\FieldType\Icon;
@@ -30,6 +31,7 @@ public function mapFieldValueForm(FormInterface $fieldForm, FieldData $data): vo
         ]);
     }
 
+    /** @return array{'iconset':array{'type':string,'default':string}} */
     public function getSettingsSchema(): array
     {
         return [
@@ -46,4 +48,4 @@ public function mapFieldDefinitionForm(FormInterface $fieldDefinitionForm, Field
             'label' => false,
         ]);
     }
-}
+}
diff --git a/src/FieldType/Icon/Value.php b/src/FieldType/Icon/Value.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Elbformat\IconBundle\FieldType\Icon;
@@ -9,11 +10,14 @@ final class Value implements ValueInterface
 {
     private ?string $icon;
 
-    public function __construct(?string $icon=null) { $this->icon = $icon; }
+    public function __construct(?string $icon = null)
+    {
+        $this->icon = $icon;
+    }
 
     public function __toString(): string
     {
-        return $this->icon;
+        return $this->icon ?? '';
     }
 
     public function getIcon(): ?string
@@ -25,4 +29,4 @@ public function setIcon(?string $icon): void
     {
         $this->icon = $icon;
     }
-}
+}
diff --git a/src/Form/Type/IconSettingsType.php b/src/Form/Type/IconSettingsType.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Elbformat\IconBundle\Form\Type;
@@ -12,12 +13,13 @@ final class IconSettingsType extends AbstractType
 {
     public function __construct(
         private readonly IconSetManager $iconSetManager,
-    ) { }
+    ) {
+    }
 
-    public function buildForm(FormBuilderInterface $builder, array $options)
+    public function buildForm(FormBuilderInterface $builder, array $options): void
     {
-        $builder->add('iconset', ChoiceType::class,[
+        $builder->add('iconset', ChoiceType::class, [
             'choices' => $this->iconSetManager->getSetList()
         ]);
     }
-}
+}
diff --git a/src/Form/Type/IconType.php b/src/Form/Type/IconType.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Elbformat\IconBundle\Form\Type;
@@ -16,18 +17,18 @@ final class IconType extends AbstractType
     public function __construct(
         private readonly IconSetManager $iconSetManager,
         private readonly Environment $twig,
-    )
-    {
+    ) {
     }
 
 
     public function buildForm(FormBuilderInterface $builder, array $options): void
     {
+        /** @var string $iconSet */
         $iconSet = $options['icon_set'];
         $iconList = $this->iconSetManager->getSet($iconSet)->getList();
         $iconTemplates = [];
         foreach($iconList as $icon) {
-            $iconTemplates[$icon] = $this->twig->render('@ElbformatIconFieldtype/icon.html.twig',['icon' => $icon,'iconset' => $iconSet]);
+            $iconTemplates[$icon] = $this->twig->render('@ElbformatIconFieldtype/icon.html.twig', ['icon' => $icon,'iconset' => $iconSet]);
         }
         $builder->add('icon', ChoiceType::class, [
             'choices' => $iconList,
@@ -47,4 +48,4 @@ public function configureOptions(OptionsResolver $resolver): void
         ]);
         $resolver->addAllowedTypes('icon_set', 'string');
     }
-}
+}
diff --git a/src/IconSet/IconSet.php b/src/IconSet/IconSet.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Elbformat\IconBundle\IconSet;
@@ -8,17 +9,17 @@ class IconSet
     /** @var array<string,string> */
     protected array $items;
 
-    /** @param string[] */
+    /** @param string[] $items */
     public function __construct(array $items)
     {
         // Convert to string => string array
         $this->items = array_flip($items);
-        array_walk($this->items, fn(&$val, $key) => $val = $key);
+        array_walk($this->items, fn (&$val, $key) => $val = $key);
     }
 
     /** @return string[] */
     public function getList(): array
     {
         return $this->items;
     }
-}
+}