GitDispatcher::createUpdate() - Code Metrics - Inspection of "Fixes to git reference selection with promote buil..." - silverstripe/deploynaut - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#655)

by Sean

created 2016-09-19 05:33 UTC

GitDispatcher::createUpdate() A

↳ Parent: GitDispatcher

Complexity

Conditions	1
Paths	1

Size

Total Lines	18
Code Lines	13

Duplication

Lines	18
Ratio	100 %

Importance

Changes

Metric	Value
dl	18
loc	18
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	13
nc	1
nop	0

<?php

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

class YourClass { }

	const ACTION_GIT = 'git';

	const REF_TYPE_FROM_UAT = 0;
	const REF_TYPE_BRANCH = 1;
	const REF_TYPE_TAG = 2;
	const REF_TYPE_PREVIOUS = 3;
	const REF_TYPE_SHA = 4;

	/**
	 * @var array
	 */
	public static $allowed_actions = [
		'update',
		'show'
	];

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

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

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

		self::ACTION_GIT
	];

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

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

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

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

	/**
	 * @param SS_HTTPRequest $request
	 * @return SS_HTTPResponse
	 */
	public function update(SS_HTTPRequest $request) {
		switch ($request->httpMethod()) {
			case 'POST':
				$this->checkSecurityToken();
				return $this->createUpdate();
			case 'GET':
				return $this->getUpdateStatus($this->getRequest()->param('ID'));
			default:
				return $this->getAPIResponse(['message' => 'Method not allowed, requires POST or GET/{id}'], 405);
		}
	}

	/**
	 * @param SS_HTTPRequest $request
	 *
	 * @return string
	 */
	public function show(\SS_HTTPRequest $request) {
		$targetEnvironment = null;
		$targetEnvironmentId = $request->getVar('environmentId');
		if (!empty($targetEnvironmentId)) {
			$targetEnvironment = DNEnvironment::get()->byId((int) $targetEnvironmentId);
		}

		$refs = [];
		$prevDeploys = [];

		$uatEnvironment = $this->project->DNEnvironmentList()->filter('Usage', 'UAT')->first();
		$uatBuild = $uatEnvironment ? $uatEnvironment->CurrentBuild() : null;
		if ($uatBuild && $uatBuild->exists() && $targetEnvironment && $targetEnvironment->Usage === 'Production') {
			$refs[self::REF_TYPE_FROM_UAT] = [
				'id' => self::REF_TYPE_FROM_UAT,
				'label' => 'Promote the version currently on UAT',
				'description' => 'Promote the version currently on UAT',
				'promote_build' => [
					'id' => $uatBuild->ID,
					'deployed' => DBField::create_field('SS_Datetime', $uatBuild->Created, 'Created')->Ago(),
					'branch' => $uatBuild->Branch,
					'tags' => $uatBuild->getTags()->toArray(),
					'sha' => $uatBuild->SHA,
					'commit_message' => $uatBuild->getCommitMessage(),
					'commit_url' => $uatBuild->getCommitURL(),
				]
			];
		}

		$refs[self::REF_TYPE_BRANCH] = [
			'id' => self::REF_TYPE_BRANCH,
			'label' => 'Branch version',
			'description' => 'Deploy the latest version of a branch',
			'list' => $this->getGitBranches($this->project)
		];

		$refs[self::REF_TYPE_TAG] = [
			'id' => self::REF_TYPE_TAG,
			'label' => 'Tag version',
			'description' => 'Deploy a tagged release',
			'list' => $this->getGitTags($this->project)
		];

		// @todo: the original was a tree that was keyed by environment, the
		// front-end dropdown needs to be changed to support that. brrrr.
		foreach ($this->getGitPrevDeploys($this->project) as $env) {
			foreach ($env as $deploy) {
				$prevDeploys[] = $deploy;
			}
		}
		$refs[self::REF_TYPE_PREVIOUS] = [
			'id' => self::REF_TYPE_PREVIOUS,
			'label' => 'Redeploy a release that was previously deployed (to any environment)',
			'description' => 'Deploy a previous release',
			'list' => $prevDeploys
		];
		$refs[self::REF_TYPE_SHA] = [
			'id' => self::REF_TYPE_SHA,
			'label' => 'Deploy a specific SHA',
			'description' => 'Deploy a specific SHA'
		];

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

	/**
	 * @return string
	 */
	public function Link() {
		return \Controller::join_links($this->project->Link(), self::ACTION_GIT);
	}

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

	/**
	 * @param int $ID
	 * @return SS_HTTPResponse
	 */
	protected function getUpdateStatus($ID) {
		$ping = DNGitFetch::get()->byID($ID);
		if (!$ping) {
			return $this->getAPIResponse(['message' => 'GIT update (' . $ID . ') not found'], 404);
		}
		$output = [
			'id' => $ID,
			'status' => $ping->ResqueStatus(),
			'message' => array_filter(explode(PHP_EOL, $ping->LogContent()))
		];

		return $this->getAPIResponse($output, 200);
	}

	/**
	 * @return SS_HTTPResponse
	 */
	protected function createUpdate() {

		/** @var DNGitFetch $fetch */
		$fetch = DNGitFetch::create();
		$fetch->ProjectID = $this->project->ID;
		$fetch->write();
		$fetch->start();

		$location = Director::absoluteBaseURL() . $this->Link() . '/update/' . $fetch->ID;
		$output = [
			'message' => 'git fetch has been queued',
			'id' => $fetch->ID,
			'location' => $location,
		];

		$response = $this->getAPIResponse($output, 201);
		$response->addHeader('Location', $location);
		return $response;
	}

	/**
	 * @param $project
	 *
	 * @return array
	 */
	protected function getGitBranches($project) {
		$branches = [];
		foreach ($project->DNBranchList() as $branch) {
			$branches[] = [
				'key' => $branch->SHA(),
				'value' => $branch->Name(),
			];
		}
		return $branches;
	}

	/**
	 * @param $project
	 *
	 * @return array
	 */
	protected function getGitTags($project) {
		$tags = [];
		foreach ($project->DNTagList()->setLimit(null) as $tag) {
			$tags[] = [
				'key' => $tag->SHA(),
				'value' => $tag->Name(),
			];
		}
		return $tags;
	}

	/**
	 * @param $project
	 *
	 * @return array
	 */
	protected function getGitPrevDeploys($project) {
		$redeploy = [];
		foreach ($project->DNEnvironmentList() as $dnEnvironment) {

			$envName = $dnEnvironment->Name;
			$perEnvDeploys = [];
			foreach ($dnEnvironment->DeployHistory() as $deploy) {
				$sha = $deploy->SHA;

				// Check if exists to make sure the newest deployment date is used.
				if (!isset($perEnvDeploys[$sha])) {
					$pastValue = sprintf(
						"%s (deployed %s)",
						substr($sha, 0, 8),
						$deploy->obj('LastEdited')->Ago()
					);
					$perEnvDeploys[$sha] = [
						'key' => $sha,
						'value' => $pastValue
					];
				}
			}
			if (!empty($perEnvDeploys)) {
				$redeploy[$envName] = array_values($perEnvDeploys);
			}
		}
		return $redeploy;
	}

}


