silverstripe / deploynaut

code/api/DeploynautAPI.php

Indentation +137 added lines, -137 removed lines

@@ -16,141 +16,141 @@
 class DeploynautAPI extends APINoun
 {
 
-    /**
-     * Default URL handlers - (Action)/(ID)//(OtherID)
-     *
-     * @var array
-     */
-    private static $url_handlers = array(
-        '' => 'listProjects',
-        '$Project//fetch' => 'project',
-        '$Project/$Environment!' => 'environment',
-        '$Project/' => 'project',
-    );
-
-    /**
-     * @var array
-     */
-    public static $allowed_actions = array(
-        'project',
-        'environment',
-        'listProjects'
-    );
-
-    /**
-     * @var string
-     */
-    protected $link = 'deploynaut/api';
-
-    /**
-     * @param SS_HTTPRequest $request
-     * @return SS_HTTPResponse
-     */
-    public function listProjects(SS_HTTPRequest $request)
-    {
-        $response = array(
-            'href' => Director::absoluteURL($this->Link()),
-            'projects' => array(),
-        );
-
-        if ($request->httpMethod() != 'GET') {
-            return $this->message('API not found', 404);
-        }
-
-        foreach (DNProject::get() as $item) {
-            if ($item->canView($this->getMember())) {
-                $response['projects'][] = array(
-                    "name" => $item->Name,
-                    "href" => Director::absoluteURL($item->APILink("")),
-                );
-            }
-        }
-
-        return $this->getAPIResponse($response);
-    }
-
-    /**
-     * Controller Action
-     *
-     * @param SS_HTTPRequest $request
-     * @return APIProject
-     */
-    public function project(SS_HTTPRequest $request)
-    {
-        $project = $this->getProject();
-        if (!$project) {
-            return $this->project404Response();
-        }
-        return new APIProject($this, $project);
-    }
-
-    /**
-     * Controller Action
-     *
-     * @param SS_HTTPRequest $request
-     * @return APIEnvironment
-     */
-    public function environment(SS_HTTPRequest $request)
-    {
-        $project = $this->getProject();
-        if (!$project) {
-            return $this->project404Response();
-        }
-
-        $environment = $this->getEnvironment();
-        if (!$environment) {
-            return $this->environment404Response();
-        }
-        return new APIEnvironment($this, $environment);
-    }
-
-    /**
-     * @return SS_HTTPResponse
-     */
-    protected function project404Response()
-    {
-        $projectName = Convert::raw2xml($this->getRequest()->latestParam('Project'));
-        return new SS_HTTPResponse('Project "' . $projectName . '" not found.', 404);
-    }
-
-    /**
-     * @return SS_HTTPResponse
-     */
-    protected function environment404Response()
-    {
-        $envName = Convert::raw2xml($this->getRequest()->latestParam('Environment'));
-        return new SS_HTTPResponse('Environment "' . $envName . '" not found.', 404);
-    }
-
-    /**
-     * Get project from URL
-     *
-     * @return DNProject
-     */
-    protected function getProject()
-    {
-        $projectName = $this->getRequest()->param('Project');
-        return DNProject::get()->filter('Name', $projectName)->first();
-    }
-
-    /**
-     * Get environment from URL
-     *
-     * @return DNEnvironment
-     */
-    protected function getEnvironment()
-    {
-        $projectName = $this->getRequest()->param('Project');
-        $project = DNProject::get()->filter('Name', $projectName)->first();
-        $environmentName = $this->getRequest()->param('Environment');
-        return $project->Environments()->filter('Name', $environmentName)->first();
-    }
-
-    /**
-     * @return string
-     */
-    public function Link()
-    {
-        return 'naut/api';
-    }
+	/**
+	 * Default URL handlers - (Action)/(ID)//(OtherID)
+	 *
+	 * @var array
+	 */
+	private static $url_handlers = array(
+		'' => 'listProjects',
+		'$Project//fetch' => 'project',
+		'$Project/$Environment!' => 'environment',
+		'$Project/' => 'project',
+	);
+
+	/**
+	 * @var array
+	 */
+	public static $allowed_actions = array(
+		'project',
+		'environment',
+		'listProjects'
+	);
+
+	/**
+	 * @var string
+	 */
+	protected $link = 'deploynaut/api';
+
+	/**
+	 * @param SS_HTTPRequest $request
+	 * @return SS_HTTPResponse
+	 */
+	public function listProjects(SS_HTTPRequest $request)
+	{
+		$response = array(
+			'href' => Director::absoluteURL($this->Link()),
+			'projects' => array(),
+		);
+
+		if ($request->httpMethod() != 'GET') {
+			return $this->message('API not found', 404);
+		}
+
+		foreach (DNProject::get() as $item) {
+			if ($item->canView($this->getMember())) {
+				$response['projects'][] = array(
+					"name" => $item->Name,
+					"href" => Director::absoluteURL($item->APILink("")),
+				);
+			}
+		}
+
+		return $this->getAPIResponse($response);
+	}
+
+	/**
+	 * Controller Action
+	 *
+	 * @param SS_HTTPRequest $request
+	 * @return APIProject
+	 */
+	public function project(SS_HTTPRequest $request)
+	{
+		$project = $this->getProject();
+		if (!$project) {
+			return $this->project404Response();
+		}
+		return new APIProject($this, $project);
+	}
+
+	/**
+	 * Controller Action
+	 *
+	 * @param SS_HTTPRequest $request
+	 * @return APIEnvironment
+	 */
+	public function environment(SS_HTTPRequest $request)
+	{
+		$project = $this->getProject();
+		if (!$project) {
+			return $this->project404Response();
+		}
+
+		$environment = $this->getEnvironment();
+		if (!$environment) {
+			return $this->environment404Response();
+		}
+		return new APIEnvironment($this, $environment);
+	}
+
+	/**
+	 * @return SS_HTTPResponse
+	 */
+	protected function project404Response()
+	{
+		$projectName = Convert::raw2xml($this->getRequest()->latestParam('Project'));
+		return new SS_HTTPResponse('Project "' . $projectName . '" not found.', 404);
+	}
+
+	/**
+	 * @return SS_HTTPResponse
+	 */
+	protected function environment404Response()
+	{
+		$envName = Convert::raw2xml($this->getRequest()->latestParam('Environment'));
+		return new SS_HTTPResponse('Environment "' . $envName . '" not found.', 404);
+	}
+
+	/**
+	 * Get project from URL
+	 *
+	 * @return DNProject
+	 */
+	protected function getProject()
+	{
+		$projectName = $this->getRequest()->param('Project');
+		return DNProject::get()->filter('Name', $projectName)->first();
+	}
+
+	/**
+	 * Get environment from URL
+	 *
+	 * @return DNEnvironment
+	 */
+	protected function getEnvironment()
+	{
+		$projectName = $this->getRequest()->param('Project');
+		$project = DNProject::get()->filter('Name', $projectName)->first();
+		$environmentName = $this->getRequest()->param('Environment');
+		return $project->Environments()->filter('Name', $environmentName)->first();
+	}
+
+	/**
+	 * @return string
+	 */
+	public function Link()
+	{
+		return 'naut/api';
+	}
 }

