Merge pull request #44 from youwe-petervanderwal/feat/only-run-installer-on-require-update

feat: only run the Testing Suite installer on actual composer require/update

Author: youwe-petervanderwal

CHANGELOG.md

@@ -32,6 +32,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated remote schema location URL for phpmd rulesets to prevent redirecting which may cause flaky builds.
 - Bumped phpro/grumphp-shim dependency from v1 to v2
 - Bumped youwe/composer-dependency-installer from v1 to v2
+- Testing Suite files are only installed in the project when the package itself is installed and/or updated, for example 
+  when running `composer require youwe/testing-suite`, `composer update [youwe/testing-suite]` or `composer install`
+  when the package was not installed (yet/anymore).
 
 ### Removed
 - Removed support for EOL PHP versions. Projects running PHP < 8.1 can stick to version 2 of the testing-suite.

phpmd.xml

@@ -4,5 +4,13 @@
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 https://pmd.sourceforge.io/ruleset_xml_schema.xsd">
     <description>PHPMD</description>
-    <rule ref="./config/default/phpmd.xml" />
+    <rule ref="./config/default/phpmd.xml">
+        <exclude name="ShortVariable"/>
+    </rule>
+
+    <rule ref="rulesets/naming.xml/ShortVariable">
+        <properties>
+            <property name="exceptions" value="io" />
+        </properties>
+    </rule>
 </ruleset>

src/Plugin.php

@@ -10,9 +10,12 @@
 namespace Youwe\TestingSuite\Composer;
 
 use Composer\Composer;
+use Composer\DependencyResolver\Operation;
 use Composer\EventDispatcher\EventSubscriberInterface;
+use Composer\Installer\PackageEvent;
 use Composer\IO\IOInterface;
 use Composer\Plugin\PluginInterface;
+use UnexpectedValueException;
 use Youwe\TestingSuite\Composer\Installer\InstallerInterface;
 
 /**
@@ -21,8 +24,23 @@
  */
 class Plugin implements PluginInterface, EventSubscriberInterface
 {
+    public const PACKAGE_NAME = 'youwe/testing-suite';
+
     /** @var InstallerInterface[] */
-    private $installers;
+    private array $installers;
+
+    /**
+     * Subscribe to post update and post install command.
+     *
+     * @return array
+     */
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            'post-package-install' => [ 'onPackageChange' ],
+            'post-package-update' => [ 'onPackageChange' ],
+        ];
+    }
 
     /**
      * Constructor.
@@ -42,7 +60,7 @@ public function __construct(InstallerInterface ...$installers)
      *
      * @return void
      */
