dave/coolify
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Merge pull request #2568 from matpratta/feat/convert-http-to-ssh-sources-with-deploy-keys

Browse Source 
fix: convert HTTP to SSH source when using deploy key on GitHub
This commit is contained in:
Andras Bacsai
2024-11-12 11:32:58 +01:00
committed by GitHub
parent 0ab77c3e9e 327b4308d4
commit 923cfd1201
5 changed files with 273 additions and 174 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
app/Models/Application.php
View File

@@ -906,21 +906,7 @@ class Application extends BaseModel
public function customRepository() public function customRepository()
{ {
preg_match('/(?<=:)\d+(?=\/)/', $this->git_repository, $matches); return convertGitUrl($this->git_repository, $this->deploymentType(), $this->source);
$port = 22;
if (count($matches) === 1) {
$port = $matches[0];
$gitHost = str($this->git_repository)->before(':');
$gitRepo = str($this->git_repository)->after('/');
$repository = "$gitHost:$gitRepo";
} else {
$repository = $this->git_repository;
}
return [
'repository' => $repository,
'port' => $port,
];
} }
public function generateBaseDir(string $uuid) public function generateBaseDir(string $uuid)

51
bootstrap/helpers/shared.php
View File

@@ -7,6 +7,7 @@ use App\Models\Application;
use App\Models\ApplicationDeploymentQueue; use App\Models\ApplicationDeploymentQueue;
use App\Models\ApplicationPreview; use App\Models\ApplicationPreview;
use App\Models\EnvironmentVariable; use App\Models\EnvironmentVariable;
use App\Models\GithubApp;
use App\Models\InstanceSettings; use App\Models\InstanceSettings;
use App\Models\LocalFileVolume; use App\Models\LocalFileVolume;
use App\Models\LocalPersistentVolume; use App\Models\LocalPersistentVolume;
@@ -4092,3 +4093,53 @@ function defaultNginxConfiguration(): string
} }
}'; }';
} }
function convertGitUrl(string $gitRepository, string $deploymentType, ?GithubApp $source = null): array
{
$repository = $gitRepository;
$providerInfo = [
'host' => null,
'user' => 'git',
'port' => 22,
'repository' => $gitRepository,
];
$sshMatches = [];
$matches = [];
// Let's try and parse the string to detect if it's a valid SSH string or not
preg_match('/((.*?)\:\/\/)?(.*@.*:.*)/', $gitRepository, $sshMatches);
if ($deploymentType === 'deploy_key' && empty($sshMatches) && $source) {
// If this happens, the user may have provided an HTTP URL when they needed an SSH one
// Let's try and fix that for known Git providers
switch ($source->getMorphClass()) {
case \App\Models\GithubApp::class:
$providerInfo['host'] = Url::fromString($source->html_url)->getHost();
$providerInfo['port'] = $source->custom_port;
$providerInfo['user'] = $source->custom_user;
break;
}
if (! empty($providerInfo['host'])) {
// Until we do not support more providers with App (like GithubApp), this will be always true, port will be 22
if ($providerInfo['port'] === 22) {
$repository = "{$providerInfo['user']}@{$providerInfo['host']}:{$providerInfo['repository']}";
} else {
$repository = "ssh://{$providerInfo['user']}@{$providerInfo['host']}:{$providerInfo['port']}/{$providerInfo['repository']}";
}
}
}
preg_match('/(?<=:)\d+(?=\/)/', $gitRepository, $matches);
if (count($matches) === 1) {
$providerInfo['port'] = $matches[0];
$gitHost = str($gitRepository)->before(':');
$gitRepo = str($gitRepository)->after('/');
$repository = "$gitHost:$gitRepo";
}
return [
'repository' => $repository,
'port' => $providerInfo['port'],
];
}

2
scripts/run
View File

