AbstractPipelineTest - Code Metrics - Inspection of "Added standard Scrutinizer config" - silverstripe/deploynaut - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#513)

by Helpful

created 2016-02-21 21:40 UTC

AbstractPipelineTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	229
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Metric	Value
wmc	9
lcom	1
cbo	6
dl	0
loc	229
rs	10

9 Methods

Rating	Name	Size	Complexity
A	testCheckPipelineStatus()	50	1
A	testAborted()	18	1
A	testAbortPipelineLink()	7	1
A	testCanCancelPipeline()	23	1
A	testMarkFailed()	22	1
B	getFailingPipeline()	29	1
A	testMarkFailedRollbackStart()	19	1
A	testMarkFailedRollbackFailing()	20	1
B	testMarkCompleteRollback()	24	1

<?php

class AbstractPipelineTest extends PipelineTest {
namespace YourVendor;

class YourClass { }

	// Fixture file containing test pipeline data
	protected static $fixture_file = 'AbstractPipelineTest.yml';

	public function testCheckPipelineStatus() {
		$pipeline = $this->objFromFixture('Pipeline', 'Pipe2');
		$pipeline->Config = serialize(array());
		$pipeline->write();

		// First step should start.
		$pipeline->checkPipelineStatus();

		$this->assertEquals('Running', $pipeline->Status);

		$this->assertEquals(true, $pipeline->isRunning());

		$this->assertDOSEquals(array(
			array('Name'=>'step1', 'Status'=>'Started'),
			array('Name'=>'step2', 'Status'=>'Queued'),
		), $pipeline->Steps());

		// Try to progress the pipeline second time. Shouldn't move until step is finished.
		$pipeline->checkPipelineStatus();
		$this->assertEquals('Running', $pipeline->Status);

		$this->assertEquals(true, $pipeline->isRunning());

		$this->assertDOSEquals(array(
			array('Name'=>'step1', 'Status'=>'Started'),
			array('Name'=>'step2', 'Status'=>'Queued'),
		), $pipeline->Steps());

		// First step finished, pipeline should move now.
		$firstStep = $pipeline->CurrentStep();
		$firstStep->Status = 'Finished';
		$firstStep->write();
		$pipeline->checkPipelineStatus();

		$this->assertEquals('Running', $pipeline->Status);

		$this->assertEquals(true, $pipeline->isRunning());

		$this->assertDOSEquals(array(
			array('Name'=>'step1', 'Status'=>'Finished'),
			array('Name'=>'step2', 'Status'=>'Started'),
		), $pipeline->Steps());

		// Last step finished. Pipeline should fold now.
		$lastStep = $pipeline->CurrentStep();
		$lastStep->Status = 'Finished';
		$lastStep->write();
		$pipeline->checkPipelineStatus();

		$this->assertEquals('Complete', $pipeline->Status);

		$this->assertEquals(false, $pipeline->isRunning());

		$this->assertDOSEquals(array(
			array('Name'=>'step1', 'Status'=>'Finished'),
			array('Name'=>'step2', 'Status'=>'Finished'),
		), $pipeline->Steps());
	}

	public function testAborted() {
		$pipeline = $this->objFromFixture('Pipeline', 'Pipe1');
		$pipeline->Config = serialize(array());
		$pipeline->write();

		$pipeline->markAborted();

		// confirm Status is now aborted
		$this->assertEquals('Aborted', $pipeline->Status);

		$this->assertEquals(true, $pipeline->isAborted());


		// Confirm steps have correct status.
		$this->assertDOSEquals(array(
			array('Name'=>'step1', 'Status'=>'Finished'),
			array('Name'=>'step2', 'Status'=>'Aborted'),
			array('Name'=>'step3', 'Status'=>'Aborted')
		), $pipeline->Steps());
	}

	public function testAbortPipelineLink() {
		$pipeline = $this->objFromFixture('Pipeline', 'Pipe1');

		// Confirm the correct abort link is generated
		$this->assertEquals($pipeline->Link('abort'),

			'naut/project/Project 1/environment/env1/pipeline/'.$pipeline->ID.'/abort');
	}

