Inspection of "Merge branch '1'" - silverstripe/silverstripe-spellcheck - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e3eba2...8f5698 )

by Robbie

created 2017-12-11 22:46 UTC

Status

Indentation +14 added lines, -14 removed lines patch added patch discarded remove patch

@@ -7,21 +7,21 @@
 block discarded – undo
 
 class SpellProviderStub implements SpellProvider, TestOnly
 {
-    public function checkWords($locale, $words)
-    {
-        if ($locale === 'en_NZ') {
-            return ['collor', 'color', 'onee'];
-        }
+	public function checkWords($locale, $words)
+	{
+		if ($locale === 'en_NZ') {
+			return ['collor', 'color', 'onee'];
+		}
 
-        return ['collor', 'colour', 'onee'];
-    }
+		return ['collor', 'colour', 'onee'];
+	}
 
-    public function getSuggestions($locale, $word)
-    {
-        if ($locale === 'en_NZ') {
-            return ['collar', 'colour'];
-        }
+	public function getSuggestions($locale, $word)
+	{
+		if ($locale === 'en_NZ') {
+			return ['collar', 'colour'];
+		}
 
-        return ['collar', 'color'];
-    }
+		return ['collar', 'color'];
+	}
 }

Please login to merge, or discard this patch.

tests/SpellControllerTest.php 1 patch

Indentation +185 added lines, -185 removed lines patch added patch discarded remove patch

