Merge pull request #20 from adrienlucas/new-composer-api

Add a haveADependencySatisfied step, and use the new Composer api.

Author: weirdan

src/Module.php

@@ -10,7 +10,8 @@
 use Codeception\Module\Cli;
 use Codeception\Module\Filesystem;
 use Codeception\TestInterface;
-use Composer\Semver\Comparator;
+use Composer\InstalledVersions;
+use Composer\Semver\Semver;
 use Composer\Semver\VersionParser;
 use Muglug\PackageVersions\Versions as LegacyVersions;
 use PackageVersions\Versions;
@@ -21,7 +22,7 @@
 
 class Module extends BaseModule
 {
-    /** @var array<string,string */
+    /** @var array<string,string> */
     private const VERSION_OPERATORS = [
         'newer than' => '>',
         'older than' => '<',
@@ -101,7 +102,7 @@ public function _before(TestInterface $test): void
      */
     public function runPsalmOn(string $filename, array $options = []): void
     {
-        $suppressProgress = $this->seePsalmVersionIs('>=', '3.4.0');
+        $suppressProgress = $this->packageSatisfiesVersionConstraint('vimeo/psalm', '>=3.4.0');
 
         $options = array_map('escapeshellarg', $options);
         $cmd = $this->config['psalm_path']
@@ -192,11 +193,11 @@ public function seeNoErrors(): void
         }
     }
 
-    public function seePsalmVersionIs(string $operator, string $version): bool
+    private function packageSatisfiesVersionConstraint(string $package, string $versionConstraint): bool
     {
-        $currentVersion = $this->getShortVersion('vimeo/psalm');
+        $currentVersion = $this->getShortVersion($package);
 
-        $this->debug(sprintf("Current version: %s", $currentVersion));
+        $this->debug(sprintf("Current version of %s : %s", $package, $currentVersion));
 
         // todo: move to init/construct/before?
         $parser = new VersionParser();
@@ -207,14 +208,22 @@ public function seePsalmVersionIs(string $operator, string $version): bool
             $currentVersion = '9999999-dev';
         }
 
-        $version = $parser->normalize($version);
+        $result = Semver::satisfies($currentVersion, $versionConstraint);
 
-        $result = Comparator::compare($currentVersion, $operator, $version);
-        $this->debug("Comparing $currentVersion $operator $version => $result");
+        $this->debug("Comparing $currentVersion against $versionConstraint => " . ($result ? 'ok' : 'ko'));
 
         return $result;
     }
 
+    /**
+     * @deprecated
+     * This method is only to maintain the public API; please use `self::haveADependencySatisfied` instead.
+     */
+    public function seePsalmVersionIs(string $operator, string $version): bool
+    {
+        return $this->packageSatisfiesVersionConstraint('vimeo/psalm', $operator . $version);
+    }
+
     /**
      * @Given I have the following code preamble :code
      */
@@ -243,7 +252,7 @@ public function runPsalmWithDeadCodeDetection(): void
 
     public function seePsalmHasTaintAnalysis(): bool
     {
-        $taintAnalysisAvailable = $this->seePsalmVersionIs('>=', '3.10.0');
+        $taintAnalysisAvailable = $this->packageSatisfiesVersionConstraint('vimeo/psalm', '>=3.10.0');
         return $taintAnalysisAvailable;
     }
 
@@ -330,7 +339,7 @@ public function havePsalmOfACertainVersionRangeBecauseOf(string $operator, strin
 
         $op = (string) self::VERSION_OPERATORS[$operator];
 
-        if (!$this->seePsalmVersionIs($op, $version)) {
+        if (!$this->packageSatisfiesVersionConstraint('vimeo/psalm', $op . $version)) {
             /** @psalm-suppress InternalClass */
             throw new SkippedTestError("This scenario requires Psalm $op $version because of $reason");
         }
@@ -407,6 +416,19 @@ function (array $row): string {
         $this->hasAutoload = true;
     }
 
+    /**
+     * @Given I have the :package package satisfying the :versionConstraint
+     */
+    public function haveADependencySatisfied(string $package, string $versionConstraint): void
+    {
+        if ($this->packageSatisfiesVersionConstraint($package, $versionConstraint)) {
+            return;
+        }
+
+        /** @psalm-suppress InternalClass */
+        throw new SkippedTestError("This scenario requires $package to match $versionConstraint");
+    }
+
     private function convertToRegexp(string $in): string
     {
         return '@' . str_replace('%', '.*', preg_quote($in, '@')) . '@';
@@ -452,7 +474,11 @@ function (array $error): array {
 
     private function getShortVersion(string $package): string
     {
-        if (class_exists(Versions::class)) {
+        /** @psalm-suppress DeprecatedClass Support of legacy code */
+        if (class_exists(InstalledVersions::class)) {
+            /** @psalm-suppress UndefinedClass Composer\InstalledVersions is undefined when using Composer 1.x */
+            return (string) InstalledVersions::getPrettyVersion($package);
+        } elseif (class_exists(Versions::class)) {
             /** @psalm-suppress UndefinedClass psalm 3.0 ignores class_exists check */
             $version = (string) Versions::getVersion($package);
         } elseif (class_exists(LegacyVersions::class)) {

tests/acceptance/PsalmModule.feature

@@ -235,3 +235,24 @@ Feature: Psalm module
       | Type            | Message |
       | TaintedInput    | /./     |
     And I see no other errors
+
+  Scenario: Skipping when dependency is not satisfied
+    Given I have the "codeception/module-cli" package satisfying the "^123.0"
+    And I have the following code
+      """
+      atan("zz");
+      """
+    When I run Psalm
+    Then I see no errors
+
+  Scenario: Running when dependency is satisfied
+    Given I have the "codeception/module-cli" package satisfying the "*"
+    And I have the following code
+      """
+      atan("zz");
+      """
+    When I run Psalm
+    Then I see these errors
+      | Type                     | Message |
+      | InvalidScalarArgument    | /./     |
+    And I see no other errors