Skip to content

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.

chore: prepare for PR

Andras Bacsai95e93ad899d6
diff --git a/app/Http/Controllers/Api/ApplicationsController.php b/app/Http/Controllers/Api/ApplicationsController.php
index 1e045ff5a6..57bcc13f6b 100644
--- a/app/Http/Controllers/Api/ApplicationsController.php
+++ b/app/Http/Controllers/Api/ApplicationsController.php
@@ -19,8 +19,8 @@ use App\Rules\ValidGitBranch;
use App\Rules\ValidGitRepositoryUrl;
use App\Services\DockerImageParser;
use Illuminate\Http\Request;
-use Illuminate\Support\Facades\Validator;
use Illuminate\Support\Facades\Http;
+use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
use OpenApi\Attributes as OA;
use Spatie\Url\Url;
@@ -2919,10 +2919,7 @@ class ApplicationsController extends Controller
new OA\MediaType(
mediaType: 'application/json',
schema: new OA\Schema(
- type: 'object',
- properties: [
- 'message' => ['type' => 'string', 'example' => 'Environment variable updated.'],
- ]
+ ref: '#/components/schemas/EnvironmentVariable'
)
),
]
diff --git a/app/Http/Controllers/Api/ServicesController.php b/app/Http/Controllers/Api/ServicesController.php
index 27fdb1ba84..ee4d84f10a 100644
--- a/app/Http/Controllers/Api/ServicesController.php
+++ b/app/Http/Controllers/Api/ServicesController.php
@@ -1141,10 +1141,7 @@ class ServicesController extends Controller
new OA\MediaType(
mediaType: 'application/json',
schema: new OA\Schema(
- type: 'object',
- properties: [
- 'message' => ['type' => 'string', 'example' => 'Environment variable updated.'],
- ]
+ ref: '#/components/schemas/EnvironmentVariable'
)
),
]
@@ -1265,10 +1262,8 @@ class ServicesController extends Controller
new OA\MediaType(
mediaType: 'application/json',
schema: new OA\Schema(
- type: 'object',
- properties: [
- 'message' => ['type' => 'string', 'example' => 'Environment variables updated.'],
- ]
+ type: 'array',
+ items: new OA\Items(ref: '#/components/schemas/EnvironmentVariable')
)
),
]
diff --git a/openapi.json b/openapi.json
index bd502865a4..cbd79ca1d3 100644
--- a/openapi.json
+++ b/openapi.json
@@ -3063,13 +3063,7 @@
"content": {
"application\/json": {
"schema": {
- "properties": {
- "message": {
- "type": "string",
- "example": "Environment variable updated."
- }
- },
- "type": "object"
+ "$ref": "#\/components\/schemas\/EnvironmentVariable"
}
}
}
@@ -9617,13 +9611,7 @@
"content": {
"application\/json": {
"schema": {
- "properties": {
- "message": {
- "type": "string",
- "example": "Environment variable updated."
- }
- },
- "type": "object"
+ "$ref": "#\/components\/schemas\/EnvironmentVariable"
}
}
}
@@ -9721,13 +9709,10 @@
"content": {
"application\/json": {
"schema": {
- "properties": {
- "message": {
- "type": "string",
- "example": "Environment variables updated."
- }
- },
- "type": "object"
+ "type": "array",
+ "items": {
+ "$ref": "#\/components\/schemas\/EnvironmentVariable"
+ }
}
}
}
diff --git a/openapi.yaml b/openapi.yaml
index 11148f43b1..1726071172 100644
--- a/openapi.yaml
+++ b/openapi.yaml
@@ -1952,9 +1952,7 @@ paths:
content:
application/json:
schema:
- properties:
- message: { type: string, example: 'Environment variable updated.' }
- type: object
+ $ref: '#/components/schemas/EnvironmentVariable'
'401':
$ref: '#/components/responses/401'
'400':
@@ -6027,9 +6025,7 @@ paths:
content:
application/json:
schema:
- properties:
- message: { type: string, example: 'Environment variable updated.' }
- type: object
+ $ref: '#/components/schemas/EnvironmentVariable'
'401':
$ref: '#/components/responses/401'
'400':
@@ -6075,9 +6071,9 @@ paths:
content:
application/json:
schema:
- properties:
- message: { type: string, example: 'Environment variables updated.' }
- type: object
+ type: array
+ items:
+ $ref: '#/components/schemas/EnvironmentVariable'
'401':
$ref: '#/components/responses/401'
'400':
diff --git a/tests/Feature/EnvironmentVariableUpdateApiTest.php b/tests/Feature/EnvironmentVariableUpdateApiTest.php
new file mode 100644
index 0000000000..9c45dc5ae7
--- /dev/null
+++ b/tests/Feature/EnvironmentVariableUpdateApiTest.php
@@ -0,0 +1,194 @@
+<?php
+
+use App\Models\Application;
+use App\Models\Environment;
+use App\Models\EnvironmentVariable;
+use App\Models\Project;
+use App\Models\Server;
+use App\Models\Service;
+use App\Models\StandaloneDocker;
+use App\Models\Team;
+use App\Models\User;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+
+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]);
+ $this->destination = StandaloneDocker::factory()->create(['server_id' => $this->server->id]);
+ $this->project = Project::factory()->create(['team_id' => $this->team->id]);
+ $this->environment = Environment::factory()->create(['project_id' => $this->project->id]);
+});
+
+describe('PATCH /api/v1/services/{uuid}/envs', function () {
+ test('returns the updated environment variable object', function () {
+ $service = Service::factory()->create([
+ 'server_id' => $this->server->id,
+ 'destination_id' => $this->destination->id,
+ 'destination_type' => $this->destination->getMorphClass(),
+ 'environment_id' => $this->environment->id,
+ ]);
+
+ EnvironmentVariable::create([
+ 'key' => 'APP_IMAGE_TAG',
+ 'value' => 'old-value',
+ 'resourceable_type' => Service::class,
+ 'resourceable_id' => $service->id,
+ 'is_preview' => false,
+ ]);
+
+ $response = $this->withHeaders([
+ 'Authorization' => 'Bearer '.$this->bearerToken,
+ 'Content-Type' => 'application/json',
+ ])->patchJson("/api/v1/services/{$service->uuid}/envs", [
+ 'key' => 'APP_IMAGE_TAG',
+ 'value' => 'new-value',
+ ]);
+
+ $response->assertStatus(201);
+ $response->assertJsonStructure([
+ 'uuid',
+ 'key',
+ 'is_literal',
+ 'is_multiline',
+ 'is_shown_once',
+ 'created_at',
+ 'updated_at',
+ ]);
+ $response->assertJsonFragment(['key' => 'APP_IMAGE_TAG']);
+ $response->assertJsonMissing(['message' => 'Environment variable updated.']);
+ });
+
+ test('returns 404 when environment variable does not exist', function () {
+ $service = Service::factory()->create([
+ 'server_id' => $this->server->id,
+ 'destination_id' => $this->destination->id,
+ 'destination_type' => $this->destination->getMorphClass(),
+ 'environment_id' => $this->environment->id,
+ ]);
+
+ $response = $this->withHeaders([
+ 'Authorization' => 'Bearer '.$this->bearerToken,
+ 'Content-Type' => 'application/json',
+ ])->patchJson("/api/v1/services/{$service->uuid}/envs", [
+ 'key' => 'NONEXISTENT_KEY',
+ 'value' => 'some-value',
+ ]);
+
+ $response->assertStatus(404);
+ $response->assertJson(['message' => 'Environment variable not found.']);
+ });
+
+ test('returns 404 when service does not exist', function () {
+ $response = $this->withHeaders([
+ 'Authorization' => 'Bearer '.$this->bearerToken,
+ 'Content-Type' => 'application/json',
+ ])->patchJson('/api/v1/services/non-existent-uuid/envs', [
+ 'key' => 'APP_IMAGE_TAG',
+ 'value' => 'some-value',
+ ]);
+
+ $response->assertStatus(404);
+ });
+
+ test('returns 422 when key is missing', function () {
+ $service = Service::factory()->create([
+ 'server_id' => $this->server->id,
+ 'destination_id' => $this->destination->id,
+ 'destination_type' => $this->destination->getMorphClass(),
+ 'environment_id' => $this->environment->id,
+ ]);
+
+ $response = $this->withHeaders([
+ 'Authorization' => 'Bearer '.$this->bearerToken,
+ 'Content-Type' => 'application/json',
+ ])->patchJson("/api/v1/services/{$service->uuid}/envs", [
+ 'value' => 'some-value',
+ ]);
+
+ $response->assertStatus(422);
+ });
+});
+
+describe('PATCH /api/v1/applications/{uuid}/envs', function () {
+ test('returns the updated environment variable object', function () {
+ $application = Application::factory()->create([
+ 'environment_id' => $this->environment->id,
+ 'destination_id' => $this->destination->id,
+ 'destination_type' => $this->destination->getMorphClass(),
+ ]);
+
+ EnvironmentVariable::create([
+ 'key' => 'APP_IMAGE_TAG',
+ 'value' => 'old-value',
+ 'resourceable_type' => Application::class,
+ 'resourceable_id' => $application->id,
+ 'is_preview' => false,
+ ]);
+
+ $response = $this->withHeaders([
+ 'Authorization' => 'Bearer '.$this->bearerToken,
+ 'Content-Type' => 'application/json',
+ ])->patchJson("/api/v1/applications/{$application->uuid}/envs", [
+ 'key' => 'APP_IMAGE_TAG',
+ 'value' => 'new-value',
+ ]);
+
+ $response->assertStatus(201);
+ $response->assertJsonStructure([
+ 'uuid',
+ 'key',
+ 'is_literal',
+ 'is_multiline',
+ 'is_shown_once',
+ 'created_at',
+ 'updated_at',
+ ]);
+ $response->assertJsonFragment(['key' => 'APP_IMAGE_TAG']);
+ $response->assertJsonMissing(['message' => 'Environment variable updated.']);
+ });
+
+ test('returns 404 when environment variable does not exist', function () {
+ $application = Application::factory()->create([
+ 'environment_id' => $this->environment->id,
+ 'destination_id' => $this->destination->id,
+ 'destination_type' => $this->destination->getMorphClass(),
+ ]);
+
+ $response = $this->withHeaders([
+ 'Authorization' => 'Bearer '.$this->bearerToken,
+ 'Content-Type' => 'application/json',
+ ])->patchJson("/api/v1/applications/{$application->uuid}/envs", [
+ 'key' => 'NONEXISTENT_KEY',
+ 'value' => 'some-value',
+ ]);
+
+ $response->assertStatus(404);
+ });
+
+ test('returns 422 when key is missing', function () {
+ $application = Application::factory()->create([
+ 'environment_id' => $this->environment->id,
+ 'destination_id' => $this->destination->id,
+ 'destination_type' => $this->destination->getMorphClass(),
+ ]);
+
+ $response = $this->withHeaders([
+ 'Authorization' => 'Bearer '.$this->bearerToken,
+ 'Content-Type' => 'application/json',
+ ])->patchJson("/api/v1/applications/{$application->uuid}/envs", [
+ 'value' => 'some-value',
+ ]);
+
+ $response->assertStatus(422);
+ });
+});