Allow final classes to be mocked

composer.json

@@ -19,6 +19,7 @@
     },
     "require-dev": {
         "dealerdirect/phpcodesniffer-composer-installer": "^0.7.0",
+        "dg/bypass-finals": "^1.0",
         "drupal/coder": "^8.3",
         "donatj/mock-webserver": "dev-master"
     }

drush.services.yml

@@ -28,11 +28,6 @@ services:
     arguments: ['@service_container']
     tags:
       - { name: drush.command }
-  helfi_api_base.test_commands:
-    class: \Drupal\helfi_api_base\Commands\TestCommands
-    arguments: ['@file_system']
-    tags:
-      - { name: drush.command }
   helfi_api_base.locale_commands:
     class: \Drupal\helfi_api_base\Commands\LocaleCommands
     arguments: ['@language_manager', '@file_system', '@string_translation', '@extension.list.module']

phpstan.neon

@@ -11,10 +11,6 @@ parameters:
   checkMissingIterableValueType: false
   treatPhpDocTypesAsCertain: false
   ignoreErrors:
-    -
-      message: '#^Method Symfony\\Contracts\\EventDispatcher\\EventDispatcherInterface::dispatch\(\) invoked with 2 parameters, 1 required.#'
-      path: src/Commands/DeployCommands.php
-      count: 2
     -
       message: '#^Unsafe usage of new static#'
       path: src/Plugin/migrate/source/HttpSourcePluginBase.php

phpunit.xml

@@ -38,6 +38,9 @@
   <listener class="\Drupal\Tests\Listeners\DrupalListener">
   </listener>
 </listeners>
+<extensions>
+  <extension class="\Drupal\helfi_api_base\BypassFinalHook"/>
+</extensions>
 <coverage cacheDirectory=".phpunit.cache/code-coverage" processUncoveredFiles="true">
   <include>
     <directory suffix=".php">./src</directory>

src/BypassFinalHook.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\helfi_api_base;
+
+use DG\BypassFinals;
+use PHPUnit\Runner\BeforeTestHook;
+
+/**
+ * Allow final classes to be mocked.
+ */
+final class BypassFinalHook implements BeforeTestHook {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function executeBeforeTest(string $test): void {
+    BypassFinals::enable();
+  }
+
+}

src/Commands/DeployCommands.php

@@ -4,9 +4,10 @@
 
 namespace Drupal\helfi_api_base\Commands;
 
+use Drupal\helfi_api_base\Event\PostDeployEvent;
+use Drupal\helfi_api_base\Event\PreDeployEvent;
 use Drush\Attributes\Command;
 use Drush\Commands\DrushCommands;
-use Symfony\Contracts\EventDispatcher\Event;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 /**
@@ -36,7 +37,7 @@ public function __construct(
    */
   #[Command(name: 'helfi:post-deploy')]
   public function postDeploy() : int {
-    $this->eventDispatcher->dispatch(new Event(), 'helfi_api_base.post_deploy');
+    $this->eventDispatcher->dispatch(new PostDeployEvent());
     return DrushCommands::EXIT_SUCCESS;
   }
 
