DeployDispatcher::summary() - Code Metrics - Inspection of "When entering SHA, dereference if possible. Show e..." - silverstripe/deploynaut - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#844)

by Sean
created 2016-11-23 01:40 UTC
DeployDispatcher::summary() B

↳ Parent: DeployDispatcher
Complexity

Conditions	5
Paths	4
Size

Total Lines	22
Code Lines	15
Duplication

Lines	5
Ratio	22.73 %
Importance

Changes
Metric	Value
dl	5
loc	22
rs	8.6737
c	0
b	0
f	0
cc	5
eloc	15
nc	4
nop	1
<?php

/**
 * This dispatcher takes care of updating and returning information about this
 * projects git repository
 */
class DeployDispatcher extends Dispatcher {
namespace YourVendor;

class YourClass { }

	const ACTION_DEPLOY = 'deploys';

	/**
	 * @var array
	 */
	private static $allowed_actions = [

		'history',
		'show',
		'delete',
		'log',
		'redeploy',
		'summary',
		'createdeployment',
		'start'
	];

	private static $dependencies = [
		'formatter' => '%$DeploynautAPIFormatter'
	];

	/**
	 * @var \DNProject
	 */
	protected $project = null;

	/**
	 * @var \DNEnvironment
	 */
	protected $environment = null;

	/**
	 * @var array
	 */
	private static $action_types = [

		self::ACTION_DEPLOY
	];

	public function init() {
		parent::init();

		$this->project = $this->getCurrentProject();

		if (!$this->project) {
			return $this->project404Response();
		}

		// Performs canView permission check by limiting visible projects
		$this->environment = $this->getCurrentEnvironment($this->project);
		if (!$this->environment) {
			return $this->environment404Response();
		}
	}

	/**
	 * @param \SS_HTTPRequest $request
	 * @return \HTMLText|\SS_HTTPResponse
	 */
	public function index(\SS_HTTPRequest $request) {
		return $this->redirect(\Controller::join_links($this->Link(), 'history'), 302);
	}

	/**
	 * @param \SS_HTTPRequest $request
	 * @return \SS_HTTPResponse
	 */
	public function history(\SS_HTTPRequest $request) {
		$data = [];

		$list = $this->environment->DeployHistory('DeployStarted');

		$fromTimestamp = $request->requestVar('from');
		if ($fromTimestamp) {
			$from = SS_Datetime::create();
			$from->setValue($fromTimestamp);
			$list = $list->filter('LastEdited:GreaterThan', $from->Format('Y-m-d H:i:s'));
		}

		foreach ($list as $deployment) {
			$data[] = $this->formatter->getDeploymentData($deployment);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		}

		return $this->getAPIResponse([
			'list' => $data,
		], 200);
	}

	/**
	 * @param \SS_HTTPRequest $request
	 * @return \SS_HTTPResponse
	 */
	public function show(\SS_HTTPRequest $request) {
		$deployment = \DNDeployment::get()->byId($request->param('ID'));
		$errorResponse = $this->validateDeployment($deployment);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		if ($errorResponse instanceof \SS_HTTPResponse) {
			return $errorResponse;
		}
		return $this->getAPIResponse(['deployment' => $this->formatter->getDeploymentData($deployment)], 200);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
	}

	/**
	 * @param \SS_HTTPRequest $request
	 * @return \SS_HTTPResponse
	 */
	public function delete(\SS_HTTPRequest $request) {
		if ($request->httpMethod() !== 'POST') {
			return $this->getAPIResponse(['message' => 'Method not allowed, requires POST'], 405);
		}

		$this->checkSecurityToken();

		$deployment = \DNDeployment::get()->byId($request->postVar('id'));
		$errorResponse = $this->validateDeployment($deployment);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		if ($errorResponse instanceof \SS_HTTPResponse) {
			return $errorResponse;
		}

		$id = $deployment->ID;
		$deployment->delete();

		return $this->getAPIResponse([
			'id' => $id,
			'message' => 'Deployment has been deleted'
		], 201);
	}

	/**
	 * @param \SS_HTTPRequest $request
	 * @return \SS_HTTPResponse
	 */
	public function log(\SS_HTTPRequest $request) {
		$deployment = \DNDeployment::get()->byId($request->param('ID'));
		$errorResponse = $this->validateDeployment($deployment);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		if ($errorResponse instanceof \SS_HTTPResponse) {
			return $errorResponse;
		}
		$log = $deployment->log();
		$lines = [];
		if ($log->exists()) {
			$lines = explode(PHP_EOL, $log->content());
		}

		return $this->getAPIResponse([
			'message' => $lines,
			'status' => $deployment->Status,
			'deployment' => $this->formatter->getDeploymentData($deployment),
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		], 200);
	}