code/api/nouns/APIEnvironment.php

Indentation +198 added lines, -198 removed lines

@@ -3,202 +3,202 @@
 class APIEnvironment extends APINoun
 {
 
-    /**
-     * @var array
-     */
-    private static $allowed_actions = array(
-        'ping',
-        'deploy'
-    );
-
-    /**
-     * @param SS_HTTPRequest $request
-     * @return SS_HTTPResponse
-     */
-    public function index(SS_HTTPRequest $request)
-    {
-        if (!$this->record->canView($this->getMember())) {
-            return $this->message('You are not authorized to view this environment', 403);
-        }
-        switch ($request->httpMethod()) {
-            case 'GET':
-                $href = Director::absoluteURL($this->record->Project()->APILink($this->record->Name));
-                return $this->getAPIResponse(array(
-                    "name" => $this->record->Name,
-                    "project" => $this->record->Project()->Name,
-                    "href" => $href,
-                    "created" => $this->record->Created,
-                    "last-edited" => $this->record->LastEdited,
-
-                    // Stolen from https://github.com/kevinswiber/siren spec
-                    "actions" => array(
-                        array(
-                            "name" => "deploy",
-                            "method" =>  "POST",
-                            "href" => "$href/deploy",
-                            "type" => "application/json",
-                            "fields" => array(
-                                array("name" => "release", "type" => "text"),
-                            ),
-                        )
-                    )
-                ));
-            default:
-                return $this->message('API not found', 404);
-        }
-    }
-
-    /**
-     * @param SS_HTTPRequest $request
-     * @return SS_HTTPResponse
-     */
-    public function ping(SS_HTTPRequest $request)
-    {
-        if (!$this->record->canView($this->getMember())) {
-            return $this->message('You are not authorized to do that on this environment', 403);
-        }
-        switch ($request->httpMethod()) {
-            case 'GET':
-                return $this->getPing($this->getRequest()->param('ID'));
-            case 'POST':
-                return $this->createPing();
-            default:
-                return $this->message('API not found', 404);
-        }
-    }
-
-    /**
-     * @param SS_HTTPRequest $request
-     * @return SS_HTTPResponse
-     */
-    public function deploy(SS_HTTPRequest $request)
-    {
-        if (!$this->record->canView($this->getMember())) {
-            return $this->message('You are not authorized to do that on this environment', 403);
-        }
-        switch ($request->httpMethod()) {
-            case 'GET':
-                return $this->getDeploy($this->getRequest()->param('ID'));
-            case 'POST':
-                return $this->createDeploy();
-            default:
-                return $this->message('API not found', 404);
-        }
-    }
-
-    /**
-     * @return string
-     */
-    public function Link()
-    {
-        return Controller::join_links(
-            $this->parent->Link(),
-            $this->record->Project()->Name,
-            $this->record->Name
-        );
-    }
-
-    /**
-     * @return SS_HTTPResponse
-     */
-    protected function showRecord()
-    {
-        return $this->getAPIResponse($this->record->toMap());
-    }
-
-    /**
-     * @return SS_HTTPResponse
-     */
-    protected function createPing()
-    {
-        if (!$this->record->canDeploy($this->getMember())) {
-            return $this->message('You are not authorized to do that on this environment', 403);
-        }
-        $ping = DNPing::create();
-        $ping->EnvironmentID = $this->record->ID;
-        $ping->write();
-        $ping->start();
-
-        $location = Director::absoluteBaseURL() . $this->Link() . '/ping/' . $ping->ID;
-        $output = array(
-            'message' => 'Ping queued as job ' . $ping->ResqueToken,
-            'href' => $location,
-        );
-
-        $response = $this->getAPIResponse($output);
-        $response->setStatusCode(201);
-        $response->addHeader('Location', $location);
-        return $response;
-    }
-
-    /**
-     * @param int $ID
-     * @return SS_HTTPResponse
-     */
-    protected function getPing($ID)
-    {
-        $ping = DNPing::get()->byID($ID);
-        if (!$ping) {
-            return $this->message('Ping not found', 404);
-        }
-        $output = array(
-            'status' => $ping->ResqueStatus(),
-            'message' => $ping->LogContent()
-        );
-
-        return $this->getAPIResponse($output);
-    }
-
-    /**
-     * @return SS_HTTPResponse
-     */
-    protected function createDeploy()
-    {
-        if (!$this->record->canDeploy($this->getMember())) {
-            return $this->message('You are not authorized to do that on this environment', 403);
-        }
-
-        $reqBody = $this->getRequestBody();
-
-        if ($reqBody === null) {
-            return $this->message('the request body did not contain a valid JSON object.', 400);
-        }
-
-        if (empty($reqBody['release'])) {
-            return $this->message('deploy requires a {"release": "sha1"} in the body of the request.', 400);
-        }
-
-        $strategy = new DeploymentStrategy($this->record, array(
-            'sha' => $reqBody['release']
-        ));
-        $deploy = $strategy->createDeployment();
-        $deploy->start();
-        $location = Director::absoluteBaseURL() . $this->Link() . '/deploy/' . $deploy->ID;
-        $output = array(
-            'message' => 'Deploy queued as job ' . $deploy->ResqueToken,
-            'href' => $location,
-        );
-        $response = $this->getAPIResponse($output);
-        $response->setStatusCode(201);
-        $response->addHeader('Location', $location);
-        return $response;
-    }
-
-    /**
-     * @param int $id
-     * @return SS_HTTPResponse
-     */
-    protected function getDeploy($id)
-    {
-        $deploy = DNDeployment::get()->byID($id);
-        if (!$deploy) {
-            return $this->message('Deploy not found', 404);
-        }
-        $output = array(
-            'status' => $deploy->ResqueStatus(),
-            'message' => $deploy->LogContent()
-        );
-
-        return $this->getAPIResponse($output);
-    }
+	/**
+	 * @var array
+	 */
+	private static $allowed_actions = array(
+		'ping',
+		'deploy'
+	);
+
+	/**
+	 * @param SS_HTTPRequest $request
+	 * @return SS_HTTPResponse
+	 */
+	public function index(SS_HTTPRequest $request)
+	{
+		if (!$this->record->canView($this->getMember())) {
+			return $this->message('You are not authorized to view this environment', 403);
+		}
+		switch ($request->httpMethod()) {
+			case 'GET':
+				$href = Director::absoluteURL($this->record->Project()->APILink($this->record->Name));
+				return $this->getAPIResponse(array(
+					"name" => $this->record->Name,
+					"project" => $this->record->Project()->Name,
+					"href" => $href,
+					"created" => $this->record->Created,
+					"last-edited" => $this->record->LastEdited,
+
+					// Stolen from https://github.com/kevinswiber/siren spec
+					"actions" => array(
+						array(
+							"name" => "deploy",
+							"method" =>  "POST",
+							"href" => "$href/deploy",
+							"type" => "application/json",
+							"fields" => array(
+								array("name" => "release", "type" => "text"),
+							),
+						)
+					)
+				));
+			default:
+				return $this->message('API not found', 404);
+		}
+	}
+
+	/**
+	 * @param SS_HTTPRequest $request
+	 * @return SS_HTTPResponse
+	 */
+	public function ping(SS_HTTPRequest $request)
+	{
+		if (!$this->record->canView($this->getMember())) {
+			return $this->message('You are not authorized to do that on this environment', 403);
+		}
+		switch ($request->httpMethod()) {
+			case 'GET':
+				return $this->getPing($this->getRequest()->param('ID'));
+			case 'POST':
+				return $this->createPing();
+			default:
+				return $this->message('API not found', 404);
+		}
+	}
+
+	/**
+	 * @param SS_HTTPRequest $request
+	 * @return SS_HTTPResponse
+	 */
+	public function deploy(SS_HTTPRequest $request)
+	{
+		if (!$this->record->canView($this->getMember())) {
+			return $this->message('You are not authorized to do that on this environment', 403);
+		}
+		switch ($request->httpMethod()) {
+			case 'GET':
+				return $this->getDeploy($this->getRequest()->param('ID'));
+			case 'POST':
+				return $this->createDeploy();
+			default:
+				return $this->message('API not found', 404);
+		}
+	}
+
+	/**
+	 * @return string
+	 */
+	public function Link()
+	{
+		return Controller::join_links(
+			$this->parent->Link(),
+			$this->record->Project()->Name,
+			$this->record->Name
+		);
+	}
+
+	/**
+	 * @return SS_HTTPResponse
+	 */
+	protected function showRecord()
+	{
+		return $this->getAPIResponse($this->record->toMap());
+	}
+
+	/**
+	 * @return SS_HTTPResponse
+	 */
+	protected function createPing()
+	{
+		if (!$this->record->canDeploy($this->getMember())) {
+			return $this->message('You are not authorized to do that on this environment', 403);
+		}
+		$ping = DNPing::create();
+		$ping->EnvironmentID = $this->record->ID;
+		$ping->write();
+		$ping->start();
+
+		$location = Director::absoluteBaseURL() . $this->Link() . '/ping/' . $ping->ID;
+		$output = array(
+			'message' => 'Ping queued as job ' . $ping->ResqueToken,
+			'href' => $location,
+		);
+
+		$response = $this->getAPIResponse($output);
+		$response->setStatusCode(201);
+		$response->addHeader('Location', $location);
+		return $response;
+	}
+
+	/**
+	 * @param int $ID
+	 * @return SS_HTTPResponse
+	 */
+	protected function getPing($ID)
+	{
+		$ping = DNPing::get()->byID($ID);
+		if (!$ping) {
+			return $this->message('Ping not found', 404);
+		}
+		$output = array(
+			'status' => $ping->ResqueStatus(),
+			'message' => $ping->LogContent()
+		);
+
+		return $this->getAPIResponse($output);
+	}
+
+	/**
+	 * @return SS_HTTPResponse
+	 */
+	protected function createDeploy()
+	{
+		if (!$this->record->canDeploy($this->getMember())) {
+			return $this->message('You are not authorized to do that on this environment', 403);
+		}
+
+		$reqBody = $this->getRequestBody();
+
+		if ($reqBody === null) {
+			return $this->message('the request body did not contain a valid JSON object.', 400);
+		}
+
+		if (empty($reqBody['release'])) {
+			return $this->message('deploy requires a {"release": "sha1"} in the body of the request.', 400);
+		}
+
+		$strategy = new DeploymentStrategy($this->record, array(
+			'sha' => $reqBody['release']
+		));
+		$deploy = $strategy->createDeployment();
+		$deploy->start();
+		$location = Director::absoluteBaseURL() . $this->Link() . '/deploy/' . $deploy->ID;
+		$output = array(
+			'message' => 'Deploy queued as job ' . $deploy->ResqueToken,
+			'href' => $location,
+		);
+		$response = $this->getAPIResponse($output);
+		$response->setStatusCode(201);
+		$response->addHeader('Location', $location);
+		return $response;
+	}
+
+	/**
+	 * @param int $id
+	 * @return SS_HTTPResponse
+	 */
+	protected function getDeploy($id)
+	{
+		$deploy = DNDeployment::get()->byID($id);
+		if (!$deploy) {
+			return $this->message('Deploy not found', 404);
+		}
+		$output = array(
+			'status' => $deploy->ResqueStatus(),
+			'message' => $deploy->LogContent()
+		);
+
+		return $this->getAPIResponse($output);
+	}
 }