-    public function activate(Composer $composer, IOInterface $io)
+    public function activate(Composer $composer, IOInterface $io): void
     {
         $this->addInstallers(
             ...include __DIR__ . '/installers.php',
@@ -57,7 +75,7 @@ public function activate(Composer $composer, IOInterface $io)
      *
      * @return void
      */
-    public function deactivate(Composer $composer, IOInterface $io)
+    public function deactivate(Composer $composer, IOInterface $io): void
     {
     }
 
@@ -69,7 +87,7 @@ public function deactivate(Composer $composer, IOInterface $io)
      *
      * @return void
      */
-    public function uninstall(Composer $composer, IOInterface $io)
+    public function uninstall(Composer $composer, IOInterface $io): void
     {
     }
 
@@ -80,37 +98,34 @@ public function uninstall(Composer $composer, IOInterface $io)
      *
      * @return void
      */
-    public function addInstallers(InstallerInterface ...$installers)
+    public function addInstallers(InstallerInterface ...$installers): void
     {
         $this->installers = array_merge($this->installers, $installers);
     }
 
     /**
-     * Run the installers.
+     * Run the installers when this package has been installed/updated
      *
+     * @param PackageEvent $event
      * @return void
      */
-    public function install()
+    public function onPackageChange(PackageEvent $event): void
     {
+        $operation = $event->getOperation();
+
+        $packageName = match (true) {
+            $operation instanceof Operation\InstallOperation => $operation->getPackage()->getName(),
+            $operation instanceof Operation\UpdateOperation => $operation->getTargetPackage()->getName(),
+            default => throw new UnexpectedValueException('Unexpected operation type: ' . $operation::class),
+        };
+
+        if ($packageName !== self::PACKAGE_NAME) {
+            return;
+        }
+
+        $event->getIO()->write('<info>Running Youwe Testing Suite installer</info>');
         foreach ($this->installers as $installer) {
             $installer->install();
         }
     }
-
-    /**
-     * Subscribe to post update and post install command.
-     *
-     * @return array
-     */
-    public static function getSubscribedEvents(): array
-    {
-        return [
-            'post-install-cmd' => [
-                'install',
-            ],
-            'post-update-cmd' => [
-                'install',
-            ],
-        ];
-    }
 }

tests/PluginTest.php

@@ -10,8 +10,12 @@
 namespace Youwe\TestingSuite\Composer\Tests;
 
 use Composer\Composer;
+use Composer\DependencyResolver\Operation;
+use Composer\Installer\PackageEvent;
 use Composer\IO\IOInterface;
+use Composer\Package\PackageInterface;
 use PHPUnit\Framework\Attributes\CoversMethod;
+use PHPUnit\Framework\Attributes\TestWith;
 use PHPUnit\Framework\MockObject\Exception;
 use PHPUnit\Framework\TestCase;
 use ReflectionProperty;
@@ -49,21 +53,66 @@ public function testActivate(): void
     /**
      * @throws Exception
      */
-    public function testInstall(): void
-    {
+    #[TestWith(
+        data: [Operation\InstallOperation::class, 'getPackage', 'youwe/testing-suite', true],
+        name: 'It runs installers when installing Testing Suite',
+    )]
+    #[TestWith(
+        data: [Operation\UpdateOperation::class, 'getTargetPackage', 'youwe/testing-suite', true],
+        name: 'It runs installers when updating Testing Suite',
+    )]
+    #[TestWith(
+        data: [Operation\InstallOperation::class, 'getPackage', 'youwe/coding-standard-phpstorm', false],
+        name: 'It doesn\'t run installers when installing something else',
+    )]
+    #[TestWith(
+        data: [Operation\UpdateOperation::class, 'getTargetPackage', 'youwe/coding-standard-phpstorm', false],
+        name: 'It doesn\'t run installers when updating something else',
+    )]
+    public function testOnPackageChange(
+        string $operationClass,
+        string $packageGetter,
+        string $packageName,
+        bool $itRunsInstallers,
+    ): void {
         $installers = [
             $this->createMock(InstallerInterface::class),
             $this->createMock(InstallerInterface::class)
         ];
 
         foreach ($installers as $installer) {
             $installer
-                ->expects(self::once())
+                ->expects($itRunsInstallers ? self::once() : self::never())
                 ->method('install');
         }
 
         $plugin = new Plugin(...$installers);
-        $plugin->install();
+
+        $package = $this->createMock(PackageInterface::class);
+        $package->expects(self::once())
+            ->method('getName')
+            ->willReturn($packageName);
+
+        $operation = $this->createMock($operationClass);
+        $operation->expects(self::once())
+            ->method($packageGetter)
+            ->willReturn($package);
+
+        $event = $this->createMock(PackageEvent::class);
+        $event->expects(self::once())
+            ->method('getOperation')
+            ->willReturn($operation);
+
+        $io = $this->createMock(IOInterface::class);
+        $io->expects($itRunsInstallers ? self::once() : self::never())
+            ->method('write')
+            ->with('<info>Running Youwe Testing Suite installer</info>');
+
+        $event->expects(self::any())
+            ->method('getIO')
+            ->willReturn($io);
+
+        $plugin->onPackageChange($event);
     }
 
     public function testGetSubscribesEvents(): void