Merge pull request #4 from YouweGit/feature/support-skipping-version-overrides

feat: support skipping package installation when upstream has out-of-…

Author: Anve94

.gitignore

@@ -1,2 +1,4 @@
 /vendor/
 composer.lock
+.idea/
+.phpunit.result.cache

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 1.5.0
+### Changed
+- Add support whether upstream projects should have versions replaced in composer.json if the version does not match.
+This can be decided per package individually, and the default value is the behavior of 1.4.0 where a package will always be replaced if the versions do not match.
+- Enforce this package is unit tested with phpunit 12. Since the dev dependency was on stable, phpunit 12 would be installed anyway on modernized systems.
+
 ## 1.4.0
 ### Added
 - Option to update module with all dependencies.

README.md

@@ -1,3 +1,42 @@
 # composer-dependency-installer
 
-PHP package for installing Composer's dependencies.
+PHP package for installing Composer's dependencies upstream.
+
+## Usage
+To install a package in upstream software requiring this package, instantiate a new instance and call the install() function.
+
+## Usage reference
+```php
+<?php
+
+declare(strict_types=1);
+
+namespace Acme\Foo;
+
+class Bar
+{
+    public function __construct(
+        private readonly DependencyInstaller $dependencyInstaller
+    ) {}
+    
+    public function installUpstreamRepository(): void
+    {
+        $this->dependencyInstaller->installRepository(
+            name: 'some/package',
+            type: 'composer',
+            url: 'mypackagedomain.dev'
+        );
+    }
+    
+    public function installUpstreamPackage(): void
+    {
+        $this->dependencyInstaller->installPackage(
+            name: 'some/package',
+            version: '^2.0.0',
+            dev: true, // Whether it should be a dev dependency (e.g. require-dev). Optional, defaults to true
+            updateDependencies: false, // Whether dependencies can be updated. Optional, defaults to true. When enabled, passes -W flag to composer
+            allowOverrideVersion: true // Whether version can be updated with new version when package is altready installed upstream. Optional, defaults to true.
+        )
+    }
+}
+```

composer.json

