Add documentation

Author: enumag

docs/index.md

@@ -0,0 +1,92 @@
+Documentation
+====
+
+Arachne/Codeception is here to help you with Integration and [Functional Tests](http://codeception.com/docs/04-FunctionalTests) for your Nette application.
+
+NetteDIModule
+----
+
+When you want to write an integration test to make sure that some services work well together you need to create the DI container first.
+
+```yml
+# /tests/integration.suite.yml
+error_level: "E_ALL"
+class_name: IntegrationSuiteTester
+modules:
+    enabled:
+        - Arachne\Codeception\Module\NetteDIModule:
+            tempDir: ../_temp/integration
+            configFiles:
+                - config/config.neon
+            # Log directory for Tracy.
+            # logDir: ../_log
+            # Debug mode.
+            # debugMode: true
+            # Sometimes you might want to override the default Nette\Configurator with your own to get rid of the default extensions.
+            # configurator: Arachne\Bootstrap\Configurator
+```
+
+```
+# /tests/integration/config/config.neon
+services:
+    - MyService
+```
+
+```php
+# /tests/integration/src/MyServiceTest.php
+use Codeception\Test\Unit;
+class MyServiceTest extends Unit
+{
+    public function testMyService()
+    {
+        // Here you can override the configFiles from integration.suite.yml if needed.
+        // $this->tester->useConfigFiles(['config/another-config.neon']);
+        $this->assertInstanceOf(MyService::class, $this->tester->grabService(MyService::class));
+    }
+}
+```
+
+NetteApplicationModule
+----
+
+In functional tests you want to emulate the HTTP request and run `Nette\Application\Application` to handle it.
+
+Unfortunately Nette framework has some downsides like the fact that Request and Response are registered as services in the DI Container. For this reason the NetteApplicationModule requires `Arachne\Codeception\DI\CodeceptionExtension` to override the default implementations. **Beware that this is meant for the functional tests only. Do NOT register the extension outside of tests.**
+
+```
+# /tests/functional.suite.yml
+error_level: "E_ALL"
+class_name: FunctionalSuiteTester
+modules:
+    enabled:
+        - Arachne\Codeception\Module\NetteApplicationModule
+        - Arachne\Codeception\Module\NetteDIModule:
+            tempDir: ../_temp/functional
+            configFiles:
+                # Your application config file.
+                - ../../app/config/config.neon
+                # Additional config file only to add Arachne\Codeception\DI\HttpExtension.
+                - config/config.neon
+```
+
+```
+# /tests/functional/config/config.neon
+extensions:
+    codeception: Arachne\Codeception\DI\HttpExtension
+```
+
+```php
+# /tests/functional/src/HomepageTest.php
+use Codeception\Test\Unit;
+class HomepageTest extends Unit
+{
+    public function testHomepage()
+    {
+        // Create http request and run Nette\Application\Application. See Arachne\Codeception\Connector\NetteConnector for details.
+        $this->tester->amOnPage('/');
+        // Assert that the response is what you expect.
+        $this->tester->seeResponseCodeIs(200);
+        $this->tester->see('Hello World!', 'h1');
+    }
+}
+```