code/api/nouns/APINoun.php

Indentation +114 added lines, -114 removed lines

@@ -1,131 +1,131 @@
 <?php
 /**
- * Base class for the APINouns
- */
+	 * Base class for the APINouns
+	 */
 class APINoun extends Controller
 {
 
-    /**
-     * @var controller
-     */
-    protected $parent = null;
+	/**
+	 * @var controller
+	 */
+	protected $parent = null;
 
-    /**
-     * @var DataObject
-     */
-    protected $record = null;
+	/**
+	 * @var DataObject
+	 */
+	protected $record = null;
 
-    /**
-     * @var Member
-     */
-    protected $member = null;
+	/**
+	 * @var Member
+	 */
+	protected $member = null;
 
-    /**
-     * Holds the url segment for this admin
-     *
-     * @param Controller|null $parent
-     * @param DataObject|null $record
-     */
-    public function __construct(\Controller $parent = null, DataObject $record = null)
-    {
-        $this->record = $record;
-        $this->parent = $parent;
-        parent::__construct();
-    }
+	/**
+	 * Holds the url segment for this admin
+	 *
+	 * @param Controller|null $parent
+	 * @param DataObject|null $record
+	 */
+	public function __construct(\Controller $parent = null, DataObject $record = null)
+	{
+		$this->record = $record;
+		$this->parent = $parent;
+		parent::__construct();
+	}
 
-    /**
-     * Enable basic auth on the API
-     */
-    public function init()
-    {
-        $this->member = BasicAuth::requireLogin('Deploynaut API');
-        parent::init();
-    }
+	/**
+	 * Enable basic auth on the API
+	 */
+	public function init()
+	{
+		$this->member = BasicAuth::requireLogin('Deploynaut API');
+		parent::init();
+	}
 
-    /**
-     * @return DataObject
-     */
-    public function getRecord()
-    {
-        return $this->record;
-    }
+	/**
+	 * @return DataObject
+	 */
+	public function getRecord()
+	{
+		return $this->record;
+	}
 
-    /**
-     * @return Member
-     */
-    public function getMember()
-    {
-        return $this->member;
-    }
+	/**
+	 * @return Member
+	 */
+	public function getMember()
+	{
+		return $this->member;
+	}
 
-    /**
-     * @param array $output
-     * @return SS_HTTPResponse
-     */
-    protected function getAPIResponse($output)
-    {
-        $response = $this->getResponse();
-        if ($this->respondWithText()) {
-            $body = print_r($output, true);
-            $response->addHeader('Content-Type', 'text/plain');
-        } else {
-            $body = Convert::raw2json($output);
-            $response->addHeader('Content-Type', 'application/json');
-        }
-        $response->setBody($body);
-        return $response;
-    }
+	/**
+	 * @param array $output
+	 * @return SS_HTTPResponse
+	 */
+	protected function getAPIResponse($output)
+	{
+		$response = $this->getResponse();
+		if ($this->respondWithText()) {
+			$body = print_r($output, true);
+			$response->addHeader('Content-Type', 'text/plain');
+		} else {
+			$body = Convert::raw2json($output);
+			$response->addHeader('Content-Type', 'application/json');
+		}
+		$response->setBody($body);
+		return $response;
+	}
 
-    /**
-     * @return boolean
-     */
-    protected function respondWithJSON()
-    {
-        if ($this->getRequest()->getExtension() == 'json') {
-            return true;
-        }
-        if (strpos($this->getRequest()->getHeader('Accept'), 'application/json') !== false) {
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * @return boolean
+	 */
+	protected function respondWithJSON()
+	{
+		if ($this->getRequest()->getExtension() == 'json') {
+			return true;
+		}
+		if (strpos($this->getRequest()->getHeader('Accept'), 'application/json') !== false) {
+			return true;
+		}
+		return false;
+	}
 
-    /**
-     * @return boolean
-     */
-    protected function respondWithText()
-    {
-        if ($this->getRequest()->getExtension() == 'txt') {
-            return true;
-        }
-        if (strpos($this->getRequest()->getHeader('Accept'), 'text/plain') !== false) {
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * @return boolean
+	 */
+	protected function respondWithText()
+	{
+		if ($this->getRequest()->getExtension() == 'txt') {
+			return true;
+		}
+		if (strpos($this->getRequest()->getHeader('Accept'), 'text/plain') !== false) {
+			return true;
+		}
+		return false;
+	}
 
-    /**
-     * @return array|null
-     */
-    protected function getRequestBody()
-    {
-        return Convert::json2array($this->getRequest()->getBody());
-    }
+	/**
+	 * @return array|null
+	 */
+	protected function getRequestBody()
+	{
+		return Convert::json2array($this->getRequest()->getBody());
+	}
 
-    /**
-     * Return a simple response with a message
-     *
-     * @param string $message
-     * @param int $statusCode
-     * @return SS_HTTPResponse
-     */
-    protected function message($message, $statusCode)
-    {
-        $response = $this->getAPIResponse(array(
-            'message' => $message,
-            'statusCode' => $statusCode
-        ));
-        $response->setStatusCode($statusCode);
-        return $response;
-    }
+	/**
+	 * Return a simple response with a message
+	 *
+	 * @param string $message
+	 * @param int $statusCode
+	 * @return SS_HTTPResponse
+	 */
+	protected function message($message, $statusCode)
+	{
+		$response = $this->getAPIResponse(array(
+			'message' => $message,
+			'statusCode' => $statusCode
+		));
+		$response->setStatusCode($statusCode);
+		return $response;
+	}
 }

code/api/nouns/APIProject.php

Indentation +101 added lines, -101 removed lines

@@ -3,115 +3,115 @@
 class APIProject extends APINoun
 {
 
-    /**
-     * @var array
-     */
-    private static $allowed_actions = array(
-        'index',
-        'fetch'
-    );
+	/**
+	 * @var array
+	 */
+	private static $allowed_actions = array(
+		'index',
+		'fetch'
+	);
 
-    /**
-     * @param SS_HTTPRequest $request
-     * @return SS_HTTPResponse
-     */
-    public function index(SS_HTTPRequest $request)
-    {
-        if (!$this->record->canView($this->getMember())) {
-            return $this->message('You are not authorized to this environment', 403);
-        }
+	/**
+	 * @param SS_HTTPRequest $request
+	 * @return SS_HTTPResponse
+	 */
+	public function index(SS_HTTPRequest $request)
+	{
+		if (!$this->record->canView($this->getMember())) {
+			return $this->message('You are not authorized to this environment', 403);
+		}
 
-        switch ($request->httpMethod()) {
-            case 'GET':
-                $response = array(
-                    "name" => $this->record->Name,
-                    "href" => Director::absoluteURL($this->record->APILink("")),
-                    "created" => $this->record->Created,
-                    "last-edited" => $this->record->LastEdited,
-                    "disk-quota-mb" => $this->record->DiskQuotaMB,
-                    "environments" => array(),
-                );
-                foreach ($this->record->DNEnvironmentList() as $environment) {
-                    $response['environments'][] = array(
-                        'name' => $environment->Name,
-                        'href' => Director::absoluteURL($this->record->APILink($environment->Name)),
-                    );
-                }
+		switch ($request->httpMethod()) {
+			case 'GET':
+				$response = array(
+					"name" => $this->record->Name,
+					"href" => Director::absoluteURL($this->record->APILink("")),
+					"created" => $this->record->Created,
+					"last-edited" => $this->record->LastEdited,
+					"disk-quota-mb" => $this->record->DiskQuotaMB,
+					"environments" => array(),
+				);
+				foreach ($this->record->DNEnvironmentList() as $environment) {
+					$response['environments'][] = array(
+						'name' => $environment->Name,
+						'href' => Director::absoluteURL($this->record->APILink($environment->Name)),
+					);
+				}
 
-                return $this->getAPIResponse($response);
-            default:
-                return $this->message('API not found', 404);
-        }
-    }
+				return $this->getAPIResponse($response);
+			default:
+				return $this->message('API not found', 404);
+		}
+	}
 
-    /**
-     * @param SS_HTTPRequest $request
-     * @return SS_HTTPResponse
-     */
-    public function fetch(SS_HTTPRequest $request)
-    {
-        if (!$this->record->canView($this->getMember())) {
-            return $this->message('You are not authorized to do that on this environment', 403);
-        }
-        switch ($request->httpMethod()) {
-            case 'GET':
-                return $this->getFetch($this->getRequest()->param('ID'));
-            case 'POST':
-                return $this->createFetch();
-            default:
-                return $this->message('API not found', 404);
-        }
-    }
+	/**
+	 * @param SS_HTTPRequest $request
+	 * @return SS_HTTPResponse
+	 */
+	public function fetch(SS_HTTPRequest $request)
+	{
+		if (!$this->record->canView($this->getMember())) {
+			return $this->message('You are not authorized to do that on this environment', 403);
+		}
+		switch ($request->httpMethod()) {
+			case 'GET':
+				return $this->getFetch($this->getRequest()->param('ID'));
+			case 'POST':
+				return $this->createFetch();
+			default:
+				return $this->message('API not found', 404);
+		}
+	}
 
-    /**
-     * @param int $ID
-     * @return SS_HTTPResponse
-     */
-    protected function getFetch($ID)
-    {
-        $ping = DNGitFetch::get()->byID($ID);
-        if (!$ping) {
-            return $this->message('Fetch not found', 404);
-        }
-        $output = array(
-            'status' => $ping->ResqueStatus(),
-            'message' => $ping->LogContent()
-        );
+	/**
+	 * @param int $ID
+	 * @return SS_HTTPResponse
+	 */
+	protected function getFetch($ID)
+	{
+		$ping = DNGitFetch::get()->byID($ID);
+		if (!$ping) {
+			return $this->message('Fetch not found', 404);
+		}
+		$output = array(
+			'status' => $ping->ResqueStatus(),
+			'message' => $ping->LogContent()
+		);
 
-        return $this->getAPIResponse($output);
-    }
+		return $this->getAPIResponse($output);
+	}
 
-    /**
-     * @return SS_HTTPResponse
-     */
-    protected function createFetch()
-    {
-        /** @var DNGitFetch $fetch */
-        $fetch = DNGitFetch::create();
-        $fetch->ProjectID = $this->record->ID;
-        $fetch->write();
-        $fetch->start();
+	/**
+	 * @return SS_HTTPResponse
+	 */
+	protected function createFetch()
+	{
+		/** @var DNGitFetch $fetch */
+		$fetch = DNGitFetch::create();
+		$fetch->ProjectID = $this->record->ID;
+		$fetch->write();
+		$fetch->start();
 
-        $location = Director::absoluteBaseURL() . $this->Link() . '/fetch/' . $fetch->ID;
-        $output = array(
-            'message' => 'Fetch queued as job ' . $fetch->ResqueToken,
-            'href' => $location,
-        );
+		$location = Director::absoluteBaseURL() . $this->Link() . '/fetch/' . $fetch->ID;
+		$output = array(
+			'message' => 'Fetch queued as job ' . $fetch->ResqueToken,
+			'href' => $location,
+		);
 
-        $response = $this->getAPIResponse($output);
-        $response->setStatusCode(201);
-        $response->addHeader('Location', $location);
-        return $response;
-    }
+		$response = $this->getAPIResponse($output);
+		$response->setStatusCode(201);
+		$response->addHeader('Location', $location);
+		return $response;
+	}
 
-    /**
-     * @return string
-     */
-    public function Link()
-    {
-        return Controller::join_links(
-            $this->parent->Link(),
-            $this->record->Name
-        );
-    }
+	/**
+	 * @return string
+	 */
+	public function Link()
+	{
+		return Controller::join_links(
+			$this->parent->Link(),
+			$this->record->Name
+		);
+	}
 }

code/backends/CapistranoDeploymentBackend.php

Indentation +423 added lines, -423 removed lines

@@ -4,427 +4,427 @@
 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) {
-            $command = $self->getCommand('deploy:cleanup', 'web', $environment, $args, $log);
-            $command->run(function ($type, $buffer) use ($log) {
-                $log->write($buffer);
-            });
-
-            if (!$command->isSuccessful()) {
-                $this->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
-        if (!empty($options['leaveMaintenancePage'])) {
-            $this->enableMaintenance($environment, $log, $project);
-        }
-
-        if (!$command->isSuccessful()) {
-            $cleanupFn();
-            $this->extend('deployFailure', $environment, $sha, $log, $project);
-            throw new RuntimeException($command->getErrorOutput());
-        }
-
-        // Check if maintenance page should be removed
-        if (empty($options['leaveMaintenancePage'])) {
-            $this->disableMaintenance($environment, $log, $project);
-        }
-
-        $cleanupFn();
-
-        $log->write(sprintf('Deploy of "%s" to "%s" finished', $sha, $name));
-
-        $this->extend('deployEnd', $environment, $sha, $log, $project);
-    }
-
-    /**
-     * 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 Process(sprintf('rm -rf %s', escapeshellarg($workingDir)));
-                $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 . '/');
-
-        // 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 Process($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';
-
-        // 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));
-        }
-
-        $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 Process(sprintf('rm -rf %s/assets && rm -f %s', $filepathBase, $databasePath));
-        $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 Process(sprintf('rm -rf %s', escapeshellarg($workingDir)));
-            $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();
-    }
+	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) {
+			$command = $self->getCommand('deploy:cleanup', 'web', $environment, $args, $log);
+			$command->run(function ($type, $buffer) use ($log) {
+				$log->write($buffer);
+			});
+
+			if (!$command->isSuccessful()) {
+				$this->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
+		if (!empty($options['leaveMaintenancePage'])) {
+			$this->enableMaintenance($environment, $log, $project);
+		}
+
+		if (!$command->isSuccessful()) {
+			$cleanupFn();
+			$this->extend('deployFailure', $environment, $sha, $log, $project);
+			throw new RuntimeException($command->getErrorOutput());
+		}
+
+		// Check if maintenance page should be removed
+		if (empty($options['leaveMaintenancePage'])) {
+			$this->disableMaintenance($environment, $log, $project);
+		}
+
+		$cleanupFn();
+
+		$log->write(sprintf('Deploy of "%s" to "%s" finished', $sha, $name));
+
+		$this->extend('deployEnd', $environment, $sha, $log, $project);
+	}
+
+	/**
+	 * 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 Process(sprintf('rm -rf %s', escapeshellarg($workingDir)));
+				$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 . '/');
+
+		// 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 Process($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';
+
+		// 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));
+		}
+
+		$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 Process(sprintf('rm -rf %s/assets && rm -f %s', $filepathBase, $databasePath));
+		$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 Process(sprintf('rm -rf %s', escapeshellarg($workingDir)));
+			$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();
+	}
 }

code/backends/DemoDeploymentBackend.php

Indentation +67 added lines, -67 removed lines

@@ -10,82 +10,82 @@
 class DemoDeploymentBackend extends Object implements DeploymentBackend
 {
 
-    /**
-     * Create a deployment strategy.
-     *
-     * @param DNEnvironment $environment
-     * @param array $options
-     *
-     * @return DeploymentStrategy
-     */
-    public function planDeploy(DNEnvironment $environment, $options = array())
-    {
-        return new DeploymentStrategy($environment, $options);
-    }
+	/**
+	 * Create a deployment strategy.
+	 *
+	 * @param DNEnvironment $environment
+	 * @param array $options
+	 *
+	 * @return DeploymentStrategy
+	 */
+	public function planDeploy(DNEnvironment $environment, $options = array())
+	{
+		return new DeploymentStrategy($environment, $options);
+	}
 
-    /**
-     * 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
-    ) {
-        $sha = $options['sha'];
+	/**
+	 * 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
+	) {
+		$sha = $options['sha'];
 
-        $this->extend('deployStart', $environment, $sha, $log, $project);
+		$this->extend('deployStart', $environment, $sha, $log, $project);
 
-        $file = sprintf('%s/%s.deploy-history.txt', DEPLOYNAUT_LOG_PATH, $environment->getFullName());
-        $CLI_file = escapeshellarg($file);
-        $CLI_line = escapeshellarg(date('Y-m-d H:i:s') . " => $sha");
+		$file = sprintf('%s/%s.deploy-history.txt', DEPLOYNAUT_LOG_PATH, $environment->getFullName());
+		$CLI_file = escapeshellarg($file);
+		$CLI_line = escapeshellarg(date('Y-m-d H:i:s') . " => $sha");
 
-        // Put maintenance page up
-        $this->enableMaintenance($environment, $log, $project);
+		// Put maintenance page up
+		$this->enableMaintenance($environment, $log, $project);
 
-        // Do the deployment
-        $log->write("Demo deployment: echo $CLI_line >> $CLI_file");
-        `echo $CLI_line >> $CLI_file`;
-        $log->write("Arbitrary pause for 10s");
-        sleep(10);
-        $log->write("Well, that was a waste of time");
+		// Do the deployment
+		$log->write("Demo deployment: echo $CLI_line >> $CLI_file");
+		`echo $CLI_line >> $CLI_file`;
+		$log->write("Arbitrary pause for 10s");
+		sleep(10);
+		$log->write("Well, that was a waste of time");
 
-        // Once the deployment has run it's necessary to update the maintenance page status
-        if (!empty($options['leaveMaintenancePage'])) {
-            $this->enableMaintenance($environment, $log, $project);
-        } else {
-            // Remove maintenance page if we want it to
-            $this->disableMaintenance($environment, $log, $project);
-        }
+		// Once the deployment has run it's necessary to update the maintenance page status
+		if (!empty($options['leaveMaintenancePage'])) {
+			$this->enableMaintenance($environment, $log, $project);
+		} else {
+			// Remove maintenance page if we want it to
+			$this->disableMaintenance($environment, $log, $project);
+		}
 
-        $this->extend('deployEnd', $environment, $sha, $log, $project);
-    }
+		$this->extend('deployEnd', $environment, $sha, $log, $project);
+	}
 
-    /**
-     * @inheritdoc
-     */
-    public function dataTransfer(DNDataTransfer $dataTransfer, DeploynautLogFile $log)
-    {
-        die('Not implemented');
-    }
+	/**
+	 * @inheritdoc
+	 */
+	public function dataTransfer(DNDataTransfer $dataTransfer, DeploynautLogFile $log)
+	{
+		die('Not implemented');
+	}
 
-    public function enableMaintenance(DNEnvironment $environment, \DeploynautLogFile $log, DNProject $project)
-    {
-        $log->write(sprintf('Maintenance page enabled on "%s"', $environment->getFullName()));
-    }
+	public function enableMaintenance(DNEnvironment $environment, \DeploynautLogFile $log, DNProject $project)
+	{
+		$log->write(sprintf('Maintenance page enabled on "%s"', $environment->getFullName()));
+	}
 
-    public function disableMaintenance(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project)
-    {
-        $log->write(sprintf('Maintenance page disabled on "%s"', $environment->getFullName()));
-    }
+	public function disableMaintenance(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project)
+	{
+		$log->write(sprintf('Maintenance page disabled on "%s"', $environment->getFullName()));
+	}
 
-    public function ping(\DNEnvironment $environment, DeploynautLogFile $log, DNProject $project)
-    {
-        $log->write(sprintf('Ping "%s"', $environment->getFullName()));
-    }
+	public function ping(\DNEnvironment $environment, DeploynautLogFile $log, DNProject $project)
+	{
+		$log->write(sprintf('Ping "%s"', $environment->getFullName()));
+	}
 }

code/backends/DeploymentBackend.php

Indentation +55 added lines, -55 removed lines

@@ -3,64 +3,64 @@
 interface DeploymentBackend
 {
 
-    /**
-     * Creates a deployment strategy that can be used to do some pre-flight checks.
-     *
-     * @param DNEnvironment $environment
-     * @param array $options An unsanitised array of request parameters from $request->requestVars.
-     *
-     * @return DeploymentStrategy
-     */
-    public function planDeploy(DNEnvironment $environment, $options);
+	/**
+	 * Creates a deployment strategy that can be used to do some pre-flight checks.
+	 *
+	 * @param DNEnvironment $environment
+	 * @param array $options An unsanitised array of request parameters from $request->requestVars.
+	 *
+	 * @return DeploymentStrategy
+	 */
+	public function planDeploy(DNEnvironment $environment, $options);
 
-    /**
-     * 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
-    );
+	/**
+	 * 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
+	);
 
-    /**
-     * Transfer data from an environment to a local file, or from a local file
-     * back into an environment. See {@link DNDataTransfer} for details.
-     *
-     * @param DNDataTransfer $dataTransfer
-     * @param DeploynautLogFile $log
-     */
-    public function dataTransfer(DNDataTransfer $dataTransfer, DeploynautLogFile $log);
+	/**
+	 * Transfer data from an environment to a local file, or from a local file
+	 * back into an environment. See {@link DNDataTransfer} for details.
+	 *
+	 * @param DNDataTransfer $dataTransfer
+	 * @param DeploynautLogFile $log
+	 */
+	public function dataTransfer(DNDataTransfer $dataTransfer, DeploynautLogFile $log);
 
-    /**
-     * Put put the maintenance page
-     *
-     * @param DNEnvironment $environment
-     * @param DeploynautLogFile $log
-     * @param DNProject $project
-     */
-    public function enableMaintenance(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project);
+	/**
+	 * Put put the maintenance page
+	 *
+	 * @param DNEnvironment $environment
+	 * @param DeploynautLogFile $log
+	 * @param DNProject $project
+	 */
+	public function enableMaintenance(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project);
 
-    /**
-     * Disable the maintenance page
-     *
-     * @param DNEnvironment $environment
-     * @param DeploynautLogFile $log
-     * @param DNProject $project
-     */
-    public function disableMaintenance(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project);
+	/**
+	 * Disable the maintenance page
+	 *
+	 * @param DNEnvironment $environment
+	 * @param DeploynautLogFile $log
+	 * @param DNProject $project
+	 */
+	public function disableMaintenance(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project);
 
-    /**
-     * Checks the status of the environment
-     *
-     * @param DNEnvironment $environment
-     * @param DeploynautLogFile $log
-     * @param DNProject $project
-     */
-    public function ping(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project);
+	/**
+	 * Checks the status of the environment
+	 *
+	 * @param DNEnvironment $environment
+	 * @param DeploynautLogFile $log
+	 * @param DNProject $project
+	 */
+	public function ping(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project);
 }

code/backends/DeploymentStrategy.php

Indentation +336 added lines, -336 removed lines

@@ -3,340 +3,340 @@
 class DeploymentStrategy extends ViewableData
 {
 
-    const SUCCESS_CODE = 'success';
-
-    const WARNING_CODE = 'warning';
-
-    const ERROR_CODE = 'error';
-
-    /**
-     * @var DNEnvironment
-     */
-    protected $environment;
-
-    /**
-     * @var string
-     */
-    protected $actionTitle = 'Deploy';
-
-    /**
-     * @var string
-     */
-    protected $actionCode = 'default';
-
-    /**
-     * @var int
-     */
-    protected $estimatedTime = 0;
-
-    /**
-     * @var array
-     */
-    protected $changes = [];
-
-    /**
-     * @var array
-     */
-    protected $options;
-
-    /**
-     * Validation code
-     *
-     * @var string
-     */
-    protected $validationCode = DeploymentStrategy::SUCCESS_CODE;
-
-    /**
-     * @var array
-     */
-    protected $messages = [];
-
-
-    /**
-     * @param DNEnvironment $environment
-     * @param array $options
-     */
-    public function __construct(DNEnvironment $environment, $options = array())
-    {
-        $this->environment = $environment;
-        $this->options = $options;
-    }
-
-    /**
-     * @param string $title
-     */
-    public function setActionTitle($title)
-    {
-        $this->actionTitle = $title;
-    }
-
-    /**
-     * @return string
-     */
-    public function getActionTitle()
-    {
-        return $this->actionTitle;
-    }
-
-    /**
-     */
-    public function setActionCode($code)
-    {
-        $this->actionCode = $code;
-    }
-
-    /**
-     * @return string
-     */
-    public function getActionCode()
-    {
-        return $this->actionCode;
-    }
-
-    /**
-     * @param int
-     */
-    public function setEstimatedTime($seconds)
-    {
-        $this->estimatedTime = $seconds;
-    }
-
-    /**
-     * @return int Time in minutes
-     */
-    public function getEstimatedTime()
-    {
-        return $this->estimatedTime;
-    }
-
-    /**
-     * @param string $title
-     * @param string $from
-     * @param string $to
-     */
-    public function setChange($title, $from, $to)
-    {
-        return $this->changes[$title] = array(
-            'from' => $from,
-            'to' => $to
-        );
-    }
-
-    /**
-     * @param string $title
-     * @param string $desc
-     */
-    public function setChangeDescriptionOnly($title, $desc)
-    {
-        return $this->changes[$title] = array(
-            'description' => $desc
-        );
-    }
-
-    /**
-     * Filter the changeset where modification was not required.
-     *
-     * @return array
-     */
-    public function getChangesModificationNeeded()
-    {
-        $filtered = [];
-        foreach ($this->changes as $change => $details) {
-            if (array_key_exists('description', $details)) {
-                $filtered[$change] = $details;
-            } elseif (
-                (array_key_exists('from', $details) || array_key_exists('to', $details))
-                && $details['from'] !== $details['to']
-            ) {
-                $filtered[$change] = $details;
-            }
-        }
-
-        return $filtered;
-    }
-
-    /**
-     * @return array Associative array of changes, e.g.
-     *	array(
-     *		'SHA' => array(
-     *			'from' => 'abc',
-     *			'to' => 'def'
-     *		)
-     *	)
-     */
-    public function getChanges()
-    {
-        return $this->changes;
-    }
-
-    /**
-     * Returns a change or a given key.
-     *
-     * @return ArrayData|null
-     */
-    public function getChange($key)
-    {
-        $changes = $this->getChanges();
-        if (array_key_exists($key, $changes)) {
-            return new ArrayData($changes[$key]);
-        }
-        return null;
-    }
-
-    /**
-     * @param string $option
-     * @param string $value
-     */
-    public function setOption($option, $value)
-    {
-        $this->options[$option] = $value;
-    }
-
-    /**
-     * @param string $option
-     * @return string|null
-     */
-    public function getOption($option)
-    {
-        if (!empty($this->options[$option])) {
-            return $this->options[$option];
-        }
-    }
-
-    /**
-     * @return string
-     */
-    public function getOptions()
-    {
-        return $this->options;
-    }
-
-    /**
-     * @param string $code
-     */
-    public function setValidationCode($code)
-    {
-        $this->validationCode = $code;
-    }
-
-    /**
-     * @return string
-     */
-    public function getValidationCode()
-    {
-        return $this->validationCode;
-    }
-
-    /**
-     * @param string $msg
-     */
-    public function setMessage($msg, $code = self::ERROR_CODE)
-    {
-        $this->messages[] = [
-            'text' => $msg,
-            'code' => $code
-        ];
-
-        $current = $this->getValidationCode();
-        $map = [
-            DeploymentStrategy::SUCCESS_CODE => 0,
-            DeploymentStrategy::WARNING_CODE => 1,
-            DeploymentStrategy::ERROR_CODE => 2
-        ];
-        if ($map[$current] < $map[$code]) {
-            $this->setValidationCode($code);
-        }
-    }
-
-    /**
-     * @return array
-     */
-    public function getMessages()
-    {
-        return $this->messages;
-    }
-
-    /**
-     * Transform the deployment strategy to an array.
-     *
-     * @return array
-     */
-    public function toArray()
-    {
-        $fields = array(
-            'actionTitle',
-            'actionCode',
-            'estimatedTime',
-            'changes',
-            'options',
-            'validationCode',
-            'messages'
-        );
-
-        $output = array();
-        foreach ($fields as $field) {
-            $output[$field] = $this->$field;
-        }
-        return $output;
-    }
-
-    /**
-     * @return string
-     */
-    public function toJSON()
-    {
-        return json_encode($this->toArray(), JSON_PRETTY_PRINT);
-    }
-
-    /**
-     * Load from JSON associative array.
-     * Environment must be set by the callee when creating this object.
-     *
-     * @param string $json
-     */
-    public function fromJSON($json)
-    {
-        $decoded = json_decode($json, true);
-        return $this->fromArray($decoded);
-    }
-
-    /**
-     * Load from array.
-     * Environment must be set by the callee when creating this object.
-     *
-     * @param string $data
-     */
-    public function fromArray($data)
-    {
-        $fields = array(
-            'actionTitle',
-            'actionCode',
-            'estimatedTime',
-            'changes',
-            'options',
-            'validationCode',
-            'messages'
-        );
-
-        foreach ($fields as $field) {
-            if (!empty($data[$field])) {
-                $this->$field = $data[$field];
-            }
-        }
-    }
-
-    /**
-     * @return DNDeployment
-     */
-    public function createDeployment()
-    {
-        $deployment = DNDeployment::create();
-        $deployment->EnvironmentID = $this->environment->ID;
-        // Pull out the SHA from the options so we can make it queryable.
-        $deployment->SHA = $this->getOption('sha');
-        $deployment->Strategy = $this->toJSON();
-        $deployment->write();
-
-        return $deployment;
-    }
+	const SUCCESS_CODE = 'success';
+
+	const WARNING_CODE = 'warning';
+
+	const ERROR_CODE = 'error';
+
+	/**
+	 * @var DNEnvironment
+	 */
+	protected $environment;
+
+	/**
+	 * @var string
+	 */
+	protected $actionTitle = 'Deploy';
+
+	/**
+	 * @var string
+	 */
+	protected $actionCode = 'default';
+
+	/**
+	 * @var int
+	 */
+	protected $estimatedTime = 0;
+
+	/**
+	 * @var array
+	 */
+	protected $changes = [];
+
+	/**
+	 * @var array
+	 */
+	protected $options;
+
+	/**
+	 * Validation code
+	 *
+	 * @var string
+	 */
+	protected $validationCode = DeploymentStrategy::SUCCESS_CODE;
+
+	/**
+	 * @var array
+	 */
+	protected $messages = [];
+
+
+	/**
+	 * @param DNEnvironment $environment
+	 * @param array $options
+	 */
+	public function __construct(DNEnvironment $environment, $options = array())
+	{
+		$this->environment = $environment;
+		$this->options = $options;
+	}
+
+	/**
+	 * @param string $title
+	 */
+	public function setActionTitle($title)
+	{
+		$this->actionTitle = $title;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getActionTitle()
+	{
+		return $this->actionTitle;
+	}
+
+	/**
+	 */
+	public function setActionCode($code)
+	{
+		$this->actionCode = $code;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getActionCode()
+	{
+		return $this->actionCode;
+	}
+
+	/**
+	 * @param int
+	 */
+	public function setEstimatedTime($seconds)
+	{
+		$this->estimatedTime = $seconds;
+	}
+
+	/**
+	 * @return int Time in minutes
+	 */
+	public function getEstimatedTime()
+	{
+		return $this->estimatedTime;
+	}
+
+	/**
+	 * @param string $title
+	 * @param string $from
+	 * @param string $to
+	 */
+	public function setChange($title, $from, $to)
+	{
+		return $this->changes[$title] = array(
+			'from' => $from,
+			'to' => $to
+		);
+	}
+
+	/**
+	 * @param string $title
+	 * @param string $desc
+	 */
+	public function setChangeDescriptionOnly($title, $desc)
+	{
+		return $this->changes[$title] = array(
+			'description' => $desc
+		);
+	}
+
+	/**
+	 * Filter the changeset where modification was not required.
+	 *
+	 * @return array
+	 */
+	public function getChangesModificationNeeded()
+	{
+		$filtered = [];
+		foreach ($this->changes as $change => $details) {
+			if (array_key_exists('description', $details)) {
+				$filtered[$change] = $details;
+			} elseif (
+				(array_key_exists('from', $details) || array_key_exists('to', $details))
+				&& $details['from'] !== $details['to']
+			) {
+				$filtered[$change] = $details;
+			}
+		}
+
+		return $filtered;
+	}
+
+	/**
+	 * @return array Associative array of changes, e.g.
+	 *	array(
+	 *		'SHA' => array(
+	 *			'from' => 'abc',
+	 *			'to' => 'def'
+	 *		)
+	 *	)
+	 */
+	public function getChanges()
+	{
+		return $this->changes;
+	}
+
+	/**
+	 * Returns a change or a given key.
+	 *
+	 * @return ArrayData|null
+	 */
+	public function getChange($key)
+	{
+		$changes = $this->getChanges();
+		if (array_key_exists($key, $changes)) {
+			return new ArrayData($changes[$key]);
+		}
+		return null;
+	}
+
+	/**
+	 * @param string $option
+	 * @param string $value
+	 */
+	public function setOption($option, $value)
+	{
+		$this->options[$option] = $value;
+	}
+
+	/**
+	 * @param string $option
+	 * @return string|null
+	 */
+	public function getOption($option)
+	{
+		if (!empty($this->options[$option])) {
+			return $this->options[$option];
+		}
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getOptions()
+	{
+		return $this->options;
+	}
+
+	/**
+	 * @param string $code
+	 */
+	public function setValidationCode($code)
+	{
+		$this->validationCode = $code;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getValidationCode()
+	{
+		return $this->validationCode;
+	}
+
+	/**
+	 * @param string $msg
+	 */
+	public function setMessage($msg, $code = self::ERROR_CODE)
+	{
+		$this->messages[] = [
+			'text' => $msg,
+			'code' => $code
+		];
+
+		$current = $this->getValidationCode();
+		$map = [
+			DeploymentStrategy::SUCCESS_CODE => 0,
+			DeploymentStrategy::WARNING_CODE => 1,
+			DeploymentStrategy::ERROR_CODE => 2
+		];
+		if ($map[$current] < $map[$code]) {
+			$this->setValidationCode($code);
+		}
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getMessages()
+	{
+		return $this->messages;
+	}
+
+	/**
+	 * Transform the deployment strategy to an array.
+	 *
+	 * @return array
+	 */
+	public function toArray()
+	{
+		$fields = array(
+			'actionTitle',
+			'actionCode',
+			'estimatedTime',
+			'changes',
+			'options',
+			'validationCode',
+			'messages'
+		);
+
+		$output = array();
+		foreach ($fields as $field) {
+			$output[$field] = $this->$field;
+		}
+		return $output;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function toJSON()
+	{
+		return json_encode($this->toArray(), JSON_PRETTY_PRINT);
+	}
+
+	/**
+	 * Load from JSON associative array.
+	 * Environment must be set by the callee when creating this object.
+	 *
+	 * @param string $json
+	 */
+	public function fromJSON($json)
+	{
+		$decoded = json_decode($json, true);
+		return $this->fromArray($decoded);
+	}
+
+	/**
+	 * Load from array.
+	 * Environment must be set by the callee when creating this object.
+	 *
+	 * @param string $data
+	 */
+	public function fromArray($data)
+	{
+		$fields = array(
+			'actionTitle',
+			'actionCode',
+			'estimatedTime',
+			'changes',
+			'options',
+			'validationCode',
+			'messages'
+		);
+
+		foreach ($fields as $field) {
+			if (!empty($data[$field])) {
+				$this->$field = $data[$field];
+			}
+		}
+	}
+
+	/**
+	 * @return DNDeployment
+	 */
+	public function createDeployment()
+	{
+		$deployment = DNDeployment::create();
+		$deployment->EnvironmentID = $this->environment->ID;
+		// Pull out the SHA from the options so we can make it queryable.
+		$deployment->SHA = $this->getOption('sha');
+		$deployment->Strategy = $this->toJSON();
+		$deployment->write();
+
+		return $deployment;
+	}
 }

code/backends/EnvironmentCreateBackend.php

Indentation +20 added lines, -20 removed lines

@@ -3,26 +3,26 @@
 interface EnvironmentCreateBackend
 {
 
-    /**
-     * @param DNCreateEnvironment $job
-     *
-     * @return true
-     * @throws Exception
-     */
-    public function createEnvironment(DNCreateEnvironment $job);
+	/**
+	 * @param DNCreateEnvironment $job
+	 *
+	 * @return true
+	 * @throws Exception
+	 */
+	public function createEnvironment(DNCreateEnvironment $job);
 
-    /**
-     * Returns form fields for the create form.
-     *
-     * @param DNProject $project
-     * @return FieldList
-     */
-    public function getCreateEnvironmentFields(DNProject $project);
+	/**
+	 * Returns form fields for the create form.
+	 *
+	 * @param DNProject $project
+	 * @return FieldList
+	 */
+	public function getCreateEnvironmentFields(DNProject $project);
 
-    /**
-     * Returns validator for the create form.
-     *
-     * @return Validator
-     */
-    public function getCreateEnvironmentValidator();
+	/**
+	 * Returns validator for the create form.
+	 *
+	 * @return Validator
+	 */
+	public function getCreateEnvironmentValidator();
 }