PartialSubmissionControllerTest::testSaveDataWithExpiredSession() - Code Metrics - Inspection of "Solves #15 Safe files to partial submissions" - Firesphere/silverstripe-partial-userforms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#16)

by Simon

created 2019-08-29 02:29 UTC

PartialSubmissionControllerTest::testSaveDataWithExpiredSession() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	9.568
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Firesphere\PartialUserforms\Tests;

use Firesphere\PartialUserforms\Controllers\PartialSubmissionController;
use Firesphere\PartialUserforms\Models\PartialFieldSubmission;
use Firesphere\PartialUserforms\Models\PartialFileFieldSubmission;
use Firesphere\PartialUserforms\Models\PartialFormSubmission;
use SilverStripe\Assets\Upload_Validator;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\FunctionalTest;
use SilverStripe\ORM\DataList;
use SilverStripe\UserForms\Model\EditableFormField\EditableFileField;
use SilverStripe\UserForms\Model\UserDefinedForm;

/**
 * Class PartialSubmissionControllerTest
 * @package Firesphere\PartialUserforms\Tests
 */
class PartialSubmissionControllerTest extends FunctionalTest
{
    protected static $fixture_file = '../fixtures/partialformtest.yml';

    /**
     * @var PartialSubmissionController
     */
    protected $controller;

    public function testClassExists()
    {
        $this->assertInstanceOf(PartialSubmissionController::class, $this->controller);
    }

    public function testSavePartialSubmissionExists()
    {
        $this->assertTrue(method_exists($this->controller, 'savePartialSubmission'));
    }

    public function testSavePartialSubmissionFormCreated()
    {
        // If successful, will return the SubmittedFormID from the session
        $id = $this->savePartial(['Field1' => 'Value1']);
        $this->assertInternalType('int', $id);

        $partial = PartialFormSubmission::get()->byID($id);
        $this->assertNotNull($partial);
    }

    public function testSavePartialSubmissionFieldCreated()
    {
        // If successful, will return the SubmittedFormID from the session
        $id = $this->savePartial(['Field1' => 'Value1']);
        $this->assertInternalType('int', $id);

        $fields = PartialFieldSubmission::get()->filter(['SubmittedFormID' => $id]);
        $this->assertCount(1, $fields);
    }

    public function testSavePartialSubmissionFileField()
    {
        $field = $this->objFromFixture(EditableFileField::class, 'filefield1');
        $field->write();
        copy(__DIR__ . '/../fixtures/Hans-fullsize-sqr.png', TEMP_FOLDER . '/tmpfile');
        $multipart = [
            'name'     => 'file1',
            'tmp_name' => TEMP_FOLDER . '/tmpfile',
            'filename' => 'Hans-fullsize-sqr.png',
            'type'     => 'image/png',
            'error'    => null,
            'size'     => filesize(TEMP_FOLDER . '/tmpfile')
        ];
        // Disable checking if the file is uploaded through a POST
        Upload_Validator::config()->set('use_is_uploaded_file', false);
        $this->savePartial(['File' => $multipart]);
        $this->assertNotNull(PartialFileFieldSubmission::get()->filter(['Name' => 'File']));
    }

    public function testPartialFormSubmissionExists()
    {
        // If successful, will return the SubmittedFormID from the session
        $id = $this->savePartial(['Field1' => 'Value1', 'Field2' => 'Value2']);

        // Second submission
        $secondId = $this->savePartial(['Field2' => 'Value2']);

        $this->assertEquals($id, $secondId);
    }

    public function testPartialFormSubmissionExistingField()
    {
        $values = [
            'Field1' => 'Value1',
            'Field2' => 'Value2',
            'Field3' => 'null'
        ];
        $id = $this->savePartial($values);
        $field3 = PartialFieldSubmission::get()
            ->filter([
                'Name'            => 'Field3',
                'SubmittedFormID' => $id
            ])
            ->first();

        $this->assertEquals('null', $field3->Value);

        // Update the values
        $values['Field3'] = 'Value3';
        $id = $this->savePartial($values);
        $field3 = PartialFieldSubmission::get()
            ->filter([
                'Name'            => 'Field3',
                'SubmittedFormID' => $id
            ])
            ->first();
        $this->assertEquals('Value3', $field3->Value);
    }

