silverstripe / deploynaut

code/model/jobs/DNCreateEnvironment.php

<?php

/**
 * DNCreateEnvironment
 *
 * @property string Data
 * @property string ResqueToken
 * @property string Status
 * @property bool IsInitialEnvironment
 *
 * @method DNProject Project()
 * @property int $ProjectID
 * @method Member Creator()
 * @property int $CreatorID
 */
class DNCreateEnvironment extends DataObject {

The property $has_one is not named in camelCase.

	/**
	 * @var array
	 */
	private static $db = array(
		'Data' => 'Text',
		'ResqueToken' => 'Varchar(255)',
		"Status" => "Enum('Queued, Started, Finished, Failed, n/a', 'n/a')",
		'IsInitialEnvironment' => 'Boolean',
	);

	/**
	 * @var array
	 */
	private static $has_one = array(
		'Project' => 'DNProject',
		'Creator' => 'Member'
	);

	/**
	 *
	 * @param int $int
	 * @return string
	 */
	public static function map_resque_status($int) {

This method seems to be duplicated in your project.

		$remap = array(
			Resque_Job_Status::STATUS_WAITING => "Queued",
			Resque_Job_Status::STATUS_RUNNING => "Running",
			Resque_Job_Status::STATUS_FAILED => "Failed",
			Resque_Job_Status::STATUS_COMPLETE => "Complete",
			false => "Invalid",
		);
		return $remap[$int];
	}

	/**
	 * @return string
	 */
	public function Name() {
		$data = unserialize($this->Data);
		return !empty($data['Name']) ? Convert::raw2xml($data['Name']) : '';
	}

	/**
	 * @return string
	 */
	public function Link() {
		return Controller::join_links($this->Project()->Link(), 'createenv', $this->ID);
	}

	/**
	 * @return string
	 */
	public function LogLink() {
		return $this->Link() . '/log';
	}

	/**
	 * @return boolean
	 */
	public function canView($member = null) {
		return $this->Project()->canView($member);
	}

	/**
	 * Return a path to the log file.
	 * @return string
	 */
	protected function logfile() {
		return sprintf(
			'%s.createenv.%s.log',
			$this->Project()->Name,
			$this->ID
		);
	}

	/**
	 * @return \DeploynautLogFile
	 */
	public function log() {
		return Injector::inst()->createWithArgs('DeploynautLogFile', array($this->logfile()));
	}

	public function LogContent() {
		return $this->log()->content();
	}

	/**
	 * Returns the status of the resque job
	 *
	 * @return string
	 */
	public function ResqueStatus() {

This method seems to be duplicated in your project.

		$status = new Resque_Job_Status($this->ResqueToken);

It seems like $this->ResqueToken can also be of type false; however, Resque_Job_Status::__construct() does only seem to accept string, did you maybe forget to handle an error condition?

		$statusCode = $status->get();
		// The Resque job can no longer be found, fallback to the DNDeployment.Status
		if($statusCode === false) {
			// Translate from the DNDeployment.Status to the Resque job status for UI purposes
			switch($this->Status) {
				case 'Finished':
					return 'Complete';
				case 'Started':
					return 'Running';
				default:
					return $this->Status;
			}
		}
		return self::map_resque_status($statusCode);
	}

	/**
	 * Start a resque job for this creation.
	 *
	 * @return string Resque token
	 */
	protected function enqueueCreation() {
		$project = $this->Project();
		$log = $this->log();

		$args = array(
			'createID' => $this->ID,
			'logfile' => $this->logfile(),
			'projectName' => $project->Name
		);

		if(!$this->CreatorID) {
			$this->CreatorID = Member::currentUserID();
		}

		if($this->CreatorID) {
			$creator = $this->Creator();
			$message = sprintf(
				'Environment creation for project %s initiated by %s (%s), with IP address %s',
				$project->Name,
				$creator->getName(),
				$creator->Email,
				Controller::curr()->getRequest()->getIP()
			);
			$log->write($message);
		}

		return Resque::enqueue('create', 'CreateEnvJob', $args, true);
	}

	public function start() {
		$log = $this->log();
		$token = $this->enqueueCreation();
		$this->ResqueToken = $token;
		$this->Status = 'Queued';
		$this->write();

		$message = sprintf('Environment creation queued as job %s', $token);
		$log->write($message);
	}

	public function createEnvironment() {
		$backend = $this->getBackend();
		if($backend) {
			return $backend->createEnvironment($this);
		}
		throw new Exception("Unable to find backend.");
	}

	/**
	 * Fetches the EnvironmentCreateBackend based on the EnvironmentType saved to this job.
	 *
	 * @return EnvironmentCreateBackend|null
	 * @throws Exception
	 */
	public function getBackend() {
		$data = unserialize($this->Data);
		if(isset($data['EnvironmentType']) && class_exists($data['EnvironmentType'])) {
			$env = Injector::inst()->get($data['EnvironmentType']);
			if($env instanceof EnvironmentCreateBackend) {
				return $env;
			} else {
				throw new Exception("Invalid backend: " . $data['EnvironmentType']);
			}
		}
		return null;
	}
}