Add UI tests [no_release] (#48)

* Add UI tests

* fix UI test

* Use real spec

* split test cases

* attempting to fix styling

* fix font

* Another attempt at fixing font

* revert font changes

* Fix screenshots

* update .gitignore

Author: lachiebol

.github/workflows/matomo-tests.yml

@@ -56,3 +56,25 @@ jobs:
           redis-service: true
           artifacts-pass: ${{ secrets.ARTIFACTS_PASS }}
           upload-artifacts: ${{ matrix.php == '7.4' && matrix.target == 'maximum_supported_matomo' }}
+          artifacts-protected: true
+          github-token: ${{ secrets.TESTS_ACCESS_TOKEN || secrets.GITHUB_TOKEN }}
+  UI:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          lfs: true
+          persist-credentials: false
+      - name: running tests
+        uses: matomo-org/github-action-tests@main
+        with:
+          plugin-name: 'ApiReference'
+          matomo-test-branch: 'maximum_supported_matomo'
+          test-type: 'UI'
+          php-version: 'matomo5_max_php'
+          node-version: '16'
+          redis-service: true
+          artifacts-pass: ${{ secrets.ARTIFACTS_PASS }}
+          upload-artifacts: true
+          artifacts-protected: true
+          github-token: ${{ secrets.TESTS_ACCESS_TOKEN || secrets.GITHUB_TOKEN }}

.gitignore

@@ -9,6 +9,7 @@ vendor/**/phpunit.xml*
 vendor/**/phpcs.xml*
 vendor/**/composer.json
 vendor/**/composer.lock
+/tests/UI/processed-ui-screenshots/
 /vue/dist/demo.html
 /vue/dist/*.common.js
 /vue/dist/*.map

tests/Fixtures/SwaggerPageFixture.php

@@ -0,0 +1,90 @@
+<?php
+
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link    https://matomo.org
+ * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+declare(strict_types=1);
+
+namespace Piwik\Plugins\ApiReference\tests\Fixtures;
+
+use Piwik\Plugins\ApiReference\ApiReference;
+use Piwik\Plugins\ApiReference\Specs\PathResolver;
+use Piwik\Tests\Framework\Fixture;
+use Piwik\Updater;
+
+class SwaggerPageFixture extends Fixture
+{
+    public $dateTime = '2010-01-03 00:00:00';
+    public $idSite = 1;
+    private bool $hadOriginalSpecFixture = false;
+    private ?string $originalSpecFixtureContents = null;
+
+    public function setUp(): void
+    {
+        $this->setUpWebsite();
+        $this->markApiReferenceAsInstalled();
+        $this->writeOpenApiSpecFixtures();
+    }
+
+    public function tearDown(): void
+    {
+        $this->removeOpenApiSpecFixtures();
+    }
+
+    private function setUpWebsite(): void
+    {
+        if (!self::siteCreated($this->idSite)) {
+            $idSite = self::createWebsite($this->dateTime);
+            $this->assertSame($this->idSite, $idSite);
+        }
+    }
+
+    private function writeOpenApiSpecFixtures(): void
+    {
+        $resolver = new PathResolver();
+        $specDirectory = $resolver->getSpecDirectory();
+        $specPath = $this->getBandwidthSpecPath();
+
+        if (!is_dir($specDirectory)) {
+            mkdir($specDirectory, 0777, true);
+        }
+
+        if (is_file($specPath)) {
+            $this->hadOriginalSpecFixture = true;
+            $originalContents = file_get_contents($specPath);
+            $this->originalSpecFixtureContents = $originalContents === false ? null : $originalContents;
+        }
+
+        copy($this->getBandwidthSpecFixturePath(), $specPath);
+    }
+
+    private function markApiReferenceAsInstalled(): void
+    {
+        (new Updater())->markComponentSuccessfullyUpdated('ApiReference', '5.0.0');
+    }
+
+    private function removeOpenApiSpecFixtures(): void
+    {
+        $specPath = $this->getBandwidthSpecPath();
+
+        if ($this->hadOriginalSpecFixture) {
+            file_put_contents($specPath, $this->originalSpecFixtureContents ?? '');
+        } elseif (is_file($specPath)) {
+            unlink($specPath);
+        }
+    }
+
+    private function getBandwidthSpecPath(): string
+    {
+        return (new PathResolver())->getSpecFilePath('Bandwidth', ApiReference::DEFAULT_SPEC_VERSION);
+    }
+
+    private function getBandwidthSpecFixturePath(): string
+    {
+        return __DIR__ . '/../Resources/SwaggerPage/Bandwidth_openapi_spec_v1.0.0.json';
+    }
+}