    public function testSubmittedFieldName()
    {
        $values = [
            'Field1' => 'Value1',
            'Field2' => 'Value2',
            'Field3' => 'null'
        ];
        $id = $this->savePartial($values);
        /** @var DataList|PartialFieldSubmission[] $fields */
        $fields = PartialFieldSubmission::get()->filter(['SubmittedFormID' => $id]);
        $this->assertCount(3, $fields);

        foreach ($fields as $key => $field) {
            $this->assertEquals('Field' . ($key + 1), $field->Name, 'Test field ' . $field->Name);
        }
    }

    public function testParent()
    {
        $values = [
            'Field1' => 'Value1',
            'Field2' => 'Value2',
            'Field3' => 'null'
        ];
        $id = $this->savePartial($values);
        /** @var DataList|PartialFieldSubmission[] $fields */
        $partialForm = PartialFormSubmission::get()->byID($id);

        // No parent class
        $this->assertEquals(UserDefinedForm::class, $partialForm->ParentClass);

        $form = UserDefinedForm::create(['Title' => 'Test']);
        $formID = $form->write();

        // With parent class
        $partialForm->ParentID = $formID;
        $partialForm->ParentClass = get_class($form);

        $this->assertEquals(UserDefinedForm::class, $partialForm->ParentClass);
    }

    public function testUnwantedFields()
    {
        $values = [
            'Field1'         => 'Value1',
            'Field2'         => 'Value2',
            'Field3'         => 'null',
            'SecurityID'     => '123456789aoeu',
            'action_process' => 'Submit'
        ];
        $id = $this->savePartial($values);
        /** @var DataList|PartialFieldSubmission[] $fields */
        $fields = PartialFieldSubmission::get()->filter(['SubmittedFormID' => $id]);

        $items = $fields->column('Name');
        $this->assertFalse(in_array('SecurityID', $items, true));
        $this->assertFalse(in_array('action_process', $items, true));
    }

    public function testArrayData()
    {
        $values = [
            'Field1' => 'Value1',
            'Field2' => 'Value2',
            'Field3' => ['Value1', 'Value2']
        ];
        $id = $this->savePartial($values);
        $field3 = PartialFieldSubmission::get()
            ->filter([
                'Name'            => 'Field3',
                'SubmittedFormID' => $id
            ])
            ->first();
        $this->assertEquals('Value1, Value2', $field3->Value);
    }

    /**
     * @todo Remove skip test after implementation
     */
    public function testSaveDataWithExpiredSession()
    {
        $this->markTestSkipped('Remove skip test once implementation is complete');

        $values = [
            'Field1' => 'Value1',
            'Field2' => 'Value2',
            'Field3' => ['Value1', 'Value2']
        ];

        $id = $this->savePartial($values);
        $this->assertInternalType('int', $id);

        $partial = PartialFormSubmission::get()->byID($id);
        $this->assertNotNull($partial);

        // Now clear session and save
        $this->session()->clear(PartialSubmissionController::SESSION_KEY);
        $values['Field1'] = 'NEW VALUE';
        $newId = $this->savePartial($values);
        $this->assertEquals($id, $newId);
    }

    /**
     * Helper function for saving partial submission
     * @param array $values
     * @return mixed Returns SubmittedFormID on success, otherwise null
     */
    private function savePartial($values)
    {
        $response = $this->post('/partialuserform/save', $values);
        $this->assertEquals(201, $response->getStatusCode());

        return $this->session()->get(PartialSubmissionController::SESSION_KEY);
    }

    public function setUp()
    {
        parent::setUp();
        $this->objFromFixture(UserDefinedForm::class, 'form1')->publishRecursive();
        $this->controller = Injector::inst()->get(PartialSubmissionController::class);
    }
}


