UserDefinedFormControllerTest::checkTemplateIsCorrect() - Code Metrics - Inspection of "Merge pull request #409 from pulls/core-validation" - silverstripe/silverstripe-userforms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b537e6...b70c66 )

by Daniel

created 2016-04-22 13:45 UTC

checkTemplateIsCorrect() A

↳ Parent: UserDefinedFormControllerTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	18
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

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

<?php

/**
 * @package userforms
 */

class UserDefinedFormControllerTest extends FunctionalTest {
namespace YourVendor;

class YourClass { }

	static $fixture_file = 'UserDefinedFormTest.yml';
class A {
    var $property;
}

	public function testProcess() {
		$form = $this->setupFormFrontend();

		$controller = new UserDefinedFormControllerTest_Controller($form);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

		$this->autoFollowRedirection = false;
		$this->clearEmails();

		// load the form
		$this->get($form->URLSegment);

		$field = $this->objFromFixture('EditableTextField', 'basic-text');

		$response = $this->submitForm('UserForm_Form', null, array($field->Name => 'Basic Value'));

		// should have a submitted form field now
		$submitted = DataObject::get('SubmittedFormField', "\"Name\" = 'basic-text-name'");
		$this->assertDOSAllMatch(array('Name' => 'basic-text-name', 'Value' => 'Basic Value', 'Title' => 'Basic Text Field'), $submitted);

		// check emails
		$this->assertEmailSent('[email protected]', '[email protected]', 'Email Subject');
		$email = $this->findEmail('[email protected]', '[email protected]', 'Email Subject');

		// assert that the email has the field title and the value html email
		$parser = new CSSContentParser($email['content']);
		$title = $parser->getBySelector('strong');

		$this->assertEquals('Basic Text Field', (string) $title[0], 'Email contains the field name');


		$value = $parser->getBySelector('dd');
		$this->assertEquals('Basic Value', (string) $value[0], 'Email contains the value');


		// no html
		$this->assertEmailSent('[email protected]', '[email protected]', 'Email Subject');
		$nohtml = $this->findEmail('[email protected]', '[email protected]', 'Email Subject');

		$this->assertContains('Basic Text Field: Basic Value', $nohtml['content'], 'Email contains no html');

		// no data
		$this->assertEmailSent('[email protected]', '[email protected]', 'Email Subject');
		$nodata = $this->findEmail('[email protected]', '[email protected]', 'Email Subject');

		$parser = new CSSContentParser($nodata['content']);
		$list = $parser->getBySelector('dl');

		$this->assertFalse(isset($list[0]), 'Email contains no fields');


		// check to see if the user was redirected (301)
		$this->assertEquals($response->getStatusCode(), 302);

		$this->assertStringEndsWith('finished#uff', $response->getHeader('Location'));

	}

	public function testValidation() {
		$form = $this->setupFormFrontend('email-form');

		// Post with no fields
		$this->get($form->URLSegment);
		$response = $this->submitForm('UserForm_Form', null, array());
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$this->assertPartialMatchBySelector(
			'.field .message',
			array('This field is required')
		);

		// Post with all fields, but invalid email
		$this->get($form->URLSegment);
		$this->submitForm('UserForm_Form', null, array(
			'required-email' => 'invalid',
			'required-text' => 'bob'
		));
		$this->assertPartialMatchBySelector(
			'.field .message',
			array('Please enter an email address')
		);

		// Post with only required
		$this->get($form->URLSegment);
		$this->submitForm('UserForm_Form', null, array(
			'required-text' => 'bob'
		));
		$this->assertPartialMatchBySelector(
			'p',
			array("Thanks, we've received your submission.")
		);
	}

	public function testFinished() {

		$form = $this->setupFormFrontend();

		// set formProcessed and SecurityID to replicate the form being filled out
		$this->session()->inst_set('SecurityID', 1);
		$this->session()->inst_set('FormProcessed', 1);

		$response = $this->get($form->URLSegment.'/finished');

		$this->assertContains($form->OnCompleteMessage ,$response->getBody());
	}

