CapistranoDeploymentBackend::setPackageGenerator() - Code Metrics - Inspection of "Use ArrayList for deploy options" - silverstripe/deploynaut - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#723)

by Sean
created 2016-10-18 22:50 UTC
CapistranoDeploymentBackend::setPackageGenerator() A

↳ Parent: CapistranoDeploymentBackend
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1
<?php

class CapistranoDeploymentBackend extends Object implements DeploymentBackend {

	protected $packageGenerator;

	public function getPackageGenerator() {
		return $this->packageGenerator;
	}

	public function setPackageGenerator(PackageGenerator $packageGenerator) {
		$this->packageGenerator = $packageGenerator;
	}

	/**
	 * Create a deployment strategy.
	 *
	 * @param DNEnvironment $environment
	 * @param array $options
	 *
	 * @return DeploymentStrategy
	 */
	public function planDeploy(DNEnvironment $environment, $options) {
		$strategy = new DeploymentStrategy($environment, $options);

		$currentBuild = $environment->CurrentBuild();
		$currentSha = $currentBuild ? $currentBuild->SHA : '-';
		if($currentSha !== $options['sha']) {
			$strategy->setChange('Code version', $currentSha, $options['sha']);
		}
		$strategy->setActionTitle('Confirm deployment');
		$strategy->setActionCode('fast');
		$strategy->setEstimatedTime('2');

		return $strategy;
	}

	/**
	 * Deploy the given build to the given environment.
	 *
	 * @param DNEnvironment $environment
	 * @param DeploynautLogFile $log
	 * @param DNProject $project
	 * @param array $options
	 */
	public function deploy(
		DNEnvironment $environment,
		DeploynautLogFile $log,
		DNProject $project,
		$options
	) {
		$name = $environment->getFullName();
		$repository = $project->getLocalCVSPath();
		$sha = $options['sha'];

		$args = array(
			'branch' => $sha,
			'repository' => $repository,
		);

		$this->extend('deployStart', $environment, $sha, $log, $project);

		$log->write(sprintf('Deploying "%s" to "%s"', $sha, $name));

		$this->enableMaintenance($environment, $log, $project);

		// Use a package generator if specified, otherwise run a direct deploy, which is the default behaviour
		// if build_filename isn't specified
		if($this->packageGenerator) {
			$log->write(sprintf('Using package generator "%s"', get_class($this->packageGenerator)));

			try {
				$args['build_filename'] = $this->packageGenerator->getPackageFilename($project->Name, $sha, $repository, $log);
			} catch (Exception $e) {
				$log->write($e->getMessage());
				throw $e;
			}

			if(empty($args['build_filename'])) {
				throw new RuntimeException('Failed to generate package.');
			}
		}

		$command = $this->getCommand('deploy', 'web', $environment, $args, $log);
		$command->run(function($type, $buffer) use($log) {
			$log->write($buffer);
		});

		// Deployment cleanup. We assume it is always safe to run this at the end, regardless of the outcome.
		$self = $this;
		$cleanupFn = function() use($self, $environment, $args, $log, $sha, $project) {
			$command = $self->getCommand('deploy:cleanup', 'web', $environment, $args, $log);
			$command->run(function($type, $buffer) use($log) {
				$log->write($buffer);
			});

			if(!$command->isSuccessful()) {
				$self->extend('cleanupFailure', $environment, $sha, $log, $project);
				$log->write('Warning: Cleanup failed, but fine to continue. Needs manual cleanup sometime.');
			}
		};

		// Once the deployment has run it's necessary to update the maintenance page status
		// as deploying removes .htaccess
		$this->enableMaintenance($environment, $log, $project);

		$rolledBack = null;
		if(!$command->isSuccessful() || !$this->smokeTest($environment, $log)) {
			$cleanupFn();
			$this->extend('deployFailure', $environment, $sha, $log, $project);

			$currentBuild = $environment->CurrentBuild();
			if (empty($currentBuild) || (!empty($options['no_rollback']) && $options['no_rollback'] !== 'false')) {
				throw new RuntimeException($command->getErrorOutput());
			}

			// re-run deploy with the current build sha to rollback
			$log->write('Deploy failed. Rolling back');
			$rollbackArgs = array_merge($args, ['branch' => $currentBuild->SHA]);
			$command = $this->getCommand('deploy', 'web', $environment, $rollbackArgs, $log);
			$command->run(function($type, $buffer) use($log) {
				$log->write($buffer);
			});

			// Once the deployment has run it's necessary to update the maintenance page status
			// as deploying removes .htaccess
			$this->enableMaintenance($environment, $log, $project);

			if (!$command->isSuccessful() || !$this->smokeTest($environment, $log)) {
				$this->extend('deployRollbackFailure', $environment, $currentBuild->SHA, $log, $project);
				$log->write('Rollback failed');
				throw new RuntimeException($command->getErrorOutput());
			}

			// By getting here, it means we have successfully rolled back without any errors
			$rolledBack = true;
		}

		$this->disableMaintenance($environment, $log, $project);

		$cleanupFn();

		// Rolling back means the rollback succeeded, but ultimately the deployment
		// has failed. Throw an exception so the job is marked as failed accordingly.
		if ($rolledBack === true) {
			throw new RuntimeException('Rollback successful');
		}

		$log->write(sprintf('Deploy of "%s" to "%s" finished', $sha, $name));

		$this->extend('deployEnd', $environment, $sha, $log, $project);
	}

