Merge pull request #89 from ByteInternet/passthrough_github_workflow_commands

Author: tdgroot

ci/test/magento/deploy1.php

@@ -2,6 +2,9 @@
 
 namespace Hypernode\DeployConfiguration;
 
+use function Deployer\run;
+use function Deployer\task;
+
 /**
  * Start by setting up the configuration
  *
@@ -10,6 +13,12 @@
  */
 $configuration = new ApplicationTemplate\Magento2(['en_US', 'nl_NL']);
 
+task('debug:github:msg', static function () {
+    run('echo "::notice::This message should pass through to Github Workflow Summary!"');
+});
+
+$configuration->addDeployTask('debug:github:msg');
+
 $productionStage = $configuration->addStage('production', 'banaan1.store');
 $productionStage->addServer('hypernode', null, [], [
     'user' => 'app',

ci/test/run-general.sh

@@ -7,9 +7,9 @@ export PHP_VERSION_SHORT=$(echo "${PHP_VERSION:-8.2}" | sed 's/\.//')
 
 # Handy aliases
 HN="docker-compose exec -T hypernode"
-DP="docker-compose exec -T deploy"
-DP1="docker-compose exec --workdir=/web1 -T deploy"
-DP2="docker-compose exec --workdir=/web2 -T deploy"
+DP="docker-compose exec -e GITHUB_WORKFLOW -T deploy"
+DP1="docker-compose exec -e GITHUB_WORKFLOW --workdir=/web1 -T deploy"
+DP2="docker-compose exec -e GITHUB_WORKFLOW --workdir=/web2 -T deploy"
 
 function install_magento() {
     $HN mysql -e "DROP DATABASE IF EXISTS dummytag_preinstalled_magento"
@@ -30,6 +30,20 @@ function install_magento() {
     --timezone=America/Chicago --elasticsearch-host=localhost"
 }
 
+function begin_task() {
+    if [[ -n "${GITHUB_WORKFLOW}" ]]; then
+        echo "::group::$@"
+    else
+        echo "$@"
+    fi
+}
+
+function end_task() {
+    if [[ -n "${GITHUB_WORKFLOW}" ]]; then
+        echo "::endgroup::"
+    fi
+}
+
 # Install docker-compose if it's not installed
 if ! [ -x "$(command -v docker-compose)" ]; then
     pip install docker-compose
@@ -38,21 +52,25 @@ fi
 # Clear up env
 trap "docker-compose down -v" EXIT
 
+begin_task "Setting up Docker stack"
 docker-compose up -d
+end_task
 
+begin_task "Setting Magento 2"
 # Create working initial Magento install on the Hypernode container
-$HN composer create-project --repository=https://mage-os.hypernode.com/mirror/ magento/project-community-edition /data/web/magento2
+$HN composer create-project --repository=https://mirror.mage-os.org/ magento/project-community-edition:2.4.5-p2 /data/web/magento2
 echo "Waiting for MySQL to be available on the Hypernode container"
 $HN bash -c "until mysql -e 'select 1' ; do sleep 1; done"
 install_magento
+end_task
 
 # Copy env to the deploy container
 $HN /data/web/magento2/bin/magento app:config:dump scopes themes
 echo "Waiting for SSH to be available on the Hypernode container"
 chmod 0600 ci/test/.ssh/id_rsa
 chmod 0600 ci/test/.ssh/authorized_keys
 $DP rsync -a app@hypernode:/data/web/magento2/ /web
-$DP rsync -v -a /config/ /web
+$DP rsync -a /config/ /web
 $DP rm /web/app/etc/env.php
 
 # Create second app

src/Brancher/BrancherHypernodeManager.php

@@ -135,11 +135,14 @@ public function waitForAvailability(string $brancherHypernode, int $timeout = 15
                 } elseif ($timeElapsed < $allowedErrorWindow) {
                     // Sometimes we get an error where the logbook is not yet available, but it will be soon.
                     // We allow a small window for this to happen, and then we throw an exception.
-                    printf(
-                        'Got an expected exception during the allowed error window of HTTP code %d, waiting for %s to become available',
-                        $e->getCode(),
-                        $brancherHypernode
+                    $this->log->info(
+                        sprintf(
+                            'Got an expected exception during the allowed error window of HTTP code %d, waiting for %s to become available.',
+                            $e->getCode(),
+                            $brancherHypernode
+                        )
                     );
+                    ;
                     continue;
                 }
             }

src/DeployerLoader.php

@@ -6,6 +6,7 @@
 
 use Deployer\Deployer;
 use Hypernode\Deploy\Console\Output\OutputWatcher;
+use Hypernode\Deploy\Printer\GithubWorkflowPrinter;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Input\InputDefinition;
@@ -32,6 +33,11 @@ public function getOrCreateInstance(OutputInterface $output): Deployer
                 new InputOption('profile'),
             ])
         );
+        if (getenv('GITHUB_WORKFLOW')) {
+            $this->deployer['pop'] = function ($c) {
+                return new GithubWorkflowPrinter($c['output']);
+            };
+        }
 
         return $this->deployer;
     }

src/Printer/GithubWorkflowPrinter.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hypernode\Deploy\Printer;
+
+use Deployer\Component\ProcessRunner\Printer;
+use Deployer\Host\Host;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Process\Process;
+
+class GithubWorkflowPrinter extends Printer
+{
+    public const WORKFLOW_COMMAND_PATTERN = '/^::[a-zA-Z0-9-].*::.*$/';
+
+    private OutputInterface $output;
+
+    public function __construct(OutputInterface $output)
+    {
+        parent::__construct($output);
+        $this->output = $output;
+    }
+
+    public function contentHasWorkflowCommand(string $content): bool
+    {
+        return (bool)preg_match(self::WORKFLOW_COMMAND_PATTERN, trim($content));
+    }
+
+    public function callback(Host $host, bool $forceOutput): callable
+    {
+        return function ($type, $buffer) use ($forceOutput, $host) {
+            if (
+                $this->output->isVerbose() || $forceOutput ||
+                ($type == Process::OUT && $this->contentHasWorkflowCommand($buffer))
+            ) {
+                $this->printBuffer($type, $host, $buffer);
+            }
+        };
+    }
+
+    public function writeln(string $type, Host $host, string $line): void
+    {
+        if (empty($line)) {
+            return;
+        }
+
+        if ($type == Process::OUT && $this->contentHasWorkflowCommand($line)) {
+            $this->output->writeln($line);
+            return;
+        }
+
+        parent::writeln($type, $host, $line);
+    }
+}