FEATURE: install correct prunner version post-package-update

Author: skurfuerst

Classes/Command/PrunnerCommandController.php

@@ -0,0 +1,53 @@
+<?php
+declare(strict_types=1);
+
+namespace Flowpack\Prunner\Command;
+
+use Flowpack\Prunner\Composer\InstallerScripts;
+use Neos\Flow\Cli\CommandController;
+
+class PrunnerCommandController extends CommandController
+{
+
+    private const COMPOSER_INSTALL_CMD_KEY = 'post-install-cmd';
+    private const COMPOSER_UPDATE_CMD_KEY = 'post-update-cmd';
+
+    public function setupProjectCommand()
+    {
+        $cmd = InstallerScripts::class . '::postUpdateAndInstall';
+
+        $this->outputLine('adding post-install-script to root composer.json');
+
+        $composerJsonFile = file_get_contents(FLOW_PATH_ROOT . '/composer.json');
+        $composerJson = json_decode($composerJsonFile, true);
+        if (!isset($composerJson['scripts'])) {
+            $composerJson['scripts'] = [];
+        }
+
+        $postInstallCmd = [];
+        if (is_string($composerJson['scripts'][self::COMPOSER_INSTALL_CMD_KEY])) {
+            $postInstallCmd[] = $composerJson['scripts'][self::COMPOSER_INSTALL_CMD_KEY];
+        } else {
+            $postInstallCmd = $composerJson['scripts'][self::COMPOSER_INSTALL_CMD_KEY];
+        }
+        if (array_search($cmd, $postInstallCmd) === false) {
+            $postInstallCmd[] = $cmd;
+        }
+        $composerJson['scripts'][self::COMPOSER_INSTALL_CMD_KEY] = $postInstallCmd;
+
+        $postUpdateCmd = [];
+        if (is_string($composerJson['scripts'][self::COMPOSER_UPDATE_CMD_KEY])) {
+            $postUpdateCmd[] = $composerJson['scripts'][self::COMPOSER_UPDATE_CMD_KEY];
+        } else {
+            $postUpdateCmd = $composerJson['scripts'][self::COMPOSER_UPDATE_CMD_KEY];
+        }
+        if (array_search($cmd, $postUpdateCmd) === false) {
+            $postUpdateCmd[] = $cmd;
+        }
+        $composerJson['scripts'][self::COMPOSER_UPDATE_CMD_KEY] = $postUpdateCmd;
+
+        file_put_contents(FLOW_PATH_ROOT . '/composer.json', json_encode($composerJson, JSON_PRETTY_PRINT));
+
+        $this->outputLine('Updated root composer.json. <b>You now need to run composer install</b>');
+    }
+}

Classes/Composer/InstallerScripts.php

@@ -0,0 +1,78 @@
+<?php
+declare(strict_types=1);
+
+namespace Flowpack\Prunner\Composer;
+
+use Composer\Script\Event;
+use Neos\Utility\Files;
+use PharData;
+
+class InstallerScripts
+{
+
+    private const PRUNNER_DISPATCH_SCRIPT = <<<'EOD'
+#!/bin/sh
+
+SCRIPTS_DIR=$(dirname "$(realpath $0)")
+
+OS_TYPE=$(uname -s)
+ARCH_TYPE=$(uname -m)
+
+# Make a very simple check if we have a bundled binary for the right OS / architecture
+BIN_TARGET="${SCRIPTS_DIR}/${OS_TYPE}_${ARCH_TYPE}/prunner"
+
+if [ -f "$BIN_TARGET" ]; then
+    $BIN_TARGET $@
+else
+    echo "Unsupported OS or architecture"
+    exit 1
+fi
+EOD;
+
+
+    public static function postUpdateAndInstall(Event $event)
+    {
+        $platform = php_uname('s'); // stuff like Darwin etc
+        $architecture = php_uname('m'); // x86_64
+
+        $version = '0.0.1';
+
+        $baseDirectory = 'prunner';
+        $platformSpecificTargetDirectory = $baseDirectory . '/' . $platform . '_' . $architecture;
+
+        if (file_exists($platformSpecificTargetDirectory . '/version') && trim(file_get_contents($platformSpecificTargetDirectory . '/version')) !== $version) {
+            echo '> Version of prunner inside ' . $platformSpecificTargetDirectory . ' is ' . trim(file_get_contents($platformSpecificTargetDirectory . '/version')) . ', but we expect ' . $version . ".\n";
+            echo '> Removing prunner, and re-downloading.' . "\n";
+            Files::removeDirectoryRecursively($platformSpecificTargetDirectory);
+        }
+        if (!file_exists($platformSpecificTargetDirectory . '/prunner')) {
+            echo '> Downloading prunner from https://github.com/Flowpack/prunner' . "\n";
+            echo '> Version:      ' . $version . "\n";
+            echo '> Platform:     ' . $platform . "\n";
+            echo '> Architecture: ' . $architecture . "\n";
+            $downloadLink = sprintf('https://github.com/Flowpack/prunner/releases/download/v%s/prunner_%s_%s_%s.tar.gz', $version, $version, $platform, $architecture);
+            $downloadedFileContents = file_get_contents($downloadLink);
+            echo '> Download complete.' . "\n";
+
+            file_put_contents('Data/Temporary/prunner.tar.gz', $downloadedFileContents);
+            unlink('Data/Temporary/prunner.tar');
+
+            // decompress from gz
+            $p = new PharData('Data/Temporary/prunner.tar.gz');
+            $p->decompress();
+            $phar = new PharData('Data/Temporary/prunner.tar');
+
+            if (!is_dir(dirname($platformSpecificTargetDirectory))) {
+                mkdir(dirname($platformSpecificTargetDirectory));
+            }
+
+            $phar->extractTo($platformSpecificTargetDirectory);
+            file_put_contents($platformSpecificTargetDirectory . '/version', $version);
+
+            echo '> Prunner extracted to ' . $platformSpecificTargetDirectory . "\n";
+        }
+
+        file_put_contents($baseDirectory . '/prunner', self::PRUNNER_DISPATCH_SCRIPT);
+        chmod($baseDirectory . '/prunner', 0755);
+    }
+}

README.md

@@ -19,6 +19,22 @@ A minimalistic React UI to start and view pipelines, jobs and task details.
 
 A Neos/Flow PHP package providing a backend module for the current pipeline state, and a PHP API.
 
+## Installation
+
+```bash
+# add the package
+composer require flowpack/prunner
+
+# patch main composer.json to add Flowpack\Prunner\Composer\InstallerScripts::postUpdateAndInstall to post-install-cmd and post-update-cmd 
+./flow prunner:setupProject
+
+# run composer install again, to download prunner.
+composer install
+
+# prunner is now installed in your project root, as "prunner/prunner"
+```
+
+Now, start up prunner 
 
 ## License