	/**
	 * @param DNEnvironment $environment
	 * @return ArrayList
	 */
	public function getDeployOptions(DNEnvironment $environment) {
		return new ArrayList(
			new PredeployBackupOption($environment->Usage === DNEnvironment::PRODUCTION),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			new NoRollbackDeployOption()

		);
	}

	/**
	 * Enable a maintenance page for the given environment using the maintenance:enable Capistrano task.
	 */
	public function enableMaintenance(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project) {

		$name = $environment->getFullName();
		$command = $this->getCommand('maintenance:enable', 'web', $environment, null, $log);
		$command->run(function($type, $buffer) use($log) {
			$log->write($buffer);
		});
		if(!$command->isSuccessful()) {
			$this->extend('maintenanceEnableFailure', $environment, $log);
			throw new RuntimeException($command->getErrorOutput());
		}
		$log->write(sprintf('Maintenance page enabled on "%s"', $name));
	}

	/**
	 * Disable the maintenance page for the given environment using the maintenance:disable Capistrano task.
	 */
	public function disableMaintenance(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project) {

		$name = $environment->getFullName();
		$command = $this->getCommand('maintenance:disable', 'web', $environment, null, $log);
		$command->run(function($type, $buffer) use($log) {
			$log->write($buffer);
		});
		if(!$command->isSuccessful()) {
			$this->extend('maintenanceDisableFailure', $environment, $log);
			throw new RuntimeException($command->getErrorOutput());
		}
		$log->write(sprintf('Maintenance page disabled on "%s"', $name));
	}

	/**
	 * Check the status using the deploy:check capistrano method
	 */
	public function ping(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project) {
		$command = $this->getCommand('deploy:check', 'web', $environment, null, $log);
		$command->run(function($type, $buffer) use($log) {
			$log->write($buffer);
			echo $buffer;
		});
	}

	/**
	 * @inheritdoc
	 */
	public function dataTransfer(DNDataTransfer $dataTransfer, DeploynautLogFile $log) {
		if($dataTransfer->Direction == 'get') {
			$this->dataTransferBackup($dataTransfer, $log);
		} else {
			$environment = $dataTransfer->Environment();
			$project = $environment->Project();
			$workingDir = TEMP_FOLDER . DIRECTORY_SEPARATOR . 'deploynaut-transfer-' . $dataTransfer->ID;
			$archive = $dataTransfer->DataArchive();

			// extract the sspak contents, we'll need these so capistrano can restore that content
			try {
				$archive->extractArchive($workingDir);
			} catch(Exception $e) {
				$log->write($e->getMessage());
				throw new RuntimeException($e->getMessage());
			}

			// validate the contents match the requested transfer mode
			$result = $archive->validateArchiveContents($dataTransfer->Mode);
			if(!$result->valid()) {
				// do some cleaning, get rid of the extracted archive lying around
				$process = new AbortableProcess(sprintf('rm -rf %s', escapeshellarg($workingDir)));
				$process->setTimeout(120);
				$process->run();

				// log the reason why we can't restore the snapshot and halt the process
				$log->write($result->message());
				throw new RuntimeException($result->message());
			}

			// Put up a maintenance page during a restore of db or assets.
			$this->enableMaintenance($environment, $log, $project);
			$this->dataTransferRestore($workingDir, $dataTransfer, $log);
			$this->disableMaintenance($environment, $log, $project);
		}
	}

