Merge pull request #81 from ByteInternet/reuse-brancher

Author: AlexanderGrooff

ci/test/run-brancher.sh

@@ -52,9 +52,15 @@ $DP test -f deployment-report.json
 $DP jq . deployment-report.json
 $DP jq .version deployment-report.json -r -e
 $DP jq .stage deployment-report.json -r -e
-$DP jq .hostnames[0] deployment-report.json -r -e
+BRANCHER_INSTANCE=$($DP jq .hostnames[0] deployment-report.json -r -e)
 $DP jq .brancher_hypernodes[0] deployment-report.json -r -e
 
+# Run another test by reusing the last instance
+$DP hypernode-deploy deploy test -f /web/deploy.php -vvv --reuse-brancher
+
+# Hostname of the reused Brancher instance should be the same as the previous one
+$DP jq .hostnames[0] deployment-report.json -r -e | grep -F "${BRANCHER_INSTANCE}"
+
 # cleanup data
 $DP hypernode-deploy cleanup -vvv
 

src/Brancher/BrancherHypernodeManager.php

@@ -56,6 +56,25 @@ public function queryBrancherHypernodes(string $hypernode, array $labels = []):
         return $result;
     }
 
+    /**
+     * Query brancher instances for the given Hypernode and label and return the
+     * most recent Brancher instance name.
+     *
+     * @param string $hypernode The parent hypernode to query the Brancher instances from
+     * @param string[] $labels Labels to match against, may be empty
+     * @return string|null The found Brancher instance name, or null if none was found
+     */
+    public function reuseExistingBrancherHypernode(string $hypernode, array $labels = []): ?string
+    {
+        $brancherHypernodes = $this->queryBrancherHypernodes($hypernode, $labels);
+        if (count($brancherHypernodes) > 0) {
+            // Return the last brancher Hypernode, which is the most recently created one
+            return $brancherHypernodes[count($brancherHypernodes) - 1];
+        }
+
+        return null;
+    }
+
     /**
      * Create brancher Hypernode instance for given Hypernode.
      *

src/Command/Build.php

@@ -33,6 +33,6 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        return $this->deployRunner->run($output, 'build', DeployRunner::TASK_BUILD, true, false);
+        return $this->deployRunner->run($output, 'build', DeployRunner::TASK_BUILD, true, false, false);
     }
 }

src/Command/ComposerAuth.php

@@ -34,6 +34,6 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        return $this->deployRunner->run($output, 'build', 'deploy:vendors:auth', false, false);
+        return $this->deployRunner->run($output, 'build', 'deploy:vendors:auth', false, false, false);
     }
 }

src/Command/Deploy.php

@@ -7,6 +7,7 @@
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Throwable;
 
@@ -28,6 +29,12 @@ protected function configure()
         $this->setName('deploy');
         $this->setDescription('Deploy application.');
         $this->addArgument('stage', InputArgument::REQUIRED, 'Stage deploy to');
+        $this->addOption(
+            'reuse-brancher',
+            null,
+            InputOption::VALUE_NONE,
+            'Reuse the brancher Hypernode from the previous deploy. Only works when using addBrancherServer in your deploy configuration.'
+        );
     }
 
     /**
@@ -40,7 +47,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $input->getArgument('stage'),
             DeployRunner::TASK_DEPLOY,
             false,
-            true
+            true,
+            $input->getOption('reuse-brancher')
         );
 
         if ($result === 0) {

src/Command/RunTask.php

@@ -50,6 +50,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $input->getArgument(self::ARGUMENT_TASK),
             $input->getOption(self::OPTION_CONFIGURE_BUILD_STAGE),
             $input->getOption(self::OPTION_CONFIGURE_SERVERS),
+            false
         );
     }
 }

src/DeployRunner.php

@@ -72,12 +72,12 @@ public function __construct(
      * @throws Throwable
      * @throws Exception
      */