	/**
	 * @param \SS_HTTPRequest $request
	 * @return \SS_HTTPResponse
	 */
	public function redeploy(\SS_HTTPRequest $request) {
		$currentBuild = $this->environment->CurrentBuild();
		if (!$currentBuild || !$currentBuild->exists()) {
			return $this->redirect(Controller::join_links(
				$this->environment->Link(\EnvironmentOverview::ACTION_OVERVIEW),
				'deployment',
				'new'
			));
		}

		$strategy = $this->environment->Backend()->planDeploy($this->environment, [
			'sha' => $currentBuild->SHA,
			'ref_type' => \GitDispatcher::REF_TYPE_PREVIOUS,
			'branch' => $currentBuild->Branch
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		]);
		$deployment = $strategy->createDeployment();

		return $this->redirect($deployment->Link());
	}

	/**
	 * Return a summary of the deployment changes without creating the deployment.
	 *
	 * @param \SS_HTTPRequest $request
	 * @return \SS_HTTPResponse
	 */
	public function summary(\SS_HTTPRequest $request) {
		if ($request->httpMethod() !== 'POST') {
			return $this->getAPIResponse(['message' => 'Method not allowed, requires POST'], 405);
		}
		$this->checkSecurityToken();

		$sha = $this->project->resolveRevision($request->postVar('ref'));
		if (!$sha) {
			return $this->getAPIResponse([
				'message' => 'The given reference could not be resolved. Does it exist in the repository?'
			], 400);
		}

		$options = ['sha' => $sha];
		if ($request->postVar('options')) {

			foreach (explode(',', $request->postVar('options')) as $option) {
				$options[$option] = true;
			}
		}
		$strategy = $this->createStrategy($options);
		return $this->getAPIResponse($strategy->toArray(), 201);
	}

	/**
	 * Create deployment. Can't use {@link create()} as it's taken by Object.
	 *
	 * @param \SS_HTTPRequest $request
	 * @return \SS_HTTPResponse
	 */
	public function createdeployment(\SS_HTTPRequest $request) {
		if ($request->httpMethod() !== 'POST') {
			return $this->getAPIResponse(['message' => 'Method not allowed, requires POST'], 405);
		}

		$this->checkSecurityToken();

		// @todo the strategy should have been saved when there has been a request for an
		// approval or a bypass. This saved state needs to be checked if it's invalidated
		// if another deploy happens before this one
		$isBranchDeploy = (int) $request->postVar('ref_type') === GitDispatcher::REF_TYPE_BRANCH;

		$options = [
			'sha' => $request->postVar('ref'),
			'ref_type' => $request->postVar('ref_type'),
			'branch' => $isBranchDeploy ? $request->postVar('ref_name') : null,
			'title' => $request->postVar('title'),
			'summary' => $request->postVar('summary')
		];

		if ($request->postVar('options')) {

			foreach (explode(',', $request->postVar('options')) as $option) {
				$options[$option] = true;
			}
		}

		$strategy = $this->createStrategy($options);

		$approver = Member::get()->byId($request->postVar('approver_id'));
		if ($approver && $approver->exists()) {
			if (!$this->project->allowed(ApprovalsDispatcher::ALLOW_APPROVAL, $approver)) {
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				return $this->getAPIResponse(['message' => 'The given approver does not have permissions to approve'], 403);
			}
		}

		$deployment = $strategy->createDeployment();
		if ($approver && $approver->exists()) {
			$deployment->ApproverID = $approver->ID;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			$deployment->write();
		}

		$deploymentLink = \Controller::join_links(Director::absoluteBaseURL(), $deployment->Link());

		$response = $this->getAPIResponse([
			'message' => 'Deployment has been created',
			'location' => $deploymentLink,
			'deployment' => $this->formatter->getDeploymentData($deployment),
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		], 201);

		$response->addHeader('Location', $deploymentLink);

		return $response;
	}

