Update examples; Add session; More docs

Author: MGatner

README.md

@@ -31,17 +31,22 @@ See the provided [composer.json](src/composer.json) for examples.
 All tests go in the **tests/** directory. There are two generic subfolders for you,
 **unit** and **database** but feel free to make your own. Tests must extend the appropriate
 test case:
-* For basic tests extend `CodeIgniter\Test\CIDatabaseTestCase`
+* For basic tests extend `CodeIgniter\Test\CIUnitTestCase`
 * For database tests extend `CIModuleTests\Support\DatabaseTestCase`
 
 Tests are individual methods within each file. Method names must start with the word "test":
 `testUserSync()` `testOutputColor()` `testFooBar()`
 
-## Database Tests
+### Database Tests
 
 If you are using database tests that require a live database connect you will need to edit
 **phpunit.xml.dist**, uncomment the database configuration lines and add your connection
 details. Example directories and files are provided for test Seeds and Models, which you
 can modify or replace with your own. Also be sure to modify
 **tests/_support/DatabaseTestCase.php** to point to your seed and include any additional
 steps in `setUp()`.
+
+### Session Tests
+
+Similarly there is a pre-configured test case available with a mock session configured to
+make testing sessions easy: **tests/_support/SessionTestCase.php**.

src/tests/_support/DatabaseTestCase.php

@@ -30,14 +30,8 @@ class DatabaseTestCase extends \CodeIgniter\Test\CIDatabaseTestCase
      */
     protected $namespace = 'CIModuleTests\Support';
 
-    /**
-     * @var SessionHandler
-     */
-    protected $session;
-
     public function setUp(): void
     {
         parent::setUp();
-        
     }
 }

src/tests/_support/SessionTestCase.php

@@ -0,0 +1,32 @@
+<?php namespace CIModuleTests\Support;
+
+use CodeIgniter\Session\Handlers\ArrayHandler;
+use Tests\Support\Session\MockSession;
+
+class SessionTestCase extends \CodeIgniter\Test\CIDatabaseTestCase
+{
+    /**
+     * @var SessionHandler
+     */
+    protected $session;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->mockSession();
+    }
+    
+    /**
+     * Pre-loads the mock session driver into $this->session.
+     *
+     * @var string
+     */
+    protected function mockSession()
+    {
+        require_once ROOTPATH . 'tests/_support/Session/MockSession.php';
+        $config = config('App');
+        $this->session = new MockSession(new ArrayHandler($config, '0.0.0.0'), $config);
+        \Config\Services::injectMock('session', $this->session);
+    }
+}

src/tests/database/ExampleDatabaseTest.php

@@ -5,7 +5,6 @@ class ExampleDatabaseTest extends CIModuleTests\Support\DatabaseTestCase
 	public function setUp(): void
 	{
 		parent::setUp();
-		
 	}
 
 	public function testDatabaseSimple()

src/tests/session/ExampleSessionTest.php

@@ -0,0 +1,18 @@
+<?php
+
+class ExampleSessionTest extends CIModuleTests\Support\SessionTestCase
+{
+	public function setUp(): void
+	{
+		parent::setUp();
+	}
+
+	public function testSessionSimple()
+	{
+		$this->session->set('logged_in', 123);
+
+		$value = $this->session->get('logged_in')
+		
+		$this->assertEquals(123, $value);
+	}
+}

src/tests/unit/ExampleTest.php

@@ -1,6 +1,6 @@
 <?php
 
-class ExampleTest extends \CodeIgniter\Test\CIDatabaseTestCase
+class ExampleTest extends \CodeIgniter\Test\CIUnitTestCase
 {
 	public function setUp(): void
 	{