-    public function run(OutputInterface $output, string $stage, string $task, bool $configureBuildStage, bool $configureServers): int
+    public function run(OutputInterface $output, string $stage, string $task, bool $configureBuildStage, bool $configureServers, bool $reuseBrancher): int
     {
         $deployer = $this->deployerLoader->getOrCreateInstance($output);
 
         try {
-            $this->prepare($configureBuildStage, $configureServers, $stage);
+            $this->prepare($configureBuildStage, $configureServers, $stage, $reuseBrancher);
         } catch (InvalidConfigurationException | ValidationException $e) {
             $output->write($e->getMessage());
             return 1;
@@ -94,7 +94,7 @@ public function run(OutputInterface $output, string $stage, string $task, bool $
      * @throws InvalidConfigurationException
      * @throws Throwable
      */
-    private function prepare(bool $configureBuildStage, bool $configureServers, string $stage): void
+    private function prepare(bool $configureBuildStage, bool $configureServers, string $stage, bool $reuseBrancher): void
     {
         $this->recipeLoader->load('common.php');
         $tasks = $this->taskFactory->loadAll();
@@ -108,7 +108,7 @@ private function prepare(bool $configureBuildStage, bool $configureServers, stri
         }
 
         if ($configureServers) {
-            $this->configureServers($config, $stage);
+            $this->configureServers($config, $stage, $reuseBrancher);
         }
 
         foreach ($tasks as $task) {
@@ -150,22 +150,22 @@ private function initializeConfigurableTask(ConfigurableTaskInterface $task, Con
         }
     }
 
-    private function configureServers(Configuration $config, string $stage): void
+    private function configureServers(Configuration $config, string $stage, bool $reuseBrancher): void
     {
         foreach ($config->getStages() as $configStage) {
             if ($configStage->getName() !== $stage) {
                 continue;
             }
 
             foreach ($configStage->getServers() as $server) {
-                $this->configureStageServer($configStage, $server, $config);
+                $this->configureStageServer($configStage, $server, $config, $reuseBrancher);
             }
         }
     }
 
-    private function configureStageServer(Stage $stage, Server $server, Configuration $config): void
+    private function configureStageServer(Stage $stage, Server $server, Configuration $config, bool $reuseBrancher): void
     {
-        $this->maybeConfigureBrancherServer($server);
+        $this->maybeConfigureBrancherServer($server, $reuseBrancher);
 
         $host = host($stage->getName() . ':' . $server->getHostname());
         $host->setHostname($server->getHostname());
@@ -218,7 +218,7 @@ private function configureStageServer(Stage $stage, Server $server, Configuratio
         }
     }
 
-    private function maybeConfigureBrancherServer(Server $server): void
+    private function maybeConfigureBrancherServer(Server $server, bool $reuseBrancher): void
     {
         $serverOptions = $server->getOptions();
         $isBrancher = $serverOptions[Server::OPTION_HN_BRANCHER] ?? false;
@@ -241,19 +241,23 @@ private function maybeConfigureBrancherServer(Server $server): void
 
             $data = $settings;
             $data['labels'] = $labels;
-            $brancherApp = $this->brancherHypernodeManager->createForHypernode($parentApp, $data);
-
-            $this->log->info(sprintf('Successfully requested brancher Hypernode, name is %s.', $brancherApp));
-            $server->setHostname(sprintf("%s.hypernode.io", $brancherApp));
-            $this->brancherHypernodesRegistered[] = $brancherApp;
-
-            try {
-                $this->log->info('Waiting for brancher Hypernode to become available...');
-                $this->brancherHypernodeManager->waitForAvailability($brancherApp);
-                $this->log->info('Brancher Hypernode has become available!');
-            } catch (CreateBrancherHypernodeFailedException | TimeoutException $e) {
-                $this->brancherHypernodeManager->cancel($brancherApp);
-                throw $e;
+            if ($reuseBrancher && $brancherApp = $this->brancherHypernodeManager->reuseExistingBrancherHypernode($parentApp, $labels)) {
+                $this->log->info(sprintf('Found existing brancher Hypernode, name is %s.', $brancherApp));
+                $server->setHostname(sprintf("%s.hypernode.io", $brancherApp));
+            } else {
+                $brancherApp = $this->brancherHypernodeManager->createForHypernode($parentApp, $data);
+                $this->log->info(sprintf('Successfully requested brancher Hypernode, name is %s.', $brancherApp));
+                $server->setHostname(sprintf("%s.hypernode.io", $brancherApp));
+                $this->brancherHypernodesRegistered[] = $brancherApp;
+
+                try {
+                    $this->log->info('Waiting for brancher Hypernode to become available...');
+                    $this->brancherHypernodeManager->waitForAvailability($brancherApp);
+                    $this->log->info('Brancher Hypernode has become available!');
+                } catch (CreateBrancherHypernodeFailedException | TimeoutException $e) {
+                    $this->brancherHypernodeManager->cancel($brancherApp);
+                    throw $e;
+                }
             }
         }
     }