Add tests

.github/workflows/qa.yaml

@@ -4,7 +4,6 @@ on:
   push:
     branches: [ "main" ]
   pull_request:
-    branches: [ "main" ]
   workflow_dispatch:
 
 permissions:
@@ -28,7 +27,7 @@ jobs:
         run: composer validate --strict
 
       - name: Install dependencies
-        uses: ramsey/composer-install@v2
+        uses: ramsey/composer-install@v3
 
       - name: Normalize composer.json
         run: composer normalize --dry-run --no-check-lock

.github/workflows/tests.yaml

@@ -4,7 +4,6 @@ on:
   push:
     branches: [ "main" ]
   pull_request:
-    branches: [ "main" ]
   workflow_dispatch:
 
 permissions:
@@ -26,6 +25,27 @@ jobs:
           - php-version: "8.2"
             dependencies: "highest" # Pimcore 11.*
 
+    env:
+      MYSQL_HOST: 127.0.0.1
+      MYSQL_PORT: 3306
+      MYSQL_USER: root
+      MYSQL_PASSWORD: pimcore
+      MYSQL_DATABASE: pimcore
+      MYSQL_SERVER_VERSION: "10.11.5-MariaDB"
+
+    services:
+      mariadb:
+        image: mariadb:10.11.5
+        env:
+          MYSQL_ROOT_PASSWORD: pimcore
+        options: >-
+          --health-cmd="healthcheck.sh --connect --innodb_initialized"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=5
+        ports:
+          - 3306:3306
+
     steps:
       - name: Git Checkout
         uses: actions/checkout@v4
@@ -36,13 +56,13 @@ jobs:
           php-version: ${{ matrix.php-version }}
 
       - name: Install dependencies
-        uses: ramsey/composer-install@v2
+        uses: ramsey/composer-install@v3
         with:
           dependency-versions: ${{ matrix.dependencies }}
 
-#      - name: Install Pimcore Admin UI
-#        run: composer require --dev pimcore/admin-ui-classic-bundle --no-interaction
-#        if: matrix.dependencies == 'highest'
+      - name: Install Pimcore Admin UI
+        run: composer require --dev pimcore/admin-ui-classic-bundle --no-interaction
+        if: matrix.dependencies == 'highest'
 
       - name: Execute tests
         run: composer tests

composer.json

@@ -36,7 +36,10 @@
     "phpstan/phpstan": "^1.10.46",
     "phpstan/phpstan-phpunit": "^1.3.15",
     "phpstan/phpstan-symfony": "^1.3.5",
-    "phpunit/phpunit": "^9.6.14"
+    "phpunit/phpunit": "^9.6.14",
+    "spatie/phpunit-snapshot-assertions": "^4.2",
+    "symfony/browser-kit": "^5.4 || ^6.4",
+    "teamneusta/pimcore-testing-framework": "^0.12.4"
   },
   "autoload": {
     "psr-4": {
@@ -46,7 +49,10 @@
   "autoload-dev": {
     "psr-4": {
       "Neusta\\Pimcore\\BackendBrandingBundle\\Tests\\": "tests/"
-    }
+    },
+    "classmap": [
+      "tests/app/TestKernel.php"
+    ]
   },
   "config": {
     "allow-plugins": {

src/Controller/CssController.php

@@ -21,7 +21,7 @@ public function __invoke(): Response
         return new Response(
             $this->cssProvider->getRules()->toString(),
             Response::HTTP_OK,
-            ['Content-type' => 'text/css'],
+            ['Content-Type' => 'text/css'],
         );
     }
 }

src/Css/CssRuleList.php

@@ -8,6 +8,16 @@ final class CssRuleList
     /** @var list<CssRule> */
     private array $rules = [];
 
+    /**
+     * @param iterable<CssRule> $rules
+     */
+    public function addRules(iterable $rules): void
+    {
+        foreach ($rules as $rule) {
+            $this->addRule($rule);
+        }
+    }
+
     public function addRule(CssRule $rule): void
     {
         $this->rules[] = $rule;

src/CssProvider.php

@@ -21,9 +21,7 @@ public function getRules(): CssRuleList
         $css = new CssRuleList();
 
         foreach ($this->providers as $provider) {
-            foreach ($provider() as $rule) {
-                $css->addRule($rule);
-            }
+            $css->addRules($provider());
         }
 
         return $css;

tests/Controller/CssControllerTest.php

@@ -0,0 +1,28 @@
+<?php
+declare(strict_types=1);
+
+namespace Neusta\Pimcore\BackendBrandingBundle\Tests\Controller;
+
+use Neusta\Pimcore\TestingFramework\Database\ResetDatabase;
+use Pimcore\Test\WebTestCase;
+use Spatie\Snapshots\MatchesSnapshots;
+
+class CssControllerTest extends WebTestCase
+{
+    use MatchesSnapshots;
+    use ResetDatabase;
+
+    /**
+     * @test
+     */
+    public function it_returns_css(): void
+    {
+        $client = self::createClient();
+
+        $client->request('GET', '/neusta/backend-branding/css');
+
+        self::assertResponseIsSuccessful();
+        self::assertResponseHeaderSame('Content-Type', 'text/css; charset=UTF-8');
+        $this->assertMatchesTextSnapshot($client->getResponse()->getContent());
+    }
+}

tests/Controller/__snapshots__/CssControllerTest__it_returns_css__1.txt

@@ -0,0 +1,52 @@
+body.x-body #pimcore_body {
+	background-color: #6428b4;
+}
+
+body.x-body #pimcore_loading.loaded {
+	background-color: #6428b4;
+}
+
+body.x-body .sf-minitoolbar {
+	background-color: #6428b4;
+}
+
+body.x-body #pimcore_panel_tabs > .x-panel-bodyWrap > .x-tab-bar {
+	background-color: #6428b4;
+}
+
+#pimcore_loading.loaded {
+	background-color: #6428b4;
+}
+
+.x-body .sf-minitoolbar {
+	background-color: #6428b4;
+}
+
+#pimcore_sidebar {
+	background-color: #028a0f;
+}
+
+#pimcore_loading.loaded {
+	background-color: #028a0f;
+}
+
+.x-body .sf-minitoolbar {
+	background-color: #028a0f;
+}
+
+#pimcore_signet {
+	background-image: url("logo.svg");
+	background-size: 70%;
+	background-position: center;
+	background-color: #000 !important;
+}
+
+#pimcore_avatar {
+	background-color: #000 !important;
+}
+
+#pimcore_panel_tabs > .x-panel-bodyWrap > .x-tab-bar {
+	background-image: url("logo.svg");
+	background-size: 40px;
+	background-position: center;
+}

