Merge pull request #238 from open-runtimes/fix-silent-build-command-failure

Report silent build command failures

Author: ChiragAgg5k

app/config/errors.php

@@ -24,6 +24,14 @@
         'message' => 'You are not authorized to access this resource.',
         'code' => 401,
     ],
+    /* Build */
+    Exception::BUILD_FAILED  => [
+        'name' => Exception::BUILD_FAILED,
+        'short' => 'Build failed',
+        'message' => 'Build failed.',
+        'code' => 400,
+        'publish' => false,
+    ],
     /* Runtime */
     Exception::RUNTIME_FAILED  => [
         'name' => Exception::RUNTIME_FAILED,

src/Executor/Exception.php

@@ -24,6 +24,8 @@ class Exception extends \RuntimeException
 
     public const string EXECUTION_BAD_JSON    = 'execution_bad_json';
 
+    public const string BUILD_FAILED       = 'build_failed';
+
     public const string RUNTIME_NOT_FOUND    = 'runtime_not_found';
 
     public const string RUNTIME_CONFLICT     = 'runtime_conflict';

src/Executor/Runner/Docker.php

@@ -376,8 +376,9 @@ public function createRuntime(
              * Execute any commands if they were provided
              */
             if ($command !== '' && $command !== '0') {
+                $stdout = '';
+
                 try {
-                    $stdout = '';
                     $status = $this->orchestration->execute(
                         name: $runtimeName,
                         command: $this->getBuildCommands($command, $version),
@@ -386,7 +387,12 @@ public function createRuntime(
                     );
 
                     if (!$status) {
-                        throw new ExecutorException(ExecutorException::RUNTIME_FAILED, 'Failed to create runtime: ' . $stdout);
+                        $message = \trim(\mb_strcut($stdout, 0, MAX_BUILD_LOG_SIZE));
+
+                        throw new ExecutorException(
+                            ExecutorException::BUILD_FAILED,
+                            $message === '' ? 'Build command failed.' : $message
+                        );
                     }
 
                     if ($version === 'v2') {
@@ -398,6 +404,16 @@ public function createRuntime(
                     } elseif (!$cacheEnabled) {
                         $output = Logs::get($runtimeName);
                     }
+                } catch (ExecutorException $err) {
+                    throw $err;
+                } catch (OrchestrationException $err) {
+                    $message = \trim(\mb_strcut($stdout, 0, MAX_BUILD_LOG_SIZE));
+
+                    throw new ExecutorException(
+                        ExecutorException::BUILD_FAILED,
+                        $message === '' ? 'Build command failed.' : $message,
+                        previous: $err
+                    );
                 } catch (Throwable $err) {
                     throw new ExecutorException(ExecutorException::RUNTIME_FAILED, $err->getMessage(), null, $err);
                 }
@@ -506,6 +522,10 @@ public function createRuntime(
             $localDevice->deletePath($tmpFolder);
             $this->runtimes->remove($runtimeName);
 
+            if ($throwable instanceof ExecutorException) {
+                throw $throwable;
+            }
+
             $message = '';
             foreach ($output as $chunk) {
                 $message .= $chunk['content'];
@@ -545,14 +565,14 @@ private function getBuildCommands(string $command, string $version): array
             return [
                 'sh',
                 '-c',
-                'touch /var/tmp/logs.txt && (' . $command . ') >> /var/tmp/logs.txt 2>&1 && cat /var/tmp/logs.txt'
+                'touch /var/tmp/logs.txt && (' . $command . ') >> /var/tmp/logs.txt 2>&1; status=$?; cat /var/tmp/logs.txt; if [ $status -ne 0 ]; then echo "Build command exited with code $status."; fi; exit $status'
             ];
         }
 
         return [
             'bash',
             '-c',
-            'mkdir -p /tmp/logging && touch /tmp/logging/timings.txt && touch /tmp/logging/logs.txt && script --log-out /tmp/logging/logs.txt --flush --log-timing /tmp/logging/timings.txt --return --quiet --command "' . \str_replace('"', '\"', $command) . '"'
+            'mkdir -p /tmp/logging && touch /tmp/logging/timings.txt && touch /tmp/logging/logs.txt && script --log-out /tmp/logging/logs.txt --flush --log-timing /tmp/logging/timings.txt --return --quiet --command "' . \str_replace('"', '\"', $command) . '"; status=$?; if [ $status -ne 0 ]; then echo "Build command exited with code $status."; fi; exit $status'
         ];
     }
 

tests/e2e/ExecutorTest.php

@@ -299,6 +299,23 @@ public function testBuild(): void
 
         $response = $this->client->call(Client::METHOD_POST, '/runtimes', [], $params);
         $this->assertEquals(400, $response['headers']['status-code']);
+        $this->assertEquals('build_failed', $response['body']['type']);
+
+        /** Silent user error in build command */
+        $params = [
+            'runtimeId' => 'test-build-fail-silent-' . $runtimeId,
+            'source' => '/storage/functions/php/code.tar.gz',
+            'destination' => '/storage/builds/test',
+            'entrypoint' => 'index.php',
+            'image' => 'openruntimes/php:v5-8.1',
+            'command' => 'exit 1',
+            'remove' => true
+        ];
+
+        $response = $this->client->call(Client::METHOD_POST, '/runtimes', [], $params);
+        $this->assertEquals(400, $response['headers']['status-code']);
+        $this->assertEquals('build_failed', $response['body']['type']);
+        $this->assertStringContainsString('Build command exited with code 1.', (string) $response['body']['message']);
 
         /** Invalid cache key */
         $params = [

tests/unit/Executor/Runner/DockerTest.php

@@ -44,6 +44,19 @@ public function testNoCacheLifecycleShellCommandsAreGenerated(): void
         $this->assertStringNotContainsString('build-cache-save.sh', $command);
     }
 
+    public function testBuildCommandsReportSilentNonZeroExit(): void
+    {
+        $docker = $this->createDocker();
+
+        foreach (['v2', 'v5'] as $version) {
+            $commands = $this->invokeGetBuildCommands($docker, 'exit 1', $version);
+            $command = \implode(' ', $commands);
+
+            $this->assertStringContainsString('Build command exited with code $status.', $command);
+            $this->assertStringContainsString('exit $status', $command);
+        }
+    }
+
     public function testInvalidBuildCacheKeyIsRejected(): void
     {
         $this->expectException(\Exception::class);