UserConfirmationStepTest::testSendDelay() - 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

UserConfirmationStepTest::testSendDelay() A

↳ Parent: UserConfirmationStepTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	64
Code Lines	44

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	64
rs	9.3956
cc	1
eloc	44
nc	1
nop	0

How to fix Long Method

<?php

class UserConfirmationStepTest extends PipelineTest {
namespace YourVendor;

class YourClass { }

	protected static $fixture_file = 'PipelineTest.yml';

	/**
	 * Makes the dummy confirmation step
	 *
	 * @return UserConfirmationStep
	 */
	public function getDummyConfirmationStep() {

		// Load data into step and pipeline
		$data = $this->getPipelineConfig();
		$confirmStep = $this->objFromFixture('UserConfirmationStep', 'testconfirm');
		$pipeline = $confirmStep->Pipeline();
		$pipeline->Config = serialize($data);
		$pipeline->write();
		$confirmStep->Config = serialize($pipeline->getConfigSetting('Steps', 'RequestConfirmationStep'));
		$confirmStep->write();

		return $confirmStep;
	}

	/**
	 * Test that timeout expiry works
	 */
	public function testTimeout() {
		$step = $this->getDummyConfirmationStep();

		// Assert dependencies are injected
		$this->assertTrue($step->getMessagingService() instanceof ConfirmationMessagingService);

		$step->start();

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

		$this->assertHasLog('Starting TestConfirmStep...');

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

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

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

		$this->assertSentMessage(
			'Deployment approval for testproject/uat has timed out due to no response',
			'[email protected]'
		);
		$this->assertSentMessage(
			'Deployment approval for testproject/uat has timed out due to no response',
			'[email protected]'
		);
		$this->assertHasLog(
			"TestConfirmStep took longer than 604800 seconds (7 days) to be approved and has timed out"
		);
	}

	public function testSendConfirm() {
		$step = $this->getDummyConfirmationStep();

		// Assert dependencies are injected
		$this->assertTrue($step->getMessagingService() instanceof ConfirmationMessagingService);

		$step->start();

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

		$this->assertEquals('None', $step->Approval);

		$this->assertHasLog('Starting TestConfirmStep...');
		$this->assertFalse($step->isTimedOut());

		$link = Director::absoluteURL('naut/project/testproject/environment/uat');
		$this->assertSentMessage(
			"You requested approval for deployment of testproject/uat. Cancel? {$link}",
			'[email protected]'
		);
		$this->assertSentMessage(
			"Deployment for testproject/uat requested by Marley, Bob. Approve? {$link}",
			'[email protected]'
		);
	}

	/**
	 * Test delayed notification
	 */
	public function testSendDelay() {
		$step = $this->getDummyConfirmationStep();

		// Assert dependencies are injected
		$this->assertTrue($step->getMessagingService() instanceof ConfirmationMessagingService);

		$step->start();

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

		$this->assertHasLog('Starting TestConfirmStep...');

		// Check only recipient and first admin has been notified
		$this->assertFalse($step->isTimedOut());

		$link = Director::absoluteURL('naut/project/testproject/environment/uat');
		$this->assertSentMessage(
			"You requested approval for deployment of testproject/uat. Cancel? {$link}",
			'[email protected]'
		);
		$this->assertSentMessage(
			"Deployment for testproject/uat requested by Marley, Bob. Approve? {$link}",
			'[email protected]'
		);
		$this->assertEquals(2, count(PipelineTest_RecordingMessageSender::get_messages()));


		// Advance 1 hour and ensure no other notifications have been sent
		SS_Datetime::set_mock_now(date('Y-m-d H:i:s', strtotime('+1 hour')));
		$this->clearLog();
		$step->start();
		$this->assertFalse($step->isTimedOut());

		$this->assertEmpty(PipelineTest_RecordingMessageSender::get_messages());


		// Advance 3 hours (2 more) and ensure the next notification is sent out
		SS_Datetime::set_mock_now(date('Y-m-d H:i:s', strtotime('+3 hour')));
		$this->clearLog();
		$step->start();
		$this->assertFalse($step->isTimedOut());

		$this->assertSentMessage(
			"Deployment for testproject/uat requested by Marley, Bob. Approve? {$link}",
			'[email protected]'
		);
		$this->assertSentMessage(
			"Deployment for testproject/uat requested by Marley, Bob. Approve? {$link}",
			'[email protected]'
		);
		$this->assertEquals(2, count(PipelineTest_RecordingMessageSender::get_messages()));


		// Go to 5 hours (another 2) and ensure the final notification is sent
		SS_Datetime::set_mock_now(date('Y-m-d H:i:s', strtotime('+5 hour')));
		$this->clearLog();
		$step->start();
		$this->assertFalse($step->isTimedOut());

		$this->assertSentMessage(
			"Deployment for testproject/uat requested by Marley, Bob. Approve? {$link}",
			'[email protected]'
		);
		$this->assertEquals(1, count(PipelineTest_RecordingMessageSender::get_messages()));


		// Go to 24 hours and ensure no notifications are sent
		SS_Datetime::set_mock_now(date('Y-m-d H:i:s', strtotime('+24 hour')));
		$this->clearLog();
		$step->start();
		$this->assertFalse($step->isTimedOut());

		$this->assertEmpty(PipelineTest_RecordingMessageSender::get_messages());

	}