tests/Css/CssPropertyTest.php

@@ -0,0 +1,45 @@
+<?php
+declare(strict_types=1);
+
+namespace Neusta\Pimcore\BackendBrandingBundle\Tests\Css;
+
+use Neusta\Pimcore\BackendBrandingBundle\Css\CssProperty;
+use PHPUnit\Framework\TestCase;
+
+class CssPropertyTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function it_has_name_and_value(): void
+    {
+        self::assertSame('color: red', (string) new CssProperty('color', 'red'));
+    }
+
+    /**
+     * @test
+     */
+    public function its_value_may_be_a_url(): void
+    {
+        self::assertSame(
+            'background-image: url("image.jpeg")',
+            (string) new CssProperty('background-image', 'image.jpeg', isUrl: true),
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function it_may_be_important(): void
+    {
+        self::assertSame(
+            'color: red !important',
+            (string) new CssProperty('color', 'red', isImportant: true),
+        );
+
+        self::assertSame(
+            'background-image: url("image.jpeg") !important',
+            (string) new CssProperty('background-image', 'image.jpeg', isUrl: true, isImportant: true),
+        );
+    }
+}

tests/Css/CssRuleListTest.php

@@ -0,0 +1,40 @@
+<?php
+declare(strict_types=1);
+
+namespace Neusta\Pimcore\BackendBrandingBundle\Tests\Css;
+
+use Neusta\Pimcore\BackendBrandingBundle\Css\CssProperty;
+use Neusta\Pimcore\BackendBrandingBundle\Css\CssRule;
+use Neusta\Pimcore\BackendBrandingBundle\Css\CssRuleList;
+use PHPUnit\Framework\TestCase;
+use Spatie\Snapshots\MatchesSnapshots;
+
+class CssRuleListTest extends TestCase
+{
+    use MatchesSnapshots;
+
+    /**
+     * @test
+     */
+    public function it_contains_a_bunch_of_rules(): void
+    {
+        $ruleList = new CssRuleList();
+
+        $ruleList->addRule(new CssRule('#some-rule',
+            new CssProperty('color', 'blue'),
+            new CssProperty('margin', '0'),
+            new CssProperty('display', 'block'),
+        ));
+
+        $ruleList->addRule(new CssRule('.another-rule',
+            new CssProperty('background-image', 'image.jpg', isUrl: true),
+            new CssProperty('padding', '0'),
+        ));
+
+        $ruleList->addRule(new CssRule('.some.specific .rule',
+            new CssProperty('border', '5px solid black', isImportant: true),
+        ));
+
+        $this->assertMatchesTextSnapshot($ruleList->toString());
+    }
+}

tests/Css/CssRuleTest.php

@@ -0,0 +1,42 @@
+<?php
+declare(strict_types=1);
+
+namespace Neusta\Pimcore\BackendBrandingBundle\Tests\Css;
+
+use Neusta\Pimcore\BackendBrandingBundle\Css\CssProperty;
+use Neusta\Pimcore\BackendBrandingBundle\Css\CssRule;
+use PHPUnit\Framework\TestCase;
+use Spatie\Snapshots\MatchesSnapshots;
+
+class CssRuleTest extends TestCase
+{
+    use MatchesSnapshots;
+
+    /**
+     * @test
+     */
+    public function it_is_a_selector_with_properties(): void
+    {
+        $this->assertMatchesTextSnapshot(new CssRule('.my-rule',
+            new CssProperty('color', 'blue'),
+            new CssProperty('margin', '0'),
+            new CssProperty('display', 'block'),
+        ));
+    }
+
+    /**
+     * @test
+     */
+    public function it_overwrites_properties_with_the_same_name(): void
+    {
+        $rule = new CssRule('.my-rule',
+            new CssProperty('color', 'blue'),
+            new CssProperty('margin', '0'),
+            new CssProperty('display', 'block'),
+        );
+
+        $rule->setProperty(new CssProperty('display', 'inline'));
+
+        $this->assertMatchesTextSnapshot($rule);
+    }
+}

tests/Css/__snapshots__/CssRuleListTest__it_contains_a_bunch_of_rules__1.txt

@@ -0,0 +1,14 @@
+#some-rule {
+	color: blue;
+	margin: 0;
+	display: block;
+}
+
+.another-rule {
+	background-image: url("image.jpg");
+	padding: 0;
+}
+
+.some.specific .rule {
+	border: 5px solid black !important;
+}

tests/Css/__snapshots__/CssRuleTest__it_is_a_selector_with_properties__1.txt

@@ -0,0 +1,5 @@
+.my-rule {
+	color: blue;
+	margin: 0;
+	display: block;
+}

tests/Css/__snapshots__/CssRuleTest__it_overwrites_properties_with_the_same_name__1.txt

@@ -0,0 +1,5 @@
+.my-rule {
+	color: blue;
+	margin: 0;
+	display: inline;
+}