Envoy.blade.php

@setup
    // check for required --branch command line param
    if (! preg_match('/^(master|develop|feature\/OGT-[a-z0-9-]+)$/', $branch)) {
        exit("The command line parameter '--branch' is required.\n");
    }

    if (! preg_match('/^(1|0)$/', $updsys)) {
        exit("The command line parameter '--updsys' with a value from [0, 1] is required.\n");
    }

    $servers = [
        'test' => '',
        'production' => '',
    ];

    // check for required server --env command line param
    $validServerEnvs = array_keys($servers);

    if (! in_array($env, $validServerEnvs)) {
        exit("The command line parameter '--env' with a value from [" . implode(', ', $validServerEnvs) . "] is required.\n");
    }

    $envNameUppercase = strtoupper($env);

    // check for required project env params for deployment
    $requiredEnvVars = [
        'APP_NAME',
        'DEPLOY_APP_URL_' . $envNameUppercase,
        'DEPLOY_APP_DIR',
        'DEPLOY_HOST_' . $envNameUppercase,
        'DEPLOY_REPO',
        'DEPLOY_SLACK_WEBHOOK',
        'DEPLOY_SLACK_WEBHOOK_ENABLED',
        'DEPLOY_USER_' . $envNameUppercase,
    ];

    try {
        require __DIR__ . '/vendor/autoload.php';
        $dotenv = Dotenv\Dotenv::createImmutable(__DIR__);
        $dotenv->load();
        $dotenv->required($requiredEnvVars)->notEmpty();
    } catch ( Exception $e )  {
        exit("Exception: " . $e->getMessage() . "\n");
    }

    // set project deployment params
    $deployUser = env('DEPLOY_USER_' . $envNameUppercase);
    $servers[$env] = $deployUser . '@' . env('DEPLOY_HOST_' . $envNameUppercase);

    $repository = env('DEPLOY_REPO');
    $appDir = env('DEPLOY_APP_DIR') . '/' . env('APP_NAME');
    $appUrl = str_replace('/', '\/', env('DEPLOY_APP_URL_' . $envNameUppercase));
    $releasesDir = $appDir . '/releases';
    $releaseDate = date('Y-m-d_H-i-s');
    $newReleaseDir = $releasesDir . '/' . $releaseDate;

    $slackWebhook = env('DEPLOY_SLACK_WEBHOOK');
    $isSlackWebhookEnabled = env('DEPLOY_SLACK_WEBHOOK_ENABLED');
    $slackWebhookMessage = "Deployment on `$env` for branch `$branch`";

    function logConsole($env, $message) {
        return "echo '\033[32m###### [" . $env . "] " . $message . " ######\033[0m';\n";
    }
@endsetup

@servers($servers)

@story('deploy', ['on' => $env])
    update_system
    install_packages
    clone_repository
    run_composer
    init_env
    run_npm
    update_symlinks
@endstory

@task('update_system')
    @if ($updsys)
        {{ logConsole($env, "Update the package sources list to get the latest list of available packages in the repositories:") }}
        sudo apt update -y

        {{ logConsole($env, "Add Ondřej Surý PHP repository - https://deb.sury.org/:") }}
        # https://github.com/oerdnj/deb.sury.org/wiki/Frequently-Asked-Questions#how-to-enable-the-debsuryorg-repository
        sudo apt -y install apt-transport-https lsb-release ca-certificates curl
        sudo wget -O /etc/apt/trusted.gpg.d/php.gpg https://packages.sury.org/php/apt.gpg
        sudo sh -c 'echo "deb https://packages.sury.org/php/ $(lsb_release -sc) main" > /etc/apt/sources.list.d/php.list'
        sudo apt update -y
    @else
        {{ logConsole($env, "[skipped] Update the package sources list.") }}
    @endif
@endtask

