DeploymentPipelineStepTest - 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

DeploymentPipelineStepTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	207
Duplicated Lines	7.25 %

Coupling/Cohesion

Components	1
Dependencies	8

Metric	Value
wmc	8
lcom	1
cbo	8
dl	15
loc	207
rs	10

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getDummyDeployment()	15	15	2
B	testSuccessful()	0	34	1
A	testSnapshotFailure()	0	20	1
A	testSnapshotSkipped()	0	13	1
B	testDeploymentFailure()	0	32	1
A	testDelayedSuccess()	0	47	1
A	testTimeout()	0	21	1

How to fix Duplicated Code

<?php

class DeploymentPipelineStepTest extends PipelineTest {
namespace YourVendor;

class YourClass { }

	protected static $fixture_file = 'PipelineTest.yml';

	/**
	 * Makes the dummy deployment step
	 *
	 * @return DeploymentPipelineStep
	 */
	public function getDummyDeployment($newEnv = false) {

		$deployStep = $this->objFromFixture('DeploymentPipelineStep', 'testdeploy');
		$deployStep->Config = serialize(array('MaxDuration' => '3600'));
		$deployStep->write();
		$pipeline = $deployStep->Pipeline();

		// simulates a new environment that hasn't got any current build
		if($newEnv) {
			$pipeline->EnvironmentID = $this->idFromFixture('PipelineTest_Environment', 'newenvironment');
		}

		$pipeline->Config = serialize(array());
		$pipeline->write();
		return $deployStep;
	}

	public function testSuccessful() {
		$step = $this->getDummyDeployment();
		$step->start();

		// Assert not error at startup
		$this->assertEquals('Started', $step->Status);

		$this->assertEquals('Snapshot', $step->Doing);

		$this->assertTrue(PipelineTest_MockLog::has_message('TestDeployStep:Snapshot creating snapshot of database'));


		// Mark the snapshot as completed and check result
		$snapshot = $step->Pipeline()->PreviousSnapshot();
		$snapshot->markFinished();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

		// Retry step
		PipelineTest_MockLog::clear();
		$step->start();

		$this->assertEquals('Started', $step->Status);

		$this->assertEquals('Deployment', $step->Doing);

		$this->assertTrue(PipelineTest_MockLog::has_message('TestDeployStep:Deployment starting deployment'));


		// Mark the service as completed and check result
		$author = $this->objFromFixture('Member', 'author');
		$deployment = $step->Pipeline()->CurrentDeployment();
		$this->assertEquals($deployment->DeployerID, $author->ID);

		$deployment->markFinished();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

		// Retry step
		PipelineTest_MockLog::clear();
		$step->start();
		$this->assertEquals('Finished', $step->Status);

		$this->assertTrue(PipelineTest_MockLog::has_message('Checking status of TestDeployStep:Deployment...'));

		$this->assertTrue(PipelineTest_MockLog::has_message('Step finished successfully!'));

	}

	/**
	 * Test failure at the snapshot step
	 */
	public function testSnapshotFailure() {
		$step = $this->getDummyDeployment();
		$step->start();

		// Assert not error at startup
		$this->assertEquals('Started', $step->Status);

		$this->assertEquals('Snapshot', $step->Doing);

		$this->assertTrue(PipelineTest_MockLog::has_message('TestDeployStep:Snapshot creating snapshot of database'));


		// Mark the service as completed and check result
		$snapshot = $step->Pipeline()->PreviousSnapshot();
		$snapshot->markFailed();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

		// Retry step
		PipelineTest_MockLog::clear();
		$step->start();
		$this->assertEquals('Failed', $step->Status);

		$this->assertTrue(PipelineTest_MockLog::has_message('Checking status of TestDeployStep:Snapshot...'));

		$this->assertTrue(PipelineTest_MockLog::has_message('TestDeployStep:Snapshot failed with task status Failed'));

	}

	/**
	 * Test snapshot is skipped when environment has no build
	 */
	public function testSnapshotSkipped() {
		$step = $this->getDummyDeployment(true);
		$step->start();

		// Assert not error at startup
		$this->assertEquals('Started', $step->Status);

		$this->assertEquals('Snapshot', $step->Doing);

		$this->assertTrue(PipelineTest_MockLog::has_message('[Skipped] No current build, skipping snapshot'));


		// Mark the service as completed and check result
		$snapshot = $step->Pipeline()->PreviousSnapshot();
		$this->assertFalse($snapshot->exists(), 'No snapshot was created');

	}

	/**
	 * Test failure at the deployment step
	 */
	public function testDeploymentFailure() {
		$step = $this->getDummyDeployment();
		$step->start();

		// Assert not error at startup
		$this->assertEquals('Started', $step->Status);

		$this->assertEquals('Snapshot', $step->Doing);

		$this->assertTrue(PipelineTest_MockLog::has_message('TestDeployStep:Snapshot creating snapshot of database'));


		// Mark the snapshot as completed and check result
		$snapshot = $step->Pipeline()->PreviousSnapshot();
		$snapshot->markFinished();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

		// Retry step
		PipelineTest_MockLog::clear();
		$step->start();

		$this->assertEquals('Started', $step->Status);

		$this->assertEquals('Deployment', $step->Doing);

		$this->assertTrue(PipelineTest_MockLog::has_message('TestDeployStep:Deployment starting deployment'));


		// Mark the service as completed and check result
		$deployment = $step->Pipeline()->CurrentDeployment();
		$deployment->markFailed();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

		// Retry step
		PipelineTest_MockLog::clear();
		$step->start();
		$this->assertEquals('Failed', $step->Status);

		$this->assertTrue(PipelineTest_MockLog::has_message('Checking status of TestDeployStep:Deployment...'));

		$this->assertTrue(PipelineTest_MockLog::has_message('TestDeployStep:Deployment failed with task status Failed'));

	}

