TraderInteractive\Chef\ChefEc2

Complexity

Total Complexity

8

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	createServer()	0	33	2
A	updateServers()	0	22	2
A	awsCredentialParameters()	0	7	1
A	chefClientParameters()	0	8	1
A	ec2SshParameters()	0	7	1

<?php

namespace TraderInteractive\Chef;

class ChefEc2
{
    /**
     * @var string The base command for knife.
     */
    private $baseKnifeCommand;

    /**
     * @var string The url for the chef API.
     */
    private $chefServerUrl;

    /**
     * @var array The credentials needed to interact with knife-ec2.
     */
    private $credentials;

    /**
     * Initialize the wrapper around knife-ec2.
     *
     * @param string $baseKnifeCommand The base command for knife.  could be 'knife' if knife is already in the path.
     *                                 If using bundler to install knife-ec2, you could do something
     *                                 like 'BUNDLE_GEMFILE=/path/to/Gemfile bundle exec knife'.
     * @param string $chefServerUrl    The url for the chef API.
     * @param array  $credentials      The credentials needed to interact with knife-ec2.  Includes awsAccessKeyId and
     *                                 awsSecretAccessKey.
     */
    public function __construct(string $baseKnifeCommand, string $chefServerUrl, array $credentials)
    {
        $this->baseKnifeCommand = $baseKnifeCommand;
        $this->chefServerUrl = $chefServerUrl;
        $this->credentials = $credentials;
    }

    /**
     * Instantiate a new server.
     *
     * @param string $region The AWS region the server is in.
     * @param string $ami The region-specific AMI to use.
     * @param string $flavor The flavor of server to create, e.g. t1.micro.
     * @param array $runList The roles/recipes for the chef run list.
     * @param string $progressFile A file path to store the server output in.
     * @param array $options Additional options for knife-ec2.  For example: ['-groups' => 'foo']
     * @param array $tags Tags to set for the server.
     * @param string $chefVersion The chef version to use to bootstrap the server.
     *
     * @return void
     */
    public function createServer(
        string $region,
        string $ami,
        string $flavor,
        array $runList,
        string $progressFile,
        array $options = [],
        array $tags = [],
        string $chefVersion = '11.8.0'
    ) {

        $tagList = [];
        foreach ($tags as $key => $value) {
            $tagList[] = "{$key}={$value}";
        }

        $fullOptions = [
            '--region' => $region,
            '--image' => $ami,
            '--flavor' => $flavor,
            '--run-list' => implode(',', $runList),
            '--tags' => implode(',', $tagList),
            '--bootstrap-version' => $chefVersion,
        ];

        $fullOptions += $options;
        $fullOptions += $this->awsCredentialParameters();
        $fullOptions += $this->chefClientParameters();
        $fullOptions += $this->ec2SshParameters();

        $command = \Hiatus\addArguments("{$this->baseKnifeCommand} ec2 server create", $fullOptions);
        \Hiatus\execX("{$command} >" . escapeshellarg($progressFile) . ' 2>&1 &');
    }

    /**
     * Runs chef client on the servers that match the query storing command output in the given file.
     *
     * @param string $query The chef query to specify what servers to update.
     * @param string $progressFile The filename to send the knife output to.
     * @param array $options Additional options for knife ssh.  For example: ['-groups' => 'foo']
     * @param array $chefOptions Additional options for chef client. For example: ['--override-runlist' => 'role[foo]']
     * @return void
     */
    public function updateServers(
        string $query,
        string $progressFile = null,
        array $options = [],
        array $chefOptions = []
    ) {
        $instanceIdUrl = 'http://169.254.169.254/latest/meta-data/instance-id';
        $chefOptions = array_merge($chefOptions, ['--json-attributes' => '/etc/chef/first-boot.json']);
        $chefCommand = \Hiatus\addArguments("sudo chef-client -N `curl {$instanceIdUrl}`", $chefOptions);
        $options = array_merge(
            $options,
            $this->chefClientParameters(),
            $this->ec2SshParameters(),
            [$query, $chefCommand]
        );
        $command = \Hiatus\addArguments("{$this->baseKnifeCommand} ssh", $options);
        if ($progressFile !== null) {
            \Hiatus\execX("{$command} >" . escapeshellarg($progressFile) . ' 2>&1 &');
        } else {
            passthru($command);
        }
    }

    /**
     * Get the knife-ec2 parameters for basic AWS API credentials.
     *
     * @return array The parameters to access AWS via knife-ec2.
     */
    private function awsCredentialParameters() : array
    {
        return [
            '--aws-access-key-id' => $this->credentials['awsAccessKeyId'],
            '--aws-secret-access-key' => $this->credentials['awsSecretAccessKey'],
        ];
    }

    /**
     * Get the chef client parameters.
     *
     * @return array The parameters to access the chef API via knife.
     */
    private function chefClientParameters() : array
    {
        return [
            '--server-url' => $this->chefServerUrl,
            '--user' => $this->credentials['chefClientName'],
            '--key' => $this->credentials['chefClientKey'],
        ];
    }

    /**
     * Get the EC2 SSH parameters.
     *
     * @return array The parameters to access the EC2 ssh servers
     */
    private function ec2SshParameters() : array
    {
        return [
            '--ssh-user' => $this->credentials['ec2SshUser'],
            '--identity-file' => $this->credentials['ec2SshKey'],
        ];
    }
}