1			<?php
2
3			namespace Firesphere\PartialUserforms\Tests;
4
5			use Firesphere\PartialUserforms\Controllers\PartialSubmissionController;
6			use Firesphere\PartialUserforms\Models\PartialFieldSubmission;
7			use Firesphere\PartialUserforms\Models\PartialFileFieldSubmission;
8			use Firesphere\PartialUserforms\Models\PartialFormSubmission;
9			use SilverStripe\Assets\Upload_Validator;
10			use SilverStripe\Core\Injector\Injector;
11			use SilverStripe\Dev\FunctionalTest;
12			use SilverStripe\ORM\DataList;
13			use SilverStripe\UserForms\Model\EditableFormField\EditableFileField;
14			use SilverStripe\UserForms\Model\UserDefinedForm;
15
16			/**
17			* Class PartialSubmissionControllerTest
18			* @package Firesphere\PartialUserforms\Tests
19			*/
20			class PartialSubmissionControllerTest extends FunctionalTest
21			{
22			protected static $fixture_file = '../fixtures/partialformtest.yml';
23
24			/**
25			* @var PartialSubmissionController
26			*/
27			protected $controller;
28
29			public function testClassExists()
30			{
31			$this->assertInstanceOf(PartialSubmissionController::class, $this->controller);
32			}
33
34			public function testSavePartialSubmissionExists()
35			{
36			$this->assertTrue(method_exists($this->controller, 'savePartialSubmission'));
37			}
38
39			public function testSavePartialSubmissionFormCreated()
40			{
41			// If successful, will return the SubmittedFormID from the session
42			$id = $this->savePartial(['Field1' => 'Value1']);
43			$this->assertInternalType('int', $id);
44
45			$partial = PartialFormSubmission::get()->byID($id);
46			$this->assertNotNull($partial);
47			}
48
49			public function testSavePartialSubmissionFieldCreated()
50			{
51			// If successful, will return the SubmittedFormID from the session
52			$id = $this->savePartial(['Field1' => 'Value1']);
53			$this->assertInternalType('int', $id);
54
55			$fields = PartialFieldSubmission::get()->filter(['SubmittedFormID' => $id]);
56			$this->assertCount(1, $fields);
57			}
58
59			public function testSavePartialSubmissionFileField()
60			{
61			$field = $this->objFromFixture(EditableFileField::class, 'filefield1');
62			$field->write();
63			copy(__DIR__ . '/../fixtures/Hans-fullsize-sqr.png', TEMP_FOLDER . '/tmpfile');
64			$multipart = [
65			'name' => 'file1',
66			'tmp_name' => TEMP_FOLDER . '/tmpfile',
67			'filename' => 'Hans-fullsize-sqr.png',
68			'type' => 'image/png',
69			'error' => null,
70			'size' => filesize(TEMP_FOLDER . '/tmpfile')
71			];
72			// Disable checking if the file is uploaded through a POST
73			Upload_Validator::config()->set('use_is_uploaded_file', false);
74			$this->savePartial(['File' => $multipart]);
75			$this->assertNotNull(PartialFileFieldSubmission::get()->filter(['Name' => 'File']));
76			}
77
78			public function testPartialFormSubmissionExists()
79			{
80			// If successful, will return the SubmittedFormID from the session
81			$id = $this->savePartial(['Field1' => 'Value1', 'Field2' => 'Value2']);
82
83			// Second submission
84			$secondId = $this->savePartial(['Field2' => 'Value2']);
85
86			$this->assertEquals($id, $secondId);
87			}
88
89			public function testPartialFormSubmissionExistingField()
90			{
91			$values = [
92			'Field1' => 'Value1',
93			'Field2' => 'Value2',
94			'Field3' => 'null'
95			];
96			$id = $this->savePartial($values);
97			$field3 = PartialFieldSubmission::get()
98			->filter([
99			'Name' => 'Field3',
100			'SubmittedFormID' => $id
101			])
102			->first();
103
104			$this->assertEquals('null', $field3->Value);
105
106			// Update the values
107			$values['Field3'] = 'Value3';
108			$id = $this->savePartial($values);
109			$field3 = PartialFieldSubmission::get()
110			->filter([
111			'Name' => 'Field3',
112			'SubmittedFormID' => $id
113			])
114			->first();
115			$this->assertEquals('Value3', $field3->Value);
116			}
117
118			public function testSubmittedFieldName()
119			{
120			$values = [
121			'Field1' => 'Value1',
122			'Field2' => 'Value2',
123			'Field3' => 'null'
124			];
125			$id = $this->savePartial($values);
126			/** @var DataList\|PartialFieldSubmission[] $fields */
127			$fields = PartialFieldSubmission::get()->filter(['SubmittedFormID' => $id]);
128			$this->assertCount(3, $fields);
129
130			foreach ($fields as $key => $field) {
131			$this->assertEquals('Field' . ($key + 1), $field->Name, 'Test field ' . $field->Name);
132			}
133			}
134
135			public function testParent()
136			{
137			$values = [
138			'Field1' => 'Value1',
139			'Field2' => 'Value2',
140			'Field3' => 'null'
141			];
142			$id = $this->savePartial($values);
143			/** @var DataList\|PartialFieldSubmission[] $fields */
144			$partialForm = PartialFormSubmission::get()->byID($id);
145
146			// No parent class
147			$this->assertEquals(UserDefinedForm::class, $partialForm->ParentClass);
148
149			$form = UserDefinedForm::create(['Title' => 'Test']);
150			$formID = $form->write();
151
152			// With parent class
153			$partialForm->ParentID = $formID;
154			$partialForm->ParentClass = get_class($form);
155
156			$this->assertEquals(UserDefinedForm::class, $partialForm->ParentClass);
157			}
158
159			public function testUnwantedFields()
160			{
161			$values = [
162			'Field1' => 'Value1',
163			'Field2' => 'Value2',
164			'Field3' => 'null',
165			'SecurityID' => '123456789aoeu',
166			'action_process' => 'Submit'
167			];
168			$id = $this->savePartial($values);
169			/** @var DataList\|PartialFieldSubmission[] $fields */
170			$fields = PartialFieldSubmission::get()->filter(['SubmittedFormID' => $id]);
171
172			$items = $fields->column('Name');
173			$this->assertFalse(in_array('SecurityID', $items, true));
174			$this->assertFalse(in_array('action_process', $items, true));
175			}
176
177			public function testArrayData()
178			{
179			$values = [
180			'Field1' => 'Value1',
181			'Field2' => 'Value2',
182			'Field3' => ['Value1', 'Value2']
183			];
184			$id = $this->savePartial($values);
185			$field3 = PartialFieldSubmission::get()
186			->filter([
187			'Name' => 'Field3',
188			'SubmittedFormID' => $id
189			])
190			->first();
191			$this->assertEquals('Value1, Value2', $field3->Value);
192			}
193
194			/**
195			* @todo Remove skip test after implementation
196			*/
197			public function testSaveDataWithExpiredSession()
198			{
199			$this->markTestSkipped('Remove skip test once implementation is complete');
200
201			$values = [
202			'Field1' => 'Value1',
203			'Field2' => 'Value2',
204			'Field3' => ['Value1', 'Value2']
205			];
206
207			$id = $this->savePartial($values);
208			$this->assertInternalType('int', $id);
209
210			$partial = PartialFormSubmission::get()->byID($id);
211			$this->assertNotNull($partial);
212
213			// Now clear session and save
214			$this->session()->clear(PartialSubmissionController::SESSION_KEY);
215			$values['Field1'] = 'NEW VALUE';
216			$newId = $this->savePartial($values);
217			$this->assertEquals($id, $newId);
218			}
219
220			/**
221			* Helper function for saving partial submission
222			* @param array $values
223			* @return mixed Returns SubmittedFormID on success, otherwise null
224			*/
225			private function savePartial($values)
226			{
227			$response = $this->post('/partialuserform/save', $values);
228			$this->assertEquals(201, $response->getStatusCode());
229
230			return $this->session()->get(PartialSubmissionController::SESSION_KEY);
231			}
232
233			public function setUp()
234			{
235			parent::setUp();
236			$this->objFromFixture(UserDefinedForm::class, 'form1')->publishRecursive();
237			$this->controller = Injector::inst()->get(PartialSubmissionController::class);
238			}
239			}
240

Firesphere / silverstripe-partial-userforms

Pull Request — master (#16)

PartialSubmissionControllerTest::testSaveDataWithExpiredSession() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like