Improve deploy command and add tests

Author: sbourouis

src/Console/DeployCommand.php

@@ -2,14 +2,16 @@
 
 namespace Laravel\Nightwatch\Console;
 
-use Exception;
+use Carbon\CarbonImmutable;
 use Illuminate\Console\Command;
-use Illuminate\Http\Client\Factory as HttpFactory;
+use Illuminate\Support\Facades\Http;
 use SensitiveParameter;
 use Symfony\Component\Console\Attribute\AsCommand;
+use Throwable;
 
 use function config;
-use function now;
+use function strlen;
+use function substr;
 
 /**
  * @internal
@@ -22,51 +24,65 @@ final class DeployCommand extends Command
      */
     protected $signature = 'nightwatch:deploy';
 
-    protected $hidden = true;
-
     /**
      * @var string
      */
     protected $description = 'Notify Nightwatch of a deployment.';
 
+    /**
+     * @var bool
+     */
+    protected $hidden = true;
+
     public function __construct(
-        private HttpFactory $http,
         #[SensitiveParameter] private ?string $token,
     ) {
         parent::__construct();
     }
 
-    public function handle(): void
+    public function handle(): int
     {
-        $tag = config('nightwatch.deployment') ?? '';
-
-        $baseUrl = $_SERVER['NIGHTWATCH_BASE_URL'] ?? 'https://nightwatch.laravel.com';
-
         if (! $this->token) {
-            $this->error('No Nightwatch token configured.');
+            $this->error('No NIGHTWATCH_TOKEN environment variable configured.');
 
-            return;
+            return 1;
         }
 
+        $tag = config('nightwatch.deployment') ?? '';
+
+        $baseUrl = $_SERVER['NIGHTWATCH_BASE_URL'] ?? 'https://nightwatch.laravel.com';
+
         try {
-            $response = $this->http
+            $response = Http::connectTimeout(5)
+                ->timeout(10)
                 ->withHeaders([
                     'Authorization' => "Bearer {$this->token}",
                     'Accept' => 'application/json',
-                    'Content-Type' => 'application/json',
                 ])
                 ->post("{$baseUrl}/api/deployments", [
-                    'timestamp' => now()->timestamp,
+                    'timestamp' => CarbonImmutable::now()->timestamp,
                     'version' => $tag,
                 ]);
 
             if ($response->successful()) {
                 $this->info('Deployment successful');
+
+                return 0;
             } else {
-                $this->error("Deployment failed: {$response->status()} {$response->body()}");
+                $message = $response->body();
+
+                if (strlen($message) > 1005) {
+                    $message = substr($message, 0, 1000).'[...]';
+                }
+
+                $this->error("Deployment failed: {$response->status()} [{$message}]");
+
+                return 1;
             }
-        } catch (Exception $e) {
-            $this->error("Deployment failed: {$e->getMessage()}");
+        } catch (Throwable $e) {
+            $this->error("Deployment failed: [{$e->getMessage()}]");
+
+            return 1;
         }
     }
 }

src/NightwatchServiceProvider.php

@@ -231,7 +231,6 @@ private function registerAgentCommand(): void
     private function registerDeployCommand(): void
     {
         $this->app->singleton(DeployCommand::class, fn () => new DeployCommand(
-            http: $this->app->make(\Illuminate\Http\Client\Factory::class),
             token: $this->nightwatchConfig['token'] ?? null,
         ));
     }

tests/Feature/Console/DeployCommandTest.php

@@ -3,6 +3,7 @@
 namespace Tests\Feature\Console;
 
 use Illuminate\Process\Exceptions\ProcessTimedOutException;
+use Illuminate\Support\Facades\Http;
 use Illuminate\Support\Facades\Process;
 use RuntimeException;
 use Tests\TestCase;
@@ -11,11 +12,10 @@
 
 class DeployCommandTest extends TestCase
 {
-    public function test_it_can_run_the_agent_command(): void
+    public function test_it_can_run_the_deploy_command(): void
     {
         $output = '';
-        $process = Process::timeout(10)->start('NIGHTWATCH_TOKEN="test-token" \
-          NIGHTWATCH_DEPLOY="v1.2.3" \
+        $process = Process::timeout(10)->start('NIGHTWATCH_DEPLOY="v1.2.3" \
           vendor/bin/testbench nightwatch:deploy'
         );
 
@@ -44,4 +44,58 @@ public function test_it_can_run_the_agent_command(): void
 
         $this->assertStringContainsString('Deployment successful', $output);
     }
+
+    public function test_it_fails_when_the_deploy_command_is_run_without_a_token(): void
+    {
+        $process = Process::timeout(10)->start('NIGHTWATCH_DEPLOY="v1.2.3" \
+          NIGHTWATCH_TOKEN="" \
+          vendor/bin/testbench nightwatch:deploy');
+
+        try {
+            $process->wait(function ($type, $o) use (&$output, $process) {
+                $output .= $o;
+
+                $process->signal(SIGTERM);
+
+                $tries = 0;
+
+                while ($tries < 3) {
+                    if (! $process->running()) {
+                        return;
+                    }
+
+                    $tries++;
+                    sleep(1);
+                }
+
+                $process->signal(SIGKILL);
+            });
+        } catch (ProcessTimedOutException $e) {
+            throw new RuntimeException('Failed to deploy or stop the agent running. Output:'.PHP_EOL.$output, previous: $e);
+        }
+
+        $this->assertStringContainsString('No NIGHTWATCH_TOKEN environment variable configured.', $process->output());
+    }
+
+    public function test_it_handles_http_errors(): void
+    {
+        Http::fake([
+            $_SERVER['NIGHTWATCH_BASE_URL'].'/api/deployments' => Http::response('Whoops!', 500),
+        ]);
+
+        $this->artisan('nightwatch:deploy')
+            ->expectsOutput('Deployment failed: 500 [Whoops!]')
+            ->assertExitCode(1);
+    }
+
+    public function test_it_handles_throwable_errors(): void
+    {
+        Http::fake([
+            $_SERVER['NIGHTWATCH_BASE_URL'].'/api/deployments' => Http::failedConnection('Whoops!'),
+        ]);
+
+        $this->artisan('nightwatch:deploy')
+            ->expectsOutput('Deployment failed: [Whoops!]')
+            ->assertExitCode(1);
+    }
 }