@@ -17,189 +17,189 @@
 block discarded – undo
  */
 class SpellControllerTest extends FunctionalTest
 {
-    protected $usesDatabase = true;
-
-    protected $securityWasEnabled = false;
-
-    protected function setUp()
-    {
-        parent::setUp();
-
-        $this->securityWasEnabled = SecurityToken::is_enabled();
-
-        // Reset config
-        Config::modify()->set(SpellController::class, 'required_permission', 'CMS_ACCESS_CMSMain');
-        Config::inst()->remove(SpellController::class, 'locales');
-        Config::modify()->set(SpellController::class, 'locales', array('en_US', 'en_NZ', 'fr_FR'));
-        Config::modify()->set(SpellController::class, 'enable_security_token', true);
-        SecurityToken::enable();
-
-        // Setup mock for testing provider
-        $spellChecker = new SpellProviderStub;
-        Injector::inst()->registerService($spellChecker, SpellProvider::class);
-    }
-
-    protected function tearDown()
-    {
-        if ($this->securityWasEnabled) {
-            SecurityToken::enable();
-        } else {
-            SecurityToken::disable();
-        }
-
-        parent::tearDown();
-    }
-
-    /**
-     * Tests security ID check
-     */
-    public function testSecurityID()
-    {
-        // Mock token
-        $securityToken = SecurityToken::inst();
-        $generator = new RandomGenerator();
-        $token = $generator->randomToken('sha1');
-        $session = array(
-            $securityToken->getName() => $token
-        );
-        $tokenError = _t(
-            'SilverStripe\\SpellCheck\\Handling\\SpellController.SecurityMissing',
-            'Your session has expired. Please refresh your browser to continue.'
-        );
-
-        // Test request sans token
-        $response = $this->get('spellcheck', Injector::inst()->create(Session::class, $session));
-        $this->assertEquals(400, $response->getStatusCode());
-        $jsonBody = json_decode($response->getBody());
-        $this->assertEquals($tokenError, $jsonBody->error->errstr);
-
-        // Test request with correct token (will fail with an unrelated error)
-        $response = $this->get(
-            'spellcheck/?SecurityID='.urlencode($token),
-            Injector::inst()->create(Session::class, $session)
-        );
-        $jsonBody = json_decode($response->getBody());
-        $this->assertNotEquals($tokenError, $jsonBody->error->errstr);
-
-        // Test request with check disabled
-        Config::modify()->set(SpellController::class, 'enable_security_token', false);
-        $response = $this->get('spellcheck', Injector::inst()->create(Session::class, $session));
-        $jsonBody = json_decode($response->getBody());
-        $this->assertNotEquals($tokenError, $jsonBody->error->errstr);
-    }
-
-    /**
-     * Tests permission check
-     */
-    public function testPermissions()
-    {
-        // Disable security ID for this test
-        Config::modify()->set(SpellController::class, 'enable_security_token', false);
-        $securityError = _t('SilverStripe\\SpellCheck\\Handling\\SpellController.SecurityDenied', 'Permission Denied');
-
-        // Test admin permissions
-        Config::modify()->set(SpellController::class, 'required_permission', 'ADMIN');
-        $this->logInWithPermission('ADMIN');
-        $response = $this->get('spellcheck');
-        $jsonBody = json_decode($response->getBody());
-        $this->assertNotEquals($securityError, $jsonBody->error->errstr);
-
-        // Test insufficient permissions
-        $this->logInWithPermission('CMS_ACCESS_CMSMain');
-        $response = $this->get('spellcheck');
-        $this->assertEquals(403, $response->getStatusCode());
-        $jsonBody = json_decode($response->getBody());
-        $this->assertEquals($securityError, $jsonBody->error->errstr);
-
-        // Test disabled permissions
-        Config::modify()->set(SpellController::class, 'required_permission', false);
-        $response = $this->get('spellcheck');
-        $jsonBody = json_decode($response->getBody());
-        $this->assertNotEquals($securityError, $jsonBody->error->errstr);
-    }
-
-    /**
-     * Ensure that invalid input is correctly rejected
-     */
-    public function testInputRejection()
-    {
-        // Disable security ID and permissions for this test
-        Config::modify()->set(SpellController::class, 'enable_security_token', false);
-        Config::modify()->set(SpellController::class, 'required_permission', false);
-        $invalidRequest = _t('SilverStripe\\SpellCheck\\Handling\\SpellController.InvalidRequest', 'Invalid request');
-
-        // Test checkWords acceptance
-        $dataCheckWords = array(
-            'id' => 'c0',
-            'method' => 'checkWords',
-            'params' => array(
-                'en_NZ',
-                array('collor', 'colour', 'color', 'onee', 'correct')
-            )
-        );
-        $response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataCheckWords)));
-        $this->assertEquals(200, $response->getStatusCode());
-        $jsonBody = json_decode($response->getBody());
-        $this->assertEquals('c0', $jsonBody->id);
-        $this->assertEquals(array("collor", "color", "onee"), $jsonBody->result);
-
-        // Test getSuggestions acceptance
-        $dataGetSuggestions = array(
-            'id' => '//c1//', // Should be reduced to only alphanumeric characters
-            'method' => 'getSuggestions',
-            'params' => array(
-                'en_NZ',
-                'collor'
-
-            )
-        );
-        $response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataGetSuggestions)));
-        $this->assertEquals(200, $response->getStatusCode());
-        $jsonBody = json_decode($response->getBody());
-        $this->assertEquals('c1', $jsonBody->id);
-        $this->assertEquals(array('collar', 'colour'), $jsonBody->result);
-
-        // Test non-ajax rejection
-        $response = $this->post('spellcheck', array('json_data' => json_encode($dataCheckWords)));
-        $this->assertEquals(400, $response->getStatusCode());
-        $jsonBody = json_decode($response->getBody());
-        $this->assertEquals($invalidRequest, $jsonBody->error->errstr);
-
-        // Test incorrect method
-        $dataInvalidMethod = $dataCheckWords;
-        $dataInvalidMethod['method'] = 'validate';
-        $response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataInvalidMethod)));
-        $this->assertEquals(400, $response->getStatusCode());
-        $jsonBody = json_decode($response->getBody());
-        $this->assertEquals(
-            _t(
-                'SilverStripe\\SpellCheck\\Handling\\.UnsupportedMethod',
-                "Unsupported method '{method}'",
-                array('method' => 'validate')
-            ),
-            $jsonBody->error->errstr
-        );
-
-        // Test missing method
-        $dataNoMethod = $dataCheckWords;
-        unset($dataNoMethod['method']);
-        $response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataNoMethod)));
-        $this->assertEquals(400, $response->getStatusCode());
-        $jsonBody = json_decode($response->getBody());
-        $this->assertEquals($invalidRequest, $jsonBody->error->errstr);
-
-        // Test unsupported locale
-        $dataWrongLocale = $dataCheckWords;
-        $dataWrongLocale['params'] = array(
-            'de_DE',
-            array('collor', 'colour', 'color', 'onee', 'correct')
-        );
-        $response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataWrongLocale)));
-        $this->assertEquals(400, $response->getStatusCode());
-        $jsonBody = json_decode($response->getBody());
-        $this->assertEquals(_t(
-            'SilverStripe\\SpellCheck\\Handling\\.InvalidLocale',
-            'Not supported locale'
-        ), $jsonBody->error->errstr);
-    }
+	protected $usesDatabase = true;
+
+	protected $securityWasEnabled = false;
+
+	protected function setUp()
+	{
+		parent::setUp();
+
+		$this->securityWasEnabled = SecurityToken::is_enabled();
+
+		// Reset config
+		Config::modify()->set(SpellController::class, 'required_permission', 'CMS_ACCESS_CMSMain');
+		Config::inst()->remove(SpellController::class, 'locales');
+		Config::modify()->set(SpellController::class, 'locales', array('en_US', 'en_NZ', 'fr_FR'));
+		Config::modify()->set(SpellController::class, 'enable_security_token', true);
+		SecurityToken::enable();
+
+		// Setup mock for testing provider
+		$spellChecker = new SpellProviderStub;
+		Injector::inst()->registerService($spellChecker, SpellProvider::class);
+	}
+
+	protected function tearDown()
+	{
+		if ($this->securityWasEnabled) {
+			SecurityToken::enable();
+		} else {
+			SecurityToken::disable();
+		}
+
+		parent::tearDown();
+	}
+
+	/**
+	 * Tests security ID check
+	 */
+	public function testSecurityID()
+	{
+		// Mock token
+		$securityToken = SecurityToken::inst();
+		$generator = new RandomGenerator();
+		$token = $generator->randomToken('sha1');
+		$session = array(
+			$securityToken->getName() => $token
+		);
+		$tokenError = _t(
+			'SilverStripe\\SpellCheck\\Handling\\SpellController.SecurityMissing',
+			'Your session has expired. Please refresh your browser to continue.'
+		);
+
+		// Test request sans token
+		$response = $this->get('spellcheck', Injector::inst()->create(Session::class, $session));
+		$this->assertEquals(400, $response->getStatusCode());
+		$jsonBody = json_decode($response->getBody());
+		$this->assertEquals($tokenError, $jsonBody->error->errstr);
+
+		// Test request with correct token (will fail with an unrelated error)
+		$response = $this->get(
+			'spellcheck/?SecurityID='.urlencode($token),
+			Injector::inst()->create(Session::class, $session)
+		);
+		$jsonBody = json_decode($response->getBody());
+		$this->assertNotEquals($tokenError, $jsonBody->error->errstr);
+
+		// Test request with check disabled
+		Config::modify()->set(SpellController::class, 'enable_security_token', false);
+		$response = $this->get('spellcheck', Injector::inst()->create(Session::class, $session));
+		$jsonBody = json_decode($response->getBody());
+		$this->assertNotEquals($tokenError, $jsonBody->error->errstr);
+	}
+
+	/**
+	 * Tests permission check
+	 */
+	public function testPermissions()
+	{
+		// Disable security ID for this test
+		Config::modify()->set(SpellController::class, 'enable_security_token', false);
+		$securityError = _t('SilverStripe\\SpellCheck\\Handling\\SpellController.SecurityDenied', 'Permission Denied');
+
+		// Test admin permissions
+		Config::modify()->set(SpellController::class, 'required_permission', 'ADMIN');
+		$this->logInWithPermission('ADMIN');
+		$response = $this->get('spellcheck');
+		$jsonBody = json_decode($response->getBody());
+		$this->assertNotEquals($securityError, $jsonBody->error->errstr);
+
+		// Test insufficient permissions
+		$this->logInWithPermission('CMS_ACCESS_CMSMain');
+		$response = $this->get('spellcheck');
+		$this->assertEquals(403, $response->getStatusCode());
+		$jsonBody = json_decode($response->getBody());
+		$this->assertEquals($securityError, $jsonBody->error->errstr);
+
+		// Test disabled permissions
+		Config::modify()->set(SpellController::class, 'required_permission', false);
+		$response = $this->get('spellcheck');
+		$jsonBody = json_decode($response->getBody());
+		$this->assertNotEquals($securityError, $jsonBody->error->errstr);
+	}
+
+	/**
+	 * Ensure that invalid input is correctly rejected
+	 */
+	public function testInputRejection()
+	{
+		// Disable security ID and permissions for this test
+		Config::modify()->set(SpellController::class, 'enable_security_token', false);
+		Config::modify()->set(SpellController::class, 'required_permission', false);
+		$invalidRequest = _t('SilverStripe\\SpellCheck\\Handling\\SpellController.InvalidRequest', 'Invalid request');
+
+		// Test checkWords acceptance
+		$dataCheckWords = array(
+			'id' => 'c0',
+			'method' => 'checkWords',
+			'params' => array(
+				'en_NZ',
+				array('collor', 'colour', 'color', 'onee', 'correct')
+			)
+		);
+		$response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataCheckWords)));
+		$this->assertEquals(200, $response->getStatusCode());
+		$jsonBody = json_decode($response->getBody());
+		$this->assertEquals('c0', $jsonBody->id);
+		$this->assertEquals(array("collor", "color", "onee"), $jsonBody->result);
+
+		// Test getSuggestions acceptance
+		$dataGetSuggestions = array(
+			'id' => '//c1//', // Should be reduced to only alphanumeric characters
+			'method' => 'getSuggestions',
+			'params' => array(
+				'en_NZ',
+				'collor'
+
+			)
+		);
+		$response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataGetSuggestions)));
+		$this->assertEquals(200, $response->getStatusCode());
+		$jsonBody = json_decode($response->getBody());
+		$this->assertEquals('c1', $jsonBody->id);
+		$this->assertEquals(array('collar', 'colour'), $jsonBody->result);
+
+		// Test non-ajax rejection
+		$response = $this->post('spellcheck', array('json_data' => json_encode($dataCheckWords)));
+		$this->assertEquals(400, $response->getStatusCode());
+		$jsonBody = json_decode($response->getBody());
+		$this->assertEquals($invalidRequest, $jsonBody->error->errstr);
+
+		// Test incorrect method
+		$dataInvalidMethod = $dataCheckWords;
+		$dataInvalidMethod['method'] = 'validate';
+		$response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataInvalidMethod)));
+		$this->assertEquals(400, $response->getStatusCode());
+		$jsonBody = json_decode($response->getBody());
+		$this->assertEquals(
+			_t(
+				'SilverStripe\\SpellCheck\\Handling\\.UnsupportedMethod',
+				"Unsupported method '{method}'",
+				array('method' => 'validate')
+			),
+			$jsonBody->error->errstr
+		);
+
+		// Test missing method
+		$dataNoMethod = $dataCheckWords;
+		unset($dataNoMethod['method']);
+		$response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataNoMethod)));
+		$this->assertEquals(400, $response->getStatusCode());
+		$jsonBody = json_decode($response->getBody());
+		$this->assertEquals($invalidRequest, $jsonBody->error->errstr);
+
+		// Test unsupported locale
+		$dataWrongLocale = $dataCheckWords;
+		$dataWrongLocale['params'] = array(
+			'de_DE',
+			array('collor', 'colour', 'color', 'onee', 'correct')
+		);
+		$response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataWrongLocale)));
+		$this->assertEquals(400, $response->getStatusCode());
+		$jsonBody = json_decode($response->getBody());
+		$this->assertEquals(_t(
+			'SilverStripe\\SpellCheck\\Handling\\.InvalidLocale',
+			'Not supported locale'
+		), $jsonBody->error->errstr);
+	}
 }