	public function testRejection() {
		$step = $this->getDummyConfirmationStep();

		// Assert dependencies are injected
		$this->assertTrue($step->getMessagingService() instanceof ConfirmationMessagingService);

		$step->start();
		$this->logInWithPermission('ADMIN');
		$step->reject();

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

		$this->assertEquals('Rejected', $step->Approval);

		$this->assertHasLog('TestConfirmStep has been rejected');
		$this->assertNotSentMessage('Deployment for testproject/uat has failed', '[email protected]');
		$this->assertNotSentMessage('Deployment for testproject/uat has failed', '[email protected]');
		$this->assertNotSentMessage('Deployment for testproject/uat has failed', '[email protected]');
		$this->assertSentMessage('Deployment for testproject/uat has been rejected', '[email protected]');
		$this->assertSentMessage('Deployment for testproject/uat has been rejected', '[email protected]');
	}

	public function testApproval() {

		$step = $this->getDummyConfirmationStep();

		// Assert dependencies are injected
		$this->assertTrue($step->getMessagingService() instanceof ConfirmationMessagingService);

		$step->start();
		$this->logInWithPermission('ADMIN');
		$step->approve();

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

		$this->assertEquals('Approved', $step->Approval);

		$this->assertHasLog('TestConfirmStep has been approved');
		$this->assertSentMessage('Deployment for testproject/uat has been approved', '[email protected]');
		$this->assertSentMessage('Deployment for testproject/uat has been approved', '[email protected]');
	}
}


1		<?php
2
3		class UserConfirmationStepTest 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 confirmation step
9		*
10		* @return UserConfirmationStep
11		*/
12	View Code Duplication	public function getDummyConfirmationStep() {
		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		// Load data into step and pipeline
14		$data = $this->getPipelineConfig();
15		$confirmStep = $this->objFromFixture('UserConfirmationStep', 'testconfirm');
16		$pipeline = $confirmStep->Pipeline();
17		$pipeline->Config = serialize($data);
18		$pipeline->write();
19		$confirmStep->Config = serialize($pipeline->getConfigSetting('Steps', 'RequestConfirmationStep'));
20		$confirmStep->write();
21
22		return $confirmStep;
23		}
24
25		/**
26		* Test that timeout expiry works
27		*/
28		public function testTimeout() {
29		$step = $this->getDummyConfirmationStep();
30
31		// Assert dependencies are injected
32		$this->assertTrue($step->getMessagingService() instanceof ConfirmationMessagingService);
		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<UserConfirmationStepTest>`. 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...
33		$step->start();
34
35		// Assert not error at startup
36		$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<UserConfirmationStepTest>`. 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)

UserConfirmationStepTest::testSendDelay() A

Complexity

Size

Duplication

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like