	public function testDelayedSuccess() {
		$step = $this->getDummyDeployment();
		$step->start();

		// Assert not error at startup
		$this->assertEquals('Started', $step->Status);

		$this->assertEquals('Snapshot', $step->Doing);

		$this->assertTrue(PipelineTest_MockLog::has_message('TestDeployStep:Snapshot creating snapshot of database'));


		// Retry step
		PipelineTest_MockLog::clear();
		$step->start();
		$this->assertEquals('Started', $step->Status);

		$this->assertEquals('Snapshot', $step->Doing);

		$this->assertTrue(PipelineTest_MockLog::has_message('Checking status of TestDeployStep:Snapshot...'));

		$this->assertTrue(PipelineTest_MockLog::has_message('TestDeployStep:Snapshot is still in progress'));


		// Mark the snapshot as completed and check result
		$snapshot = $step->Pipeline()->PreviousSnapshot();
		$snapshot->markFinished();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

		// Advance to deployment
		PipelineTest_MockLog::clear();
		$step->start();
		$this->assertEquals('Started', $step->Status);

		$this->assertEquals('Deployment', $step->Doing);

		$this->assertTrue(PipelineTest_MockLog::has_message('TestDeployStep:Deployment starting deployment'));


		// Retry step
		PipelineTest_MockLog::clear();
		$step->start();
		$this->assertEquals('Started', $step->Status);

		$this->assertEquals('Deployment', $step->Doing);

		$this->assertTrue(PipelineTest_MockLog::has_message('Checking status of TestDeployStep:Deployment...'));

		$this->assertTrue(PipelineTest_MockLog::has_message('TestDeployStep:Deployment is still in progress'));


		// Mark the service as completed and check result
		$deployment = $step->Pipeline()->CurrentDeployment();
		$deployment->markFinished();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

		// Retry step
		PipelineTest_MockLog::clear();
		$step->start();
		$this->assertEquals('Finished', $step->Status);

		$this->assertTrue(PipelineTest_MockLog::has_message('Checking status of TestDeployStep:Deployment...'));

		$this->assertTrue(PipelineTest_MockLog::has_message('Step finished successfully!'));

	}

	public function testTimeout() {
		$step = $this->getDummyDeployment();
		$step->start();

		// Assert not error at startup
		$this->assertEquals('Started', $step->Status);

		$this->assertTrue(PipelineTest_MockLog::has_message('TestDeployStep:Snapshot creating snapshot of database'));


		// Go to two hours into the future
		SS_Datetime::set_mock_now(date('Y-m-d H:i:s', strtotime('+2 hours')));

		// Retry step
		PipelineTest_MockLog::clear();
		$step->start();
		$this->assertEquals('Failed', $step->Status);

		$this->assertTrue($step->isTimedOut());

		$this->assertTrue(PipelineTest_MockLog::has_message('Checking status of TestDeployStep:Snapshot...'));

		$this->assertTrue(PipelineTest_MockLog::has_message(

			'TestDeployStep:Snapshot took longer than 3600 seconds to run and has timed out'
		));
	}
}


1		<?php
2
3		class DeploymentPipelineStepTest 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		protected static $fixture_file = 'PipelineTest.yml';
6
7		/**
8		* Makes the dummy deployment step
9		*
10		* @return DeploymentPipelineStep
11		*/
12	View Code Duplication	public function getDummyDeployment($newEnv = false) {
		0 ignored issues – show Duplication introduced 2016-02-21 21:44 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...
13		$deployStep = $this->objFromFixture('DeploymentPipelineStep', 'testdeploy');
14		$deployStep->Config = serialize(array('MaxDuration' => '3600'));
15		$deployStep->write();
16		$pipeline = $deployStep->Pipeline();
17
18		// simulates a new environment that hasn't got any current build
19		if($newEnv) {
20		$pipeline->EnvironmentID = $this->idFromFixture('PipelineTest_Environment', 'newenvironment');
21		}
22
23		$pipeline->Config = serialize(array());
24		$pipeline->write();
25		return $deployStep;
26		}
27
28		public function testSuccessful() {
29		$step = $this->getDummyDeployment();
30		$step->start();
31
32		// Assert not error at startup
33		$this->assertEquals('Started', $step->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<DeploymentPipelineStepTest>`. 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...
34		$this->assertEquals('Snapshot', $step->Doing);
		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<DeploymentPipelineStepTest>`. 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...
35		$this->assertTrue(PipelineTest_MockLog::has_message('TestDeployStep:Snapshot creating snapshot of database'));
		1 ignored issue – show Bug introduced 2016-02-21 21:44 UTC by Report Bug Copy Issue Report The method `assertTrue()` does not seem to exist on `object<DeploymentPipelineStepTest>`. 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...

silverstripe / deploynaut

Pull Request — master (#513)

DeploymentPipelineStepTest A

Complexity

Size/Duplication

Coupling/Cohesion

7 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like