@task('install_packages')
    @if ($updsys)
        # @todo Install basic packages like git, ... (pre-installed on the test server)
        # @todo Install NGINX packages (pre-installed on the test server)
        # @todo Create NGINX server config for project (created directly on the test server)
        # @todo Update npm

        {{ logConsole($env, "Install required PHP packages for NGINX:") }}
        # includes php-common php7.4-cli php7.4-common php7.4-fpm php7.4-json php7.4-opcache php7.4-readline
        # includes PHP modules (php -m) for e.g. ctype fileinfo json openssl pdo tokenizer
        sudo apt -y install php7.4-fpm

        {{ logConsole($env, "Install additionally required PHP packages for Laravel:") }}
        # https://laravel.com/docs/8.x/deployment#server-requirements
        sudo apt -y install php7.4-bcmath php7.4-mbstring php7.4-xml

        {{ logConsole($env, "Install PHP dependency manager Composer for Laravel:") }}
        php -r "readfile('https://getcomposer.org/installer');" | sudo php -- --install-dir=/usr/local/bin/ --filename=composer

        {{ logConsole($env, "Install Node.js package manager npm for Laravel / Vue.js:") }}
        curl -sL https://deb.nodesource.com/setup_16.x | sudo bash -
        sudo apt -y install nodejs
    @else
        {{ logConsole($env, "[skipped] Install required packages.") }}
    @endif
@endtask

@task('clone_repository')
    # @todo clone a certain tag of repository

    {{ logConsole($env, "Cloning " . $branch . " of repository " . $repository) }}
    test -d {{ $releasesDir }} || sudo mkdir -p {{ $releasesDir }}
    sudo chown -R {{ $deployUser }}:{{ $deployUser }} {{ $appDir }}

    eval $(ssh-agent -s)
    ssh-add ~/.ssh/id_ed25519_{{ $deployUser }}

    git clone --depth 1 --branch {{ $branch }} {{ $repository }} {{ $newReleaseDir }}
@endtask

@task('run_composer')
    {{ logConsole($env, "Run composer") }}
    cd {{ $newReleaseDir }}
    composer install --optimize-autoloader --no-dev
@endtask

@task('init_env')
    {{ logConsole($env, "Init env") }}
    cd {{ $newReleaseDir }}
    cp .env.{{ substr($env, 0, 4) }} .env
    php artisan key:generate

    sed -i -E "s/^ASSET_URL=.*$/ASSET_URL={{ $appUrl }}/g" .env
@endtask

@task('run_npm')
    {{ logConsole($env, "Run NPM to install all dependencies of the project in package-lock.json...") }}
    cd {{ $newReleaseDir }}
    npm install --production

    {{ logConsole($env, "Run all Mix tasks and minify output...") }}
    # https://laravel.com/docs/8.x/mix#running-mix
    npm run prod
@endtask

@task('update_symlinks')
    {{ logConsole($env, "Prepare storage directory") }}
    test -d {{ $appDir }}/storage/logs || sudo mkdir -p {{ $appDir }}/storage/logs
    test -d {{ $appDir }}/storage/framework/sessions || sudo mkdir -p {{ $appDir }}/storage/framework/sessions
    test -d {{ $appDir }}/storage/framework/views || sudo mkdir -p {{ $appDir }}/storage/framework/views
    sudo chown -R www-data:www-data {{ $appDir }}/storage

    {{ logConsole($env, "Linking storage directory") }}
    rm -rf {{ $newReleaseDir }}/storage
    ln -nfs {{ $appDir }}/storage {{ $newReleaseDir }}/storage

    {{ logConsole($env, "Prepare images directory") }}
    test -d {{ $appDir }}/images || sudo mkdir -p {{ $appDir }}/images
    sudo chown -R www-data:www-data {{ $appDir }}/images

    {{ logConsole($env, "Linking images directory") }}
    rm -rf {{ $newReleaseDir }}/public/images/static
    ln -nfs {{ $appDir }}/images {{ $newReleaseDir }}/public/images/static

    {{ logConsole($env, "Linking current release") }}
    ln -nfs {{ $newReleaseDir }} {{ $appDir }}/current
@endtask

@before
    if ($isSlackWebhookEnabled) {
        if ($task === 'clone_repository') {
            @slack($slackWebhook, '', "$slackWebhookMessage started...");
        }
    }
@endbefore

@success
    if ($isSlackWebhookEnabled) {
        @slack($slackWebhook, '', "$slackWebhookMessage finished.");
    }
@endsuccess

@finished
    if ($isSlackWebhookEnabled) {
        if ($exitCode > 0) {
            @slack($slackWebhook, '', "$slackWebhookMessage failed.");
        }
    }
@endfinished