@@ -25,7 +25,7 @@
     },
     "require-dev": {
         "kint-php/kint": "@stable",
-        "phpunit/phpunit": "@stable"
+        "phpunit/phpunit": "^12"
     },
     "autoload": {
         "psr-4": {

phpunit.xml

@@ -7,9 +7,4 @@
             <directory>tests</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">src</directory>
-        </whitelist>
-    </filter>
 </phpunit>

src/DependencyInstaller.php

@@ -99,18 +99,24 @@ public function installRepository(string $name, string $type, string $url)
      * @param string $version
      * @param bool $dev
      * @param bool $updateDependencies
+     * @param bool $allowOverrideVersion
      *
      * @return void
      *
      * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
      */
-    public function installPackage(string $name, string $version, bool $dev = true, bool $updateDependencies = false)
-    {
+    public function installPackage(
+        string $name,
+        string $version,
+        bool $dev = true,
+        bool $updateDependencies = false,
+        bool $allowOverrideVersion = true
+    ) {
         $node = $dev ? 'require-dev' : 'require';
 
         if (array_key_exists($node, $this->definition)
             && array_key_exists($name, $this->definition[$node])
-            && $this->definition[$node][$name] === $version
+            && ($this->definition[$node][$name] === $version || !$allowOverrideVersion)
         ) {
             return;
         }

tests/DependencyInstallerTest.php

@@ -10,47 +10,44 @@
 namespace Youwe\Composer\DependencyInstaller\Tests;
 
 use Composer\Json\JsonFile;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\CoversMethod;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\MockObject\Exception;
 use Seld\JsonLint\ParsingException;
 use Youwe\Composer\DependencyInstaller\DependencyInstaller;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Output\OutputInterface;
 
-/**
- * @coversDefaultClass \Youwe\Composer\DependencyInstaller\DependencyInstaller
- */
+#[CoversClass(DependencyInstaller::class)]
+#[CoversMethod(DependencyInstaller::class, '__construct')]
+#[CoversMethod(DependencyInstaller::class, 'installPackage')]
+#[CoversMethod(DependencyInstaller::class, 'installRepository')]
 class DependencyInstallerTest extends TestCase
 {
-    /** @var string */
-    private static $directory = __DIR__ . DIRECTORY_SEPARATOR . 'tmp';
+    private static string $directory = __DIR__ . DIRECTORY_SEPARATOR . 'tmp';
+    private DependencyInstaller $dependencyInstaller;
 
     /**
-     * @return void
+     * @throws Exception
      */
-    public static function setUpBeforeClass()
+    protected function setUp(): void
     {
-        static::tearDownAfterClass();
-
         mkdir(static::$directory);
         chdir(static::$directory);
         file_put_contents('composer.json', '{}');
+
+        $this->updateComposerFileReference();
     }
 
-    /**
-     * @return void
-     */
-    public static function tearDownAfterClass()
+    protected function tearDown(): void
     {
         if (is_dir(static::$directory)) {
             static::rrmdir(static::$directory);
         }
     }
 
-    /**
-     * @param string $src
-     *
-     * @return void
-     */
-    private static function rrmdir(string $src)
+    private static function rrmdir(string $src): void
     {
         $dir = opendir($src);
         while (false !== ($file = readdir($dir))) {
@@ -67,45 +64,24 @@ private static function rrmdir(string $src)
         rmdir($src);
     }
 
-
-    /**
-     * @return DependencyInstaller
-     * @covers ::__construct
-     */
-    public function testConstructor(): DependencyInstaller
+    public function testConstructor(): void
     {
-        $installer = new DependencyInstaller(
-            'composer.json',
-            $this->createMock(OutputInterface::class)
-        );
-
         $this->assertInstanceOf(
             DependencyInstaller::class,
-            $installer
+            $this->dependencyInstaller
         );
-
-        return $installer;
     }
 
     /**
-     * @depends      testConstructor
-     * @dataProvider repositoryProvider
-     *
-     * @param string              $name
-     * @param string              $type
-     * @param string              $url
-     * @param DependencyInstaller $dependencyInstaller
-     *
-     * @return void
-     * @covers ::installRepository
+     * @throws ParsingException
      */
+    #[DataProvider('repositoryProvider')]
     public function testInstallRepository(
         string $name,
         string $type,
         string $url,
-        DependencyInstaller $dependencyInstaller
-    ) {
-        $dependencyInstaller->installRepository($name, $type, $url);
+    ): void {
+        $this->dependencyInstaller->installRepository($name, $type, $url);
 
         $jsonFile   = new JsonFile('composer.json');
         $definition = $jsonFile->read();
@@ -121,35 +97,25 @@ public function testInstallRepository(
     /**
      * @return array
      */
-    public function repositoryProvider(): array
+    public static function repositoryProvider(): array
     {
         return [
             ['mediact', 'composer', 'https://composer.mediact.nl']
         ];
     }
 
     /**
-     * @depends      testConstructor
-     * @dataProvider packageProvider
-     *
-     * @param string $name
-     * @param string $version
-     * @param bool $dev
-     * @param bool $updateDependencies
-     * @param DependencyInstaller $dependencyInstaller
-     *
-     * @return void
      * @throws ParsingException
-     * @covers ::installPackage
      */
+    #[DataProvider('packageProvider')]
     public function testInstallPackage(
         string $name,
         string $version,
         bool $dev,
         bool $updateDependencies,
-        DependencyInstaller $dependencyInstaller
+        bool $allowOverrideVersion
     ) {
-        $dependencyInstaller->installPackage($name, $version, $dev, $updateDependencies);
+        $this->dependencyInstaller->installPackage($name, $version, $dev, $updateDependencies, $allowOverrideVersion);
 
         $jsonFile   = new JsonFile('composer.json');
         $definition = $jsonFile->read();
@@ -161,14 +127,90 @@ public function testInstallPackage(
         $this->assertEquals($version, $definition[$node][$name]);
     }
 
-    /**
-     * @return array
-     */
-    public function packageProvider(): array
+    public static function packageProvider(): array
     {
         return [
-            ['psr/log', '@stable', true, false],
-            ['psr/log', '@stable', false, false]
+            ['psr/log', '@stable', true, false, true],
+            ['psr/log', '@stable', false, false, true]
         ];
     }
+
+    /**
+     * @throws ParsingException
+     * @throws Exception
+     */
+    public function testOriginalPackageVersionCanBePreserved() {
+        $this->dependencyInstaller->installPackage(
+            'psr/link',
+            '1.1.1',
+            false,
+            false,
+            false
+        );
+
+        $this->updateComposerFileReference();
+
+        $this->dependencyInstaller->installPackage(
+            'psr/link',
+            '^2',
+            false,
+            false,
+            false
+        );
+
+        $this->updateComposerFileReference();
+
+        $jsonFile   = new JsonFile('composer.json');
+        $definition = $jsonFile->read();
+
+        // Assert the pre-existing composer versions was NOT wiped by a dependency installer package installation
+        $this->assertArrayHasKey('require', $definition);
+        $this->assertArrayHasKey('psr/link', $definition['require']);
+        $this->assertEquals('1.1.1', $definition['require']['psr/link']);
+    }
+
+    /**
+     * @throws ParsingException|Exception
+     */
+    public function testOriginalPackageVersionCanBeOverridden(): void {
+        // Install and validate base package availability
+        $this->dependencyInstaller->installPackage(
+            'psr/link',
+            '1.1.1',
+            false
+        );
+
+        $this->updateComposerFileReference();
+
+        $this->dependencyInstaller->installPackage(
+            'psr/link',
+            '@stable',
+            false
+        );
+
+        $jsonFile   = new JsonFile('composer.json');
+        $definition = $jsonFile->read();
+
+        $this->assertArrayHasKey('require', $definition);
+        $this->assertArrayHasKey('psr/link', $definition['require']);
+        $this->assertEquals('@stable', $definition['require']['psr/link']);
+    }
+
+    /**
+     * Update the composer file reference since it is loaded only once as part of the constructor.
+     *
+     * We refresh the composer file reference whenever the composer file is changed, otherwise the dependency
+     * installer will always hold a reference to the previous state of the composer file and not contain any
+     * changes if multiple installations happen in the same testing function.
+     *
+     * @return void
+     * @throws Exception
+     */
+    private function updateComposerFileReference(): void
+    {
+        $this->dependencyInstaller = new DependencyInstaller(
+            'composer.json',
+            $this->createMock(OutputInterface::class)
+        );
+    }
 }