An open-source, self-hostable PaaS alternative to Vercel, Heroku & Netlify that lets you easily deploy static sites, databases, full-stack applications and 360+ one-click services on your own servers.
PHP coolifydatabasesdeploymentdockerdocker-composeinertiajslaravelmariadbmysqlnextjsnodejsphppostgresredisself-hostedself-hostingserverstatic-sitesveltesvelte5
feat(api): add is_preview_deployments_enabled on applications
Julien Bouquillon89d7672253bd
diff --git a/app/Http/Controllers/Api/ApplicationsController.php b/app/Http/Controllers/Api/ApplicationsController.phpindex eb2e7fc53b..a59e71efa4 100644--- a/app/Http/Controllers/Api/ApplicationsController.php+++ b/app/Http/Controllers/Api/ApplicationsController.php@@ -168,6 +168,7 @@ class ApplicationsController extends Controller'is_spa' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application is a single-page application (SPA). Only relevant when is_static is true.'],'is_auto_deploy_enabled' => ['type' => 'boolean', 'description' => 'The flag to indicate if auto-deploy is enabled on git push. Defaults to true.'],'is_force_https_enabled' => ['type' => 'boolean', 'description' => 'The flag to indicate if HTTPS is forced. Defaults to true.'],+ 'is_preview_deployments_enabled' => ['type' => 'boolean', 'description' => 'Enable preview deployments for pull requests.'],'static_image' => ['type' => 'string', 'enum' => ['nginx:alpine'], 'description' => 'The static image.'],'install_command' => ['type' => 'string', 'description' => 'The install command.'],'build_command' => ['type' => 'string', 'description' => 'The build command.'],@@ -335,6 +336,7 @@ class ApplicationsController extends Controller'is_spa' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application is a single-page application (SPA). Only relevant when is_static is true.'],'is_auto_deploy_enabled' => ['type' => 'boolean', 'description' => 'The flag to indicate if auto-deploy is enabled on git push. Defaults to true.'],'is_force_https_enabled' => ['type' => 'boolean', 'description' => 'The flag to indicate if HTTPS is forced. Defaults to true.'],+ 'is_preview_deployments_enabled' => ['type' => 'boolean', 'description' => 'Enable preview deployments for pull requests.'],'static_image' => ['type' => 'string', 'enum' => ['nginx:alpine'], 'description' => 'The static image.'],'install_command' => ['type' => 'string', 'description' => 'The install command.'],'build_command' => ['type' => 'string', 'description' => 'The build command.'],@@ -501,6 +503,7 @@ class ApplicationsController extends Controller'is_spa' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application is a single-page application (SPA). Only relevant when is_static is true.'],'is_auto_deploy_enabled' => ['type' => 'boolean', 'description' => 'The flag to indicate if auto-deploy is enabled on git push. Defaults to true.'],'is_force_https_enabled' => ['type' => 'boolean', 'description' => 'The flag to indicate if HTTPS is forced. Defaults to true.'],+ 'is_preview_deployments_enabled' => ['type' => 'boolean', 'description' => 'Enable preview deployments for pull requests.'],'static_image' => ['type' => 'string', 'enum' => ['nginx:alpine'], 'description' => 'The static image.'],'install_command' => ['type' => 'string', 'description' => 'The install command.'],'build_command' => ['type' => 'string', 'description' => 'The build command.'],@@ -694,6 +697,7 @@ class ApplicationsController extends Controller'redirect' => ['type' => 'string', 'nullable' => true, 'description' => 'How to set redirect with Traefik / Caddy. www<->non-www.', 'enum' => ['www', 'non-www', 'both']],'instant_deploy' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application should be deployed instantly.'],'is_force_https_enabled' => ['type' => 'boolean', 'description' => 'The flag to indicate if HTTPS is forced. Defaults to true.'],+ 'is_preview_deployments_enabled' => ['type' => 'boolean', 'description' => 'Enable preview deployments for pull requests.'],'use_build_server' => ['type' => 'boolean', 'nullable' => true, 'description' => 'Use build server.'],'is_http_basic_auth_enabled' => ['type' => 'boolean', 'description' => 'HTTP Basic Authentication enabled.'],'http_basic_auth_username' => ['type' => 'string', 'nullable' => true, 'description' => 'Username for HTTP Basic Authentication'],@@ -828,6 +832,7 @@ class ApplicationsController extends Controller'redirect' => ['type' => 'string', 'nullable' => true, 'description' => 'How to set redirect with Traefik / Caddy. www<->non-www.', 'enum' => ['www', 'non-www', 'both']],'instant_deploy' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application should be deployed instantly.'],'is_force_https_enabled' => ['type' => 'boolean', 'description' => 'The flag to indicate if HTTPS is forced. Defaults to true.'],+ 'is_preview_deployments_enabled' => ['type' => 'boolean', 'description' => 'Enable preview deployments for pull requests.'],'use_build_server' => ['type' => 'boolean', 'nullable' => true, 'description' => 'Use build server.'],'is_http_basic_auth_enabled' => ['type' => 'boolean', 'description' => 'HTTP Basic Authentication enabled.'],'http_basic_auth_username' => ['type' => 'string', 'nullable' => true, 'description' => 'Username for HTTP Basic Authentication'],@@ -1011,7 +1016,7 @@ class ApplicationsController extends Controllerif ($return instanceof JsonResponse) {return $return;}- $allowedFields = ['project_uuid', 'environment_name', 'environment_uuid', 'server_uuid', 'destination_uuid', 'type', 'name', 'description', 'is_static', 'is_spa', 'is_auto_deploy_enabled', 'is_force_https_enabled', 'domains', 'git_repository', 'git_branch', 'git_commit_sha', 'private_key_uuid', 'docker_registry_image_name', 'docker_registry_image_tag', 'build_pack', 'install_command', 'build_command', 'start_command', 'ports_exposes', 'ports_mappings', 'custom_network_aliases', 'base_directory', 'publish_directory', 'health_check_enabled', 'health_check_type', 'health_check_command', 'health_check_path', 'health_check_port', 'health_check_host', 'health_check_method', 'health_check_return_code', 'health_check_scheme', 'health_check_response_text', 'health_check_interval', 'health_check_timeout', 'health_check_retries', 'health_check_start_period', 'limits_memory', 'limits_memory_swap', 'limits_memory_swappiness', 'limits_memory_reservation', 'limits_cpus', 'limits_cpuset', 'limits_cpu_shares', 'custom_labels', 'custom_docker_run_options', 'post_deployment_command', 'post_deployment_command_container', 'pre_deployment_command', 'pre_deployment_command_container', 'manual_webhook_secret_github', 'manual_webhook_secret_gitlab', 'manual_webhook_secret_bitbucket', 'manual_webhook_secret_gitea', 'redirect', 'github_app_uuid', 'instant_deploy', 'dockerfile', 'dockerfile_location', 'docker_compose_location', 'docker_compose_raw', 'docker_compose_custom_start_command', 'docker_compose_custom_build_command', 'docker_compose_domains', 'watch_paths', 'use_build_server', 'static_image', 'custom_nginx_configuration', 'is_http_basic_auth_enabled', 'http_basic_auth_username', 'http_basic_auth_password', 'connect_to_docker_network', 'force_domain_override', 'autogenerate_domain', 'is_container_label_escape_enabled', 'is_preserve_repository_enabled'];+ $allowedFields = ['project_uuid', 'environment_name', 'environment_uuid', 'server_uuid', 'destination_uuid', 'type', 'name', 'description', 'is_static', 'is_spa', 'is_auto_deploy_enabled', 'is_force_https_enabled', 'is_preview_deployments_enabled', 'domains', 'git_repository', 'git_branch', 'git_commit_sha', 'private_key_uuid', 'docker_registry_image_name', 'docker_registry_image_tag', 'build_pack', 'install_command', 'build_command', 'start_command', 'ports_exposes', 'ports_mappings', 'custom_network_aliases', 'base_directory', 'publish_directory', 'health_check_enabled', 'health_check_type', 'health_check_command', 'health_check_path', 'health_check_port', 'health_check_host', 'health_check_method', 'health_check_return_code', 'health_check_scheme', 'health_check_response_text', 'health_check_interval', 'health_check_timeout', 'health_check_retries', 'health_check_start_period', 'limits_memory', 'limits_memory_swap', 'limits_memory_swappiness', 'limits_memory_reservation', 'limits_cpus', 'limits_cpuset', 'limits_cpu_shares', 'custom_labels', 'custom_docker_run_options', 'post_deployment_command', 'post_deployment_command_container', 'pre_deployment_command', 'pre_deployment_command_container', 'manual_webhook_secret_github', 'manual_webhook_secret_gitlab', 'manual_webhook_secret_bitbucket', 'manual_webhook_secret_gitea', 'redirect', 'github_app_uuid', 'instant_deploy', 'dockerfile', 'dockerfile_location', 'docker_compose_location', 'docker_compose_raw', 'docker_compose_custom_start_command', 'docker_compose_custom_build_command', 'docker_compose_domains', 'watch_paths', 'use_build_server', 'static_image', 'custom_nginx_configuration', 'is_http_basic_auth_enabled', 'http_basic_auth_username', 'http_basic_auth_password', 'connect_to_docker_network', 'force_domain_override', 'autogenerate_domain', 'is_container_label_escape_enabled', 'is_preserve_repository_enabled'];$validator = customApiValidator($request->all(), ['name' => 'string|max:255',@@ -1057,6 +1062,7 @@ class ApplicationsController extends Controller$isSpa = $request->is_spa;$isAutoDeployEnabled = $request->is_auto_deploy_enabled;$isForceHttpsEnabled = $request->is_force_https_enabled;+ $isPreviewDeploymentsEnabled = $request->is_preview_deployments_enabled;$connectToDockerNetwork = $request->connect_to_docker_network;$customNginxConfiguration = $request->custom_nginx_configuration;$isContainerLabelEscapeEnabled = $request->boolean('is_container_label_escape_enabled', true);@@ -1261,6 +1267,10 @@ class ApplicationsController extends Controller$application->settings->is_force_https_enabled = $isForceHttpsEnabled;$application->settings->save();}+ if (isset($isPreviewDeploymentsEnabled)) {+ $application->settings->is_preview_deployments_enabled = $isPreviewDeploymentsEnabled;+ $application->settings->save();+ }if (isset($connectToDockerNetwork)) {$application->settings->connect_to_docker_network = $connectToDockerNetwork;$application->settings->save();@@ -1497,6 +1507,10 @@ class ApplicationsController extends Controller$application->settings->is_force_https_enabled = $isForceHttpsEnabled;$application->settings->save();}+ if (isset($isPreviewDeploymentsEnabled)) {+ $application->settings->is_preview_deployments_enabled = $isPreviewDeploymentsEnabled;+ $application->settings->save();+ }if (isset($connectToDockerNetwork)) {$application->settings->connect_to_docker_network = $connectToDockerNetwork;$application->settings->save();@@ -1697,6 +1711,10 @@ class ApplicationsController extends Controller$application->settings->is_force_https_enabled = $isForceHttpsEnabled;$application->settings->save();}+ if (isset($isPreviewDeploymentsEnabled)) {+ $application->settings->is_preview_deployments_enabled = $isPreviewDeploymentsEnabled;+ $application->settings->save();+ }if (isset($connectToDockerNetwork)) {$application->settings->connect_to_docker_network = $connectToDockerNetwork;$application->settings->save();@@ -1812,6 +1830,10 @@ class ApplicationsController extends Controller$application->settings->is_force_https_enabled = $isForceHttpsEnabled;$application->settings->save();}+ if (isset($isPreviewDeploymentsEnabled)) {+ $application->settings->is_preview_deployments_enabled = $isPreviewDeploymentsEnabled;+ $application->settings->save();+ }if (isset($connectToDockerNetwork)) {$application->settings->connect_to_docker_network = $connectToDockerNetwork;$application->settings->save();@@ -1922,6 +1944,10 @@ class ApplicationsController extends Controller$application->settings->is_force_https_enabled = $isForceHttpsEnabled;$application->settings->save();}+ if (isset($isPreviewDeploymentsEnabled)) {+ $application->settings->is_preview_deployments_enabled = $isPreviewDeploymentsEnabled;+ $application->settings->save();+ }if (isset($connectToDockerNetwork)) {$application->settings->connect_to_docker_network = $connectToDockerNetwork;$application->settings->save();@@ -2350,6 +2376,7 @@ class ApplicationsController extends Controller'is_spa' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application is a single-page application (SPA). Only relevant when is_static is true.'],'is_auto_deploy_enabled' => ['type' => 'boolean', 'description' => 'The flag to indicate if auto-deploy is enabled on git push. Defaults to true.'],'is_force_https_enabled' => ['type' => 'boolean', 'description' => 'The flag to indicate if HTTPS is forced. Defaults to true.'],+ 'is_preview_deployments_enabled' => ['type' => 'boolean', 'description' => 'Enable preview deployments for pull requests.'],'install_command' => ['type' => 'string', 'description' => 'The install command.'],'build_command' => ['type' => 'string', 'description' => 'The build command.'],'start_command' => ['type' => 'string', 'description' => 'The start command.'],@@ -2494,7 +2521,7 @@ class ApplicationsController extends Controller$this->authorize('update', $application);$server = $application->destination->server;- $allowedFields = ['name', 'description', 'is_static', 'is_spa', 'is_auto_deploy_enabled', 'is_force_https_enabled', 'domains', 'git_repository', 'git_branch', 'git_commit_sha', 'docker_registry_image_name', 'docker_registry_image_tag', 'build_pack', 'static_image', 'install_command', 'build_command', 'start_command', 'ports_exposes', 'ports_mappings', 'custom_network_aliases', 'base_directory', 'publish_directory', 'health_check_enabled', 'health_check_type', 'health_check_command', 'health_check_path', 'health_check_port', 'health_check_host', 'health_check_method', 'health_check_return_code', 'health_check_scheme', 'health_check_response_text', 'health_check_interval', 'health_check_timeout', 'health_check_retries', 'health_check_start_period', 'limits_memory', 'limits_memory_swap', 'limits_memory_swappiness', 'limits_memory_reservation', 'limits_cpus', 'limits_cpuset', 'limits_cpu_shares', 'custom_labels', 'custom_docker_run_options', 'post_deployment_command', 'post_deployment_command_container', 'pre_deployment_command', 'pre_deployment_command_container', 'watch_paths', 'manual_webhook_secret_github', 'manual_webhook_secret_gitlab', 'manual_webhook_secret_bitbucket', 'manual_webhook_secret_gitea', 'dockerfile_location', 'dockerfile_target_build', 'docker_compose_location', 'docker_compose_custom_start_command', 'docker_compose_custom_build_command', 'docker_compose_domains', 'redirect', 'instant_deploy', 'use_build_server', 'custom_nginx_configuration', 'is_http_basic_auth_enabled', 'http_basic_auth_username', 'http_basic_auth_password', 'connect_to_docker_network', 'force_domain_override', 'is_container_label_escape_enabled', 'is_preserve_repository_enabled'];+ $allowedFields = ['name', 'description', 'is_static', 'is_spa', 'is_auto_deploy_enabled', 'is_force_https_enabled', 'is_preview_deployments_enabled', 'domains', 'git_repository', 'git_branch', 'git_commit_sha', 'docker_registry_image_name', 'docker_registry_image_tag', 'build_pack', 'static_image', 'install_command', 'build_command', 'start_command', 'ports_exposes', 'ports_mappings', 'custom_network_aliases', 'base_directory', 'publish_directory', 'health_check_enabled', 'health_check_type', 'health_check_command', 'health_check_path', 'health_check_port', 'health_check_host', 'health_check_method', 'health_check_return_code', 'health_check_scheme', 'health_check_response_text', 'health_check_interval', 'health_check_timeout', 'health_check_retries', 'health_check_start_period', 'limits_memory', 'limits_memory_swap', 'limits_memory_swappiness', 'limits_memory_reservation', 'limits_cpus', 'limits_cpuset', 'limits_cpu_shares', 'custom_labels', 'custom_docker_run_options', 'post_deployment_command', 'post_deployment_command_container', 'pre_deployment_command', 'pre_deployment_command_container', 'watch_paths', 'manual_webhook_secret_github', 'manual_webhook_secret_gitlab', 'manual_webhook_secret_bitbucket', 'manual_webhook_secret_gitea', 'dockerfile_location', 'dockerfile_target_build', 'docker_compose_location', 'docker_compose_custom_start_command', 'docker_compose_custom_build_command', 'docker_compose_domains', 'redirect', 'instant_deploy', 'use_build_server', 'custom_nginx_configuration', 'is_http_basic_auth_enabled', 'http_basic_auth_username', 'http_basic_auth_password', 'connect_to_docker_network', 'force_domain_override', 'is_container_label_escape_enabled', 'is_preserve_repository_enabled'];$validationRules = ['name' => 'string|max:255',@@ -2507,6 +2534,7 @@ class ApplicationsController extends Controller'docker_compose_domains.*.domain' => 'string|nullable','custom_nginx_configuration' => 'string|nullable','is_http_basic_auth_enabled' => 'boolean|nullable',+ 'is_preview_deployments_enabled' => 'boolean|nullable','http_basic_auth_username' => 'string','http_basic_auth_password' => 'string',];@@ -2738,6 +2766,7 @@ class ApplicationsController extends Controller$isSpa = $request->is_spa;$isAutoDeployEnabled = $request->is_auto_deploy_enabled;$isForceHttpsEnabled = $request->is_force_https_enabled;+ $isPreviewDeploymentsEnabled = $request->is_preview_deployments_enabled;$connectToDockerNetwork = $request->connect_to_docker_network;$useBuildServer = $request->use_build_server;$isContainerLabelEscapeEnabled = $request->boolean('is_container_label_escape_enabled');@@ -2767,6 +2796,11 @@ class ApplicationsController extends Controller$application->settings->save();}+ if (isset($isPreviewDeploymentsEnabled)) {+ $application->settings->is_preview_deployments_enabled = $isPreviewDeploymentsEnabled;+ $application->settings->save();+ }+if (isset($connectToDockerNetwork)) {$application->settings->connect_to_docker_network = $connectToDockerNetwork;$application->settings->save();diff --git a/tests/Feature/ApplicationPreviewDeploymentsApiTest.php b/tests/Feature/ApplicationPreviewDeploymentsApiTest.phpnew file mode 100644index 0000000000..8752d81ef4--- /dev/null+++ b/tests/Feature/ApplicationPreviewDeploymentsApiTest.php@@ -0,0 +1,108 @@+<?php++use App\Models\Application;+use App\Models\Environment;+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 Visus\Cuid2\Cuid2;++uses(RefreshDatabase::class);++beforeEach(function () {+ $this->team = Team::factory()->create();+ $this->user = User::factory()->create();+ $this->team->members()->attach($this->user->id, ['role' => 'owner']);++ session(['currentTeam' => $this->team]);++ $this->token = $this->user->createToken('test-token', ['*']);+ $this->bearerToken = $this->token->plainTextToken;++ $this->server = Server::factory()->create(['team_id' => $this->team->id]);++ StandaloneDocker::withoutEvents(function () {+ $this->destination = $this->server->standaloneDockers()->firstOrCreate(+ ['network' => 'coolify'],+ ['uuid' => (string) new Cuid2, 'name' => 'test-docker']+ );+ });++ $this->project = Project::create([+ 'uuid' => (string) new Cuid2,+ 'name' => 'test-project',+ 'team_id' => $this->team->id,+ ]);++ $this->environment = $this->project->environments()->first();++ $this->application = Application::factory()->create([+ 'environment_id' => $this->environment->id,+ 'destination_id' => $this->destination->id,+ 'destination_type' => $this->destination->getMorphClass(),+ ]);+});++function previewDeploymentsAuthHeaders($bearerToken): array+{+ return [+ 'Authorization' => 'Bearer '.$bearerToken,+ 'Content-Type' => 'application/json',+ ];+}++describe('PATCH /api/v1/applications/{uuid} is_preview_deployments_enabled', function () {+ test('can enable preview deployments', function () {+ $this->application->settings->update(['is_preview_deployments_enabled' => false]);++ $response = $this->withHeaders(previewDeploymentsAuthHeaders($this->bearerToken))+ ->patchJson("/api/v1/applications/{$this->application->uuid}", [+ 'is_preview_deployments_enabled' => true,+ ]);++ $response->assertOk();++ $this->application->refresh();+ expect($this->application->settings->is_preview_deployments_enabled)->toBeTrue();+ });++ test('can disable preview deployments', function () {+ $this->application->settings->update(['is_preview_deployments_enabled' => true]);++ $response = $this->withHeaders(previewDeploymentsAuthHeaders($this->bearerToken))+ ->patchJson("/api/v1/applications/{$this->application->uuid}", [+ 'is_preview_deployments_enabled' => false,+ ]);++ $response->assertOk();++ $this->application->refresh();+ expect($this->application->settings->is_preview_deployments_enabled)->toBeFalse();+ });++ test('is_preview_deployments_enabled is not changed when not in request', function () {+ $this->application->settings->update(['is_preview_deployments_enabled' => true]);++ $response = $this->withHeaders(previewDeploymentsAuthHeaders($this->bearerToken))+ ->patchJson("/api/v1/applications/{$this->application->uuid}", [+ 'name' => 'updated-name',+ ]);++ $response->assertOk();++ $this->application->refresh();+ expect($this->application->settings->is_preview_deployments_enabled)->toBeTrue();+ });++ test('rejects non-boolean value', function () {+ $response = $this->withHeaders(previewDeploymentsAuthHeaders($this->bearerToken))+ ->patchJson("/api/v1/applications/{$this->application->uuid}", [+ 'is_preview_deployments_enabled' => 'yes',+ ]);++ $response->assertStatus(422);+ });+});