deploy.php

<?php

namespace Deployer;

use Exception;

/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//// Dependencies
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

require 'recipe/common.php';

/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//// Environments
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

define('ENV_PATH', realpath(getcwd()) . '/');
define('ENV_FILE', ENV_PATH . 'deploy.json');

// Define the project root
set('abspath', ENV_PATH);

if (file_exists(ENV_FILE) == false) {
    throw new Exception('Unable to find configuration file at ' . ENV_FILE);
} else {
    $json = file_get_contents(ENV_FILE);

    if ($json == false) {
        throw new Exception(
            'Unable to read ' . $env_path . 'config.json. Check your current user has permission to read the file'
        );
    }
    $json = json_decode($json, true, 12);

    // register the repo
    set('repository', $json['git_repo']);

    set('config', $json);

    // Collect the WordPress config
    $wp_json = $json['wordpress'];

    // Collect the environment config
    $env_json = $json['environments'];

    // Set the name
    set('application', $wp_json['wp_sitename']);

    // register the local wp url
    set('local_url', $wp_json['wp_home_url']);

    // Register hosts and associated metadata
    if (!empty($env_json)) {
        if (isset($env_json['local'])) {
            $local_json = $env_json['local'];

            $host = localhost();
            $host->hostname('localhost');
            $host->set('local', true);

            unset($env_json['local']);
        }

        foreach ($env_json as $env => $env_config) {
            $host = host($env);

            $host->set('stage', $env);
            $host->set('forwardAgent', true);

            foreach ($env_config as $key => $value) {
                if ($key == 'hostname') {
                    $host->hostname($value);
                } elseif ($key == 'deploy_user') {
                    $host->user($value);
                } else {
                    $host->set($key, $value);
                }
            }
        }
    }
}

/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//// Misc. Helper Functions
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

/**
 * Searches $file for $before and replaces it with $after
 *
 * @param string $file
 * @param string $before
 * @param string $after
 * @return bool
 */
function searchreplaceinfile(string $file, string $before, string $after)
{
    $seperator = '/';
    $before = str_replace($seperator, '\\' . $seperator, $before);
    $after = str_replace($seperator, '\\' . $seperator, $after);

    $cmd = "{{bin/sed}} 's" . $seperator . $before . $seperator . $after . $seperator . "g' \"$file\"";
    $stage = get('stage', 'local');
    if ($stage == 'local') {
        return runLocally($cmd);
    } else {
        return run($cmd);
    }
}

/**
 * Get an array of environment vars
 *
 * @param string $stage
 * @return array
 */
function getenvbag(string $stage)
{
    $config = get('config');
    return $config['environments'][$stage];
}

/**
 * Get an array of default configuration options
 *
 * @return array
 */
function getconfig()
{
    $config = get('config');
    return $config['wordpress'];
}

/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//// Below be dragons - tread carefully!
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

// Detect the current operator
set('user', function () {
    try {
        return runLocally('whoami');
    } catch (\Throwable $exception) {
        return 'no_user';
    }
});

// Can a user interactive with the TTY?
set('allow_input', function () {
    $user = get('user');
    if ($user != 'runner') {
        // Do not allow interaction for when used with CI/CD
        return true;
    } else {
        return false;
    }
});

// Define a list of files that should be shared between deployments
set('shared_files', ['wp-config.php', '.htaccess', 'robots.txt']);

// Define a list of files that should be copied from the 'templates' folder to the root
set('templates', ['.htaccess', 'robots.txt']);

// Should a TTY be opened for Git?
set('git_tty', get('allow_input'));

// Set the directory where shared files are set
set('shared_dir', function () {
    if (get('stage', 'local') == 'local') {
        return get('abspath');
    }
    return get('deploy_path') . '/shared/';
});

// Define a directory that is shared between deployments
set('shared_dirs', [
    'content/uploads',
    'content/w3tc-config' // W3 Total Cache wants to write it's own config to disk
]);

// Define web user writeable directories
set('writable_dirs', [
    'content/uploads',
    'content/w3tc-config' // W3 Total Cache wants to write it's own config to disk
]);

// Use ACL to extend existing permissions
set('writable_mode', 'chgrp'); // chmod, chown, chgrp or acl.
set('writable_chmod_mode', '775');

// Default to only shallow clone
set('git_recursive', false);

// Set apache config options
set('http_user', function () {
    if ($webuser = run("cat /etc/apache2/envvars | grep 'APACHE_RUN_USER'")) {
        $www = explode('=', $webuser);
        return end($www);
    }
    return 'nobody';
});
set('http_group', function () {
    if ($webgroup = run("cat /etc/apache2/envvars | grep 'APACHE_RUN_GROUP'")) {
        $www = explode('=', $webgroup);
        return end($www);
    }
    return 'nobody';
});

