silverstripe-userforms/tests/Control/UserDefinedFormControllerTest.php

428 lines
16 KiB
PHP
Raw Normal View History

<?php
namespace SilverStripe\UserForms\Tests\Control;
use SilverStripe\Assets\Dev\TestAssetStore;
use SilverStripe\Assets\File;
use SilverStripe\Assets\Folder;
use SilverStripe\Assets\Storage\AssetStore;
use SilverStripe\Assets\Upload_Validator;
use InvalidArgumentException;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\HTTPResponse;
use SilverStripe\Control\Session;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\CSSContentParser;
use SilverStripe\Dev\FunctionalTest;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\FormAction;
use SilverStripe\ORM\DataObject;
use SilverStripe\Security\InheritedPermissions;
use SilverStripe\UserForms\Control\UserDefinedFormController;
use SilverStripe\UserForms\Model\EditableFormField;
use SilverStripe\UserForms\Model\EditableFormField\EditableFileField;
use SilverStripe\UserForms\Model\EditableFormField\EditableTextField;
use SilverStripe\UserForms\Model\Recipient\EmailRecipient;
use SilverStripe\UserForms\Model\Submission\SubmittedFormField;
use SilverStripe\UserForms\Model\UserDefinedForm;
use SilverStripe\View\ArrayData;
use SilverStripe\View\SSViewer;
/**
* @package userforms
*/
2016-07-21 07:53:59 +02:00
class UserDefinedFormControllerTest extends FunctionalTest
{
protected static $fixture_file = '../UserFormsTest.yml';
protected static $use_draft_site = true;
protected static $disable_themes = true;
protected function setUp()
{
parent::setUp();
// Set backend and base url
TestAssetStore::activate('AssetStoreTest');
Config::modify()->merge(SSViewer::class, 'themes', ['simple', '$default']);
}
public function tearDown()
{
TestAssetStore::reset();
parent::tearDown();
}
2016-07-21 07:53:59 +02:00
public function testProcess()
{
$form = $this->setupFormFrontend();
2015-09-11 00:20:06 +02:00
$controller = new UserDefinedFormController($form);
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
$this->autoFollowRedirection = false;
$this->clearEmails();
2015-08-11 22:57:19 +02:00
2016-07-21 07:53:59 +02:00
// load the form
$this->get($form->URLSegment);
2015-08-11 22:57:19 +02:00
$field = $this->objFromFixture(EditableTextField::class, 'basic-text');
2015-08-11 22:57:19 +02:00
$response = $this->submitForm('UserForm_Form_' . $form->ID, null, [$field->Name => 'Basic Value']);
2016-07-21 07:53:59 +02:00
// should have a submitted form field now
$submitted = DataObject::get(SubmittedFormField::class, "\"Name\" = 'basic_text_name'");
$this->assertListAllMatch(
[
'Name' => 'basic_text_name',
'Value' => 'Basic Value',
'Title' => 'Basic Text Field'
],
$submitted
);
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
// check emails
$this->assertEmailSent('test@example.com', 'no-reply@example.com', 'Email Subject');
$email = $this->findEmail('test@example.com', 'no-reply@example.com', 'Email Subject');
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
// assert that the email has the field title and the value html email
$parser = new CSSContentParser($email['Content']);
2016-07-21 07:53:59 +02:00
$title = $parser->getBySelector('strong');
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
$this->assertEquals('Basic Text Field', (string) $title[0], 'Email contains the field name');
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
$value = $parser->getBySelector('dd');
$this->assertEquals('Basic Value', (string) $value[0], 'Email contains the value');
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
// no html
$this->assertEmailSent('nohtml@example.com', 'no-reply@example.com', 'Email Subject');
$nohtml = $this->findEmail('nohtml@example.com', 'no-reply@example.com', 'Email Subject');
$this->assertContains('Basic Text Field: Basic Value', $nohtml['Content'], 'Email contains no html');
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
// no data
$this->assertEmailSent('nodata@example.com', 'no-reply@example.com', 'Email Subject');
$nodata = $this->findEmail('nodata@example.com', 'no-reply@example.com', 'Email Subject');
2015-09-11 00:20:06 +02:00
$parser = new CSSContentParser($nodata['Content']);
2016-07-21 07:53:59 +02:00
$list = $parser->getBySelector('dl');
2015-09-11 00:20:06 +02:00
$this->assertEmpty($list, 'Email contains no fields');
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
// check to see if the user was redirected (301)
$this->assertEquals($response->getStatusCode(), 302);
$location = $response->getHeader('Location');
$this->assertContains('finished', $location);
$this->assertStringEndsWith('#uff', $location);
// check that multiple email addresses are supported in to and from
$this->assertEmailSent(
'test1@example.com; test2@example.com',
'test3@example.com; test4@example.com',
'Test Email'
);
2016-07-21 07:53:59 +02:00
}
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
public function testValidation()
{
$form = $this->setupFormFrontend('email-form');
2016-07-21 07:53:59 +02:00
// Post with no fields
$this->get($form->URLSegment);
/** @var HTTPResponse $response */
$response = $this->submitForm('UserForm_Form_' . $form->ID, null, []);
$this->assertContains('This field is required', $response->getBody());
2016-07-21 07:53:59 +02:00
// Post with all fields, but invalid email
$this->get($form->URLSegment);
/** @var HTTPResponse $response */
$response = $this->submitForm('UserForm_Form_' . $form->ID, null, [
2016-07-21 07:53:59 +02:00
'required-email' => 'invalid',
'required-text' => 'bob'
]);
$this->assertContains('Please enter an email address', $response->getBody());
2016-07-21 07:53:59 +02:00
// Post with only required
$this->get($form->URLSegment);
/** @var HTTPResponse $response */
$response = $this->submitForm('UserForm_Form_' . $form->ID, null, [
2016-07-21 07:53:59 +02:00
'required-text' => 'bob'
]);
$this->assertContains("Thanks, we've received your submission.", $response->getBody());
2016-07-21 07:53:59 +02:00
}
2016-07-21 07:53:59 +02:00
public function testFinished()
{
$form = $this->setupFormFrontend();
2016-07-21 07:53:59 +02:00
// set formProcessed and SecurityID to replicate the form being filled out
$this->session()->set('SecurityID', 1);
$this->session()->set('FormProcessed', 1);
2016-07-21 07:53:59 +02:00
$response = $this->get($form->URLSegment.'/finished');
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
$this->assertContains($form->OnCompleteMessage, $response->getBody());
}
2016-07-21 07:53:59 +02:00
public function testAppendingFinished()
{
$form = $this->setupFormFrontend();
2016-07-21 07:53:59 +02:00
// replicate finished being added to the end of the form URL without the form being filled out
$this->session()->set('SecurityID', 1);
$this->session()->set('FormProcessed', null);
2016-07-21 07:53:59 +02:00
$response = $this->get($form->URLSegment.'/finished');
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
$this->assertNotContains($form->OnCompleteMessage, $response->getBody());
}
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
public function testForm()
{
$form = $this->objFromFixture(UserDefinedForm::class, 'basic-form-page');
$controller = new UserDefinedFormController($form);
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
// test form
$this->assertEquals($controller->Form()->getName(), 'Form_' . $form->ID, 'The form is referenced as Form');
2016-07-21 07:53:59 +02:00
$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::class, 'validation-form');
$controller = new UserDefinedFormController($requiredForm);
2016-07-21 07:53:59 +02:00
$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);
}
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
public function testGetFormFields()
{
// generating the fieldset of fields
$form = $this->objFromFixture(UserDefinedForm::class, 'basic-form-page');
2015-09-11 00:20:06 +02:00
$controller = new UserDefinedFormController($form);
2016-07-21 07:53:59 +02:00
$formSteps = $controller->Form()->getFormFields();
$firstStep = $formSteps->first();
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
$this->assertEquals($formSteps->Count(), 1);
$this->assertEquals($firstStep->getChildren()->Count(), 1);
2016-07-21 07:53:59 +02:00
// custom error message on a form field
$requiredForm = $this->objFromFixture(UserDefinedForm::class, 'validation-form');
$controller = new UserDefinedFormController($requiredForm);
2015-09-11 00:20:06 +02:00
Config::modify()->set(UserDefinedForm::class, 'required_identifier', '*');
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
$formSteps = $controller->Form()->getFormFields();
$firstStep = $formSteps->first();
$firstField = $firstStep->getChildren()->first();
2016-07-21 07:53:59 +02:00
$this->assertEquals('Custom Error Message', $firstField->getCustomValidationMessage());
$this->assertEquals($firstField->Title(), 'Required Text Field <span class=\'required-identifier\'>*</span>');
2016-07-21 07:53:59 +02:00
// test custom right title
$field = $form->Fields()->limit(1, 1)->First();
$field->RightTitle = 'Right Title';
$field->write();
2015-09-11 00:20:06 +02:00
$controller = new UserDefinedFormController($form);
2016-07-21 07:53:59 +02:00
$formSteps = $controller->Form()->getFormFields();
$firstStep = $formSteps->first();
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
$this->assertEquals($firstStep->getChildren()->First()->RightTitle(), "Right Title");
2016-07-21 07:53:59 +02:00
// test empty form
$emptyForm = $this->objFromFixture(UserDefinedForm::class, 'empty-form');
$controller = new UserDefinedFormController($emptyForm);
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
$this->assertFalse($controller->Form()->getFormFields()->exists());
}
2015-07-24 04:37:48 +02:00
2016-07-21 07:53:59 +02:00
public function testGetFormActions()
{
// generating the fieldset of actions
$form = $this->objFromFixture(UserDefinedForm::class, 'basic-form-page');
2015-09-11 00:20:06 +02:00
$controller = new UserDefinedFormController($form);
2016-07-21 07:53:59 +02:00
$actions = $controller->Form()->getFormActions();
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
// by default will have 1 submit button which links to process
$expected = new FieldList(new FormAction('process', 'Submit'));
$expected->setForm($controller->Form());
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
$this->assertEquals($actions, $expected);
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
// the custom popup should have a reset button and a custom text
$custom = $this->objFromFixture(UserDefinedForm::class, 'form-with-reset-and-custom-action');
$controller = new UserDefinedFormController($custom);
2016-07-21 07:53:59 +02:00
$actions = $controller->Form()->getFormActions();
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
$expected = new FieldList(new FormAction('process', 'Custom Button'));
$expected->push(FormAction::create('clearForm', 'Clear')->setAttribute('type', 'reset'));
2016-07-21 07:53:59 +02:00
$expected->setForm($controller->Form());
2016-07-21 07:53:59 +02:00
$this->assertEquals($actions, $expected);
}
2015-07-24 04:37:48 +02:00
2016-07-21 07:53:59 +02:00
public function testRenderingIntoFormTemplate()
{
$form = $this->setupFormFrontend();
2015-09-11 00:20:06 +02:00
$this->logInWithPermission('ADMIN');
2016-07-21 07:53:59 +02:00
$form->Content = 'This is some content without a form nested between it';
$form->publishRecursive();
2015-09-11 00:20:06 +02:00
$controller = new UserDefinedFormController($form);
2015-09-11 00:20:06 +02:00
// check to see if $Form is placed in the template
2016-07-21 07:53:59 +02:00
$index = new ArrayData($controller->index());
$parser = new CSSContentParser($index->renderWith(__CLASS__));
2015-09-11 00:20:06 +02:00
$this->checkTemplateIsCorrect($parser, $form);
2016-07-21 07:53:59 +02:00
}
2016-07-21 07:53:59 +02:00
public function testRenderingIntoTemplateWithSubstringReplacement()
{
$form = $this->setupFormFrontend();
2015-09-11 00:20:06 +02:00
$controller = new UserDefinedFormController($form);
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
// check to see if $Form is replaced to inside the content
$index = new ArrayData($controller->index());
$parser = new CSSContentParser($index->renderWith(__CLASS__));
2015-09-11 00:20:06 +02:00
$this->checkTemplateIsCorrect($parser, $form);
2016-07-21 07:53:59 +02:00
}
public function testRenderingIntoTemplateWithDisabledInterpolation()
{
$form = $this->setupFormFrontend();
$controller = new UserDefinedFormController($form);
$controller->config()->set('disable_form_content_shortcode', true);
// check to see if $Form is replaced to inside the content
$index = new ArrayData($controller->index());
$html = $index->renderWith(__CLASS__);
$parser = new CSSContentParser($html);
// Assert Content has been rendered with the shortcode in place
$this->assertContains('<p>Here is my form</p><p>$UserDefinedForm</p><p>Thank you for filling it out</p>', $html);
// And the form in the $From area
$this->assertArrayHasKey(0, $parser->getBySelector('form#UserForm_Form_' . $form->ID));
// check for the input
$this->assertArrayHasKey(0, $parser->getBySelector('input.text'));
}
2016-07-21 07:53:59 +02:00
/**
* Publish a form for use on the frontend
*
* @param string $fixtureName
* @return UserDefinedForm
*/
protected function setupFormFrontend($fixtureName = 'basic-form-page')
{
$form = $this->objFromFixture(UserDefinedForm::class, $fixtureName);
2015-09-11 00:20:06 +02:00
$this->actWithPermission('ADMIN', function () use ($form) {
$form->publishRecursive();
});
2016-07-21 07:53:59 +02:00
return $form;
}
2015-09-11 00:20:06 +02:00
public function checkTemplateIsCorrect($parser, $form)
2016-07-21 07:53:59 +02:00
{
$this->assertArrayHasKey(0, $parser->getBySelector('form#UserForm_Form_' . $form->ID));
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
// check for the input
$this->assertArrayHasKey(0, $parser->getBySelector('input.text'));
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
// check for the label and the text
$label = $parser->getBySelector('label.left');
$this->assertArrayHasKey(0, $label);
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
$this->assertEquals((string) $label[0][0], "Basic Text Field", "Label contains correct field name");
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
// check for the action
$action = $parser->getBySelector('input.action');
$this->assertArrayHasKey(0, $action);
2015-09-11 00:20:06 +02:00
2016-07-21 07:53:59 +02:00
$this->assertEquals((string) $action[0]['value'], "Submit", "Submit button has default text");
}
public function testRecipientSubjectMergeFields()
{
$form = $this->setupFormFrontend();
$recipient = $this->objFromFixture(EmailRecipient::class, 'recipient-1');
$recipient->EmailSubject = 'Email Subject: $basic_text_name';
$recipient->write();
$this->autoFollowRedirection = false;
$this->clearEmails();
// load the form
$this->get($form->URLSegment);
$field = $this->objFromFixture(EditableTextField::class, 'basic-text');
$response = $this->submitForm('UserForm_Form_' . $form->ID, null, [$field->Name => 'Basic Value']);
// should have a submitted form field now
$submitted = DataObject::get(SubmittedFormField::class, "\"Name\" = 'basic_text_name'");
$this->assertListAllMatch(
[
'Name' => 'basic_text_name',
'Value' => 'Basic Value',
'Title' => 'Basic Text Field'
],
$submitted
);
// check emails
$this->assertEmailSent('test@example.com', 'no-reply@example.com', 'Email Subject: Basic Value');
}
public function testImageThumbnailCreated()
{
Config::modify()->set(Upload_Validator::class, 'use_is_uploaded_file', false);
$userForm = $this->setupFormFrontend('upload-form');
$controller = UserDefinedFormController::create($userForm);
$field = $this->objFromFixture(EditableFileField::class, 'file-field-1');
$path = realpath(__DIR__ . '/fixtures/testfile.jpg');
$data = [
$field->Name => [
'name' => 'testfile.jpg',
'type' => 'image/jpeg',
'tmp_name' => $path,
'error' => 0,
'size' => filesize($path),
]
];
$_FILES[$field->Name] = $data[$field->Name];
$controller->getRequest()->setSession(new Session([]));
$controller->process($data, $controller->Form());
/** @var File $image */
// Getting File instead of Image so that we still delete the physical file in case it was
// created with the wrong ClassName
// Using StartsWith in-case of existing file so was created as testfile-v2.jpg
$image = File::get()->filter(['Name:StartsWith' => 'testfile'])->last();
$this->assertNotNull($image);
// Assert thumbnail variant created
/** @var AssetStore $store */
$store = Injector::inst()->get(AssetStore::class);
$this->assertTrue($store->exists($image->getFilename(), $image->getHash(), 'FitMaxWzM1MiwyNjRd'));
}
}