@@ -24,7 +24,7 @@ function logs {
docker exec -t coolify tail -f storage/logs/laravel.log docker exec -t coolify tail -f storage/logs/laravel.log
} }
function test { function test {
docker exec -t coolify php artisan test --testsuite=Feature docker exec -t coolify php artisan test --testsuite=Feature -p
} }
function sync:bunny { function sync:bunny {

62
tests/Feature/ConvertingGitUrlsTest.php Normal file
View File

@@ -0,0 +1,62 @@
<?php
use App\Models\GithubApp;
test('convertGitUrlsForDeployKeyAndGithubAppAndHttpUrl', function () {
$githubApp = GithubApp::find(0);
$result = convertGitUrl('andrasbacsai/coolify-examples.git', 'deploy_key', $githubApp);
expect($result)->toBe([
'repository' => 'git@github.com:andrasbacsai/coolify-examples.git',
'port' => 22,
]);
});
test('convertGitUrlsForDeployKeyAndGithubAppAndSshUrl', function () {
$githubApp = GithubApp::find(0);
$result = convertGitUrl('git@github.com:andrasbacsai/coolify-examples.git', 'deploy_key', $githubApp);
expect($result)->toBe([
'repository' => 'git@github.com:andrasbacsai/coolify-examples.git',
'port' => 22,
]);
});
test('convertGitUrlsForDeployKeyAndHttpUrl', function () {
$result = convertGitUrl('andrasbacsai/coolify-examples.git', 'deploy_key', null);
expect($result)->toBe([
'repository' => 'andrasbacsai/coolify-examples.git',
'port' => 22,
]);
});
test('convertGitUrlsForDeployKeyAndSshUrl', function () {
$result = convertGitUrl('git@github.com:andrasbacsai/coolify-examples.git', 'deploy_key', null);
expect($result)->toBe([
'repository' => 'git@github.com:andrasbacsai/coolify-examples.git',
'port' => 22,
]);
});
test('convertGitUrlsForSourceAndSshUrl', function () {
$result = convertGitUrl('git@github.com:andrasbacsai/coolify-examples.git', 'source', null);
expect($result)->toBe([
'repository' => 'git@github.com:andrasbacsai/coolify-examples.git',
'port' => 22,
]);
});
test('convertGitUrlsForSourceAndHttpUrl', function () {
$result = convertGitUrl('andrasbacsai/coolify-examples.git', 'source', null);
expect($result)->toBe([
'repository' => 'andrasbacsai/coolify-examples.git',
'port' => 22,
]);
});
test('convertGitUrlsForSourceAndSshUrlWithCustomPort', function () {
$result = convertGitUrl('git@git.domain.com:766/group/project.git', 'source', null);
expect($result)->toBe([
'repository' => 'git@git.domain.com:group/project.git',
'port' => '766',
]);
});

316
tests/Feature/DockerComposeParseTest.php
View File

@@ -9,171 +9,171 @@ use App\Models\StandaloneDocker;
use Illuminate\Support\Collection; use Illuminate\Support\Collection;
use Symfony\Component\Yaml\Yaml; use Symfony\Component\Yaml\Yaml;
beforeEach(function () { // beforeEach(function () {
$this->applicationYaml = ' // $this->applicationYaml = '
version: "3.8" // version: "3.8"
services: // services:
app: // app:
image: nginx // image: nginx
environment: // environment:
SERVICE_FQDN_APP: /app // SERVICE_FQDN_APP: /app
APP_KEY: base64 // APP_KEY: base64
APP_DEBUG: "${APP_DEBUG:-false}" // APP_DEBUG: "${APP_DEBUG:-false}"
APP_URL: $SERVICE_FQDN_APP // APP_URL: $SERVICE_FQDN_APP
DB_URL: postgres://${SERVICE_USER_POSTGRES}:${SERVICE_PASSWORD_POSTGRES}@db:5432/postgres?schema=public // DB_URL: postgres://${SERVICE_USER_POSTGRES}:${SERVICE_PASSWORD_POSTGRES}@db:5432/postgres?schema=public
volumes: // volumes:
- "./nginx:/etc/nginx" // - "./nginx:/etc/nginx"
- "data:/var/www/html" // - "data:/var/www/html"
depends_on: // depends_on:
- db // - db
db: // db:
image: postgres // image: postgres
environment: // environment:
POSTGRES_USER: "${SERVICE_USER_POSTGRES}" // POSTGRES_USER: "${SERVICE_USER_POSTGRES}"
POSTGRES_PASSWORD: "${SERVICE_PASSWORD_POSTGRES}" // POSTGRES_PASSWORD: "${SERVICE_PASSWORD_POSTGRES}"
volumes: // volumes:
- "dbdata:/var/lib/postgresql/data" // - "dbdata:/var/lib/postgresql/data"
healthcheck: // healthcheck:
test: // test:
- CMD // - CMD
- pg_isready // - pg_isready
- "-U" // - "-U"
- "postgres" // - "postgres"
interval: 2s // interval: 2s
timeout: 10s // timeout: 10s
retries: 10 // retries: 10
depends_on: // depends_on:
app: // app:
condition: service_healthy // condition: service_healthy
networks: // networks:
default: // default:
name: something // name: something
external: true // external: true
noinet: // noinet:
driver: bridge // driver: bridge
internal: true'; // internal: true';
$this->applicationComposeFileString = Yaml::parse($this->applicationYaml); // $this->applicationComposeFileString = Yaml::parse($this->applicationYaml);
$this->application = Application::create([ // $this->application = Application::create([
'name' => 'Application for tests', // 'name' => 'Application for tests',
'docker_compose_domains' => json_encode([ // 'docker_compose_domains' => json_encode([
'app' => [ // 'app' => [
'domain' => 'http://bcoowoookw0co4cok4sgc4k8.127.0.0.1.sslip.io', // 'domain' => 'http://bcoowoookw0co4cok4sgc4k8.127.0.0.1.sslip.io',
], // ],
]), // ]),
'preview_url_template' => '{{pr_id}}.{{domain}}', // 'preview_url_template' => '{{pr_id}}.{{domain}}',
'uuid' => 'bcoowoookw0co4cok4sgc4k8s', // 'uuid' => 'bcoowoookw0co4cok4sgc4k8s',
'repository_project_id' => 603035348, // 'repository_project_id' => 603035348,
'git_repository' => 'coollabsio/coolify-examples', // 'git_repository' => 'coollabsio/coolify-examples',
'git_branch' => 'main', // 'git_branch' => 'main',
'base_directory' => '/docker-compose-test', // 'base_directory' => '/docker-compose-test',
'docker_compose_location' => 'docker-compose.yml', // 'docker_compose_location' => 'docker-compose.yml',
'docker_compose_raw' => $this->applicationYaml, // 'docker_compose_raw' => $this->applicationYaml,
'build_pack' => 'dockercompose', // 'build_pack' => 'dockercompose',
'ports_exposes' => '3000', // 'ports_exposes' => '3000',
'environment_id' => 1, // 'environment_id' => 1,
'destination_id' => 0, // 'destination_id' => 0,
'destination_type' => StandaloneDocker::class, // 'destination_type' => StandaloneDocker::class,
'source_id' => 1, // 'source_id' => 1,
'source_type' => GithubApp::class, // 'source_type' => GithubApp::class,
]); // ]);
$this->application->environment_variables_preview()->where('key', 'APP_DEBUG')->update(['value' => 'true']); // $this->application->environment_variables_preview()->where('key', 'APP_DEBUG')->update(['value' => 'true']);
$this->applicationPreview = ApplicationPreview::create([ // $this->applicationPreview = ApplicationPreview::create([
'git_type' => 'github', // 'git_type' => 'github',
'application_id' => $this->application->id, // 'application_id' => $this->application->id,
'pull_request_id' => 1, // 'pull_request_id' => 1,
'pull_request_html_url' => 'https://github.com/coollabsio/coolify-examples/pull/1', // 'pull_request_html_url' => 'https://github.com/coollabsio/coolify-examples/pull/1',
]); // ]);
$this->serviceYaml = ' // $this->serviceYaml = '
services: // services:
activepieces: // activepieces:
image: "ghcr.io/activepieces/activepieces:latest" // image: "ghcr.io/activepieces/activepieces:latest"
environment: // environment:
- SERVICE_FQDN_ACTIVEPIECES // - SERVICE_FQDN_ACTIVEPIECES
- AP_API_KEY=$SERVICE_PASSWORD_64_APIKEY // - AP_API_KEY=$SERVICE_PASSWORD_64_APIKEY
- AP_URL=$SERVICE_URL_ACTIVEPIECES // - AP_URL=$SERVICE_URL_ACTIVEPIECES
- AP_ENCRYPTION_KEY=$SERVICE_PASSWORD_ENCRYPTIONKEY // - AP_ENCRYPTION_KEY=$SERVICE_PASSWORD_ENCRYPTIONKEY
- AP_ENGINE_EXECUTABLE_PATH=dist/packages/engine/main.js // - AP_ENGINE_EXECUTABLE_PATH=dist/packages/engine/main.js
- AP_ENVIRONMENT=prod // - AP_ENVIRONMENT=prod
- AP_EXECUTION_MODE=${AP_EXECUTION_MODE} // - AP_EXECUTION_MODE=${AP_EXECUTION_MODE}
- AP_FRONTEND_URL=$SERVICE_FQDN_ACTIVEPIECES // - AP_FRONTEND_URL=$SERVICE_FQDN_ACTIVEPIECES
- AP_JWT_SECRET=$SERVICE_PASSWORD_64_JWT // - AP_JWT_SECRET=$SERVICE_PASSWORD_64_JWT
- AP_POSTGRES_DATABASE=activepieces // - AP_POSTGRES_DATABASE=activepieces
- AP_POSTGRES_HOST=postgres // - AP_POSTGRES_HOST=postgres
- AP_POSTGRES_PASSWORD=$SERVICE_PASSWORD_POSTGRES // - AP_POSTGRES_PASSWORD=$SERVICE_PASSWORD_POSTGRES
- AP_POSTGRES_PORT=5432 // - AP_POSTGRES_PORT=5432
- AP_POSTGRES_USERNAME=$SERVICE_USER_POSTGRES // - AP_POSTGRES_USERNAME=$SERVICE_USER_POSTGRES
- AP_REDIS_HOST=redis // - AP_REDIS_HOST=redis
- AP_REDIS_PORT=6379 // - AP_REDIS_PORT=6379
- AP_SANDBOX_RUN_TIME_SECONDS=600 // - AP_SANDBOX_RUN_TIME_SECONDS=600
- AP_TELEMETRY_ENABLED=true // - AP_TELEMETRY_ENABLED=true
- "AP_TEMPLATES_SOURCE_URL=https://cloud.activepieces.com/api/v1/flow-templates" // - "AP_TEMPLATES_SOURCE_URL=https://cloud.activepieces.com/api/v1/flow-templates"
- AP_TRIGGER_DEFAULT_POLL_INTERVAL=5 // - AP_TRIGGER_DEFAULT_POLL_INTERVAL=5
- AP_WEBHOOK_TIMEOUT_SECONDS=30 // - AP_WEBHOOK_TIMEOUT_SECONDS=30
depends_on: // depends_on:
postgres: // postgres:
condition: service_healthy // condition: service_healthy
redis: // redis:
condition: service_started // condition: service_started
healthcheck: // healthcheck:
test: ["CMD", "curl", "-f", "http://127.0.0.1:80"] // test: ["CMD", "curl", "-f", "http://127.0.0.1:80"]
interval: 5s // interval: 5s
timeout: 20s // timeout: 20s
retries: 10 // retries: 10
postgres: // postgres:
image: "nginx" // image: "nginx"
environment: // environment:
- SERVICE_FQDN_ACTIVEPIECES=/api // - SERVICE_FQDN_ACTIVEPIECES=/api
- POSTGRES_DB=activepieces // - POSTGRES_DB=activepieces
- PASSW=$AP_POSTGRES_PASSWORD // - PASSW=$AP_POSTGRES_PASSWORD
- AP_FRONTEND_URL=$SERVICE_FQDN_ACTIVEPIECES // - AP_FRONTEND_URL=$SERVICE_FQDN_ACTIVEPIECES
- POSTGRES_PASSWORD=$SERVICE_PASSWORD_POSTGRES // - POSTGRES_PASSWORD=$SERVICE_PASSWORD_POSTGRES
- POSTGRES_USER=$SERVICE_USER_POSTGRES // - POSTGRES_USER=$SERVICE_USER_POSTGRES
volumes: // volumes:
- "pg-data:/var/lib/postgresql/data" // - "pg-data:/var/lib/postgresql/data"
healthcheck: // healthcheck:
test: ["CMD-SHELL", "pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}"] // test: ["CMD-SHELL", "pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}"]
interval: 5s // interval: 5s
timeout: 20s // timeout: 20s
retries: 10 // retries: 10
redis: // redis:
image: "redis:latest" // image: "redis:latest"
volumes: // volumes:
- "redis_data:/data" // - "redis_data:/data"
healthcheck: // healthcheck:
test: ["CMD", "redis-cli", "ping"] // test: ["CMD", "redis-cli", "ping"]
interval: 5s // interval: 5s
timeout: 20s // timeout: 20s
retries: 10 // retries: 10
'; // ';
$this->serviceComposeFileString = Yaml::parse($this->serviceYaml); // $this->serviceComposeFileString = Yaml::parse($this->serviceYaml);
$this->service = Service::create([ // $this->service = Service::create([
'name' => 'Service for tests', // 'name' => 'Service for tests',
'uuid' => 'tgwcg8w4s844wkog8kskw44g', // 'uuid' => 'tgwcg8w4s844wkog8kskw44g',
'docker_compose_raw' => $this->serviceYaml, // 'docker_compose_raw' => $this->serviceYaml,
'environment_id' => 1, // 'environment_id' => 1,
'server_id' => 0, // 'server_id' => 0,
'destination_id' => 0, // 'destination_id' => 0,
'destination_type' => StandaloneDocker::class, // 'destination_type' => StandaloneDocker::class,
]); // ]);
}); // });
afterEach(function () { // afterEach(function () {
// $this->applicationPreview->forceDelete(); // // $this->applicationPreview->forceDelete();
$this->application->forceDelete(); // $this->application->forceDelete();
DeleteResourceJob::dispatchSync($this->service); // DeleteResourceJob::dispatchSync($this->service);
$this->service->forceDelete(); // $this->service->forceDelete();
}); // });
test('ServiceComposeParseNew', function () { // test('ServiceComposeParseNew', function () {
$output = newParser($this->service); // $output = newParser($this->service);
$this->service->saveComposeConfigs(); // $this->service->saveComposeConfigs();
expect($output)->toBeInstanceOf(Collection::class); // expect($output)->toBeInstanceOf(Collection::class);
}); // });
// test('ApplicationComposeParse', function () { // test('ApplicationComposeParse', function () {
// expect($this->jsonapplicationComposeFile)->toBeJson()->ray(); // expect($this->jsonapplicationComposeFile)->toBeJson()->ray();