// Detect which version of sed is being used on the target
set('bin/sed', function () {
    if (!commandExist('sed')) {
        throw new Exception("sed was not detected in your \$PATH");
    }
    $sed = run("command -v 'sed' || which 'sed' || type -p 'sed'");
    $which_sed = run($sed . ' --version | head -n 1');
    if (strstr($which_sed, 'GNU sed')) {
        return "$sed -i";
    } else {
        return "$sed -i ''";
    }
});

// Detect which version of curl is being used
set('bin/curl', function () {
    if (!commandExist('curl')) {
        throw new Exception("curl was not detected in your \$PATH");
    }
    return run("command -v 'curl' || which 'curl' || type -p 'curl'");
});

// Detect which version of sed is being used on the target
set('bin/wp', function () {
    if (!commandExist('wp')) {
        throw new Exception("wp-cli was not detected in your \$PATH");
    }
    return run("command -v 'wp' || which 'wp' || type -p 'wp'");
});

// Set WP bin to local path
set('bin/wpl', function () {
    return runLocally("command -v 'wp' || which 'wp' || type -p 'wp'");
});

// Detect which version of npm is being used on the target
set('bin/npm', function () {
    if (!commandExist('npm')) {
        throw new Exception("npm was not detected in your \$PATH");
    }
    return run("command -v 'npm' || which 'npm' || type -p 'npm'");
});

// Returns Composer binary path if found
set('bin/composer', function () {
    if (!commandExist('composer')) {
        throw new Exception("composer was not detected in your \$PATH");
    }
    return run("command -v 'composer' || which 'composer' || type -p 'composer'");
});

// Every release should be datetime stamped
set('release_name', date('YmdHis'));

// Try to use git cache where applicable
set('git_cache', true);

// Disable usage data
set('allow_anonymous_stats', false);

// Ensure permissions are set recursively
set('writable_recursive', true);

/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//// Tasks
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

task('deploy', [
    'deploy:info',
    'deploy:lock',
    'deploy:release',
    'deploy:update_code',
    'deploy:shared',
    'deploy:clear_paths',
    'deploy:symlink',
    'deploy:unlock',
    'cleanup',
    'success'
])->desc('Deploy your project');

fail('deploy', 'deploy:unlock');

/**
 * Log the deployment info into a revisions file in the deployment path
 */
task('signoff', function () {
    $signoff = 'Branch ({{branch}}) deployed by ({{user}}) for release ({{release_name}})';
    cd('{{deploy_path}}');
    run('touch revisions.log');
    run('echo "' . $signoff . '" >> revisions.log');
    writeln('<info>' . $signoff . '</info>');
})->setPrivate();

/**
 * Helpful debug task
 */
task('debug:info', function () {
    writeln('Current user: <info>' . get('user') . '</info>');
    writeln('Current branch: <info>' . get('branch') . '</info>');
    writeln('Supports TTY: <info>' . (get('allow_input') ? 'Yes' : 'No') . '</info>');
    writeln(
        'Binaries:
        <comment>wp</comment>: ' .
            get('bin/wp') .
            '
        <comment>curl</comment>: ' .
            get('bin/curl') .
            '
        <comment>npm</comment>: ' .
            get('bin/npm') .
            '
        <comment>sed</comment>: ' .
            get('bin/sed') .
            '
        <comment>composer</comment>: ' .
            get('bin/composer') .
            '
        <comment>php</comment>: ' .
            get('bin/php') .
            '
        <comment>git</comment>: ' .
            get('bin/git') .
            '
        <comment>symlink</comment>: ' .
            get('bin/symlink')
    );
});

after('cleanup', 'signoff');

$autoload = array_diff(scandir(realpath(__DIR__) . '/config/tasks/', SCANDIR_SORT_ASCENDING), ['..', '.', '.DS_Store']);
if (!empty($autoload)) {
    array_map(function ($task) {
        require_once realpath(__DIR__) . '/config/tasks/' . $task;
    }, $autoload);
}

/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//// Hide uncommon tasks from the CLI
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

task('deploy:clear_paths')->setPrivate();
task('deploy:copy_dirs')->setPrivate();
task('deploy:prepare')->setPrivate();
task('deploy:release')->setPrivate();
task('deploy:shared')->setPrivate();
task('deploy:symlink')->setPrivate();
task('deploy:update_code')->setPrivate();
task('deploy:vendors')->setPrivate();
task('deploy:writable')->setPrivate();
task('cleanup')->setPrivate();