	public function testCanCancelPipeline() {
		$member = $this->objFromFixture('Member', 'Deployer2');
		$member->logIn();
		$pipeline = $this->objFromFixture('Pipeline', 'Pipe1');

		$environment = $pipeline->Environment();

		// confirm Status is now running
		$this->assertEquals('Running', $pipeline->Status);


		// confirm non-admin member who did not start the pipeline cannot stop it
		$this->assertEquals(false, $environment->CanCancelPipeline());


		// confirm member who started pipeline can stop it
		$member = $this->objFromFixture('Member', 'Deployer1');
		$member->logIn();
		$this->assertEquals(true, $environment->CanCancelPipeline());


		// confirm admin member can stop pipeline
		$member = $this->objFromFixture('Member', 'Deployer3');
		$member->logIn();
		$this->assertEquals(true, $environment->CanCancelPipeline());

	}

	public function testMarkFailed() {
		$pipeline = $this->objFromFixture('Pipeline', 'Pipe1');
		$pipeline->Config = serialize(array());
		$pipeline->write();

		// Pretend second step fails.
		$step = $this->objFromFixture('PipelineStep', 'Step2');
		$step->Status = 'Failed';
		$step->write();
		$pipeline->markFailed();

		// confirm Status is now Failed.
		$this->assertEquals('Failed', $pipeline->Status);

		$this->assertEquals(true, $pipeline->isFailed());


		// Confirm steps have correct status.
		$this->assertDOSEquals(array(
			array('Name'=>'step1', 'Status'=>'Finished'),
			array('Name'=>'step2', 'Status'=>'Failed'),
			array('Name'=>'step3', 'Status'=>'Aborted')
		), $pipeline->Steps());
	}

	/**
	 * Provide rollback-able pipeline on the verge of failing.
	 */
	public function getFailingPipeline() {
		// Get default backups
		$previous = DNDeployment::create();
		$previous->SHA = '9f0a012e97715b1871n41gk30f34268u12a0029q';
		$previous->write();
		$current = DNDeployment::create();
		$current->write();
		$snapshot = DNDataTransfer::create();
		$snapshot->write();

		$pipeline = $this->objFromFixture('Pipeline', 'FailingPipe');
		$pipeline->Config = serialize(array(
			'RollbackStep1' => array(
				'Class' => 'RollbackStep',
				'RestoreDB' => false,
				'MaxDuration' => '3600'
			),
			'RollbackStep2' => array(
				'Class' => 'SmokeTestPipelineStep',
				'MaxDuration' => '3600'
			)
		));
		$pipeline->PreviousDeploymentID = $previous->ID;
		$pipeline->CurrentDeploymentID = $current->ID;
		$pipeline->PreviousSnapshotID = $snapshot->ID;
		$pipeline->write();

		return $pipeline;
	}

	public function testMarkFailedRollbackStart() {

		$pipeline = $this->getFailingPipeline();
		$this->assertEquals($pipeline->RollbackStep1ID, 0);

		$this->assertEquals($pipeline->RollbackStep2ID, 0);

		$this->assertFalse($pipeline->isFailed());

		$this->assertFalse($pipeline->isRollback());


		$pipeline->markFailed();

		$this->assertNotEmpty($pipeline->RollbackStep1());

		$this->assertNotEmpty($pipeline->RollbackStep2());

		$this->assertFalse($pipeline->isFailed());

		$this->assertTrue($pipeline->isRollback());

		$this->assertHasLog('Beginning rollback...');
		$this->assertEquals($pipeline->RollbackStep1()->Status, 'Started');

		$this->assertEquals($pipeline->RollbackStep2()->Status, 'Queued');


	}

