mirror of
https://github.com/tiennm99/coolify.git
synced 2026-10-14 20:17:05 +00:00
fix(deployment): detect application configuration changes consistently
Expand configuration snapshots, handle defaults from older snapshots, and refresh configuration state after Livewire setting changes.
This commit is contained in:
1 parent
5381287606
commit
99e255a572
16 files changed
+415
-11
No files matched your search
@@ -11,6 +11,7 @@ use App\Models\Server;
|
||||
use App\Models\Team;
|
||||
use App\Models\User;
|
||||
use Illuminate\Foundation\Testing\RefreshDatabase;
|
||||
use Illuminate\Support\Facades\Http;
|
||||
use Livewire\Features\SupportLockedProperties\CannotUpdateLockedPropertyException;
|
||||
use Livewire\Livewire;
|
||||
use Visus\Cuid2\Cuid2;
|
||||
@@ -117,6 +118,48 @@ test('changeSource rejects an arbitrary class as source_type', function () {
|
||||
expect($this->applicationA->source_type)->not->toBe(Server::class);
|
||||
});
|
||||
|
||||
test('changeSource dispatches configuration changed for an owned source', function () {
|
||||
Http::fake([
|
||||
'https://api.github.com/repos/*' => Http::response(['id' => 123]),
|
||||
]);
|
||||
$source = GithubApp::create([
|
||||
'name' => 'own-github-app',
|
||||
'team_id' => $this->teamA->id,
|
||||
'api_url' => 'https://api.github.com',
|
||||
'html_url' => 'https://github.com',
|
||||
'is_public' => true,
|
||||
]);
|
||||
$this->applicationA->update(['git_repository' => 'coollabsio/coolify']);
|
||||
|
||||
Livewire::test(Source::class, ['application' => $this->applicationA->fresh()])
|
||||
->call('changeSource', $source->id, GithubApp::class)
|
||||
->assertDispatched('configurationChanged');
|
||||
});
|
||||
|
||||
test('changeSource dispatches configuration changed when repository metadata lookup fails after persistence', function () {
|
||||
Http::fake([
|
||||
'https://api.github.com/repos/*' => Http::response(
|
||||
['message' => 'Unavailable'],
|
||||
503,
|
||||
['X-RateLimit-Reset' => now()->addMinute()->timestamp],
|
||||
),
|
||||
]);
|
||||
$source = GithubApp::create([
|
||||
'name' => 'own-unavailable-github-app',
|
||||
'team_id' => $this->teamA->id,
|
||||
'api_url' => 'https://api.github.com',
|
||||
'html_url' => 'https://github.com',
|
||||
'is_public' => true,
|
||||
]);
|
||||
$this->applicationA->update(['git_repository' => 'coollabsio/coolify']);
|
||||
|
||||
Livewire::test(Source::class, ['application' => $this->applicationA->fresh()])
|
||||
->call('changeSource', $source->id, GithubApp::class)
|
||||
->assertDispatched('configurationChanged');
|
||||
|
||||
expect($this->applicationA->refresh()->source_id)->toBe($source->id);
|
||||
});
|
||||
|
||||
test('privateKeyId is locked so submit() cannot persist a client-supplied foreign id', function () {
|
||||
// Without #[Locked], an attacker could POST {"updates": {"privateKeyId": <foreign_id>},
|
||||
// "calls": [{"method": "submit"}]} and have syncData(true) write the foreign id through
|
||||
|
||||
@@ -16,6 +16,8 @@ uses(RefreshDatabase::class);
|
||||
function createApplicationForAdvancedStopGracePeriodTest(): Application
|
||||
{
|
||||
$team = Team::factory()->create();
|
||||
$team->members()->attach(auth()->id(), ['role' => 'owner']);
|
||||
session(['currentTeam' => $team]);
|
||||
$server = Server::factory()->create(['team_id' => $team->id]);
|
||||
$project = Project::factory()->create(['team_id' => $team->id]);
|
||||
$environment = Environment::factory()->create(['project_id' => $project->id]);
|
||||
@@ -43,7 +45,8 @@ it('saves a valid stop grace period', function () {
|
||||
->set('stopGracePeriod', '300')
|
||||
->call('saveStopGracePeriod')
|
||||
->assertHasNoErrors()
|
||||
->assertDispatched('success');
|
||||
->assertDispatched('success')
|
||||
->assertDispatched('configurationChanged');
|
||||
|
||||
expect($application->settings()->first()->stop_grace_period)->toBe(300);
|
||||
});
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
<?php
|
||||
|
||||
use App\Livewire\Project\Shared\EnvironmentVariable\All as EnvironmentVariableAll;
|
||||
use App\Livewire\Project\Shared\HealthChecks;
|
||||
use App\Models\Application;
|
||||
use App\Models\Environment;
|
||||
use App\Models\InstanceSettings;
|
||||
use App\Models\Project;
|
||||
use App\Models\Team;
|
||||
use App\Models\User;
|
||||
use Illuminate\Foundation\Testing\RefreshDatabase;
|
||||
use Livewire\Livewire;
|
||||
|
||||
uses(RefreshDatabase::class);
|
||||
|
||||
beforeEach(function () {
|
||||
InstanceSettings::unguarded(function () {
|
||||
InstanceSettings::updateOrCreate(['id' => 0], []);
|
||||
});
|
||||
$this->team = Team::factory()->create();
|
||||
$this->user = User::factory()->create();
|
||||
$this->team->members()->attach($this->user->id, ['role' => 'owner']);
|
||||
$this->actingAs($this->user);
|
||||
session(['currentTeam' => $this->team]);
|
||||
|
||||
$project = Project::factory()->create(['team_id' => $this->team->id]);
|
||||
$environment = Environment::factory()->create(['project_id' => $project->id]);
|
||||
$this->application = Application::factory()->create(['environment_id' => $environment->id])->refresh();
|
||||
});
|
||||
|
||||
it('refreshes configuration changes after health check saves', function (string $method) {
|
||||
Livewire::test(HealthChecks::class, ['resource' => $this->application])
|
||||
->call($method)
|
||||
->assertHasNoErrors()
|
||||
->assertDispatched('configurationChanged');
|
||||
})->with(['instantSave', 'submit', 'toggleHealthcheck']);
|
||||
|
||||
it('refreshes configuration changes after environment variable settings are saved', function () {
|
||||
Livewire::test(EnvironmentVariableAll::class, ['resource' => $this->application])
|
||||
->set('use_build_secrets', true)
|
||||
->call('instantSave')
|
||||
->assertHasNoErrors()
|
||||
->assertDispatched('configurationChanged');
|
||||
});
|
||||
@@ -0,0 +1,36 @@
|
||||
<?php
|
||||
|
||||
use App\Livewire\Project\Application\Swarm;
|
||||
use App\Models\Application;
|
||||
use App\Models\Environment;
|
||||
use App\Models\Project;
|
||||
use App\Models\Server;
|
||||
use App\Models\Team;
|
||||
use App\Models\User;
|
||||
use Illuminate\Foundation\Testing\RefreshDatabase;
|
||||
use Livewire\Livewire;
|
||||
|
||||
uses(RefreshDatabase::class);
|
||||
|
||||
it('dispatches configuration changed when Swarm settings are saved', function (string $method) {
|
||||
$team = Team::factory()->create();
|
||||
$user = User::factory()->create();
|
||||
$team->members()->attach($user->id, ['role' => 'owner']);
|
||||
$server = Server::factory()->create(['team_id' => $team->id]);
|
||||
$project = Project::factory()->create(['team_id' => $team->id]);
|
||||
$environment = Environment::factory()->create(['project_id' => $project->id]);
|
||||
$application = Application::factory()->create([
|
||||
'environment_id' => $environment->id,
|
||||
'destination_id' => $server->standaloneDockers()->firstOrFail()->id,
|
||||
'destination_type' => $server->standaloneDockers()->firstOrFail()->getMorphClass(),
|
||||
'swarm_replicas' => 1,
|
||||
]);
|
||||
|
||||
$this->actingAs($user);
|
||||
|
||||
Livewire::test(Swarm::class, ['application' => $application])
|
||||
->set('isSwarmOnlyWorkerNodes', false)
|
||||
->call($method)
|
||||
->assertHasNoErrors()
|
||||
->assertDispatched('configurationChanged');
|
||||
})->with(['instantSave', 'submit']);
|
||||
@@ -118,4 +118,24 @@ uZx9iFkCELtxrh31QJ68AAAAEXNhaWxANzZmZjY2ZDJlMmRkAQIDBA==
|
||||
->assertSee('nixpacks.toml')
|
||||
->assertDontSee('railpack.json');
|
||||
});
|
||||
|
||||
test('saving general settings refreshes configuration changes when label reset is disabled', function () {
|
||||
$application = Application::factory()->create([
|
||||
'environment_id' => $this->environment->id,
|
||||
'destination_id' => $this->destination->id,
|
||||
'destination_type' => StandaloneDocker::class,
|
||||
'build_pack' => 'nixpacks',
|
||||
'static_image' => 'nginx:alpine',
|
||||
'base_directory' => '/',
|
||||
'is_http_basic_auth_enabled' => false,
|
||||
'redirect' => 'no',
|
||||
]);
|
||||
$application->settings->update(['is_container_label_readonly_enabled' => false]);
|
||||
|
||||
Livewire::test(General::class, ['application' => $application->refresh()])
|
||||
->set('isPreserveRepositoryEnabled', true)
|
||||
->call('instantSave')
|
||||
->assertHasNoErrors()
|
||||
->assertDispatched('configurationChanged');
|
||||
});
|
||||
});
|
||||
@@ -6,6 +6,7 @@ use App\Models\Environment;
|
||||
use App\Models\EnvironmentVariable;
|
||||
use App\Models\Project;
|
||||
use App\Models\Team;
|
||||
use App\Services\DeploymentConfiguration\ConfigurationDiffer;
|
||||
use Illuminate\Foundation\Testing\RefreshDatabase;
|
||||
use Illuminate\Support\Str;
|
||||
use Tests\TestCase;
|
||||
@@ -78,6 +79,192 @@ it('detects redeploy-only domain changes', function () {
|
||||
->and($change['new_full_value'])->toBe($domains);
|
||||
});
|
||||
|
||||
it('detects Docker image reference changes as redeploy-only changes', function (string $field, string $label, string $newValue) {
|
||||
$application = snapshotTestApplication([
|
||||
'build_pack' => 'dockerimage',
|
||||
'docker_registry_image_name' => 'ghcr.io/coollabsio/shoutrrr',
|
||||
'docker_registry_image_tag' => '1.3.0-rc.4',
|
||||
]);
|
||||
markSnapshotTestApplicationDeployed($application);
|
||||
|
||||
$application->update([$field => $newValue]);
|
||||
$diff = $application->refresh()->pendingDeploymentConfigurationDiff();
|
||||
$change = collect($diff->changes())->firstWhere('label', $label);
|
||||
|
||||
expect($diff->isChanged())->toBeTrue()
|
||||
->and($diff->requiresBuild())->toBeFalse()
|
||||
->and($change)->not->toBeNull()
|
||||
->and($change['old_display_value'])->not->toBe($change['new_display_value'])
|
||||
->and($change['new_display_value'])->toBe($newValue);
|
||||
})->with([
|
||||
'image name' => ['docker_registry_image_name', 'Docker image', 'ghcr.io/coollabsio/coolify'],
|
||||
'image tag' => ['docker_registry_image_tag', 'Docker image tag or hash', '1.3.0-rc.5'],
|
||||
]);
|
||||
|
||||
it('detects deployment hook changes as redeploy-only changes', function (string $field, string $label, string $newValue) {
|
||||
$application = snapshotTestApplication();
|
||||
markSnapshotTestApplicationDeployed($application);
|
||||
|
||||
$application->update([$field => $newValue]);
|
||||
$diff = $application->refresh()->pendingDeploymentConfigurationDiff();
|
||||
|
||||
expect($diff->requiresBuild())->toBeFalse()
|
||||
->and(collect($diff->changes())->pluck('label'))->toContain($label);
|
||||
})->with([
|
||||
'pre-deployment command' => ['pre_deployment_command', 'Pre-deployment command', 'php artisan migrate --force'],
|
||||
'pre-deployment container' => ['pre_deployment_command_container', 'Pre-deployment command container', 'web'],
|
||||
'post-deployment command' => ['post_deployment_command', 'Post-deployment command', 'php artisan cache:clear'],
|
||||
'post-deployment container' => ['post_deployment_command_container', 'Post-deployment command container', 'worker'],
|
||||
]);
|
||||
|
||||
it('detects source integration changes as build changes', function (string $field, string $label, mixed $newValue) {
|
||||
$application = snapshotTestApplication([
|
||||
'source_id' => 1,
|
||||
'source_type' => 'App\\Models\\GithubApp',
|
||||
]);
|
||||
markSnapshotTestApplicationDeployed($application);
|
||||
|
||||
$application->forceFill([$field => $newValue])->save();
|
||||
$diff = $application->refresh()->pendingDeploymentConfigurationDiff();
|
||||
|
||||
expect($diff->requiresBuild())->toBeTrue()
|
||||
->and(collect($diff->changes())->pluck('label'))->toContain($label);
|
||||
})->with([
|
||||
'source ID' => ['source_id', 'Source ID', 2],
|
||||
'source type' => ['source_type', 'Source type', 'App\\Models\\GitlabApp'],
|
||||
]);
|
||||
|
||||
it('detects build-affecting application settings', function (string $field, string $label) {
|
||||
$application = snapshotTestApplication();
|
||||
$application->settings->update([$field => false]);
|
||||
markSnapshotTestApplicationDeployed($application);
|
||||
|
||||
$application->settings->update([$field => true]);
|
||||
$diff = $application->refresh()->pendingDeploymentConfigurationDiff();
|
||||
|
||||
expect($diff->requiresBuild())->toBeTrue()
|
||||
->and(collect($diff->changes())->pluck('label'))->toContain($label);
|
||||
})->with([
|
||||
'static site' => ['is_static', 'Static site'],
|
||||
'single-page application' => ['is_spa', 'Single-page application'],
|
||||
'Git submodules' => ['is_git_submodules_enabled', 'Git submodules'],
|
||||
'Git LFS' => ['is_git_lfs_enabled', 'Git LFS'],
|
||||
'shallow clone' => ['is_git_shallow_clone_enabled', 'Shallow clone'],
|
||||
'environment variable sorting' => ['is_env_sorting_enabled', 'Sort environment variables'],
|
||||
]);
|
||||
|
||||
it('detects runtime-affecting application settings as redeploy-only changes', function (string $field, string $label, mixed $newValue) {
|
||||
$application = snapshotTestApplication();
|
||||
$application->settings->update([$field => is_bool($newValue) ? ! $newValue : null]);
|
||||
markSnapshotTestApplicationDeployed($application);
|
||||
|
||||
$application->settings->update([$field => $newValue]);
|
||||
$diff = $application->refresh()->pendingDeploymentConfigurationDiff();
|
||||
|
||||
expect($diff->requiresBuild())->toBeFalse()
|
||||
->and(collect($diff->changes())->pluck('label'))->toContain($label);
|
||||
})->with([
|
||||
'consistent container name' => ['is_consistent_container_name_enabled', 'Consistent container name', true],
|
||||
'container label escaping' => ['is_container_label_escape_enabled', 'Escape container labels', false],
|
||||
'container labels read-only' => ['is_container_label_readonly_enabled', 'Read-only container labels', false],
|
||||
'log drain' => ['is_log_drain_enabled', 'Log drain', true],
|
||||
'Swarm worker nodes' => ['is_swarm_only_worker_nodes', 'Swarm worker nodes only', true],
|
||||
'stop grace period' => ['stop_grace_period', 'Stop grace period', 45],
|
||||
'preserve repository' => ['is_preserve_repository_enabled', 'Preserve repository', true],
|
||||
]);
|
||||
|
||||
it('classifies runtime options as redeploy-only and custom nginx configuration as build-affecting', function () {
|
||||
$application = snapshotTestApplication();
|
||||
markSnapshotTestApplicationDeployed($application);
|
||||
|
||||
$application->update(['custom_docker_run_options' => '--init']);
|
||||
|
||||
expect($application->refresh()->pendingDeploymentConfigurationDiff()->requiresBuild())->toBeFalse();
|
||||
|
||||
markSnapshotTestApplicationDeployed($application->refresh());
|
||||
$application->update(['custom_nginx_configuration' => 'server { listen 80; }']);
|
||||
|
||||
expect($application->refresh()->pendingDeploymentConfigurationDiff()->requiresBuild())->toBeTrue();
|
||||
});
|
||||
|
||||
it('keeps Docker run options compatible with older build-section snapshots', function () {
|
||||
$application = snapshotTestApplication(['custom_docker_run_options' => '--init'])->refresh();
|
||||
$previousSnapshot = $application->deploymentConfigurationSnapshot();
|
||||
$buildItems = collect(data_get($previousSnapshot, 'sections.build.items'));
|
||||
|
||||
expect($buildItems->pluck('key'))->toContain('custom_docker_run_options');
|
||||
|
||||
data_set(
|
||||
$previousSnapshot,
|
||||
'sections.build.items',
|
||||
$buildItems->map(function (array $item): array {
|
||||
if ($item['key'] === 'custom_docker_run_options') {
|
||||
$item['impact'] = 'build';
|
||||
}
|
||||
|
||||
return $item;
|
||||
})->all(),
|
||||
);
|
||||
|
||||
expect(app(ConfigurationDiffer::class)->diff($previousSnapshot, $application->deploymentConfigurationSnapshot())->isChanged())->toBeFalse();
|
||||
|
||||
$application->update(['custom_docker_run_options' => '--rm']);
|
||||
|
||||
expect(app(ConfigurationDiffer::class)->diff($previousSnapshot, $application->refresh()->deploymentConfigurationSnapshot())->requiresBuild())->toBeFalse();
|
||||
});
|
||||
|
||||
it('does not report newly tracked settings when an older snapshot omitted their default values', function () {
|
||||
$application = snapshotTestApplication();
|
||||
$application->settings->update(['stop_grace_period' => DEFAULT_STOP_GRACE_PERIOD_SECONDS]);
|
||||
$currentSnapshot = $application->deploymentConfigurationSnapshot();
|
||||
$introducedKeys = [
|
||||
'is_static',
|
||||
'is_spa',
|
||||
'is_git_submodules_enabled',
|
||||
'is_git_lfs_enabled',
|
||||
'is_git_shallow_clone_enabled',
|
||||
'is_env_sorting_enabled',
|
||||
'is_consistent_container_name_enabled',
|
||||
'is_container_label_escape_enabled',
|
||||
'is_container_label_readonly_enabled',
|
||||
'is_log_drain_enabled',
|
||||
'is_swarm_only_worker_nodes',
|
||||
'is_preserve_repository_enabled',
|
||||
'stop_grace_period',
|
||||
];
|
||||
$previousSnapshot = $currentSnapshot;
|
||||
|
||||
foreach (['build', 'runtime'] as $section) {
|
||||
data_set(
|
||||
$previousSnapshot,
|
||||
"sections.{$section}.items",
|
||||
collect(data_get($previousSnapshot, "sections.{$section}.items"))
|
||||
->reject(fn (array $item): bool => in_array($item['key'], $introducedKeys, true))
|
||||
->values()
|
||||
->all(),
|
||||
);
|
||||
}
|
||||
|
||||
expect(app(ConfigurationDiffer::class)->diff($previousSnapshot, $currentSnapshot)->isChanged())->toBeFalse();
|
||||
});
|
||||
|
||||
it('accepts the historical environment sorting default in older snapshots', function () {
|
||||
$application = snapshotTestApplication();
|
||||
$application->settings->update(['is_env_sorting_enabled' => true]);
|
||||
$currentSnapshot = $application->deploymentConfigurationSnapshot();
|
||||
$previousSnapshot = $currentSnapshot;
|
||||
data_set(
|
||||
$previousSnapshot,
|
||||
'sections.build.items',
|
||||
collect(data_get($previousSnapshot, 'sections.build.items'))
|
||||
->reject(fn (array $item): bool => $item['key'] === 'is_env_sorting_enabled')
|
||||
->values()
|
||||
->all(),
|
||||
);
|
||||
|
||||
expect(app(ConfigurationDiffer::class)->diff($previousSnapshot, $currentSnapshot)->isChanged())->toBeFalse();
|
||||
});
|
||||
|
||||
it('detects environment variable value changes without exposing secret values', function () {
|
||||
$application = snapshotTestApplication();
|
||||
EnvironmentVariable::create([
|
||||
|
||||
Reference in new issue
Block a user