	/**
	 * @param string $action Capistrano action to be executed
	 * @param string $roles Defining a server role is required to target only the required servers.
	 * @param DNEnvironment $environment
	 * @param array<string>|null $args Additional arguments for process
	 * @param DeploynautLogFile $log
	 * @return \Symfony\Component\Process\Process
	 */
	public function getCommand($action, $roles, DNEnvironment $environment, $args = null, DeploynautLogFile $log) {
		$name = $environment->getFullName();
		$env = $environment->Project()->getProcessEnv();

		if(!$args) {
			$args = array();
		}
		$args['history_path'] = realpath(DEPLOYNAUT_LOG_PATH . '/');
		$args['environment_id'] = $environment->ID;

		// Inject env string directly into the command.
		// Capistrano doesn't like the $process->setEnv($env) we'd normally do below.
		$envString = '';
		if(!empty($env)) {
			$envString .= 'env ';
			foreach($env as $key => $value) {
				$envString .= "$key=\"$value\" ";
			}
		}

		$data = DNData::inst();
		// Generate a capfile from a template
		$capTemplate = file_get_contents(BASE_PATH . '/deploynaut/Capfile.template');
		$cap = str_replace(
			array('<config root>', '<ssh key>', '<base path>'),
			array($data->getEnvironmentDir(), DEPLOYNAUT_SSH_KEY, BASE_PATH),
			$capTemplate
		);

		if(defined('DEPLOYNAUT_CAPFILE')) {
			$capFile = DEPLOYNAUT_CAPFILE;
		} else {
			$capFile = ASSETS_PATH . '/Capfile';
		}
		file_put_contents($capFile, $cap);

		$command = "{$envString}cap -f " . escapeshellarg($capFile) . " -vv $name $action ROLES=$roles";
		foreach($args as $argName => $argVal) {
			$command .= ' -s ' . escapeshellarg($argName) . '=' . escapeshellarg($argVal);
		}

		$log->write(sprintf('Running command: %s', $command));

		$process = new AbortableProcess($command);
		$process->setTimeout(3600);
		return $process;
	}