	public function testMarkFailedRollbackFailing() {

		$pipeline = $this->getFailingPipeline();

		// Trigger rollback.
		$pipeline->markFailed();

		// Fail first rollback step.
		$pipeline->RollbackStep1()->markFailed();

		$this->assertHasLog('Pipeline failed, rollback failed.');

		$pipeline = Pipeline::get()->byID($pipeline->ID);
		$this->assertTrue($pipeline->isFailed());

		$this->assertFalse($pipeline->isRollback());

		$this->assertEquals($pipeline->RollbackStep1()->Status, 'Failed');

		$this->assertEquals($pipeline->RollbackStep2()->Status, 'Aborted');

		$this->assertEquals($pipeline->Status, 'Failed');


	}

	public function testMarkCompleteRollback() {

		$pipeline = $this->getFailingPipeline();

		// Trigger rollback.
		$pipeline->markFailed();

		// Succeed the rollback.
		$pipeline->RollbackStep1()->finish();
		$pipeline->RollbackStep2()->finish();

		// Progress the pipeline. Will call markFailed.
		$pipeline->checkPipelineStatus();

		$this->assertHasLog('Pipeline failed, but rollback completed successfully.');

		$pipeline = Pipeline::get()->byID($pipeline->ID);
		$this->assertTrue($pipeline->isFailed());

		$this->assertFalse($pipeline->isRollback());

		$this->assertEquals($pipeline->RollbackStep1()->Status, 'Finished');

		$this->assertEquals($pipeline->RollbackStep2()->Status, 'Finished');

		$this->assertEquals($pipeline->Status, 'Failed');


	}
}


1			<?php
2
3			class AbstractPipelineTest extends PipelineTest {
			1 ignored issue – show Coding Style Compatibility introduced 2016-02-21 21:44 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...
4
5			// Fixture file containing test pipeline data
6			protected static $fixture_file = 'AbstractPipelineTest.yml';
7
8			public function testCheckPipelineStatus() {
9			$pipeline = $this->objFromFixture('Pipeline', 'Pipe2');
10			$pipeline->Config = serialize(array());
11			$pipeline->write();
12
13			// First step should start.
14			$pipeline->checkPipelineStatus();
15
16			$this->assertEquals('Running', $pipeline->Status);
			1 ignored issue – show Bug introduced 2016-02-21 21:44 UTC by Report Bug Copy Issue Report The method `assertEquals()` does not seem to exist on `object<AbstractPipelineTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
17			$this->assertEquals(true, $pipeline->isRunning());
			1 ignored issue – show Bug introduced 2016-02-21 21:44 UTC by Report Bug Copy Issue Report The method `assertEquals()` does not seem to exist on `object<AbstractPipelineTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
18			$this->assertDOSEquals(array(
19			array('Name'=>'step1', 'Status'=>'Started'),
20			array('Name'=>'step2', 'Status'=>'Queued'),
21			), $pipeline->Steps());
22
23			// Try to progress the pipeline second time. Shouldn't move until step is finished.
24			$pipeline->checkPipelineStatus();
25			$this->assertEquals('Running', $pipeline->Status);
			1 ignored issue – show Bug introduced 2016-02-21 21:44 UTC by Report Bug Copy Issue Report The method `assertEquals()` does not seem to exist on `object<AbstractPipelineTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
26			$this->assertEquals(true, $pipeline->isRunning());
			1 ignored issue – show Bug introduced 2016-02-21 21:44 UTC by Report Bug Copy Issue Report The method `assertEquals()` does not seem to exist on `object<AbstractPipelineTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
27			$this->assertDOSEquals(array(
28			array('Name'=>'step1', 'Status'=>'Started'),
29			array('Name'=>'step2', 'Status'=>'Queued'),
30			), $pipeline->Steps());
31
32			// First step finished, pipeline should move now.
33			$firstStep = $pipeline->CurrentStep();
34			$firstStep->Status = 'Finished';
35			$firstStep->write();

silverstripe / deploynaut

Pull Request — master (#513)

AbstractPipelineTest A

Complexity

Size/Duplication

Coupling/Cohesion

9 Methods

Duplication Side-by-Side

Filter issues like