Create deploy command

Author: sbourouis

config/nightwatch.php

@@ -5,6 +5,7 @@
     'token' => env('NIGHTWATCH_TOKEN'),
     'deployment' => env('NIGHTWATCH_DEPLOY'),
     'server' => env('NIGHTWATCH_SERVER', (string) gethostname()),
+    'base_url' => env('NIGHTWATCH_BASE_URL', 'https://nightwatch.laravel.com'),
     'capture_exception_source_code' => env('NIGHTWATCH_CAPTURE_EXCEPTION_SOURCE_CODE', true),
     'redact_headers' => explode(',', env('NIGHTWATCH_REDACT_HEADERS', 'Authorization,Cookie,Proxy-Authorization,X-XSRF-TOKEN')),
 

src/Console/DeployCommand.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace Laravel\Nightwatch\Console;
+
+use Exception;
+use Illuminate\Console\Command;
+use Illuminate\Http\Client\Factory as HttpFactory;
+use SensitiveParameter;
+use Symfony\Component\Console\Attribute\AsCommand;
+
+use function config;
+use function now;
+
+/**
+ * @internal
+ */
+#[AsCommand(name: 'nightwatch:deploy', description: 'Notice the Nightwatch agent that a new deployment has been made.')]
+final class DeployCommand extends Command
+{
+    /**
+     * @var string
+     */
+    protected $signature = 'nightwatch:deploy';
+
+    protected $hidden = true;
+
+    /**
+     * @var string
+     */
+    protected $description = 'Notice the Nightwatch agent that a new deployment has been made.';
+
+    public function __construct(
+        private HttpFactory $http,
+        private ?string $baseUrl,
+        #[SensitiveParameter] private ?string $token,
+    ) {
+        parent::__construct();
+    }
+
+    public function handle(): void
+    {
+        $tag = config('nightwatch.deployment') ?? '';
+
+        if (! $this->baseUrl) {
+            $this->error('No Nightwatch base URL configured.');
+
+            return;
+        }
+
+        if (! $this->token) {
+            $this->error('No Nightwatch token configured.');
+
+            return;
+        }
+
+        try {
+            $response = $this->http
+                ->withHeaders([
+                    'Authorization' => "Bearer {$this->token}",
+                    'Accept' => 'application/json',
+                    'Content-Type' => 'application/json',
+                ])
+                ->post("{$this->baseUrl}/api/deployments", [
+                    'timestamp' => now()->timestamp,
+                    'version' => $tag,
+                ]);
+
+            if ($response->successful()) {
+                $this->info('Deployment successful');
+            } else {
+                $this->error("Deployment failed: {$response->status()} {$response->body()}");
+            }
+        } catch (Exception $e) {
+            $this->error("Deployment failed: {$e->getMessage()}");
+        }
+    }
+}

src/NightwatchServiceProvider.php

@@ -40,6 +40,7 @@
 use Illuminate\Support\Facades\Context;
 use Illuminate\Support\ServiceProvider;
 use Laravel\Nightwatch\Console\AgentCommand;
+use Laravel\Nightwatch\Console\DeployCommand;
 use Laravel\Nightwatch\Facades\Nightwatch;
 use Laravel\Nightwatch\Factories\Logger;
 use Laravel\Nightwatch\Hooks\ArtisanStartingListener;
@@ -192,6 +193,7 @@ private function registerBindings(): void
         $this->registerLogger();
         $this->registerMiddleware();
         $this->registerAgentCommand();
+        $this->registerDeployCommand();
         $this->buildAndRegisterCore();
     }
 
@@ -226,6 +228,15 @@ 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,
+            baseUrl: $this->nightwatchConfig['base_url'] ?? null,
+        ));
+    }
+
     private function buildAndRegisterCore(): void
     {
         $clock = new Clock;
@@ -295,6 +306,7 @@ private function registerCommands(): void
         $this->commands([
             Console\AgentCommand::class,
             Console\StatusCommand::class,
+            Console\DeployCommand::class,
         ]);
     }
 

tests/Feature/Console/DeployCommandTest.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Tests\Feature\Console;
+
+use Illuminate\Process\Exceptions\ProcessTimedOutException;
+use Illuminate\Support\Facades\Process;
+use RuntimeException;
+use Tests\TestCase;
+
+use function sleep;
+
+class DeployCommandTest extends TestCase
+{
+    public function test_it_can_run_the_agent_command(): void
+    {
+        $output = '';
+        $process = Process::timeout(10)->start('NIGHTWATCH_TOKEN="test-token" \
+          NIGHTWATCH_BASE_URL="http://localhost" \
+          NIGHTWATCH_DEPLOY="v1.2.3" \
+          vendor/bin/testbench nightwatch:deploy'
+        );
+
+        try {
+            $result = $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('Deployment successful', $output);
+    }
+}