	/**
	 * Backs up database and/or assets to a designated folder,
	 * and packs up the files into a single sspak.
	 *
	 * @param DNDataTransfer    $dataTransfer
	 * @param DeploynautLogFile $log
	 */
	protected function dataTransferBackup(DNDataTransfer $dataTransfer, DeploynautLogFile $log) {
		$environment = $dataTransfer->Environment();
		$name = $environment->getFullName();

		// Associate a new archive with the transfer.
		// Doesn't retrieve a filepath just yet, need to generate the files first.
		$dataArchive = DNDataArchive::create();
		$dataArchive->Mode = $dataTransfer->Mode;
		$dataArchive->AuthorID = $dataTransfer->AuthorID;
		$dataArchive->OriginalEnvironmentID = $environment->ID;
		$dataArchive->EnvironmentID = $environment->ID;
		$dataArchive->IsBackup = $dataTransfer->IsBackupDataTransfer();

		// Generate directory structure with strict permissions (contains very sensitive data)
		$filepathBase = $dataArchive->generateFilepath($dataTransfer);
		mkdir($filepathBase, 0700, true);

		$databasePath = $filepathBase . DIRECTORY_SEPARATOR . 'database.sql.gz';

		// Backup database
		if(in_array($dataTransfer->Mode, array('all', 'db'))) {

			$log->write(sprintf('Backup of database from "%s" started', $name));
			$command = $this->getCommand('data:getdb', 'db', $environment, array('data_path' => $databasePath), $log);
			$command->run(function($type, $buffer) use($log) {
				$log->write($buffer);
			});
			if(!$command->isSuccessful()) {
				$this->extend('dataTransferFailure', $environment, $log);
				throw new RuntimeException($command->getErrorOutput());
			}
			$log->write(sprintf('Backup of database from "%s" done', $name));
		}

		// Backup assets
		if(in_array($dataTransfer->Mode, array('all', 'assets'))) {

			$log->write(sprintf('Backup of assets from "%s" started', $name));
			$command = $this->getCommand('data:getassets', 'web', $environment, array('data_path' => $filepathBase), $log);
			$command->run(function($type, $buffer) use($log) {
				$log->write($buffer);
			});
			if(!$command->isSuccessful()) {
				$this->extend('dataTransferFailure', $environment, $log);
				throw new RuntimeException($command->getErrorOutput());
			}
			$log->write(sprintf('Backup of assets from "%s" done', $name));
		}

		// ensure the database connection is re-initialised, which is needed if the transfer
		// above took a really long time because the handle to the db may have become invalid.
		global $databaseConfig;
function myFunction($a, $b) {
    // Do something
}
		DB::connect($databaseConfig);

		$log->write('Creating sspak...');

		$sspakFilename = sprintf('%s.sspak', $dataArchive->generateFilename($dataTransfer));
		$sspakFilepath = $filepathBase . DIRECTORY_SEPARATOR . $sspakFilename;

		try {
			$dataArchive->attachFile($sspakFilepath, $dataTransfer);
			$dataArchive->setArchiveFromFiles($filepathBase);
		} catch(Exception $e) {
			$log->write($e->getMessage());
			throw new RuntimeException($e->getMessage());
		}

		// Remove any assets and db files lying around, they're not longer needed as they're now part
		// of the sspak file we just generated. Use --force to avoid errors when files don't exist,
		// e.g. when just an assets backup has been requested and no database.sql exists.
		$process = new AbortableProcess(sprintf('rm -rf %s/assets && rm -f %s', escapeshellarg($filepathBase), escapeshellarg($databasePath)));

		$process->setTimeout(120);
		$process->run();
		if(!$process->isSuccessful()) {
			$log->write('Could not delete temporary files');
			throw new RuntimeException($process->getErrorOutput());
		}

		$log->write(sprintf('Creating sspak file done: %s', $dataArchive->ArchiveFile()->getAbsoluteURL()));
	}

	/**
	 * Utility function for triggering the db rebuild and flush.
	 * Also cleans up and generates new error pages.
	 * @param DeploynautLogFile $log
	 */
	public function rebuild(DNEnvironment $environment, $log) {

		$name = $environment->getFullName();
		$command = $this->getCommand('deploy:migrate', 'web', $environment, null, $log);
		$command->run(function($type, $buffer) use($log) {
			$log->write($buffer);
		});
		if(!$command->isSuccessful()) {
			$log->write(sprintf('Rebuild of "%s" failed: %s', $name, $command->getErrorOutput()));
			throw new RuntimeException($command->getErrorOutput());
		}
		$log->write(sprintf('Rebuild of "%s" done', $name));
	}