Please login to merge, or discard this patch.

		@@ -7,21 +7,21 @@
		block discarded – undo
7	7
8	8	class SpellProviderStub implements SpellProvider, TestOnly
9	9	{
10		- public function checkWords($locale, $words)
11		- {
12		- if ($locale === 'en_NZ') {
13		- return ['collor', 'color', 'onee'];
14		- }
	10	+ public function checkWords($locale, $words)
	11	+ {
	12	+ if ($locale === 'en_NZ') {
	13	+ return ['collor', 'color', 'onee'];
	14	+ }
15	15
16		- return ['collor', 'colour', 'onee'];
17		- }
	16	+ return ['collor', 'colour', 'onee'];
	17	+ }
18	18
19		- public function getSuggestions($locale, $word)
20		- {
21		- if ($locale === 'en_NZ') {
22		- return ['collar', 'colour'];
23		- }
	19	+ public function getSuggestions($locale, $word)
	20	+ {
	21	+ if ($locale === 'en_NZ') {
	22	+ return ['collar', 'colour'];
	23	+ }
24	24
25		- return ['collar', 'color'];
26		- }
	25	+ return ['collar', 'color'];
	26	+ }
27	27	}

		@@ -17,189 +17,189 @@
		block discarded – undo
17	17	*/
18	18	class SpellControllerTest extends FunctionalTest
19	19	{
20		- protected $usesDatabase = true;
21		-
22		- protected $securityWasEnabled = false;
23		-
24		- protected function setUp()
25		- {
26		- parent::setUp();
27		-
28		- $this->securityWasEnabled = SecurityToken::is_enabled();
29		-
30		- // Reset config
31		- Config::modify()->set(SpellController::class, 'required_permission', 'CMS_ACCESS_CMSMain');
32		- Config::inst()->remove(SpellController::class, 'locales');
33		- Config::modify()->set(SpellController::class, 'locales', array('en_US', 'en_NZ', 'fr_FR'));
34		- Config::modify()->set(SpellController::class, 'enable_security_token', true);
35		- SecurityToken::enable();
36		-
37		- // Setup mock for testing provider
38		- $spellChecker = new SpellProviderStub;
39		- Injector::inst()->registerService($spellChecker, SpellProvider::class);
40		- }
41		-
42		- protected function tearDown()
43		- {
44		- if ($this->securityWasEnabled) {
45		- SecurityToken::enable();
46		- } else {
47		- SecurityToken::disable();
48		- }
49		-
50		- parent::tearDown();
51		- }
52		-
53		- /**
54		- * Tests security ID check
55		- */
56		- public function testSecurityID()
57		- {
58		- // Mock token
59		- $securityToken = SecurityToken::inst();
60		- $generator = new RandomGenerator();
61		- $token = $generator->randomToken('sha1');
62		- $session = array(
63		- $securityToken->getName() => $token
64		- );
65		- $tokenError = _t(
66		- 'SilverStripe\\SpellCheck\\Handling\\SpellController.SecurityMissing',
67		- 'Your session has expired. Please refresh your browser to continue.'
68		- );
69		-
70		- // Test request sans token
71		- $response = $this->get('spellcheck', Injector::inst()->create(Session::class, $session));
72		- $this->assertEquals(400, $response->getStatusCode());
73		- $jsonBody = json_decode($response->getBody());
74		- $this->assertEquals($tokenError, $jsonBody->error->errstr);
75		-
76		- // Test request with correct token (will fail with an unrelated error)
77		- $response = $this->get(
78		- 'spellcheck/?SecurityID='.urlencode($token),
79		- Injector::inst()->create(Session::class, $session)
80		- );
81		- $jsonBody = json_decode($response->getBody());
82		- $this->assertNotEquals($tokenError, $jsonBody->error->errstr);
83		-
84		- // Test request with check disabled
85		- Config::modify()->set(SpellController::class, 'enable_security_token', false);
86		- $response = $this->get('spellcheck', Injector::inst()->create(Session::class, $session));
87		- $jsonBody = json_decode($response->getBody());
88		- $this->assertNotEquals($tokenError, $jsonBody->error->errstr);
89		- }
90		-
91		- /**
92		- * Tests permission check
93		- */
94		- public function testPermissions()
95		- {
96		- // Disable security ID for this test
97		- Config::modify()->set(SpellController::class, 'enable_security_token', false);
98		- $securityError = _t('SilverStripe\\SpellCheck\\Handling\\SpellController.SecurityDenied', 'Permission Denied');
99		-
100		- // Test admin permissions
101		- Config::modify()->set(SpellController::class, 'required_permission', 'ADMIN');
102		- $this->logInWithPermission('ADMIN');
103		- $response = $this->get('spellcheck');
104		- $jsonBody = json_decode($response->getBody());
105		- $this->assertNotEquals($securityError, $jsonBody->error->errstr);
106		-
107		- // Test insufficient permissions
108		- $this->logInWithPermission('CMS_ACCESS_CMSMain');
109		- $response = $this->get('spellcheck');
110		- $this->assertEquals(403, $response->getStatusCode());
111		- $jsonBody = json_decode($response->getBody());
112		- $this->assertEquals($securityError, $jsonBody->error->errstr);
113		-
114		- // Test disabled permissions
115		- Config::modify()->set(SpellController::class, 'required_permission', false);
116		- $response = $this->get('spellcheck');
117		- $jsonBody = json_decode($response->getBody());
118		- $this->assertNotEquals($securityError, $jsonBody->error->errstr);
119		- }
120		-
121		- /**
122		- * Ensure that invalid input is correctly rejected
123		- */
124		- public function testInputRejection()
125		- {
126		- // Disable security ID and permissions for this test
127		- Config::modify()->set(SpellController::class, 'enable_security_token', false);
128		- Config::modify()->set(SpellController::class, 'required_permission', false);
129		- $invalidRequest = _t('SilverStripe\\SpellCheck\\Handling\\SpellController.InvalidRequest', 'Invalid request');
130		-
131		- // Test checkWords acceptance
132		- $dataCheckWords = array(
133		- 'id' => 'c0',
134		- 'method' => 'checkWords',
135		- 'params' => array(
136		- 'en_NZ',
137		- array('collor', 'colour', 'color', 'onee', 'correct')
138		- )
139		- );
140		- $response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataCheckWords)));
141		- $this->assertEquals(200, $response->getStatusCode());
142		- $jsonBody = json_decode($response->getBody());
143		- $this->assertEquals('c0', $jsonBody->id);
144		- $this->assertEquals(array("collor", "color", "onee"), $jsonBody->result);
145		-
146		- // Test getSuggestions acceptance
147		- $dataGetSuggestions = array(
148		- 'id' => '//c1//', // Should be reduced to only alphanumeric characters
149		- 'method' => 'getSuggestions',
150		- 'params' => array(
151		- 'en_NZ',
152		- 'collor'
153		-
154		- )
155		- );
156		- $response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataGetSuggestions)));
157		- $this->assertEquals(200, $response->getStatusCode());
158		- $jsonBody = json_decode($response->getBody());
159		- $this->assertEquals('c1', $jsonBody->id);
160		- $this->assertEquals(array('collar', 'colour'), $jsonBody->result);
161		-
162		- // Test non-ajax rejection
163		- $response = $this->post('spellcheck', array('json_data' => json_encode($dataCheckWords)));
164		- $this->assertEquals(400, $response->getStatusCode());
165		- $jsonBody = json_decode($response->getBody());
166		- $this->assertEquals($invalidRequest, $jsonBody->error->errstr);
167		-
168		- // Test incorrect method
169		- $dataInvalidMethod = $dataCheckWords;
170		- $dataInvalidMethod['method'] = 'validate';
171		- $response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataInvalidMethod)));
172		- $this->assertEquals(400, $response->getStatusCode());
173		- $jsonBody = json_decode($response->getBody());
174		- $this->assertEquals(
175		- _t(
176		- 'SilverStripe\\SpellCheck\\Handling\\.UnsupportedMethod',
177		- "Unsupported method '{method}'",
178		- array('method' => 'validate')
179		- ),
180		- $jsonBody->error->errstr
181		- );
182		-
183		- // Test missing method
184		- $dataNoMethod = $dataCheckWords;
185		- unset($dataNoMethod['method']);
186		- $response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataNoMethod)));
187		- $this->assertEquals(400, $response->getStatusCode());
188		- $jsonBody = json_decode($response->getBody());
189		- $this->assertEquals($invalidRequest, $jsonBody->error->errstr);
190		-
191		- // Test unsupported locale
192		- $dataWrongLocale = $dataCheckWords;
193		- $dataWrongLocale['params'] = array(
194		- 'de_DE',
195		- array('collor', 'colour', 'color', 'onee', 'correct')
196		- );
197		- $response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataWrongLocale)));
198		- $this->assertEquals(400, $response->getStatusCode());
199		- $jsonBody = json_decode($response->getBody());
200		- $this->assertEquals(_t(
201		- 'SilverStripe\\SpellCheck\\Handling\\.InvalidLocale',
202		- 'Not supported locale'
203		- ), $jsonBody->error->errstr);
204		- }
	20	+ protected $usesDatabase = true;
	21	+
	22	+ protected $securityWasEnabled = false;
	23	+
	24	+ protected function setUp()
	25	+ {
	26	+ parent::setUp();
	27	+
	28	+ $this->securityWasEnabled = SecurityToken::is_enabled();
	29	+
	30	+ // Reset config
	31	+ Config::modify()->set(SpellController::class, 'required_permission', 'CMS_ACCESS_CMSMain');
	32	+ Config::inst()->remove(SpellController::class, 'locales');
	33	+ Config::modify()->set(SpellController::class, 'locales', array('en_US', 'en_NZ', 'fr_FR'));
	34	+ Config::modify()->set(SpellController::class, 'enable_security_token', true);
	35	+ SecurityToken::enable();
	36	+
	37	+ // Setup mock for testing provider
	38	+ $spellChecker = new SpellProviderStub;
	39	+ Injector::inst()->registerService($spellChecker, SpellProvider::class);
	40	+ }
	41	+
	42	+ protected function tearDown()
	43	+ {
	44	+ if ($this->securityWasEnabled) {
	45	+ SecurityToken::enable();
	46	+ } else {
	47	+ SecurityToken::disable();
	48	+ }
	49	+
	50	+ parent::tearDown();
	51	+ }
	52	+
	53	+ /**
	54	+ * Tests security ID check
	55	+ */
	56	+ public function testSecurityID()
	57	+ {
	58	+ // Mock token
	59	+ $securityToken = SecurityToken::inst();
	60	+ $generator = new RandomGenerator();
	61	+ $token = $generator->randomToken('sha1');
	62	+ $session = array(
	63	+ $securityToken->getName() => $token
	64	+ );
	65	+ $tokenError = _t(
	66	+ 'SilverStripe\\SpellCheck\\Handling\\SpellController.SecurityMissing',
	67	+ 'Your session has expired. Please refresh your browser to continue.'
	68	+ );
	69	+
	70	+ // Test request sans token
	71	+ $response = $this->get('spellcheck', Injector::inst()->create(Session::class, $session));
	72	+ $this->assertEquals(400, $response->getStatusCode());
	73	+ $jsonBody = json_decode($response->getBody());
	74	+ $this->assertEquals($tokenError, $jsonBody->error->errstr);
	75	+
	76	+ // Test request with correct token (will fail with an unrelated error)
	77	+ $response = $this->get(
	78	+ 'spellcheck/?SecurityID='.urlencode($token),
	79	+ Injector::inst()->create(Session::class, $session)
	80	+ );
	81	+ $jsonBody = json_decode($response->getBody());
	82	+ $this->assertNotEquals($tokenError, $jsonBody->error->errstr);
	83	+
	84	+ // Test request with check disabled
	85	+ Config::modify()->set(SpellController::class, 'enable_security_token', false);
	86	+ $response = $this->get('spellcheck', Injector::inst()->create(Session::class, $session));
	87	+ $jsonBody = json_decode($response->getBody());
	88	+ $this->assertNotEquals($tokenError, $jsonBody->error->errstr);
	89	+ }
	90	+
	91	+ /**
	92	+ * Tests permission check
	93	+ */
	94	+ public function testPermissions()
	95	+ {
	96	+ // Disable security ID for this test
	97	+ Config::modify()->set(SpellController::class, 'enable_security_token', false);
	98	+ $securityError = _t('SilverStripe\\SpellCheck\\Handling\\SpellController.SecurityDenied', 'Permission Denied');
	99	+
	100	+ // Test admin permissions
	101	+ Config::modify()->set(SpellController::class, 'required_permission', 'ADMIN');
	102	+ $this->logInWithPermission('ADMIN');
	103	+ $response = $this->get('spellcheck');
	104	+ $jsonBody = json_decode($response->getBody());
	105	+ $this->assertNotEquals($securityError, $jsonBody->error->errstr);
	106	+
	107	+ // Test insufficient permissions
	108	+ $this->logInWithPermission('CMS_ACCESS_CMSMain');
	109	+ $response = $this->get('spellcheck');
	110	+ $this->assertEquals(403, $response->getStatusCode());
	111	+ $jsonBody = json_decode($response->getBody());
	112	+ $this->assertEquals($securityError, $jsonBody->error->errstr);
	113	+
	114	+ // Test disabled permissions
	115	+ Config::modify()->set(SpellController::class, 'required_permission', false);
	116	+ $response = $this->get('spellcheck');
	117	+ $jsonBody = json_decode($response->getBody());
	118	+ $this->assertNotEquals($securityError, $jsonBody->error->errstr);
	119	+ }
	120	+
	121	+ /**
	122	+ * Ensure that invalid input is correctly rejected
	123	+ */
	124	+ public function testInputRejection()
	125	+ {
	126	+ // Disable security ID and permissions for this test
	127	+ Config::modify()->set(SpellController::class, 'enable_security_token', false);
	128	+ Config::modify()->set(SpellController::class, 'required_permission', false);
	129	+ $invalidRequest = _t('SilverStripe\\SpellCheck\\Handling\\SpellController.InvalidRequest', 'Invalid request');
	130	+
	131	+ // Test checkWords acceptance
	132	+ $dataCheckWords = array(
	133	+ 'id' => 'c0',
	134	+ 'method' => 'checkWords',
	135	+ 'params' => array(
	136	+ 'en_NZ',
	137	+ array('collor', 'colour', 'color', 'onee', 'correct')
	138	+ )
	139	+ );
	140	+ $response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataCheckWords)));
	141	+ $this->assertEquals(200, $response->getStatusCode());
	142	+ $jsonBody = json_decode($response->getBody());
	143	+ $this->assertEquals('c0', $jsonBody->id);
	144	+ $this->assertEquals(array("collor", "color", "onee"), $jsonBody->result);
	145	+
	146	+ // Test getSuggestions acceptance
	147	+ $dataGetSuggestions = array(
	148	+ 'id' => '//c1//', // Should be reduced to only alphanumeric characters
	149	+ 'method' => 'getSuggestions',
	150	+ 'params' => array(
	151	+ 'en_NZ',
	152	+ 'collor'
	153	+
	154	+ )
	155	+ );
	156	+ $response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataGetSuggestions)));
	157	+ $this->assertEquals(200, $response->getStatusCode());
	158	+ $jsonBody = json_decode($response->getBody());
	159	+ $this->assertEquals('c1', $jsonBody->id);
	160	+ $this->assertEquals(array('collar', 'colour'), $jsonBody->result);
	161	+
	162	+ // Test non-ajax rejection
	163	+ $response = $this->post('spellcheck', array('json_data' => json_encode($dataCheckWords)));
	164	+ $this->assertEquals(400, $response->getStatusCode());
	165	+ $jsonBody = json_decode($response->getBody());
	166	+ $this->assertEquals($invalidRequest, $jsonBody->error->errstr);
	167	+
	168	+ // Test incorrect method
	169	+ $dataInvalidMethod = $dataCheckWords;
	170	+ $dataInvalidMethod['method'] = 'validate';
	171	+ $response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataInvalidMethod)));
	172	+ $this->assertEquals(400, $response->getStatusCode());
	173	+ $jsonBody = json_decode($response->getBody());
	174	+ $this->assertEquals(
	175	+ _t(
	176	+ 'SilverStripe\\SpellCheck\\Handling\\.UnsupportedMethod',
	177	+ "Unsupported method '{method}'",
	178	+ array('method' => 'validate')
	179	+ ),
	180	+ $jsonBody->error->errstr
	181	+ );
	182	+
	183	+ // Test missing method
	184	+ $dataNoMethod = $dataCheckWords;
	185	+ unset($dataNoMethod['method']);
	186	+ $response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataNoMethod)));
	187	+ $this->assertEquals(400, $response->getStatusCode());
	188	+ $jsonBody = json_decode($response->getBody());
	189	+ $this->assertEquals($invalidRequest, $jsonBody->error->errstr);
	190	+
	191	+ // Test unsupported locale
	192	+ $dataWrongLocale = $dataCheckWords;
	193	+ $dataWrongLocale['params'] = array(
	194	+ 'de_DE',
	195	+ array('collor', 'colour', 'color', 'onee', 'correct')
	196	+ );
	197	+ $response = $this->post('spellcheck', array('ajax' => 1, 'json_data' => json_encode($dataWrongLocale)));
	198	+ $this->assertEquals(400, $response->getStatusCode());
	199	+ $jsonBody = json_decode($response->getBody());
	200	+ $this->assertEquals(_t(
	201	+ 'SilverStripe\\SpellCheck\\Handling\\.InvalidLocale',
	202	+ 'Not supported locale'
	203	+ ), $jsonBody->error->errstr);
	204	+ }
205	205	}

silverstripe / silverstripe-spellcheck

Push — master ( e3eba2...8f5698 )

Status

Category

Indentation +14 added lines, -14 removed lines patch added patch discarded remove patch

Indentation +185 added lines, -185 removed lines patch added patch discarded remove patch