UHF-9718: Command to check module versions

.github/workflows/ci.yml

@@ -13,6 +13,17 @@ jobs:
     container:
       image: ghcr.io/city-of-helsinki/drupal-php-docker:${{ matrix.php-versions }}-alpine
 
+    services:
+      db:
+        image: mysql:8
+        env:
+          MYSQL_USER: drupal
+          MYSQL_PASSWORD: drupal
+          MYSQL_DATABASE: drupal
+          MYSQL_ROOT_PASSWORD: drupal
+        ports:
+          - 3306:3306
+
     steps:
       - uses: actions/checkout@v3
         with:
@@ -22,7 +33,7 @@ jobs:
         run: composer install
 
       - name: Run PHPCS
-        run: vendor/bin/phpcs --ignore=*/vendor/* .
+        run: vendor/bin/phpcs --ignore=*/vendor/*,*/sut/* .
 
       - name: Run phpstan
         run: vendor/bin/phpstan analyze -c phpstan.neon .

.gitignore

@@ -1,5 +1,8 @@
 vendor/
 composer.lock
+!tests/fixtures/composer.lock
 tests/.phpunit.cache
 tests/fixtures/schema
 tests/coverage.xml
+sut/core
+sut/modules

composer.json

@@ -5,9 +5,13 @@
     "license": "GPL-2.0-or-later",
     "minimum-stability": "dev",
     "require": {
-        "drush/drush": "^11 || ^12"
+        "drupal/helfi_api_base": "*",
+        "drush/drush": "^11 || ^12 || ^13"
     },
     "require-dev": {
+        "composer/installers": "^2",
+        "drupal/core-recommended": "^10.2",
+        "drupal/core-dev": "^10.2",
         "dealerdirect/phpcodesniffer-composer-installer": "^0.7.0",
         "drupal/coder": "^8.3",
         "phpspec/prophecy-phpunit": "^2",
@@ -27,12 +31,37 @@
         "psr-4": {
             "DrupalToolsTest\\": "tests/fixtures"
         },
+        "classmap": [
+            "sut/core",
+            "sut/modules/contrib"
+        ],
         "files": [ "tests/fixtures/migration_fixture.php" ]
     },
+    "repositories": {
+        "platform": {
+            "type": "composer",
+            "url": "https://repository.drupal.hel.ninja"
+        },
+        "drupal_org": {
+            "type": "composer",
+            "url": "https://packages.drupal.org/8"
+        }
+    },
     "config": {
         "allow-plugins": {
+            "composer/installers": true,
             "dealerdirect/phpcodesniffer-composer-installer": true,
             "phpstan/extension-installer": true
         }
+    },
+    "extra": {
+        "installer-paths": {
+            "sut/core": ["type:drupal-core"],
+            "sut/libraries/{$name}": ["type:drupal-library"],
+            "sut/modules/contrib/{$name}": ["type:drupal-module"],
+            "sut/profiles/contrib/{$name}": ["type:drupal-profile"],
+            "sut/themes/contrib/{$name}": ["type:drupal-theme"],
+            "sut/drush/contrib/{$name}": ["type:drupal-drush"]
+        }
     }
 }

phpstan.neon

@@ -4,6 +4,7 @@ parameters:
   paths:
     - ./
   excludePaths:
+    - sut
     - vendor
     - src/Drush/Commands/HelperDrushCommands.php
     - src/Drush/Commands/OpenShiftDrushCommands.php

src/Drush/Commands/HelperDrushCommands.php

@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace DrupalTools\Drush\Commands;
 

src/Drush/Commands/OpenShiftDrushCommands.php

@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace DrupalTools\Drush\Commands;
 

src/Drush/Commands/PackageScannerDrushCommands.php

@@ -0,0 +1,85 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DrupalTools\Drush\Commands;
+
+use ComposerLockParser\ComposerInfo;
+use Consolidation\AnnotatedCommand\CommandResult;
+use Consolidation\OutputFormatters\StructuredData\RowsOfFields;
+use Drupal\Component\DependencyInjection\ContainerInterface;
+use Drupal\helfi_api_base\Package\VersionChecker;
+use Drush\Attributes\Argument;
+use Drush\Attributes\Command;
+use Drush\Attributes\FieldLabels;
+use Drush\Commands\DrushCommands;
+
+/**
+ * A drush command to check whether given Helfi packages are up-to-date.
+ */
+final class PackageScannerDrushCommands extends DrushCommands {
+
+  /**
+   * Constructs a new instance.
+   *
+   * @param \Drupal\helfi_api_base\Package\VersionChecker $versionChecker
+   *   The version checker service.
+   */
+  public function __construct(
+    private readonly VersionChecker $versionChecker,
+  ) {
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container): self {
+    return new self(
+      $container->get('helfi_api_base.package_version_checker'),
+    );
+  }
+
+  /**
+   * Checks whether Composer packages are up-to-date.
+   *
+   * @param string $file
+   *   The path to composer.lock file.
+   * @param array $options
+   *   The options.
+   *
+   * @return \Consolidation\AnnotatedCommand\CommandResult
+   *   The result.
+   */
+  #[Command(name: 'helfi:tools:check-composer-versions')]
+  #[Argument(name: 'file', description: 'Path to composer.lock file')]
+  #[FieldLabels(labels: [
+    'name' => 'Name',
+    'version' => 'Current version',
+    'latest' => 'Latest version',
+  ])]
+  public function checkVersions(string $file, array $options = ['format' => 'table']) : CommandResult {
+    $info = new ComposerInfo($file);
+
+    $rows = [];
+    /** @var \Composer\Package\Package $package */
+    foreach (iterator_to_array($info->getPackages()) as $package) {
+      $version = $this->versionChecker->get($package->getName(), $package->getVersion());
+
+      // Skip dev versions since we can't easily verify the latest
+      // version.
+      if (!$version || $version->isLatest || str_starts_with($package->getVersion(), 'dev-')) {
+        continue;
+      }
+      $rows[] = [
+        'name' => $package->getName(),
+        'version' => $package->getVersion(),
+        'latest' => $version->latestVersion,
+      ];
+    }
+
+    $exitCode = $rows ? DrushCommands::EXIT_FAILURE_WITH_CLARITY : DrushCommands::EXIT_SUCCESS;
+
+    return CommandResult::dataWithExitCode(new RowsOfFields($rows), $exitCode);
+  }
+
+}