Get the integration tests up and running again

- The messenger transactional wrap is not working with the tests, as it conflicts with the DoctrineTestBundle - Fix some type problems (DateTime vs DateTimeImmutable, nulls and initialization errors) - `SearchManager::findActivityPubActorsByUsername` now converts `!user@domain` into `@user@domain` so searching for a magazine by `!mag@domain` works from the API as well - The `StatsContentRepository` had a sign error - add a new docker compose for the test dependencies, as well as oauth keys for the tests - remove the purge user test, as this is no longer an option - change the .env.test to fit the new dependencies
MbinOrg · Dec 17, 2024 · 18db1cc · 18db1cc
1 parent 656f721
commit 18db1cc
Show file tree

Hide file tree

Showing 244 changed files with 4,190 additions and 4,910 deletions.
diff --git a/.env.test b/.env.test
@@ -6,11 +6,19 @@ PANTHER_APP_ENV=panther
 PANTHER_ERROR_SCREENSHOT_DIR=./var/error-screenshots
 
 # Mbin variables
-DATABASE_URL="postgresql://kbin:[email protected]:5432/kbin_test?serverVersion=13&charset=utf8"
+DATABASE_URL="postgresql://mbin:[email protected]:5433/mbin?serverVersion=16&charset=utf8"
+REDIS_DNS=redis://[email protected]:6380
 MAILER_DSN=null://default
 KBIN_JS_ENABLED=false
 KBIN_DEFAULT_LANG=en
 KBIN_DOMAIN=kbin.test
 ELASTICSEARCH_ENABLED=false
 KBIN_API_ITEMS_PER_PAGE=2
 KBIN_FEDERATION_ENABLED=false
+
+###> league/oauth2-server-bundle ###
+OAUTH_PRIVATE_KEY=%kernel.project_dir%/config/oauth2/tests/private.pem
+OAUTH_PUBLIC_KEY=%kernel.project_dir%/config/oauth2/tests/public.pem
+OAUTH_ENCRYPTION_KEY=MF3Sks6dIHhMvk1SALv68e8LydunZopLennBuF9jALk=
+OAUTH_PASSPHRASE=null
+###< league/oauth2-server-bundle ###
diff --git a/.github/workflows/action.yaml b/.github/workflows/action.yaml
@@ -81,6 +81,61 @@ jobs:
           SYMFONY_DEPRECATIONS_HELPER: disabled
         run: php bin/phpunit tests/Unit
 
+  integration-test:
+    runs-on: ubuntu-latest
+    container:
+      image: danger89/mbin-pipeline:1.2.0
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Get Composer Cache Directory
+        id: composer-cache
+        run: |
+          echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - run: cp .env.example .env
+      - name: Composer install
+        run: composer install --no-scripts --no-progress
+
+      - uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Run integration tests
+        env:
+          COMPOSER_CACHE_DIR: ${{ steps.composer-cache.outputs.dir }}
+          SYMFONY_DEPRECATIONS_HELPER: disabled
+        run: php bin/phpunit tests/Functional
+    services:
+      postgres:
+        # Docker Hub image
+        image: postgres
+        # Provide the password for postgres
+        env:
+          POSTGRES_DB: mbin_test
+          POSTGRES_USER: mbin
+          POSTGRES_PASSWORD: ChangeThisPostgresPass
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+      redis:
+        # Docker Hub image
+        image: redis
+        # Set health checks to wait until redis has started
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          # Maps port 6379 on service container to the host
+          - 6380:6379
+
   audit-check:
     runs-on: ubuntu-latest
     container:

diff --git a/config/oauth2/tests/private.pem b/config/oauth2/tests/private.pem
@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDwTLg0F+MPOubO
+8QXiNBAzWVFdP8LKemjKjUWembvcSIkeKhyIvk5YSbsX56vc7ArJnX8ikdnhVw5u
+wK7K9vwU8+FJBFStHypexOQGJchSpV76kWYK4J6zFVy11bCbsHPrlwM0chM7pBgU
+JSJ2c5KPaGhKUwZ/DzsP+qzLh1Us/LKtuLc5uPPEN1824Up7DFr6RiM0dWKjyvEB
+bNJmDAFr/F4j6K7zZLv52U49kdWetHNMLXQxWB8WMU6hJHRGqgz8rJI+gcqyHLDC
+eKlMJErnnA9kDC3pKTjDugUFSVS3bgi7tv1q+/KiYHUf1STV5oY74JC4JfRPYmoB
++ZmKf9gLAgMBAAECggEAD2kEHnHHtxgnvsQDL2n3qKtaMJjgWjwhEJhLC4GVZBTn
+bN6g0ijOJ72hY3DmeyD3YiLuXnOsXYCdOtSy1kOiOopspfztRzrqlzBDj/IIAjt7
+t1BFaH4rf0A9SqXyZlGZutUw40H2N3VtsTZecD/iJBM7LkUGc3XbwPRqShUa4msP
+DLfYymEtShJ71uNdveNmTSWntuw8crFHZhZGxFlqiNdJ8sJXH5qxJvV69p9rJe21
+7F9zCoWsdAs33u1xb7zSh6XumnvtqQ8kLO0pXqx0zSF1Xqt/35qo2qQfRgNRspiK
+uQkn6qGbpzZ73PZ1raIXjbiNXPVy2yb3aQI9I2UxlQKBgQD+OXx5c/M2JaGNsDEv
+cWCNgm5YDQATpFp1GaSW0dlyUpWN8nF7AwAa7+o40yPEHyDuKjKKJDIRdbtcocqI
+UD+EQ8qeDXL+e9mljK/hoIVoystZryyON+SbTrzobzTVp51I0olKwv318R7nzFep
+qSyczDjfvs29zNZwzLuwLjVzbwKBgQDx+lZ7vwNkl7S3TSzVeMPCeIaY22IO7wKN
+yoDsth/DyC/qINwhQLdCiTCZNhqsqKtlacWXd7CRJsesU41Za1cEGY0Zad2kxc0g
+I59SaoHE6RNbW2xQ6u2/elmxHs9jyfIcEJ2lRMlVDh38Qk29CNKmmO+xiByfXNKy
+pM1MRbPnJQKBgD0NmzojwYYAdZLsfHNzXAfACjX1MU6GSv8SYHej//+3m5kSX3R2
+XQEbGvn4ov9HpoXr9mU8mhWdW5i8dkJUW1ytVyyr+DDrl3JtnhOmlEN9aGaqbh3d
+iHZP64g6pMqmzVwey7/7ojf9Zzmt1mO1cDRby1DYptptJhbC5FREVKvbAoGBAJLf
+k0zLNSECoBM+ib8M7S2GAJSZXJyZ4F/2EWkcZo1sXgDrbxHT+Sguo0vrtickvdvx
+Zpi4cni4JCxqDnq/F3MKm0VYp8rSsN4YISViNmAx5KjoBgfbgPFfLz+95r24Hvd/
+8mAVL2ssBXFPQWZDC7FJVPvaFR15tv3t4BqymC7tAoGBAKR9e/VLI2cajpBdXzK4
+JhaQ59R/ybxPdg5JhyGC3n9WN5lK71pdbR04vNVAT3+LwpNu49DKEYkiSCfo3tAl
+iJPnKe8mGgQ4f1W7bvbW9GxMYWp/SGQRE3MZbH1ChUlCiqlzhkmwq1LgOFURCO+3
+GyQt5+0mF/tTqsFwt+n1VOtI
+-----END PRIVATE KEY-----
diff --git a/config/oauth2/tests/public.pem b/config/oauth2/tests/public.pem
@@ -0,0 +1,9 @@
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8Ey4NBfjDzrmzvEF4jQQ
+M1lRXT/Cynpoyo1Fnpm73EiJHiociL5OWEm7F+er3OwKyZ1/IpHZ4VcObsCuyvb8
+FPPhSQRUrR8qXsTkBiXIUqVe+pFmCuCesxVctdWwm7Bz65cDNHITO6QYFCUidnOS
+j2hoSlMGfw87D/qsy4dVLPyyrbi3ObjzxDdfNuFKewxa+kYjNHVio8rxAWzSZgwB
+a/xeI+iu82S7+dlOPZHVnrRzTC10MVgfFjFOoSR0RqoM/KySPoHKshywwnipTCRK
+55wPZAwt6Sk4w7oFBUlUt24Iu7b9avvyomB1H9Uk1eaGO+CQuCX0T2JqAfmZin/Y
+CwIDAQAB
+-----END PUBLIC KEY-----
diff --git a/docker/tests/compose.yml b/docker/tests/compose.yml
@@ -0,0 +1,20 @@
+services:
+  db:
+    image: postgres:${POSTGRES_VERSION:-16}-alpine
+    container_name: mbin-tests-db
+    restart: unless-stopped
+    ports:
+      - "5433:5432"
+    environment:
+      - POSTGRES_DB=mbin_test
+      - POSTGRES_USER=mbin
+      - POSTGRES_PASSWORD=ChangeThisPostgresPass
+  redis:
+    image: redis:alpine
+    container_name: mbin-tests-redis
+    restart: unless-stopped
+    command: /bin/sh -c "redis-server --requirepass 123456789"
+    ports:
+      - "6380:6379"
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
diff --git a/docs/03-contributing/01-getting_started.md b/docs/03-contributing/01-getting_started.md
@@ -192,15 +192,17 @@ _Optionally:_ If you want to start federating, you will also need to messenger j
 
 More info: [Contributing guide](https://github.com/MbinOrg/mbin/blob/main/CONTRIBUTING.md), [Admin guide](../02-admin/README.md) and [Symfony Local Web Server](https://symfony.com/doc/current/setup/symfony_server.html)
 
-## Unit tests
+## Testing
 
 When fixing a bug or implementing a new feature or improvement, we expect that test code will also be included with every delivery of production code. There are three levels of tests that we distinguish between:
 
 - Unit Tests: test a specific unit (SUT), mock external functions/classes/database calls, etc. Unit-tests are fast, isolated and repeatable
 - Integration Tests: test larger part of the code, combining multiple units together (classes, services or alike).
 - Application Tests: test high-level functionality, APIs or web calls.
 
-### Prepare for unit tests
+For more info read: [Symfony Testing guide](https://symfony.com/doc/current/testing.html).
+
+### Prepare testing
 
 1. First increase execution time in your PHP config file: `/etc/php/8.3/fpm/php.ini`:
 
@@ -226,7 +228,21 @@ Running the unit tests can be done by executing:
 SYMFONY_DEPRECATIONS_HELPER=disabled ./bin/phpunit tests/Unit
 ```
 
-For more info read: [Symfony Testing guide](https://symfony.com/doc/current/testing.html).
+### Running integration tests
+
+Our integration tests depend on a database and a caching server (Valkey / KeyDB / Redis). 
+The database and cache are cleared / dumped every test run. 
+To start the services:
+
+```sh
+cd docker/tests && docker compose up -d
+```
+
+To run the integration tests:
+
+```sh
+SYMFONY_DEPRECATIONS_HELPER=disabled ./bin/phpunit tests/Functional
+```
 
 ## Linting
 

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -12,7 +12,8 @@
         <server name="APP_ENV" value="test" force="true" />
         <server name="SHELL_VERBOSITY" value="-1" />
         <server name="SYMFONY_PHPUNIT_REMOVE" value="" />
-        <server name="SYMFONY_PHPUNIT_VERSION" value="9.6" />
+        <server name="SYMFONY_PHPUNIT_VERSION" value="11.4.3" />
+        <server name="BOOTSTRAP_DB" value="1" />
     </php>
 
     <testsuites>

diff --git a/src/Controller/Api/Instance/InstanceRetrieveStatsApi.php b/src/Controller/Api/Instance/InstanceRetrieveStatsApi.php
@@ -229,14 +229,14 @@ public function content(
             if (null === $startString) {
                 $start = null;
             } else {
-                $start = new \DateTime($startString);
+                $start = new \DateTimeImmutable($startString);
             }
 
             $endString = $request->get('end');
             if (null === $endString) {
                 $end = null;
             } else {
-                $end = new \DateTime($endString);
+                $end = new \DateTimeImmutable($endString);
             }
         } catch (\Exception $e) {
             throw new BadRequestHttpException('Failed to parse start or end time');

diff --git a/src/Controller/Api/Magazine/Admin/MagazineRetrieveStatsApi.php b/src/Controller/Api/Magazine/Admin/MagazineRetrieveStatsApi.php
@@ -284,14 +284,14 @@ public function content(
             if (null === $startString) {
                 $start = null;
             } else {
-                $start = new \DateTime($startString);
+                $start = new \DateTimeImmutable($startString);
             }
 
             $endString = $request->get('end');
             if (null === $endString) {
                 $end = null;
             } else {
-                $end = new \DateTime($endString);
+                $end = new \DateTimeImmutable($endString);
             }
         } catch (\Exception $e) {
             throw new BadRequestHttpException('Failed to parse start or end time');

diff --git a/src/DTO/EntryRequestDto.php b/src/DTO/EntryRequestDto.php
@@ -71,6 +71,7 @@ public function mergeIntoDto(EntryDto $dto): EntryDto
         $dto->isOc = $this->isOc ?? $dto->isOc;
         $dto->lang = $this->lang ?? $dto->lang ?? SettingsManager::getValue('KBIN_DEFAULT_LANG');
         $dto->url = $this->url ?? $dto->url;
+        $dto->tags = $this->tags ?? $dto->tags;
 
         return $dto;
     }

diff --git a/src/Entity/Entry.php b/src/Entity/Entry.php
@@ -166,6 +166,7 @@ public function __construct(
         $this->favourites = new ArrayCollection();
         $this->notifications = new ArrayCollection();
         $this->badges = new ArrayCollection();
+        $this->hashtags = new ArrayCollection();
 
         $user->addEntry($this);
 

diff --git a/src/Entity/Magazine.php b/src/Entity/Magazine.php
@@ -134,6 +134,8 @@ public function __construct(
         $this->reports = new ArrayCollection();
         $this->badges = new ArrayCollection();
         $this->logs = new ArrayCollection();
+        $this->moderatorRequests = new ArrayCollection();
+        $this->ownershipRequests = new ArrayCollection();
 
         if (null !== $user) {
             $this->addModerator(new Moderator($this, $user, null, true, true));

diff --git a/src/MessageHandler/ActivityPub/Inbox/ActivityHandler.php b/src/MessageHandler/ActivityPub/Inbox/ActivityHandler.php
@@ -30,6 +30,7 @@
 use App\Service\SettingsManager;
 use Doctrine\ORM\EntityManagerInterface;
 use Psr\Log\LoggerInterface;
+use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Component\Messenger\Attribute\AsMessageHandler;
 use Symfony\Component\Messenger\Exception\UnrecoverableMessageHandlingException;
 use Symfony\Component\Messenger\MessageBusInterface;
@@ -39,6 +40,7 @@ class ActivityHandler extends MbinMessageHandler
 {
     public function __construct(
         private readonly EntityManagerInterface $entityManager,
+        private readonly KernelInterface $kernel,
         private readonly SignatureValidator $signatureValidator,
         private readonly SettingsManager $settingsManager,
         private readonly MessageBusInterface $bus,
@@ -48,7 +50,7 @@ public function __construct(
         private readonly RemoteInstanceManager $remoteInstanceManager,
         private readonly LoggerInterface $logger
     ) {
-        parent::__construct($this->entityManager);
+        parent::__construct($this->entityManager, $this->kernel);
     }
 
     public function __invoke(ActivityMessage $message): void

diff --git a/src/MessageHandler/ActivityPub/Inbox/AddHandler.php b/src/MessageHandler/ActivityPub/Inbox/AddHandler.php
@@ -22,6 +22,7 @@
 use App\Service\SettingsManager;
 use Doctrine\ORM\EntityManagerInterface;
 use Psr\Log\LoggerInterface;
+use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Component\Messenger\Attribute\AsMessageHandler;
 use Symfony\Component\Messenger\MessageBusInterface;
 
@@ -30,6 +31,7 @@ class AddHandler extends MbinMessageHandler
 {
     public function __construct(
         private readonly EntityManagerInterface $entityManager,
+        private readonly KernelInterface $kernel,
         private readonly ActivityPubManager $activityPubManager,
         private readonly ApHttpClient $apHttpClient,
         private readonly ApActivityRepository $apActivityRepository,
@@ -41,7 +43,7 @@ public function __construct(
         private readonly EntryManager $entryManager,
         private readonly SettingsManager $settingsManager,
     ) {
-        parent::__construct($this->entityManager);
+        parent::__construct($this->entityManager, $this->kernel);
     }
 
     public function __invoke(AddMessage $message): void

diff --git a/src/MessageHandler/ActivityPub/Inbox/AnnounceHandler.php b/src/MessageHandler/ActivityPub/Inbox/AnnounceHandler.php
@@ -14,6 +14,7 @@
 use App\Service\VoteManager;
 use Doctrine\ORM\EntityManagerInterface;
 use Psr\Log\LoggerInterface;
+use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Component\Messenger\Attribute\AsMessageHandler;
 use Symfony\Component\Messenger\MessageBusInterface;
 
@@ -24,11 +25,12 @@ public function __construct(
         private readonly ActivityPubManager $activityPubManager,
         private readonly EntityManagerInterface $entityManager,
         private readonly MessageBusInterface $bus,
+        private readonly KernelInterface $kernel,
         private readonly VoteManager $manager,
         private readonly VoteHandleSubscriber $voteHandleSubscriber,
         private readonly LoggerInterface $logger,
     ) {
-        parent::__construct($this->entityManager);
+        parent::__construct($this->entityManager, $this->kernel);
     }
 
     public function __invoke(AnnounceMessage $message): void

diff --git a/src/MessageHandler/ActivityPub/Inbox/ChainActivityHandler.php b/src/MessageHandler/ActivityPub/Inbox/ChainActivityHandler.php
@@ -26,6 +26,7 @@
 use App\Service\SettingsManager;
 use Doctrine\ORM\EntityManagerInterface;
 use Psr\Log\LoggerInterface;
+use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Component\Messenger\Attribute\AsMessageHandler;
 use Symfony\Component\Messenger\MessageBusInterface;
 
@@ -34,6 +35,7 @@ class ChainActivityHandler extends MbinMessageHandler
 {
     public function __construct(
         private readonly EntityManagerInterface $entityManager,
+        private readonly KernelInterface $kernel,
         private readonly LoggerInterface $logger,
         private readonly ApHttpClient $client,
         private readonly MessageBusInterface $bus,
@@ -42,7 +44,7 @@ public function __construct(
         private readonly Page $page,
         private readonly SettingsManager $settingsManager,
     ) {
-        parent::__construct($this->entityManager);
+        parent::__construct($this->entityManager, $this->kernel);
     }
 
     public function __invoke(ChainActivityMessage $message): void

diff --git a/src/MessageHandler/ActivityPub/Inbox/CreateHandler.php b/src/MessageHandler/ActivityPub/Inbox/CreateHandler.php
@@ -26,6 +26,7 @@
 use App\Service\MessageManager;
 use Doctrine\ORM\EntityManagerInterface;
 use Psr\Log\LoggerInterface;
+use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Component\Messenger\Attribute\AsMessageHandler;
 use Symfony\Component\Messenger\MessageBusInterface;
 
@@ -34,6 +35,7 @@ class CreateHandler extends MbinMessageHandler
 {
     public function __construct(
         private readonly EntityManagerInterface $entityManager,
+        private readonly KernelInterface $kernel,
         private readonly Note $note,
         private readonly Page $page,
         private readonly MessageBusInterface $bus,
@@ -42,7 +44,7 @@ public function __construct(
         private readonly ActivityPubManager $activityPubManager,
         private readonly ApActivityRepository $repository
     ) {
-        parent::__construct($this->entityManager);
+        parent::__construct($this->entityManager, $this->kernel);
     }
 
     /**