setup unit tests seperate from WordPress 'unit' tests #2701

.gitignore

@@ -7,3 +7,6 @@ npm-debug.log
 **/.DS_Store
 includes/freemius/assets/img/caldera-forms.png
 bin/caldera-forms
+
+wordpress/*
+wp-content/*

README.md

@@ -74,6 +74,9 @@ The local server is [http://localhost:8228](http://localhost:8228)
 
 ### Test Structures
 * PHP tests go in /tests and are run using phpunit
+    - Integration tests, which require WordPress, are in tests. These used to be all the tests we have.
+    - Unit tests -- isolated tests that do NOT require WordPress -- go in `tests/Unit`.
+    - The trait `calderawp\calderaforms\Util\Traits` should have all of the factories used for integration and unit tests (aspirational.)
 * JavaScript UNIT tests go in clients/tests
     - Unit tests go in clients/tests/unit and are run using [Jest](https://facebook.github.io/jest/docs/en/getting-started.html)
     - Unit tests must have the word test in file name. For example, `formConfig.test.js`

composer.json

@@ -48,17 +48,27 @@
             "calderawp\\calderaforms\\pro\\": "includes/cf-pro-client/classes/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "calderawp\\calderaforms\\Tests\\Unit\\": "tests/Unit/",
+            "calderawp\\calderaforms\\Tests\\Util\\": "tests/Util/",
+            "calderawp\\calderaforms\\Tests\\Util\\Traits\\": "tests/Util/Traits/"
+        }
+    },
     "require-dev": {
         "phpunit/phpunit":"~5.5.0",
         "wpackagist-plugin/gutenberg":"*",
-        "johnpbloch/wordpress" : "*"
+        "johnpbloch/wordpress" : "*",
+        "brain/monkey": "^2.2",
+        "mockery/mockery": ">=0.9 <2"
     },
     "scripts" : {
         "wp:install": "bash ./bin/install-docker.sh && composer wp:config",
         "wp:activate": "bash ./bin/activate-plugin.sh",
         "wp:config": "docker-compose run --rm cli wp rewrite structure '/%postname%/'",
         "wp:start": "docker-compose up -d",
         "wp:tests": "docker-compose run --rm wordpress_phpunit phpunit --configuration phpunit-integration.xml.dist",
-        "wp:destroy": "docker-compose rm --stop --force"
+        "wp:destroy": "docker-compose rm --stop --force",
+        "test:unit": "phpunit --configuration phpunit-unit.xml.dist"
     }
 }

phpunit-unit.xml.dist

@@ -0,0 +1,15 @@
+<phpunit
+	bootstrap="tests/bootstrap-unit.php"
+	backupGlobals="false"
+	colors="true"
+	convertErrorsToExceptions="true"
+	convertNoticesToExceptions="true"
+	convertWarningsToExceptions="true"
+	>
+	<testsuites>
+		<testsuite name="unit" suffix=".php">
+			<directory>./tests/Unit</directory>
+		</testsuite>
+	</testsuites>
+	<log type="coverage-clover" target="clover.xml"/>
+</phpunit>

tests/Unit/SampleTest.php

@@ -0,0 +1,25 @@
+<?php
+
+
+namespace calderawp\calderaforms\Tests\Unit;
+
+
+class SampleTest extends TestCase
+{
+
+    /**
+     * Super basic test for educational purposes
+     *
+     * @covers TestCase
+     */
+    public function testTheTruth()
+    {
+        //What should the value be?
+        $excepted = true;
+        //What is the value actually
+        $actual = false;
+        //Are they not the same?
+        $this->assertNotEquals($excepted, $actual);
+    }
+
+}

tests/Unit/TestCase.php

@@ -0,0 +1,56 @@
+<?php
+
+
+namespace calderawp\calderaforms\Tests\Unit;
+
+
+use Brain\Monkey;
+
+use calderawp\calderaforms\Tests\Util\Traits\SharedFactories;
+use PHPUnit\Framework\TestCase as FrameworkTestCase;
+
+/**
+ * Class TestCase
+ *
+ * Default test case for all unit tests
+ * @package CalderaLearn\RestSearch\Tests\Unit
+ */
+abstract class TestCase extends FrameworkTestCase
+{
+    use SharedFactories;
+    /**
+     * Prepares the test environment before each test.
+     */
+    protected function setUp()
+    {
+        parent::setUp();
+        Monkey\setUp();
+
+        $this->setup_common_wp_stubs();
+    }
+
+    /**
+     * Cleans up the test environment after each test.
+     */
+    protected function tearDown()
+    {
+        Monkey\tearDown();
+        parent::tearDown();
+    }
+
+    //phpcs:disable
+    /**
+     * Set up the stubs for the common WordPress escaping and internationalization functions.
+     */
+    protected function setup_common_wp_stubs()
+    {
+        // Common internationalization functions.
+        Monkey\Functions\stubs(array(
+            '__',
+            'esc_html__',
+            'esc_html_x',
+            'esc_attr_x',
+        ));
+    }
+    //phpcs:enable
+}