	public function testAppendingFinished() {

		$form = $this->setupFormFrontend();

		// replicate finished being added to the end of the form URL without the form being filled out
		$this->session()->inst_set('SecurityID', 1);
		$this->session()->inst_set('FormProcessed', null);

		$response = $this->get($form->URLSegment.'/finished');

		$this->assertNotContains($form->OnCompleteMessage ,$response->getBody());
	}

	public function testForm() {
		$form = $this->objFromFixture('UserDefinedForm', 'basic-form-page');

		$controller = new UserDefinedFormControllerTest_Controller($form);

		// test form
		$this->assertEquals($controller->Form()->getName(), 'Form', 'The form is referenced as Form');

		$this->assertEquals($controller->Form()->Fields()->Count(), 1); // disabled SecurityID token fields

		$this->assertEquals($controller->Form()->Actions()->Count(), 1);

		$this->assertEquals(count($controller->Form()->getValidator()->getRequired()), 0);


		$requiredForm = $this->objFromFixture('UserDefinedForm', 'validation-form');
		$controller = new UserDefinedFormControllerTest_Controller($requiredForm);

		$this->assertEquals($controller->Form()->Fields()->Count(), 1); // disabled SecurityID token fields

		$this->assertEquals($controller->Form()->Actions()->Count(), 1);

		$this->assertEquals(count($controller->Form()->getValidator()->getRequired()), 1);

	}

	public function testGetFormFields() {
		// generating the fieldset of fields
		$form = $this->objFromFixture('UserDefinedForm', 'basic-form-page');

		$controller = new UserDefinedFormControllerTest_Controller($form);

		$formSteps = $controller->Form()->getFormFields();
		$firstStep = $formSteps->first();

		$this->assertEquals($formSteps->Count(), 1);

		$this->assertEquals($firstStep->getChildren()->Count(), 1);


		// custom error message on a form field
		$requiredForm = $this->objFromFixture('UserDefinedForm', 'validation-form');
		$controller = new UserDefinedFormControllerTest_Controller($requiredForm);

		UserDefinedForm::config()->required_identifier = "*";

		$formSteps = $controller->Form()->getFormFields();
		$firstStep = $formSteps->first();
		$firstField = $firstStep->getChildren()->first();

		$this->assertEquals('Custom Error Message', $firstField->getCustomValidationMessage());

		$this->assertEquals($firstField->Title(), 'Required Text Field <span class=\'required-identifier\'>*</span>');


		// test custom right title
		$field = $form->Fields()->limit(1, 1)->First();

		$field->RightTitle = 'Right Title';
		$field->write();

		$controller = new UserDefinedFormControllerTest_Controller($form);
		$formSteps = $controller->Form()->getFormFields();
		$firstStep = $formSteps->first();

		$this->assertEquals($firstStep->getChildren()->First()->RightTitle(), "Right Title");


		// test empty form
		$emptyForm = $this->objFromFixture('UserDefinedForm', 'empty-form');
		$controller = new UserDefinedFormControllerTest_Controller($emptyForm);

		$this->assertFalse($controller->Form()->getFormFields()->exists());

	}

	public function testGetFormActions()
	{
		// generating the fieldset of actions
		$form = $this->objFromFixture('UserDefinedForm', 'basic-form-page');

		$controller = new UserDefinedFormControllerTest_Controller($form);
		$actions = $controller->Form()->getFormActions();

		// by default will have 1 submit button which links to process
		$expected = new FieldList(new FormAction('process', 'Submit'));
		$expected->setForm($controller->Form());

		$this->assertEquals($actions, $expected);


		// the custom popup should have a reset button and a custom text
		$custom = $this->objFromFixture('UserDefinedForm', 'form-with-reset-and-custom-action');
		$controller = new UserDefinedFormControllerTest_Controller($custom);
		$actions = $controller->Form()->getFormActions();

		$expected = new FieldList(new FormAction('process', 'Custom Button'));
		$expected->push(new ResetFormAction("clearForm", "Clear"));
		$expected->setForm($controller->Form());

		$this->assertEquals($actions, $expected);

	}

