initial igniter support

igniter/tests/.htaccess

@@ -0,0 +1,6 @@
+<IfModule authz_core_module>
+	Require all denied
+</IfModule>
+<IfModule !authz_core_module>
+	Deny from all
+</IfModule>

igniter/tests/README.md

@@ -0,0 +1,118 @@
+# Running Application Tests
+
+This is the quick-start to CodeIgniter testing. Its intent is to describe what
+it takes to set up your application and get it ready to run unit tests.
+It is not intended to be a full description of the test features that you can
+use to test your application. Those details can be found in the documentation.
+
+## Resources
+
+* [CodeIgniter 4 User Guide on Testing](https://codeigniter.com/user_guide/testing/index.html)
+* [PHPUnit docs](https://phpunit.de/documentation.html)
+* [Any tutorials on Unit testing in CI4?](https://forum.codeigniter.com/showthread.php?tid=81830)
+
+## Requirements
+
+It is recommended to use the latest version of PHPUnit. At the time of this
+writing, we are running version 9.x. Support for this has been built into the
+**composer.json** file that ships with CodeIgniter and can easily be installed
+via [Composer](https://getcomposer.org/) if you don't already have it installed globally.
+
+```console
+> composer install
+```
+
+If running under macOS or Linux, you can create a symbolic link to make running tests a touch nicer.
+
+```console
+> ln -s ./vendor/bin/phpunit ./phpunit
+```
+
+You also need to install [XDebug](https://xdebug.org/docs/install) in order
+for code coverage to be calculated successfully. After installing `XDebug`, you must add `xdebug.mode=coverage` in the **php.ini** file to enable code coverage.
+
+## Setting Up
+
+A number of the tests use a running database.
+In order to set up the database edit the details for the `tests` group in
+**app/Config/Database.php** or **.env**.
+Make sure that you provide a database engine that is currently running on your machine.
+More details on a test database setup are in the
+[Testing Your Database](https://codeigniter.com/user_guide/testing/database.html) section of the documentation.
+
+## Running the tests
+
+The entire test suite can be run by simply typing one command-line command from the main directory.
+
+```console
+> ./phpunit
+```
+
+If you are using Windows, use the following command.
+
+```console
+> vendor\bin\phpunit
+```
+
+You can limit tests to those within a single test directory by specifying the
+directory name after phpunit.
+
+```console
+> ./phpunit app/Models
+```
+
+## Generating Code Coverage
+
+To generate coverage information, including HTML reports you can view in your browser,
+you can use the following command:
+
+```console
+> ./phpunit --colors --coverage-text=tests/coverage.txt --coverage-html=tests/coverage/ -d memory_limit=1024m
+```
+
+This runs all of the tests again collecting information about how many lines,
+functions, and files are tested. It also reports the percentage of the code that is covered by tests.
+It is collected in two formats: a simple text file that provides an overview as well
+as a comprehensive collection of HTML files that show the status of every line of code in the project.
+
+The text file can be found at **tests/coverage.txt**.
+The HTML files can be viewed by opening **tests/coverage/index.html** in your favorite browser.
+
+## PHPUnit XML Configuration
+
+The repository has a ``phpunit.xml.dist`` file in the project root that's used for
+PHPUnit configuration. This is used to provide a default configuration if you
+do not have your own configuration file in the project root.
+
+The normal practice would be to copy ``phpunit.xml.dist`` to ``phpunit.xml``
+(which is git ignored), and to tailor it as you see fit.
+For instance, you might wish to exclude database tests, or automatically generate
+HTML code coverage reports.
+
+## Test Cases
+
+Every test needs a *test case*, or class that your tests extend. CodeIgniter 4
+provides one class that you may use directly:
+* `CodeIgniter\Test\CIUnitTestCase`
+
+Most of the time you will want to write your own test cases that extend `CIUnitTestCase`
+to hold functions and services common to your test suites.
+
+## Creating Tests
+
+All tests go in the **tests/** directory. Each test file is a class that extends a
+**Test Case** (see above) and contains methods for the individual tests. These method
+names must start with the word "test" and should have descriptive names for precisely what
+they are testing:
+`testUserCanModifyFile()` `testOutputColorMatchesInput()` `testIsLoggedInFailsWithInvalidUser()`
+
+Writing tests is an art, and there are many resources available to help learn how.
+Review the links above and always pay attention to your code coverage.
+
+### Database Tests
+
+Tests can include migrating, seeding, and testing against a mock or live database.
+Be sure to modify the test case (or create your own) to point to your seed and migrations
+and include any additional steps to be run before tests in the `setUp()` method.
+See [Testing Your Database](https://codeigniter.com/user_guide/testing/database.html)
+for details.

igniter/tests/_support/Database/Migrations/2020-02-22-222222_example_migration.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Tests\Support\Database\Migrations;
+
+use CodeIgniter\Database\Migration;
+
+class ExampleMigration extends Migration
+{
+    protected $DBGroup = 'tests';
+
+    public function up(): void
+    {
+        $this->forge->addField('id');
+        $this->forge->addField([
+            'name'       => ['type' => 'varchar', 'constraint' => 31],
+            'uid'        => ['type' => 'varchar', 'constraint' => 31],
+            'class'      => ['type' => 'varchar', 'constraint' => 63],
+            'icon'       => ['type' => 'varchar', 'constraint' => 31],
+            'summary'    => ['type' => 'varchar', 'constraint' => 255],
+            'created_at' => ['type' => 'datetime', 'null' => true],
+            'updated_at' => ['type' => 'datetime', 'null' => true],
+            'deleted_at' => ['type' => 'datetime', 'null' => true],
+        ]);
+
+        $this->forge->addKey('name');
+        $this->forge->addKey('uid');
+        $this->forge->addKey(['deleted_at', 'id']);
+        $this->forge->addKey('created_at');
+
+        $this->forge->createTable('factories');
+    }
+
+    public function down(): void
+    {
+        $this->forge->dropTable('factories');
+    }
+}

igniter/tests/_support/Database/Seeds/ExampleSeeder.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Tests\Support\Database\Seeds;
+
+use CodeIgniter\Database\Seeder;
+
+class ExampleSeeder extends Seeder
+{
+    public function run(): void
+    {
+        $factories = [
+            [
+                'name'    => 'Test Factory',
+                'uid'     => 'test001',
+                'class'   => 'Factories\Tests\NewFactory',
+                'icon'    => 'fas fa-puzzle-piece',
+                'summary' => 'Longer sample text for testing',
+            ],
+            [
+                'name'    => 'Widget Factory',
+                'uid'     => 'widget',
+                'class'   => 'Factories\Tests\WidgetPlant',
+                'icon'    => 'fas fa-puzzle-piece',
+                'summary' => 'Create widgets in your factory',
+            ],
+            [
+                'name'    => 'Evil Factory',
+                'uid'     => 'evil-maker',
+                'class'   => 'Factories\Evil\MyFactory',
+                'icon'    => 'fas fa-book-dead',
+                'summary' => 'Abandon all hope, ye who enter here',
+            ],
+        ];
+
+        $builder = $this->db->table('factories');
+
+        foreach ($factories as $factory) {
+            $builder->insert($factory);
+        }
+    }
+}

igniter/tests/_support/Libraries/ConfigReader.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Tests\Support\Libraries;
+
+/**
+ * Class ConfigReader
+ *
+ * An extension of BaseConfig that prevents the constructor from
+ * loading external values. Used to read actual local values from
+ * a config file.
+ */
+class ConfigReader extends \Config\App
+{
+    public function __construct()
+    {
+    }
+}

igniter/tests/_support/Models/ExampleModel.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Tests\Support\Models;
+
+use CodeIgniter\Model;
+
+class ExampleModel extends Model
+{
+    protected $table          = 'factories';
+    protected $primaryKey     = 'id';
+    protected $returnType     = 'object';
+    protected $useSoftDeletes = false;
+    protected $allowedFields  = [
+        'name',
+        'uid',
+        'class',
+        'icon',
+        'summary',
+    ];
+    protected $useTimestamps      = true;
+    protected $validationRules    = [];
+    protected $validationMessages = [];
+    protected $skipValidation     = false;
+}

igniter/tests/database/ExampleDatabaseTest.php

@@ -0,0 +1,46 @@
+<?php
+
+use CodeIgniter\Test\CIUnitTestCase;
+use CodeIgniter\Test\DatabaseTestTrait;
+use Tests\Support\Database\Seeds\ExampleSeeder;
+use Tests\Support\Models\ExampleModel;
+
+/**
+ * @internal
+ */
+final class ExampleDatabaseTest extends CIUnitTestCase
+{
+    use DatabaseTestTrait;
+
+    protected $seed = ExampleSeeder::class;
+
+    public function testModelFindAll(): void
+    {
+        $model = new ExampleModel();
+
+        // Get every row created by ExampleSeeder
+        $objects = $model->findAll();
+
+        // Make sure the count is as expected
+        $this->assertCount(3, $objects);
+    }
+
+    public function testSoftDeleteLeavesRow(): void
+    {
+        $model = new ExampleModel();
+        $this->setPrivateProperty($model, 'useSoftDeletes', true);
+        $this->setPrivateProperty($model, 'tempUseSoftDeletes', true);
+
+        /** @var stdClass $object */
+        $object = $model->first();
+        $model->delete($object->id);
+
+        // The model should no longer find it
+        $this->assertNull($model->find($object->id));
+
+        // ... but it should still be in the database
+        $result = $model->builder()->where('id', $object->id)->get()->getResult();
+
+        $this->assertCount(1, $result);
+    }
+}

igniter/tests/index.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<title>403 Forbidden</title>
+</head>
+<body>
+
+<p>Directory access is forbidden.</p>
+
+</body>
+</html>

igniter/tests/session/ExampleSessionTest.php

@@ -0,0 +1,17 @@
+<?php
+
+use CodeIgniter\Test\CIUnitTestCase;
+
+/**
+ * @internal
+ */
+final class ExampleSessionTest extends CIUnitTestCase
+{
+    public function testSessionSimple(): void
+    {
+        $session = service('session');
+
+        $session->set('logged_in', 123);
+        $this->assertSame(123, $session->get('logged_in'));
+    }
+}

igniter/tests/unit/HealthTest.php

@@ -0,0 +1,49 @@
+<?php
+
+use CodeIgniter\Test\CIUnitTestCase;
+use Config\App;
+use Tests\Support\Libraries\ConfigReader;
+
+/**
+ * @internal
+ */
+final class HealthTest extends CIUnitTestCase
+{
+    public function testIsDefinedAppPath(): void
+    {
+        $this->assertTrue(defined('APPPATH'));
+    }
+
+    public function testBaseUrlHasBeenSet(): void
+    {
+        $validation = service('validation');
+
+        $env = false;
+
+        // Check the baseURL in .env
+        if (is_file(HOMEPATH . '.env')) {
+            $env = preg_grep('/^app\.baseURL = ./', file(HOMEPATH . '.env')) !== false;
+        }
+
+        if ($env) {
+            // BaseURL in .env is a valid URL?
+            // phpunit.xml.dist sets app.baseURL in $_SERVER
+            // So if you set app.baseURL in .env, it takes precedence
+            $config = new App();
+            $this->assertTrue(
+                $validation->check($config->baseURL, 'valid_url'),
+                'baseURL "' . $config->baseURL . '" in .env is not valid URL',
+            );
+        }
+
+        // Get the baseURL in app/Config/App.php
+        // You can't use Config\App, because phpunit.xml.dist sets app.baseURL
+        $reader = new ConfigReader();
+
+        // BaseURL in app/Config/App.php is a valid URL?
+        $this->assertTrue(
+            $validation->check($reader->baseURL, 'valid_url'),
+            'baseURL "' . $reader->baseURL . '" in app/Config/App.php is not valid URL',
+        );
+    }
+}