Add docs and examples

Author: MGatner

README.md

@@ -1,2 +1,47 @@
 # ci4-module-tests
 Testing scaffold for PHPUnit tests in CodeIgniter 4
+
+## Overview
+
+**CIModuleTests** is intended to be integrated into third-party modules for CodeIgniter 4.
+It provides a scaffold and basic examples of how to perform module testing dependent on the
+framework without being integrated into a specific project.
+
+For more on Testing in CodeIgniter 4 visit the
+[User Guide](https://codeigniter4.github.io/CodeIgniter4/testing/).
+
+## Install
+
+1. Clone this repo and merge the **tests** folder and **phpunit.xml.dist** and
+**composer.json**<sup>1</sup> files from **src/** into the root of your module. 
+2. From your package root run `composer install` to install all the required support packages.
+3. Run `composer test` to initiate the tests.
+
+<sup>1</sup> Note: Unless you are starting fresh you likely will already have your own version of
+**composer.json**, in which case you will need to be sure to merge the following settings
+for **CIModuleTests**:
+* `repositories` needs an entry for `https://github.com/codeigniter4/CodeIgniter4`
+* `require-dev` needs the CodeIgniter 4 repo, PHPUnit, and Mockery
+* `autoload-dev` must supply the PSR4 namespace for the test supports
+
+See the provided [composer.json](src/composer.json) for examples.
+
+## Creating Tests
+
+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 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
+
+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()`.

src/composer.json

@@ -0,0 +1,47 @@
+{
+	"name": "mgatner/ci-module-tests",
+	"description": "Testing scaffold for PHPUnit tests in CodeIgniter 4",
+	"keywords": [
+		"codeigniter",
+		"codeigniter4",
+		"phpunit",
+		"tests",
+		"modules",
+		"coverage"
+	],
+	"homepage": "https://github.com/mgatner/ci-module-tests",
+	"license": "MIT",
+	"authors": [
+		{
+			"name": "Matthew Gatner",
+			"email": "mgatner@tattersoftware.com",
+			"homepage": "https://tattersoftware.com",
+			"role": "Developer"
+		}
+	],
+	"repositories": [
+		{
+			"type": "vcs",
+			"url": "https://github.com/codeigniter4/CodeIgniter4"
+		}
+	],
+	"require": {
+		"php" : ">=7.2"
+	},
+	"require-dev": {
+		"phpunit/phpunit" : "^7.0",
+		"mockery/mockery": "^1.0",
+		"codeigniter4/codeigniter4": "dev-develop"
+	},
+	"autoload-dev": {
+		"psr-4": {
+			"CIModuleTests\\Support\\": "tests/_support"
+		}
+	},
+	"scripts": {
+		"test": "phpunit",
+		"post-update-cmd": [
+			"composer dump-autoload"
+		]
+	}
+}

src/phpunit.xml.dist

@@ -30,13 +30,15 @@
     </logging>
 
     <php>
-        <env name="app.baseURL" value="http://example.com"/>
-        <env name="CI_ENVIRONMENT" value="testing"/>
-<!--        <env name="database.tests.DBDriver" value="MySQLi"/>-->
-<!--        <env name="database.tests.database" value="mythauth"/>-->
-<!--        <env name="database.tests.username" value="root"/>-->
-        <env name="database.tests.DBDriver" value="SQLite3"/>
-        <env name="database.tests.database" value=":memory:"/>
-<!--        <env name="database.tests.DBPrefix" value="handlers_"/>-->
+		<env name="app.baseURL" value="http://example.com"/>
+		<env name="CI_ENVIRONMENT" value="testing"/>
+<!--	<env name="database.tests.hostname" value="localhost"/>  -->
+<!--	<env name="database.tests.database" value="tests"/>      -->
+<!--	<env name="database.tests.username" value="tests_user"/> -->
+<!--	<env name="database.tests.password" value=""/>           -->
+<!--	<env name="database.tests.DBDriver" value="MySQLi"/>     -->
+<!--	<env name="database.tests.DBPrefix" value="tests_"/>     -->
+		<env name="database.tests.database" value=":memory:"/>
+		<env name="database.tests.DBDriver" value="SQLite3"/>
     </php>
 </phpunit>

src/tests/_support/DatabaseTestCase.php

@@ -14,7 +14,7 @@ class DatabaseTestCase extends \CodeIgniter\Test\CIDatabaseTestCase
      *
      * @var string
      */
-    protected $seed = 'ExampleSeeder';
+    protected $seed = 'CIModuleTests\Support\Database\Seeds\ExampleSeeder';
 
     /**
      * The path to where we can find the test Seeds directory.

src/tests/database/ExampleDatabaseTest.php

@@ -8,7 +8,7 @@ public function setUp(): void
 
 	}
 
-	public function simpleDatabaseTest()
+	public function testDatabaseSimple()
 	{
 		$model = new \CIModuleTests\Support\Models\ExampleModel();
 

src/tests/unit/ExampleTest.php

@@ -8,7 +8,7 @@ public function setUp(): void
 
 	}
 
-	public function simpleTest()
+	public function testSimple()
 	{
 		$test = defined('APPPATH');
 		$this->assertTrue($test);