	public function testRenderingIntoFormTemplate() {

		$form = $this->setupFormFrontend();

		$form->Content = 'This is some content without a form nested between it';
		$form->doPublish();

		$controller = new UserDefinedFormControllerTest_Controller($form);

		// check to see if $Form is replaced to inside the content
		$index = new ArrayData($controller->index());
		$parser = new CSSContentParser($index->renderWith(array('UserDefinedFormControllerTest')));

		$this->checkTemplateIsCorrect($parser);
	}

	public function testRenderingIntoTemplateWithSubstringReplacement() {

		$form = $this->setupFormFrontend();

		$controller = new UserDefinedFormControllerTest_Controller($form);

		// check to see if $Form is replaced to inside the content
		$index = new ArrayData($controller->index());
		$parser = new CSSContentParser($index->renderWith(array('UserDefinedFormControllerTest')));

		$this->checkTemplateIsCorrect($parser);
	}
	/**
	 * Publish a form for use on the frontend
	 *
	 * @param string $fixtureName
	 * @return UserDefinedForm
	 */
	protected function setupFormFrontend($fixtureName = 'basic-form-page') {
		$form = $this->objFromFixture('UserDefinedForm', $fixtureName);
		$this->logInWithPermission('ADMIN');

		$form->doPublish();

		$member = Member::currentUser();
		$member->logOut();

		return $form;
	}

	public function checkTemplateIsCorrect($parser) {
		$this->assertArrayHasKey(0, $parser->getBySelector('form#UserForm_Form'));


		// check for the input
		$this->assertArrayHasKey(0, $parser->getBySelector('input.text'));


		// check for the label and the text
		$label = $parser->getBySelector('label.left');
		$this->assertArrayHasKey(0, $label);


		$this->assertEquals((string) $label[0][0], "Basic Text Field", "Label contains correct field name");


		// check for the action
		$action = $parser->getBySelector('input.action');
		$this->assertArrayHasKey(0, $action);


		$this->assertEquals((string) $action[0]['value'], "Submit", "Submit button has default text");

	}
}

class UserDefinedFormControllerTest_Controller extends UserDefinedForm_Controller implements TestOnly {
namespace YourVendor;

class YourClass { }

	/**
	 * Overloaded to avoid inconsistencies between 2.4.2 and 2.4.3 (disables all security tokens in unit tests by default)
	 */
	public function Form() {
		$form = parent::Form();

		if($form) $form->disableSecurityToken();

		return $form;
	}

}


1			<?php
2
3			/**
4			* @package userforms
5			*/
6
7			class UserDefinedFormControllerTest extends FunctionalTest {
			0 ignored issues – show Coding Style Compatibility introduced 2015-11-21 07:02 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			static $fixture_file = 'UserDefinedFormTest.yml';
			0 ignored issues – show Coding Style introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$fixture_file`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
10
11			public function testProcess() {
12			$form = $this->setupFormFrontend();
13
14			$controller = new UserDefinedFormControllerTest_Controller($form);
			0 ignored issues – show Unused Code introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report `$controller` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
15
16			$this->autoFollowRedirection = false;
17			$this->clearEmails();
18
19			// load the form
20			$this->get($form->URLSegment);
21
22			$field = $this->objFromFixture('EditableTextField', 'basic-text');
23
24			$response = $this->submitForm('UserForm_Form', null, array($field->Name => 'Basic Value'));
25
26			// should have a submitted form field now
27			$submitted = DataObject::get('SubmittedFormField', "\"Name\" = 'basic-text-name'");
28			$this->assertDOSAllMatch(array('Name' => 'basic-text-name', 'Value' => 'Basic Value', 'Title' => 'Basic Text Field'), $submitted);
29
30			// check emails
31			$this->assertEmailSent('[email protected]', '[email protected]', 'Email Subject');
32			$email = $this->findEmail('[email protected]', '[email protected]', 'Email Subject');
33
34			// assert that the email has the field title and the value html email
35			$parser = new CSSContentParser($email['content']);
36			$title = $parser->getBySelector('strong');
37

silverstripe / silverstripe-userforms

Push — master ( b537e6...b70c66 )

checkTemplateIsCorrect() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like