feat(api): add application settings to application endpoints

2026-10-15 12:14:07 +00:00 · 2026-07-14 13:44:45 +02:00
1 parent 99e255a572
commit 34e6a6dd5d
@@ -0,0 +1,257 @@
+<?php
+
+use App\Models\Application;
+use App\Models\Environment;
+use App\Models\GithubApp;
+use App\Models\InstanceSettings;
+use App\Models\PrivateKey;
+use App\Models\Project;
+use App\Models\Server;
+use App\Models\StandaloneDocker;
+use App\Models\Team;
+use App\Models\User;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\Http;
+use Illuminate\Support\Facades\Storage;
+
+uses(RefreshDatabase::class);
+
+beforeEach(function () {
+    Storage::fake('ssh-keys');
+    InstanceSettings::unguarded(fn () => InstanceSettings::firstOrCreate(['id' => 0]));
+
+    $this->team = Team::factory()->create();
+    $this->user = User::factory()->create();
+    $this->team->members()->attach($this->user->id, ['role' => 'owner']);
+    session(['currentTeam' => $this->team]);
+
+    $this->bearerToken = $this->user->createToken('build-secrets-api-test', ['*'])->plainTextToken;
+    $this->server = Server::factory()->create(['team_id' => $this->team->id]);
+    $this->destination = StandaloneDocker::where('server_id', $this->server->id)->first();
+    $this->project = Project::factory()->create(['team_id' => $this->team->id]);
+    $this->environment = Environment::factory()->create(['project_id' => $this->project->id]);
+    $this->application = Application::factory()->create([
+        'environment_id' => $this->environment->id,
+        'destination_id' => $this->destination->id,
+        'destination_type' => $this->destination->getMorphClass(),
+    ]);
+});
+
+function buildSecretsApiHeaders(string $bearerToken): array
+{
+    return [
+        'Authorization' => 'Bearer '.$bearerToken,
+        'Content-Type' => 'application/json',
+    ];
+}
+
+function buildSecretsGithubPrivateKey(): string
+{
+    $key = openssl_pkey_new([
+        'private_key_bits' => 2048,
+        'private_key_type' => OPENSSL_KEYTYPE_RSA,
+    ]);
+
+    openssl_pkey_export($key, $privateKey);
+
+    return $privateKey;
+}
+
+describe('PATCH /api/v1/applications/{uuid} use_build_secrets', function () {
+    test('updates the application setting', function () {
+        expect($this->application->settings->use_build_secrets)->toBeFalse();
+
+        $this->withHeaders(buildSecretsApiHeaders($this->bearerToken))
+            ->patchJson("/api/v1/applications/{$this->application->uuid}", [
+                'use_build_secrets' => true,
+            ])
+            ->assertOk();
+
+        expect($this->application->fresh()->settings->use_build_secrets)->toBeTrue();
+
+        $this->withHeaders(buildSecretsApiHeaders($this->bearerToken))
+            ->patchJson("/api/v1/applications/{$this->application->uuid}", [
+                'use_build_secrets' => false,
+            ])
+            ->assertOk();
+
+        expect($this->application->fresh()->settings->use_build_secrets)->toBeFalse();
+    });
+
+    test('rejects non boolean values', function () {
+        $this->withHeaders(buildSecretsApiHeaders($this->bearerToken))
+            ->patchJson("/api/v1/applications/{$this->application->uuid}", [
+                'use_build_secrets' => 'not-a-boolean',
+            ])
+            ->assertUnprocessable()
+            ->assertJsonValidationErrors('use_build_secrets');
+    });
+
+    test('does not change the setting when omitted', function () {
+        $this->application->settings->update(['use_build_secrets' => true]);
+
+        $this->withHeaders(buildSecretsApiHeaders($this->bearerToken))
+            ->patchJson("/api/v1/applications/{$this->application->uuid}", [
+                'name' => 'updated-name',
+            ])
+            ->assertOk();
+
+        expect($this->application->fresh()->settings->use_build_secrets)->toBeTrue();
+    });
+});
+
+describe('POST /api/v1/applications/public use_build_secrets', function () {
+    test('creates an application with the requested build secrets setting', function (bool $useBuildSecrets) {
+        $response = $this->withHeaders(buildSecretsApiHeaders($this->bearerToken))
+            ->postJson('/api/v1/applications/public', [
+                'project_uuid' => $this->project->uuid,
+                'environment_uuid' => $this->environment->uuid,
+                'server_uuid' => $this->server->uuid,
+                'git_repository' => 'https://gitlab.com/coolify/build-secrets-test',
+                'git_branch' => 'main',
+                'build_pack' => 'nixpacks',
+                'ports_exposes' => '3000',
+                'use_build_secrets' => $useBuildSecrets,
+                'autogenerate_domain' => false,
+            ])
+            ->assertCreated();
+
+        $application = Application::where('uuid', $response->json('uuid'))->firstOrFail();
+
+        expect($application->settings->use_build_secrets)->toBe($useBuildSecrets);
+    })->with([
+        'enabled' => true,
+        'disabled' => false,
+    ]);
+
+    test('rejects non boolean values', function () {
+        $this->withHeaders(buildSecretsApiHeaders($this->bearerToken))
+            ->postJson('/api/v1/applications/public', [
+                'project_uuid' => $this->project->uuid,
+                'environment_uuid' => $this->environment->uuid,
+                'server_uuid' => $this->server->uuid,
+                'git_repository' => 'https://gitlab.com/coolify/build-secrets-test',
+                'git_branch' => 'main',
+                'build_pack' => 'nixpacks',
+                'ports_exposes' => '3000',
+                'use_build_secrets' => 'not-a-boolean',
+                'autogenerate_domain' => false,
+            ])
+            ->assertUnprocessable()
+            ->assertJsonValidationErrors('use_build_secrets');
+    });
+});
+
+describe('other application creation endpoints use_build_secrets', function () {
+    test('creates a Dockerfile application with build secrets enabled', function () {
+        $response = $this->withHeaders(buildSecretsApiHeaders($this->bearerToken))
+            ->postJson('/api/v1/applications/dockerfile', [
+                'project_uuid' => $this->project->uuid,
+                'environment_uuid' => $this->environment->uuid,
+                'server_uuid' => $this->server->uuid,
+                'dockerfile' => base64_encode("FROM nginx:alpine\nEXPOSE 80"),
+                'use_build_secrets' => true,
+                'autogenerate_domain' => false,
+            ])
+            ->assertCreated();
+
+        $application = Application::where('uuid', $response->json('uuid'))->firstOrFail();
+
+        expect($application->settings->use_build_secrets)->toBeTrue();
+    });
+
+    test('creates a Docker image application with build secrets enabled', function () {
+        $response = $this->withHeaders(buildSecretsApiHeaders($this->bearerToken))
+            ->postJson('/api/v1/applications/dockerimage', [
+                'project_uuid' => $this->project->uuid,
+                'environment_uuid' => $this->environment->uuid,
+                'server_uuid' => $this->server->uuid,
+                'docker_registry_image_name' => 'nginx',
+                'docker_registry_image_tag' => 'alpine',
+                'ports_exposes' => '80',
+                'use_build_secrets' => true,
+                'autogenerate_domain' => false,
+            ])
+            ->assertCreated();
+
+        $application = Application::where('uuid', $response->json('uuid'))->firstOrFail();
+
+        expect($application->settings->use_build_secrets)->toBeTrue();
+    });
+
+    test('creates a private deploy key application with build secrets enabled', function () {
+        $privateKey = PrivateKey::factory()->create(['team_id' => $this->team->id]);
+
+        $response = $this->withHeaders(buildSecretsApiHeaders($this->bearerToken))
+            ->postJson('/api/v1/applications/private-deploy-key', [
+                'project_uuid' => $this->project->uuid,
+                'environment_uuid' => $this->environment->uuid,
+                'server_uuid' => $this->server->uuid,
+                'private_key_uuid' => $privateKey->uuid,
+                'git_repository' => 'git@gitlab.com:coolify/build-secrets-test.git',
+                'git_branch' => 'main',
+                'build_pack' => 'nixpacks',
+                'ports_exposes' => '3000',
+                'use_build_secrets' => true,
+                'autogenerate_domain' => false,
+            ])
+            ->assertCreated();
+
+        $application = Application::where('uuid', $response->json('uuid'))->firstOrFail();
+
+        expect($application->settings->use_build_secrets)->toBeTrue();
+    });
+
+    test('creates a private GitHub App application with build secrets enabled', function () {
+        $privateKey = PrivateKey::create([
+            'name' => 'GitHub App Key',
+            'private_key' => buildSecretsGithubPrivateKey(),
+            'team_id' => $this->team->id,
+        ]);
+        $githubApp = GithubApp::create([
+            'name' => 'Build Secrets GitHub App',
+            'api_url' => 'https://api.github.com',
+            'html_url' => 'https://github.com',
+            'app_id' => 12345,
+            'installation_id' => 67890,
+            'client_id' => 'build-secrets-client-id',
+            'client_secret' => 'build-secrets-client-secret',
+            'webhook_secret' => 'build-secrets-webhook-secret',
+            'private_key_id' => $privateKey->id,
+            'team_id' => $this->team->id,
+            'is_system_wide' => false,
+            'is_public' => false,
+        ]);
+
+        Http::fake([
+            'https://api.github.com/zen' => Http::response('Keep it logically awesome.', 200, [
+                'Date' => now()->toRfc7231String(),
+            ]),
+            'https://api.github.com/app/installations/67890/access_tokens' => Http::response([
+                'token' => 'github-installation-token',
+            ], 201),
+            'https://api.github.com/repos/coolify/build-secrets-test' => Http::response([
+                'id' => 123456,
+            ]),
+        ]);
+
+        $response = $this->withHeaders(buildSecretsApiHeaders($this->bearerToken))
+            ->postJson('/api/v1/applications/private-github-app', [
+                'project_uuid' => $this->project->uuid,
+                'environment_uuid' => $this->environment->uuid,
+                'server_uuid' => $this->server->uuid,
+                'github_app_uuid' => $githubApp->uuid,
+                'git_repository' => 'coolify/build-secrets-test',
+                'git_branch' => 'main',
+                'build_pack' => 'nixpacks',
+                'ports_exposes' => '3000',
+                'use_build_secrets' => true,
+                'autogenerate_domain' => false,
+            ])
+            ->assertCreated();
+
+        $application = Application::where('uuid', $response->json('uuid'))->firstOrFail();
+
+        expect($application->settings->use_build_secrets)->toBeTrue();
+    });
+});
@@ -0,0 +1,183 @@
+<?php
+
+use App\Models\Application;
+use App\Models\Environment;
+use App\Models\InstanceSettings;
+use App\Models\Project;
+use App\Models\Server;
+use App\Models\StandaloneDocker;
+use App\Models\Team;
+use App\Models\User;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\Queue;
+
+uses(RefreshDatabase::class);
+
+beforeEach(function () {
+    InstanceSettings::unguarded(fn () => InstanceSettings::firstOrCreate(['id' => 0]));
+
+    $this->team = Team::factory()->create();
+    $this->user = User::factory()->create();
+    $this->team->members()->attach($this->user->id, ['role' => 'owner']);
+    session(['currentTeam' => $this->team]);
+
+    $this->bearerToken = $this->user->createToken('application-settings-api-test', ['*'])->plainTextToken;
+    $this->server = Server::factory()->create(['team_id' => $this->team->id]);
+    $this->destination = StandaloneDocker::where('server_id', $this->server->id)->first();
+    $this->project = Project::factory()->create(['team_id' => $this->team->id]);
+    $this->environment = Environment::factory()->create(['project_id' => $this->project->id]);
+    $this->application = Application::factory()->create([
+        'environment_id' => $this->environment->id,
+        'destination_id' => $this->destination->id,
+        'destination_type' => $this->destination->getMorphClass(),
+    ]);
+});
+
+function applicationSettingsApiHeaders(string $bearerToken): array
+{
+    return [
+        'Authorization' => 'Bearer '.$bearerToken,
+        'Content-Type' => 'application/json',
+    ];
+}
+
+function recommendedApplicationSettingsPayload(): array
+{
+    return [
+        'is_git_submodules_enabled' => false,
+        'is_git_lfs_enabled' => false,
+        'is_git_shallow_clone_enabled' => false,
+        'disable_build_cache' => true,
+        'inject_build_args_to_dockerfile' => false,
+        'include_source_commit_in_build' => true,
+        'is_env_sorting_enabled' => true,
+        'is_pr_deployments_public_enabled' => true,
+        'stop_grace_period' => 45,
+        'docker_images_to_keep' => 7,
+        'is_gzip_enabled' => false,
+        'is_stripprefix_enabled' => false,
+        'is_raw_compose_deployment_enabled' => true,
+    ];
+}
+
+test('GET /api/v1/applications/{uuid} includes settings without internal metadata', function () {
+    $this->application->settings->update(recommendedApplicationSettingsPayload());
+
+    $this->withHeaders(applicationSettingsApiHeaders($this->bearerToken))
+        ->getJson("/api/v1/applications/{$this->application->uuid}")
+        ->assertOk()
+        ->assertJsonPath('settings.disable_build_cache', true)
+        ->assertJsonPath('settings.stop_grace_period', 45)
+        ->assertJsonMissingPath('settings.id')
+        ->assertJsonMissingPath('settings.application_id')
+        ->assertJsonMissingPath('settings.created_at')
+        ->assertJsonMissingPath('settings.updated_at');
+});
+
+test('PATCH /api/v1/applications/{uuid} updates application settings', function () {
+    $this->application->update(['build_pack' => 'dockercompose']);
+
+    $this->withHeaders(applicationSettingsApiHeaders($this->bearerToken))
+        ->patchJson("/api/v1/applications/{$this->application->uuid}", recommendedApplicationSettingsPayload())
+        ->assertOk();
+
+    $settings = $this->application->fresh()->settings;
+
+    foreach (recommendedApplicationSettingsPayload() as $field => $value) {
+        expect($settings->{$field})->toBe($value);
+    }
+});
+
+test('application creation accepts application settings', function () {
+    Queue::fake();
+
+    $response = $this->withHeaders(applicationSettingsApiHeaders($this->bearerToken))
+        ->postJson('/api/v1/applications/public', array_merge([
+            'project_uuid' => $this->project->uuid,
+            'environment_uuid' => $this->environment->uuid,
+            'server_uuid' => $this->server->uuid,
+            'git_repository' => 'https://gitlab.com/coolify/application-settings-test',
+            'git_branch' => 'main',
+            'build_pack' => 'dockercompose',
+            'autogenerate_domain' => false,
+        ], recommendedApplicationSettingsPayload()))
+        ->assertCreated();
+
+    $settings = Application::where('uuid', $response->json('uuid'))->firstOrFail()->settings;
+
+    foreach (recommendedApplicationSettingsPayload() as $field => $value) {
+        expect($settings->{$field})->toBe($value);
+    }
+});
+
+test('proxy settings regenerate managed labels', function () {
+    $this->application->settings->update([
+        'is_container_label_readonly_enabled' => true,
+        'is_gzip_enabled' => true,
+        'is_stripprefix_enabled' => true,
+    ]);
+    $this->application->update(['custom_labels' => base64_encode('sentinel-label=true')]);
+
+    $this->withHeaders(applicationSettingsApiHeaders($this->bearerToken))
+        ->patchJson("/api/v1/applications/{$this->application->uuid}", [
+            'is_gzip_enabled' => false,
+            'is_stripprefix_enabled' => false,
+        ])
+        ->assertOk();
+
+    expect(base64_decode($this->application->fresh()->custom_labels))->not->toContain('sentinel-label=true');
+});
+
+test('rejects invalid boolean application settings', function () {
+    $this->withHeaders(applicationSettingsApiHeaders($this->bearerToken))
+        ->patchJson("/api/v1/applications/{$this->application->uuid}", [
+            'disable_build_cache' => 'not-a-boolean',
+        ])
+        ->assertUnprocessable()
+        ->assertJsonValidationErrors('disable_build_cache');
+});
+
+test('validates stop grace period bounds', function (int $stopGracePeriod) {
+    $this->withHeaders(applicationSettingsApiHeaders($this->bearerToken))
+        ->patchJson("/api/v1/applications/{$this->application->uuid}", [
+            'stop_grace_period' => $stopGracePeriod,
+        ])
+        ->assertUnprocessable()
+        ->assertJsonValidationErrors('stop_grace_period');
+})->with([
+    'below minimum' => 0,
+    'above maximum' => 3601,
+]);
+
+test('validates Docker image retention bounds', function (int $dockerImagesToKeep) {
+    $this->withHeaders(applicationSettingsApiHeaders($this->bearerToken))
+        ->patchJson("/api/v1/applications/{$this->application->uuid}", [
+            'docker_images_to_keep' => $dockerImagesToKeep,
+        ])
+        ->assertUnprocessable()
+        ->assertJsonValidationErrors('docker_images_to_keep');
+})->with([
+    'below minimum' => -1,
+    'above maximum' => 101,
+]);
+
+test('stop grace period can be reset to null', function () {
+    $this->application->settings->update(['stop_grace_period' => 45]);
+
+    $this->withHeaders(applicationSettingsApiHeaders($this->bearerToken))
+        ->patchJson("/api/v1/applications/{$this->application->uuid}", [
+            'stop_grace_period' => null,
+        ])
+        ->assertOk();
+
+    expect($this->application->fresh()->settings->stop_grace_period)->toBeNull();
+});
+
+test('raw compose deployment can only be enabled for Docker Compose applications', function () {
+    $this->withHeaders(applicationSettingsApiHeaders($this->bearerToken))
+        ->patchJson("/api/v1/applications/{$this->application->uuid}", [
+            'is_raw_compose_deployment_enabled' => true,
+        ])
+        ->assertUnprocessable()
+        ->assertJsonValidationErrors('is_raw_compose_deployment_enabled');
+});