feature_setup.php

<?php

namespace Deployer;

use MoveElevator\DeployerTools\Database\DbUtility;

require_once('feature_init.php');
require_once('url_shortener.php');

task('feature:setup', function () {
    // Without a feature we are deploying the base instance and must not touch any
    // feature scaffolding — renderRemoteTemplates() would overwrite its .env.
    if (!featureRequested()) {
        return;
    }
    checkVerbosity();

    // extend deploy path / public url
    $feature = initFeature();

    if (!checkFeatureBranchExists()) {
        info("setup feature branch <fg=magenta;options=bold>$feature</>");
        set('feature_setup', true);
        DbUtility::getDatabaseManager()->create();
        renderRemoteTemplates();
    } else {
        set('feature_setup', false);
    }
})
    ->select('type=feature-branch-deployment')
    ->once()
    ->desc('Setup a feature branch')
;


/**
 * Checks if a feature branch already exists regarding the database and the server path
 *
 * @throws \Deployer\Exception\Exception
 * @throws \Deployer\Exception\RunException
 * @throws \Deployer\Exception\TimeoutException
 */
function checkFeatureBranchExists(): bool
{
    $path = get('deploy_path');
    return (DbUtility::getDatabaseManager()->exists() && test("[[ -d $path ]]"));
}

/**
 * Render additional remote files by given templates to ensure the operability of feature branches
 *
 * Configure the registration of templates like this:
 *
 * set('feature_templates', [
 *    __DIR__ . '/.deployment/deployer/templates/.env.dist' => '/shared/.env'
 * ]);
 *
 * Within the template file (e.g. .env.dist) are arguments to replace available:
 *  {{DEPLOYER_CONFIG_DATABASE_USER}}
 *
 * @return void
 * @throws \Deployer\Exception\Exception
 * @throws \Deployer\Exception\RunException
 * @throws \Deployer\Exception\TimeoutException
 */
function renderRemoteTemplates(): void
{
    debug('Rendering remote template');
    $databaseName = DbUtility::getDatabaseManager()->getDatabaseName();
    // the normalized name, matching the instance directory and url segment
    $feature = get('feature');
    $templates = get('feature_templates');

    if (!$templates) {
        $templates = [];
    }

    // ToDo: simplify!
    // get additional arguments from environment variables
    $environmentVariables = getenv();
    $additionalTemplateVariables = [];
    foreach ($environmentVariables as $key => $value) {
        if (str_starts_with($key, 'DEPLOYER_CONFIG_')) {
            debug('additional template variable: ' . $key);
            $additionalTemplateVariables[$key] = $value;
        }
    }

    $featurePath = isUrlShortener() ? "$feature/" :$feature . '/current/' . get('web_path') ;

    // preparing default arguments for templates and extend by additional template variables
    $arguments = array_merge([
        'DEPLOYER_CONFIG_DATABASE_HOST' => get('database_host'),
        'DEPLOYER_CONFIG_DATABASE_PORT' => get('database_port'),
        'DEPLOYER_CONFIG_DATABASE_USER' => get('database_user'),
        'DEPLOYER_CONFIG_DATABASE_PASSWORD' => get('database_password'),
        'DEPLOYER_CONFIG_DATABASE_NAME' => has('database_name') ? get('database_name') : $databaseName,
        'DEPLOYER_CONFIG_FEATURE_NAME' => (string)$feature,
        'DEPLOYER_CONFIG_FEATURE_URL' => get('public_urls')[0],
        'DEPLOYER_CONFIG_FEATURE_PATH' => $featurePath,
        'DEPLOYER_CONFIG_ENCRYPTION_KEY' => bin2hex(random_bytes(48)),
    ],
        $additionalTemplateVariables)
    ;

    // iterate through predefined templates
    foreach ($templates as $template => $target) {
        debug('Uploading template: ' . $template . '...');
        uploadTemplate($template, $target, $arguments);
    }
}

/**
 * Extend a given local template with the provided arguments and uploads them to a remote host
 *
 * @param $localTemplate
 * @param $remoteTarget
 * @param $arguments
 * @return void
 * @throws \Deployer\Exception\Exception
 * @throws \Deployer\Exception\RunException
 * @throws \Deployer\Exception\TimeoutException
 */
function uploadTemplate($localTemplate, $remoteTarget, $arguments): void {

    debug('Uploading template: ' . $localTemplate . '...');

    $templateContent = file_get_contents($localTemplate);

    // replace all {{variables}} with arguments
    foreach ($arguments as $argument => $replacement) {
        $templateContent = str_replace('{{' .$argument . '}}', (string)$replacement, $templateContent);
    }

    // generate temporary local file for file upload to remote
    $temporaryFileName = ".deployer." . preg_replace('/[^A-Za-z0-9\-]/', '', $remoteTarget) . ".tmp";
    file_put_contents($temporaryFileName, $templateContent);

    $path = get('deploy_path') . $remoteTarget;

    // create path to template destination if not exists
    runExtended("mkdir -p " . pathinfo($path)['dirname']);

    // upload template to remote
    upload($temporaryFileName,get('deploy_path') . $remoteTarget);
    unlink($temporaryFileName);
}