@@ -50,7 +51,7 @@ public function postDeploy() : int {
    */
   #[Command(name: 'helfi:pre-deploy')]
   public function preDeploy() : int {
-    $this->eventDispatcher->dispatch(new Event(), 'helfi_api_base.pre_deploy');
+    $this->eventDispatcher->dispatch(new PreDeployEvent());
     return DrushCommands::EXIT_SUCCESS;
   }
 

src/Entity/Revision/RevisionManager.php

@@ -9,6 +9,7 @@
 use Drupal\Core\Config\ConfigFactoryInterface;
 use Drupal\Core\Database\Connection;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\Core\Entity\RevisionableStorageInterface;
 use Drupal\Core\Entity\TranslatableRevisionableInterface;
 
 /**
@@ -102,6 +103,7 @@ public function deleteRevisions(string $entityType, array $revisionIds) : void {
 
     $storage = $this->entityTypeManager
       ->getStorage($entityType);
+    assert($storage instanceof RevisionableStorageInterface);
 
     foreach ($revisionIds as $id) {
       $storage->deleteRevision($id);
@@ -131,6 +133,8 @@ public function getRevisionsPerLanguage(
     $this->assertEntityType($entityType);
 
     $storage = $this->entityTypeManager->getStorage($entityType);
+    assert($storage instanceof RevisionableStorageInterface);
+
     $definition = $this->entityTypeManager->getDefinition($entityType);
 
     $revision_ids = $this->connection->query(

src/Event/PostDeployEvent.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\helfi_api_base\Event;
+
+use Symfony\Contracts\EventDispatcher\Event;
+
+/**
+ * Post-deploy event.
+ */
+final class PostDeployEvent extends Event {
+}

src/Event/PreDeployEvent.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\helfi_api_base\Event;
+
+use Symfony\Contracts\EventDispatcher\Event;
+
+/**
+ * Pre-deploy event.
+ */
+final class PreDeployEvent extends Event {
+}

src/EventSubscriber/DeployHookEventSubscriberBase.php

@@ -4,6 +4,8 @@
 
 namespace Drupal\helfi_api_base\EventSubscriber;
 
+use Drupal\helfi_api_base\Event\PostDeployEvent;
+use Drupal\helfi_api_base\Event\PreDeployEvent;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Contracts\EventDispatcher\Event;
 
@@ -35,8 +37,8 @@ public function onPreDeploy(Event $event) : void {
    */
   public static function getSubscribedEvents() : array {
     return [
-      'helfi_api_base.post_deploy' => ['onPostDeploy'],
-      'helfi_api_base.pre_deploy' => ['onPreDeploy'],
+      PostDeployEvent::class => ['onPostDeploy'],
+      PreDeployEvent::class => ['onPreDeploy'],
     ];
   }
 

tests/src/Kernel/EnvironmentResponseSubscriberTest.php

@@ -52,6 +52,8 @@ private function getResponseEvent(Request $request = NULL) : ResponseEvent {
     return new ResponseEvent(
       $this->container->get('http_kernel'),
       $request,
+      // @todo Rename this once Core requires 7.0 symfony.
+      // @phpstan-ignore-next-line
       HttpKernelInterface::MASTER_REQUEST,
       new HtmlResponse()
     );

tests/src/Kernel/EventSubscriber/EnsureApiAccountsSubscriberTest.php

@@ -6,12 +6,12 @@
 
 use Drupal\helfi_api_base\Environment\EnvironmentEnum;
 use Drupal\helfi_api_base\Environment\Project;
+use Drupal\helfi_api_base\Event\PostDeployEvent;
 use Drupal\KernelTests\KernelTestBase;
 use Drupal\Tests\helfi_api_base\Traits\EnvironmentResolverTrait;
 use Drupal\Tests\user\Traits\UserCreationTrait;
 use Drupal\user\Entity\Role;
 use Drupal\user\UserInterface;
-use Symfony\Contracts\EventDispatcher\Event;
 
 /**
  * Tests EnsureApiAccountSubscriber.
@@ -76,9 +76,9 @@ public function testPasswordReset(): void {
 
     $this->assertFalse(user_load_by_name('helfi-admin'));
     // Make sure account is created if one does not exist yet.
-    /** @var \Drupal\helfi_api_base\EventSubscriber\EnsureApiAccountsSubscriber $service */
-    $service = $this->container->get('helfi_api_base.ensure_api_accounts_subscriber');
-    $service->onPostDeploy(new Event());
+    /** @var \Symfony\Contracts\EventDispatcher\EventDispatcherInterface $service */
+    $service = $this->container->get('event_dispatcher');
+    $service->dispatch(new PostDeployEvent());
     $account = user_load_by_name('helfi-admin');
     $this->assertInstanceOf(UserInterface::class, $account);
     $this->assertTrue($account->hasRole('debug_api'));
@@ -96,7 +96,7 @@ public function testPasswordReset(): void {
         ],
       ])
       ->save();
-    $service->onPostDeploy(new Event());
+    $service->dispatch(new PostDeployEvent());
     $account = user_load_by_name('helfi-admin');
     $this->assertInstanceOf(UserInterface::class, $account);
     $this->assertEquals('[email protected]', $account->getEmail());

tests/src/Kernel/TestLoggerTraitTest.php

@@ -4,6 +4,7 @@
 
 namespace Drupal\Tests\helfi_api_base\Kernel;
 
+use Drupal\Core\Utility\Error;
 use Drupal\KernelTests\KernelTestBase;
 use Drupal\Tests\helfi_api_base\Traits\TestLoggerTrait;
 
@@ -49,7 +50,7 @@ public function testDoesNotExpectLogEntry() : void {
    */
   public function testWatchdogException() : void {
     $this->expectLogMessage('Test message', \InvalidArgumentException::class);
-    watchdog_exception('helfi_api_base', new \InvalidArgumentException('Test message'));
+    Error::logException($this->testLogger, new \InvalidArgumentException('Test message'));
   }
 
 }

tests/src/Unit/Commands/DeployCommandsTest.php

@@ -5,10 +5,11 @@
 namespace Drupal\Tests\helfi_api_base\Unit\Commands;
 
 use Drupal\helfi_api_base\Commands\DeployCommands;
+use Drupal\helfi_api_base\Event\PostDeployEvent;
+use Drupal\helfi_api_base\Event\PreDeployEvent;
 use Drupal\Tests\UnitTestCase;
 use Drush\Commands\DrushCommands;
 use Prophecy\PhpUnit\ProphecyTrait;
-use Symfony\Contracts\EventDispatcher\Event;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 /**
@@ -25,7 +26,7 @@ class DeployCommandsTest extends UnitTestCase {
    */
   public function testPostDeploy() : void {
     $eventDispatcher = $this->prophesize(EventDispatcherInterface::class);
-    $eventDispatcher->dispatch(new Event(), 'helfi_api_base.post_deploy')->shouldBeCalledTimes(1);
+    $eventDispatcher->dispatch(new PostDeployEvent())->shouldBeCalledTimes(1);
     $sut = new DeployCommands($eventDispatcher->reveal());
     $this->assertEquals(DrushCommands::EXIT_SUCCESS, $sut->postDeploy());
   }
@@ -36,7 +37,7 @@ public function testPostDeploy() : void {
    */
   public function testPreDeploy() : void {
     $eventDispatcher = $this->prophesize(EventDispatcherInterface::class);
-    $eventDispatcher->dispatch(new Event(), 'helfi_api_base.pre_deploy')->shouldBeCalledTimes(1);
+    $eventDispatcher->dispatch(new PreDeployEvent())->shouldBeCalledTimes(1);
     $sut = new DeployCommands($eventDispatcher->reveal());
     $this->assertEquals(DrushCommands::EXIT_SUCCESS, $sut->preDeploy());
   }