Merge pull request #1686 from jim-parry/refactor/filters

Refactor/filters

app/Config/Filters.php

@@ -7,9 +7,9 @@ class Filters extends BaseConfig
 	// Makes reading things below nicer,
 	// and simpler to change out script that's used.
 	public $aliases = [
-		'csrf'     => \App\Filters\CSRF::class,
-		'toolbar'  => \App\Filters\DebugToolbar::class,
-		'honeypot' => \App\Filters\Honeypot::class,
+		'csrf'     => \CodeIgniter\Filters\CSRF::class,
+		'toolbar'  => \CodeIgniter\Filters\DebugToolbar::class,
+		'honeypot' => \CodeIgniter\Filters\Honeypot::class,
 	];
 
 	// Always applied before every request

app/Filters/CSRF.php → system/Filters/CSRF.php

@@ -1,4 +1,4 @@
-<?php namespace App\Filters;
+<?php namespace CodeIgniter\Filters;
 
 use CodeIgniter\Filters\FilterInterface;
 use CodeIgniter\HTTP\RequestInterface;

app/Filters/DebugToolbar.php → system/Filters/DebugToolbar.php

@@ -1,4 +1,4 @@
-<?php namespace App\Filters;
+<?php namespace CodeIgniter\Filters;
 
 use CodeIgniter\Filters\FilterInterface;
 use CodeIgniter\HTTP\RequestInterface;

app/Filters/Honeypot.php → system/Filters/Honeypot.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Filters;
+namespace CodeIgniter\Filters;
 
 use CodeIgniter\Filters\FilterInterface;
 use CodeIgniter\HTTP\RequestInterface;

tests/system/Autoloader/FileLocatorTest.php