1		<?php
2
3		/**
4		* This dispatcher takes care of updating and returning information about this
5		* projects git repository
6		*/
7		class GitDispatcher extends Dispatcher {
		0 ignored issues – show Coding Style introduced 2016-09-09 01:22 UTC by Report Bug Copy Issue Report The property $allowed_actions is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2016-09-09 01:22 UTC by Report Bug Copy Issue Report The property $action_types is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style Compatibility introduced 2016-09-09 01:22 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
8
9		const ACTION_GIT = 'git';
10
11		const REF_TYPE_FROM_UAT = 0;
12		const REF_TYPE_BRANCH = 1;
13		const REF_TYPE_TAG = 2;
14		const REF_TYPE_PREVIOUS = 3;
15		const REF_TYPE_SHA = 4;
16
17		/**
18		* @var array
19		*/
20		public static $allowed_actions = [
21		'update',
22		'show'
23		];
24
25		/**
26		* @var \DNProject
27		*/
28		protected $project = null;
29
30		/**
31		* @var \DNEnvironment
32		*/
33		protected $environment = null;
34
35		/**
36		* @var array
37		*/
38		private static $action_types = [
		0 ignored issues – show Comprehensibility introduced 2016-09-09 01:22 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2016-09-09 01:22 UTC by Report Bug Copy Issue Report The property `$action_types` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
39		self::ACTION_GIT
40		];
41
42		public function init() {
43		parent::init();
44
45		$this->project = $this->getCurrentProject();
46
47		if (!$this->project) {
48		return $this->project404Response();
49		}
50		}
51
52		/**
53		*
54		* @param \SS_HTTPRequest $request
55		*
56		* @return \HTMLText\|\SS_HTTPResponse
57		*/
58		public function index(\SS_HTTPRequest $request) {
59		return $this->redirect(\Controller::join_links($this->Link(), 'show'), 302);
60		}
61
62		/**
63		* @param SS_HTTPRequest $request
64		* @return SS_HTTPResponse
65		*/
66		public function update(SS_HTTPRequest $request) {
67		switch ($request->httpMethod()) {
68		case 'POST':
69		$this->checkSecurityToken();
70		return $this->createUpdate();
71		case 'GET':
72		return $this->getUpdateStatus($this->getRequest()->param('ID'));
73		default:
74		return $this->getAPIResponse(['message' => 'Method not allowed, requires POST or GET/{id}'], 405);
75		}
76		}
77
78		/**
79		* @param SS_HTTPRequest $request
80		*
81		* @return string
82		*/
83		public function show(\SS_HTTPRequest $request) {
84		$targetEnvironment = null;
85		$targetEnvironmentId = $request->getVar('environmentId');
86		if (!empty($targetEnvironmentId)) {
87		$targetEnvironment = DNEnvironment::get()->byId((int) $targetEnvironmentId);
88		}
89
90		$refs = [];
91		$prevDeploys = [];
92
93		$uatEnvironment = $this->project->DNEnvironmentList()->filter('Usage', 'UAT')->first();
94		$uatBuild = $uatEnvironment ? $uatEnvironment->CurrentBuild() : null;
95		if ($uatBuild && $uatBuild->exists() && $targetEnvironment && $targetEnvironment->Usage === 'Production') {
96		$refs[self::REF_TYPE_FROM_UAT] = [
97		'id' => self::REF_TYPE_FROM_UAT,
98		'label' => 'Promote the version currently on UAT',
99		'description' => 'Promote the version currently on UAT',
100		'promote_build' => [
101		'id' => $uatBuild->ID,
102		'deployed' => DBField::create_field('SS_Datetime', $uatBuild->Created, 'Created')->Ago(),
103		'branch' => $uatBuild->Branch,
104		'tags' => $uatBuild->getTags()->toArray(),
105		'sha' => $uatBuild->SHA,
106		'commit_message' => $uatBuild->getCommitMessage(),
107		'commit_url' => $uatBuild->getCommitURL(),
108		]
109		];
110		}
111
112		$refs[self::REF_TYPE_BRANCH] = [
113		'id' => self::REF_TYPE_BRANCH,
114		'label' => 'Branch version',
115		'description' => 'Deploy the latest version of a branch',
116		'list' => $this->getGitBranches($this->project)
117		];
118
119		$refs[self::REF_TYPE_TAG] = [
120		'id' => self::REF_TYPE_TAG,
121		'label' => 'Tag version',
122		'description' => 'Deploy a tagged release',
123		'list' => $this->getGitTags($this->project)
124		];
125
126		// @todo: the original was a tree that was keyed by environment, the
127		// front-end dropdown needs to be changed to support that. brrrr.
128		foreach ($this->getGitPrevDeploys($this->project) as $env) {
129		foreach ($env as $deploy) {
130		$prevDeploys[] = $deploy;
131		}
132		}
133		$refs[self::REF_TYPE_PREVIOUS] = [
134		'id' => self::REF_TYPE_PREVIOUS,
135		'label' => 'Redeploy a release that was previously deployed (to any environment)',
136		'description' => 'Deploy a previous release',
137		'list' => $prevDeploys
138		];
139		$refs[self::REF_TYPE_SHA] = [
140		'id' => self::REF_TYPE_SHA,
141		'label' => 'Deploy a specific SHA',
142		'description' => 'Deploy a specific SHA'
143		];
144
145		return $this->getAPIResponse(['refs' => $refs], 200);
146		}
147
148		/**
149		* @return string
150		*/
151		public function Link() {
152		return \Controller::join_links($this->project->Link(), self::ACTION_GIT);
153		}
154
155		/**
156		* @param string $name
157		*
158		* @return array
159		*/
160		public function getModel($name = '') {
161		return [];
162		}
163
164		/**
165		* @param int $ID
166		* @return SS_HTTPResponse
167		*/
168		protected function getUpdateStatus($ID) {
169		$ping = DNGitFetch::get()->byID($ID);
170		if (!$ping) {
171		return $this->getAPIResponse(['message' => 'GIT update (' . $ID . ') not found'], 404);
172		}
173		$output = [
174		'id' => $ID,
175		'status' => $ping->ResqueStatus(),
176		'message' => array_filter(explode(PHP_EOL, $ping->LogContent()))
177		];
178
179		return $this->getAPIResponse($output, 200);
180		}
181
182		/**
183		* @return SS_HTTPResponse
184		*/
185	View Code Duplication	protected function createUpdate() {
		0 ignored issues – show Duplication introduced 2016-09-05 23:47 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
186		/** @var DNGitFetch $fetch */
187		$fetch = DNGitFetch::create();
188		$fetch->ProjectID = $this->project->ID;
189		$fetch->write();
190		$fetch->start();
191
192		$location = Director::absoluteBaseURL() . $this->Link() . '/update/' . $fetch->ID;
193		$output = [
194		'message' => 'git fetch has been queued',
195		'id' => $fetch->ID,
196		'location' => $location,
197		];
198
199		$response = $this->getAPIResponse($output, 201);
200		$response->addHeader('Location', $location);
201		return $response;
202		}
203
204		/**
205		* @param $project
206		*
207		* @return array
208		*/
209		protected function getGitBranches($project) {
210		$branches = [];
211		foreach ($project->DNBranchList() as $branch) {
212		$branches[] = [
213		'key' => $branch->SHA(),
214		'value' => $branch->Name(),
215		];
216		}
217		return $branches;
218		}
219
220		/**
221		* @param $project
222		*
223		* @return array
224		*/
225		protected function getGitTags($project) {
226		$tags = [];
227		foreach ($project->DNTagList()->setLimit(null) as $tag) {
228		$tags[] = [
229		'key' => $tag->SHA(),
230		'value' => $tag->Name(),
231		];
232		}
233		return $tags;
234		}
235
236		/**
237		* @param $project
238		*
239		* @return array
240		*/
241		protected function getGitPrevDeploys($project) {
242		$redeploy = [];
243	View Code Duplication	foreach ($project->DNEnvironmentList() as $dnEnvironment) {
		0 ignored issues – show Duplication introduced 2016-09-05 23:47 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
244		$envName = $dnEnvironment->Name;
245		$perEnvDeploys = [];
246		foreach ($dnEnvironment->DeployHistory() as $deploy) {
247		$sha = $deploy->SHA;
248
249		// Check if exists to make sure the newest deployment date is used.
250		if (!isset($perEnvDeploys[$sha])) {
251		$pastValue = sprintf(
252		"%s (deployed %s)",
253		substr($sha, 0, 8),
254		$deploy->obj('LastEdited')->Ago()
255		);
256		$perEnvDeploys[$sha] = [
257		'key' => $sha,
258		'value' => $pastValue
259		];
260		}
261		}
262		if (!empty($perEnvDeploys)) {
263		$redeploy[$envName] = array_values($perEnvDeploys);
264		}
265		}
266		return $redeploy;
267		}
268
269		}
270

silverstripe / deploynaut

Pull Request — master (#655)

GitDispatcher::createUpdate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like