	/**
	 * @param \SS_HTTPRequest $request
	 * @return \SS_HTTPResponse
	 */
	public function start(\SS_HTTPRequest $request) {
		if ($request->httpMethod() !== 'POST') {
			return $this->getAPIResponse(['message' => 'Method not allowed, requires POST'], 405);
		}

		$this->checkSecurityToken();

		$deployment = \DNDeployment::get()->byId($request->postVar('id'));
		$errorResponse = $this->validateDeployment($deployment);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		if ($errorResponse instanceof \SS_HTTPResponse) {
			return $errorResponse;
		}

		// The deployment cannot be started until it has been approved, or bypassed straight to approved state
		if ($deployment->State !== \DNDeployment::STATE_APPROVED) {
			return $this->getAPIResponse(['message' => 'This deployment has not been approved. Cannot deploy'], 403);
		}

		// until we have a system that can invalidate currently scheduled deployments due
		// to emergency deploys etc, replan the deployment to check if it's still valid.
		$options = $deployment->getDeploymentStrategy()->getOptions();
		$strategy = $this->environment->Backend()->planDeploy($this->environment, $options);
		$deployment->Strategy = $strategy->toJSON();

		// if the person starting is not the one who created the deployment, update the deployer
		if (Member::currentUserID() !== $deployment->DeployerID) {
			$deployment->DeployerID = Member::currentUserID();
		}

		try {
			$deployment->getMachine()->apply(\DNDeployment::TR_QUEUE);
		} catch (\Exception $e) {
			return $this->getAPIResponse([
				'message' => $e->getMessage()
			], 400);
		}

		$location = \Controller::join_links(Director::absoluteBaseURL(), $this->Link('log'), $deployment->ID);

		$response = $this->getAPIResponse([
			'message' => 'Deployment has been queued',
			'location' => $location,
			'deployment' => $this->formatter->getDeploymentData($deployment),
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		], 201);

		$response->addHeader('Location', $location);

		return $response;
	}

	/**
	 * @param string $action
	 * @return string
	 */
	public function Link($action = '') {
		return \Controller::join_links($this->environment->Link(), self::ACTION_DEPLOY, $action);
	}

	/**
	 * @param string $name
	 * @return array
	 */
	public function getModel($name = '') {
		return [];
	}

	/**
	 * @var array
	 * @return \DeploymentStrategy
	 */
	protected function createStrategy($options) {
		$strategy = $this->environment->Backend()->planDeploy($this->environment, $options);
		$data = $strategy->toArray();

		$interface = $this->project->getRepositoryInterface();
		if ($this->canCompareCodeVersions($interface, $data['changes'])) {
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
			$compareurl = sprintf(
				'%s/compare/%s...%s',
				$interface->URL,
				$data['changes']['Code version']['from'],
				$data['changes']['Code version']['to']
			);
			$data['changes']['Code version']['compareUrl'] = $compareurl;

			// special case for .platform.yml field so we don't show a huge blob of changes,
			// but rather a link to where the .platform.yml changes were made in the code
			if (isset($data['changes']['.platform.yml other'])) {
				$data['changes']['.platform.yml other']['compareUrl'] = $compareurl;
				$data['changes']['.platform.yml other']['description'] = '';
			}
		}
		$this->extend('updateDeploySummary', $data);

		// Ensure changes that would have been updated are persisted in the object,
		// such as the comparison URL, so that they will be written to the Strategy
		// field on the DNDeployment object as part of {@link createDeployment()}
		$strategy->setChanges($data['changes']);

		return $strategy;
	}

	/**
	 * @param ArrayData $interface
	 * @param $changes
	 * @return bool
	 */
	protected function canCompareCodeVersions(\ArrayData $interface, $changes) {
		if (empty($changes['Code version'])) {
			return false;
		}
		$codeVersion = $changes['Code version'];
		if (empty($interface)) {
			return false;
		}
		if (empty($interface->URL)) {
			return false;
		}
		if (empty($codeVersion['from']) || empty($codeVersion['to'])) {
			return false;
		}
		if (strlen($codeVersion['from']) !== 40 || strlen($codeVersion['to']) !== 40) {
			return false;
		}
		return true;
	}

	/**
	 * Check if a DNDeployment exists and do permission checks on it. If there is something wrong it will return
	 * an APIResponse with the error, otherwise null.
	 *
	 * @param \DNDeployment $deployment
	 *
	 * @return null|SS_HTTPResponse
	 */
	protected function validateDeployment($deployment) {

		if (!$deployment || !$deployment->exists()) {
			return $this->getAPIResponse(['message' => 'This deployment does not exist'], 404);
		}
		if ($deployment->EnvironmentID != $this->environment->ID) {
			return $this->getAPIResponse(['message' => 'This deployment does not belong to the environment'], 403);
		}
		if (!$deployment->canView()) {
			return $this->getAPIResponse(['message' => 'You are not authorised to view this deployment'], 403);
		}
		return null;
	}

}

silverstripe / deploynaut

Pull Request — master (#844)

DeployDispatcher::summary() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