@@ -209,8 +209,8 @@ public function testListFilesFromMultipleDir()
 	{
 		$files = $this->locator->listFiles('Filters/');
 
-		$expectedWin = APPPATH . 'Filters\DebugToolbar.php';
-		$expectedLin = APPPATH . 'Filters/DebugToolbar.php';
+		$expectedWin = SYSTEMPATH . 'Filters\DebugToolbar.php';
+		$expectedLin = SYSTEMPATH . 'Filters/DebugToolbar.php';
 		$this->assertTrue(in_array($expectedWin, $files) || in_array($expectedLin, $files));
 
 		$expectedWin = SYSTEMPATH . 'Filters\Filters.php';

tests/system/Filters/CSRFTest.php

@@ -0,0 +1,46 @@
+<?php
+namespace CodeIgniter\Filters;
+
+use Config\Filters as FilterConfig;
+use CodeIgniter\Config\Services;
+use CodeIgniter\Filters\Exceptions\FilterException;
+use CodeIgniter\Honeypot\Exceptions\HoneypotException;
+use CodeIgniter\HTTP\ResponseInterface;
+
+/**
+ * @backupGlobals enabled
+ */
+class CSRFTest extends \CIUnitTestCase
+{
+
+	protected $config;
+	protected $request;
+	protected $response;
+
+	protected function setUp()
+	{
+		parent::setUp();
+		$this->config = new \Config\Filters();
+	}
+
+	//--------------------------------------------------------------------
+	public function testNormal()
+	{
+		$this->config->globals = [
+			'before' => ['csrf'],
+			'after'  => [],
+		];
+
+		$this->request  = Services::request(null, false);
+		$this->response = Services::response();
+
+		$filters = new Filters($this->config, $this->request, $this->response);
+		$uri     = 'admin/foo/bar';
+
+		// we expect CSRF requests to be ignored in CLI
+		$expected = $this->request;
+		$request  = $filters->run($uri, 'before');
+		$this->assertEquals($expected, $request);
+	}
+
+}

tests/system/Filters/DebugToolbarTest.php

@@ -0,0 +1,52 @@
+<?php
+namespace CodeIgniter\Filters;
+
+use Config\Filters as FilterConfig;
+use CodeIgniter\Config\Services;
+use CodeIgniter\Filters\Exceptions\FilterException;
+use CodeIgniter\HTTP\ResponseInterface;
+
+/**
+ * @backupGlobals enabled
+ */
+class DebugToolbarTest extends \CIUnitTestCase
+{
+
+	protected $request;
+	protected $response;
+
+	protected function setUp()
+	{
+		parent::setUp();
+
+		$this->request  = Services::request();
+		$this->response = Services::response();
+	}
+
+	//--------------------------------------------------------------------
+
+	public function testDebugToolbarFilter()
+	{
+		$_SERVER['REQUEST_METHOD'] = 'GET';
+
+		$config          = new FilterConfig();
+		$config->globals = [
+			'before' => ['toolbar'], // not normal; exercising its before()
+			'after'  => ['toolbar'],
+		];
+
+		$filter = new DebugToolbar();
+
+		$expectedBefore = $this->request;
+		$expectedAfter  = $this->response;
+
+		// nothing should change here, since we have no before logic
+		$filter->before($this->request);
+		$this->assertEquals($expectedBefore, $this->request);
+
+		// nothing should change here, since we are running in the CLI
+		$filter->after($this->request, $this->response);
+		$this->assertEquals($expectedAfter, $this->response);
+	}
+
+}

tests/system/Filters/FiltersTest.php

@@ -1,6 +1,7 @@
 <?php
 namespace CodeIgniter\Filters;
 
+use Config\Filters as FilterConfig;
 use CodeIgniter\Config\Services;
 use CodeIgniter\Filters\Exceptions\FilterException;
 use CodeIgniter\HTTP\ResponseInterface;

tests/system/Filters/HoneypotTest.php

@@ -0,0 +1,119 @@
+<?php
+namespace CodeIgniter\Filters;
+
+use Config\Filters as FilterConfig;
+use CodeIgniter\Config\Services;
+use CodeIgniter\Filters\Exceptions\FilterException;
+use CodeIgniter\Honeypot\Exceptions\HoneypotException;
+use CodeIgniter\HTTP\ResponseInterface;
+
+/**
+ * @backupGlobals enabled
+ */
+class HoneypotTest extends \CIUnitTestCase
+{
+
+	protected $config;
+	protected $honey;
+	protected $request;
+	protected $response;
+
+	protected function setUp()
+	{
+		parent::setUp();
+		$this->config = new \Config\Filters();
+		$this->honey  = new \Config\Honeypot();
+
+		unset($_POST[$this->honey->name]);
+		$_SERVER['REQUEST_METHOD'] = 'POST';
+		$_POST[$this->honey->name] = 'hey';
+	}
+
+	//--------------------------------------------------------------------
+	public function testBeforeTriggered()
+	{
+		$this->config->globals = [
+			'before' => ['honeypot'],
+			'after'  => [],
+		];
+
+		$this->request  = Services::request(null, false);
+		$this->response = Services::response();
+
+		$filters = new Filters($this->config, $this->request, $this->response);
+		$uri     = 'admin/foo/bar';
+
+		$this->expectException(HoneypotException::class);
+		$request = $filters->run($uri, 'before');
+	}
+
+	//--------------------------------------------------------------------
+	public function testBeforeClean()
+	{
+		$this->config->globals = [
+			'before' => ['honeypot'],
+			'after'  => [],
+		];
+
+		unset($_POST[$this->honey->name]);
+		$this->request  = Services::request(null, false);
+		$this->response = Services::response();
+
+		$expected = $this->request;
+
+		$filters = new Filters($this->config, $this->request, $this->response);
+		$uri     = 'admin/foo/bar';
+
+		$request = $filters->run($uri, 'before');
+		$this->assertEquals($expected, $request);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * @runInSeparateProcess
+	 * @preserveGlobalState  disabled
+	 */
+	public function testAfter()
+	{
+		$this->config->globals = [
+			'before' => [],
+			'after'  => ['honeypot'],
+		];
+
+		$this->request  = Services::request(null, false);
+		$this->response = Services::response();
+
+		$filters = new Filters($this->config, $this->request, $this->response);
+		$uri     = 'admin/foo/bar';
+
+		$this->response->setBody('<form></form>');
+		$this->response = $filters->run($uri, 'after');
+		$this->assertContains($this->honey->name, $this->response->getBody());
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * @runInSeparateProcess
+	 * @preserveGlobalState  disabled
+	 */
+	public function testAfterNotApplicable()
+	{
+		$this->config->globals = [
+			'before' => [],
+			'after'  => ['honeypot'],
+		];
+
+		$this->request  = Services::request(null, false);
+		$this->response = Services::response();
+
+		$filters = new Filters($this->config, $this->request, $this->response);
+		$uri     = 'admin/foo/bar';
+
+		$this->response->setBody('<div></div>');
+		$this->response = $filters->run($uri, 'after');
+		$this->assertNotContains($this->honey->name, $this->response->getBody());
+	}
+
+}

tests/system/Honeypot/HoneypotTest.php

@@ -7,8 +7,6 @@
 use CodeIgniter\Honeypot\Exceptions\HoneypotException;
 use CodeIgniter\Test\CIUnitTestCase;
 
-require_once __DIR__ . '/fixtures/HoneyTrap.php';
-
 /**
  * @backupGlobals enabled
  */
@@ -90,7 +88,7 @@ public function testConfigName()
 	public function testHoneypotFilterBefore()
 	{
 		$config = [
-			'aliases' => ['trap' => 'CodeIgniter\Honeypot\fixtures\HoneyTrap'],
+			'aliases' => ['trap' => '\CodeIgniter\Filters\Honeypot'],
 			'globals' => [
 				'before' => ['trap'],
 				'after'  => [],
@@ -107,7 +105,7 @@ public function testHoneypotFilterBefore()
 	public function testHoneypotFilterAfter()
 	{
 		$config = [
-			'aliases' => ['trap' => 'CodeIgniter\Honeypot\fixtures\HoneyTrap'],
+			'aliases' => ['trap' => '\CodeIgniter\Filters\Honeypot'],
 			'globals' => [
 				'before' => [],
 				'after'  => ['trap'],