	/**
	 * Extracts a *.sspak file referenced through the passed in $dataTransfer
	 * and pushes it to the environment referenced in $dataTransfer.
	 *
	 * @param string $workingDir Directory for the unpacked files.
	 * @param DNDataTransfer $dataTransfer
	 * @param DeploynautLogFile $log
	 */
	protected function dataTransferRestore($workingDir, DNDataTransfer $dataTransfer, DeploynautLogFile $log) {
		$environment = $dataTransfer->Environment();
		$name = $environment->getFullName();

		// Rollback cleanup.
		$self = $this;
		$cleanupFn = function() use($self, $workingDir, $environment, $log) {

			// Rebuild makes sense even if failed - maybe we can at least partly recover.
			$self->rebuild($environment, $log);
			$process = new AbortableProcess(sprintf('rm -rf %s', escapeshellarg($workingDir)));
			$process->setTimeout(120);
			$process->run();
		};

		// Restore database into target environment
		if(in_array($dataTransfer->Mode, array('all', 'db'))) {

			$log->write(sprintf('Restore of database to "%s" started', $name));
			$args = array('data_path' => $workingDir . DIRECTORY_SEPARATOR . 'database.sql');
			$command = $this->getCommand('data:pushdb', 'db', $environment, $args, $log);
			$command->run(function($type, $buffer) use($log) {
				$log->write($buffer);
			});
			if(!$command->isSuccessful()) {
				$cleanupFn();
				$log->write(sprintf('Restore of database to "%s" failed: %s', $name, $command->getErrorOutput()));
				$this->extend('dataTransferFailure', $environment, $log);
				throw new RuntimeException($command->getErrorOutput());
			}
			$log->write(sprintf('Restore of database to "%s" done', $name));
		}

		// Restore assets into target environment
		if(in_array($dataTransfer->Mode, array('all', 'assets'))) {

			$log->write(sprintf('Restore of assets to "%s" started', $name));
			$args = array('data_path' => $workingDir . DIRECTORY_SEPARATOR . 'assets');
			$command = $this->getCommand('data:pushassets', 'web', $environment, $args, $log);
			$command->run(function($type, $buffer) use($log) {
				$log->write($buffer);
			});
			if(!$command->isSuccessful()) {
				$cleanupFn();
				$log->write(sprintf('Restore of assets to "%s" failed: %s', $name, $command->getErrorOutput()));
				$this->extend('dataTransferFailure', $environment, $log);
				throw new RuntimeException($command->getErrorOutput());
			}
			$log->write(sprintf('Restore of assets to "%s" done', $name));
		}

		$log->write('Rebuilding and cleaning up');
		$cleanupFn();
	}

	/**
	 * This is mostly copy-pasted from Anthill/Smoketest.
	 *
	 * @param DNEnvironment $environment
	 * @param DeploynautLogFile $log
	 * @return bool
	 */
	protected function smokeTest(DNEnvironment $environment, DeploynautLogFile $log) {
		$url = $environment->getBareURL();
		$timeout = 600;
		$tick = 60;

		if(!$url) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$log->write('Skipping site accessible check: no URL found.');
			return true;
		}

		$start = time();
		$infoTick = time() + $tick;

		$log->write(sprintf(
			'Waiting for "%s" to become accessible... (timeout: %smin)',
			$url,
			$timeout / 60
		));

		// configure curl so that curl_exec doesn't wait a long time for a response
		$ch = curl_init();
		curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
		curl_setopt($ch, CURLOPT_TIMEOUT, 5);
		curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
		curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
		curl_setopt($ch, CURLOPT_MAXREDIRS, 10); // set a high number of max redirects (but not infinite amount) to avoid a potential infinite loop

		curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
		curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
		curl_setopt($ch, CURLOPT_URL, $url);
		curl_setopt($ch, CURLOPT_USERAGENT, 'Rainforest');
		$success = false;

		// query the site every second. Note that if the URL doesn't respond,
		// curl_exec will take 5 seconds to timeout (see CURLOPT_CONNECTTIMEOUT and CURLOPT_TIMEOUT above)
		do {
			if(time() > $start + $timeout) {
				$log->write(sprintf(' * Failed: check for %s timed out after %smin', $url, $timeout / 60));
				return false;
			}

			$response = curl_exec($ch);

			// check the HTTP response code for HTTP protocols
			$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
			if($status && !in_array($status, [500, 501, 502, 503, 504])) {
				$success = true;
			}

			// check for any curl errors, mostly for checking the response state of non-HTTP protocols,
			// but applies to checks of any protocol
			if($response && !curl_errno($ch)) {
				$success = true;
			}

			// Produce an informational ticker roughly every $tick
			if (time() > $infoTick) {
				$message = [];

				// Collect status information from different sources.
				if ($status) {
					$message[] = sprintf('HTTP status code is %s', $status);
				}
				if (!$response) {
					$message[] = 'response is empty';
				}
				if ($error = curl_error($ch)) {
					$message[] = sprintf('request error: %s', $error);
				}

				$log->write(sprintf(
					' * Still waiting: %s...',
					implode(', ', $message)
				));

				$infoTick = time() + $tick;
			}

			sleep(1);
		} while(!$success);

		curl_close($ch);
		$log->write(' * Success: site is accessible!');
		return true;
	}

}

Pull Request — master (#723)

CapistranoDeploymentBackend::setPackageGenerator() A

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

silverstripe / deploynaut

Pull Request — master (#723)

CapistranoDeploymentBackend::setPackageGenerator() A

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like
