From d4be41f0bd35e7ebc27de2541fd3e9b6320bd8f9 Mon Sep 17 00:00:00 2001
From: Flavio Copes <copesc@gmail.com>
Date: Thu, 13 Oct 2016 16:36:52 +0200
Subject: [PATCH] Add Codeception testing suite

---
 README.md                      |  5 +++
 codeception.yml                | 18 ++++++++
 composer.json                  |  8 ++++
 tests/_bootstrap.php           | 11 +++++
 tests/_support/Helper/Unit.php | 80 ++++++++++++++++++++++++++++++++++
 tests/_support/UnitTester.php  | 26 +++++++++++
 tests/unit.suite.yml           |  9 ++++
 tests/unit/_bootstrap.php      |  3 ++
 8 files changed, 160 insertions(+)
 create mode 100644 codeception.yml
 create mode 100644 tests/_bootstrap.php
 create mode 100644 tests/_support/Helper/Unit.php
 create mode 100644 tests/_support/UnitTester.php
 create mode 100644 tests/unit.suite.yml
 create mode 100644 tests/unit/_bootstrap.php

diff --git a/README.md b/README.md
index f6d9811f..d689dbaa 100644
--- a/README.md
+++ b/README.md
@@ -105,3 +105,8 @@ If you have been following the [blog](http://getgrav.org/blog), [Twitter](https:
 The **standard free version**, is very powerful, and has more functionality than most commercial flat-file CMS systems.
 
 We also intend to release in the near future a more feature-rich **pro version** that will include enhanced functionality, as well as some additional nice-to-have capabilities. This pro version will be a **paid** plugin the price of which is not yet 100% finalized.
+
+# Running Tests
+
+First install the dev dependencies by running `composer update` from the Grav root.
+Then `composer test` will run the Unit Tests, which should be always executed successfully on any site.
diff --git a/codeception.yml b/codeception.yml
new file mode 100644
index 00000000..7d317a5a
--- /dev/null
+++ b/codeception.yml
@@ -0,0 +1,18 @@
+actor: Tester
+paths:
+    tests: tests
+    log: tests/_output
+    data: tests/_data
+    support: tests/_support
+    envs: tests/_envs
+settings:
+    bootstrap: _bootstrap.php
+    colors: true
+    memory_limit: 1024M
+extensions:
+    enabled:
+        - Codeception\Extension\RunFailed
+        # - Codeception\Extension\Recorder
+
+modules:
+    config:
diff --git a/composer.json b/composer.json
index bd3f435e..2386d0ac 100644
--- a/composer.json
+++ b/composer.json
@@ -2,5 +2,13 @@
     "require": {
         "composer/semver": "^1.4",
         "fguillot/picofeed": "@stable"
+    },
+    "require-dev": {
+        "codeception/codeception": "^2.1",
+        "fzaninotto/faker": "^1.5"
+    },
+    "scripts": {
+        "test": "vendor/bin/codecept run unit",
+        "test-windows": "vendor\\bin\\codecept run unit"
     }
 }
diff --git a/tests/_bootstrap.php b/tests/_bootstrap.php
new file mode 100644
index 00000000..9b932bd6
--- /dev/null
+++ b/tests/_bootstrap.php
@@ -0,0 +1,11 @@
+<?php
+// This is global bootstrap for autoloading
+
+use Codeception\Util\Fixtures;
+use Faker\Factory;
+
+ini_set('error_log', __DIR__ . '/error.log');
+
+$fake = Factory::create();
+Fixtures::add('fake', $fake);
+
diff --git a/tests/_support/Helper/Unit.php b/tests/_support/Helper/Unit.php
new file mode 100644
index 00000000..19987296
--- /dev/null
+++ b/tests/_support/Helper/Unit.php
@@ -0,0 +1,80 @@
+<?php
+namespace Helper;
+
+use Codeception;
+// here you can define custom actions
+// all public methods declared in helper class will be available in $I
+
+/**
+ * Class Unit
+ * @package Helper
+ */
+class Unit extends Codeception\Module
+{
+    /**
+     * HOOK: used after configuration is loaded
+     */
+    public function _initialize() {
+    }
+
+    /**
+     * HOOK: on every Actor class initialization
+     */
+    public function _cleanup() {
+    }
+
+    /**
+     * HOOK: before suite
+     *
+     * @param array $settings
+     */
+    public function _beforeSuite($settings = []) {
+    }
+
+    /**
+     * HOOK: after suite
+     **/
+    public function _afterSuite() {
+    }
+
+    /**
+     * HOOK: before each step
+     *
+     * @param Codeception\Step $step*
+     */
+    public function _beforeStep(Codeception\Step $step) {
+    }
+
+    /**
+     * HOOK: after each step
+     *
+     * @param Codeception\Step $step
+     */
+    public function _afterStep(Codeception\Step $step) {
+    }
+
+    /**
+     * HOOK: before each suite
+     *
+     * @param Codeception\TestCase $test
+     */
+    public function _before(Codeception\TestCase $test) {
+    }
+
+    /**
+     * HOOK: before each suite
+     *
+     * @param Codeception\TestCase $test
+     */
+    public function _after(Codeception\TestCase $test) {
+    }
+
+    /**
+     * HOOK: on fail
+     *
+     * @param Codeception\TestCase $test
+     * @param $fail
+     */
+    public function _failed(Codeception\TestCase $test, $fail) {
+    }
+}
diff --git a/tests/_support/UnitTester.php b/tests/_support/UnitTester.php
new file mode 100644
index 00000000..28353572
--- /dev/null
+++ b/tests/_support/UnitTester.php
@@ -0,0 +1,26 @@
+<?php
+
+
+/**
+ * Inherited Methods
+ * @method void wantToTest($text)
+ * @method void wantTo($text)
+ * @method void execute($callable)
+ * @method void expectTo($prediction)
+ * @method void expect($prediction)
+ * @method void amGoingTo($argumentation)
+ * @method void am($role)
+ * @method void lookForwardTo($achieveValue)
+ * @method void comment($description)
+ * @method \Codeception\Lib\Friend haveFriend($name, $actorClass = NULL)
+ *
+ * @SuppressWarnings(PHPMD)
+*/
+class UnitTester extends \Codeception\Actor
+{
+    use _generated\UnitTesterActions;
+
+   /**
+    * Define custom actions here
+    */
+}
diff --git a/tests/unit.suite.yml b/tests/unit.suite.yml
new file mode 100644
index 00000000..02dc9b1e
--- /dev/null
+++ b/tests/unit.suite.yml
@@ -0,0 +1,9 @@
+# Codeception Test Suite Configuration
+#
+# Suite for unit (internal) tests.
+
+class_name: UnitTester
+modules:
+    enabled:
+        - Asserts
+        - \Helper\Unit
\ No newline at end of file
diff --git a/tests/unit/_bootstrap.php b/tests/unit/_bootstrap.php
new file mode 100644
index 00000000..5634ef57
--- /dev/null
+++ b/tests/unit/_bootstrap.php
@@ -0,0 +1,3 @@
+<?php
+// Here you can initialize variables that will be available to your tests
+