From fd3f73af13a4fac95710359be9dcc40055f99583 Mon Sep 17 00:00:00 2001
From: Oliver Klee <github@oliverklee.de>
Date: Thu, 31 May 2018 23:48:38 +0200
Subject: [PATCH] [FEATURE] Example acceptance tests with Codeception (#31)

---
 README.md                                     | 18 ++++++++
 Tests/Acceptance/StarterCest.php              | 28 +++++++++++++
 .../Acceptance/_support/AcceptanceTester.php  | 26 ++++++++++++
 .../Acceptance/_support/Helper/Acceptance.php | 10 +++++
 .../Acceptance/_support/_generated/.gitignore |  2 +
 codeception.yml                               | 41 +++++++++++++++++++
 composer.json                                 |  2 +
 7 files changed, 127 insertions(+)
 create mode 100644 Tests/Acceptance/StarterCest.php
 create mode 100644 Tests/Acceptance/_support/AcceptanceTester.php
 create mode 100644 Tests/Acceptance/_support/Helper/Acceptance.php
 create mode 100644 Tests/Acceptance/_support/_generated/.gitignore
 create mode 100644 codeception.yml

diff --git a/README.md b/README.md
index d8f6a3f..d7f4f09 100644
--- a/README.md
+++ b/README.md
@@ -64,6 +64,24 @@ In the Run configurations, copy the PHPUnit configuration and use these settings
 - [x] Use alternative configuration file
 - use `.Build/vendor/nimut/testing-framework/res/Configuration/FunctionalTests.xml`
 
+### Running the acceptance tests
+
+#### On the command line
+
+1. make sure you have Chrome installed on your machine
+2. `composer update codeception/codeception` (just in case)
+3. [download the latest version of ChromeDriver](http://chromedriver.chromium.org/downloads)
+4. unzip it
+5. `chromedriver --url-base=/wd/hub &`
+6. `.Build/vendor/bin/codecept run`
+7. Run 'Acceptance (Codeception)'
+
+
+#### In PhpStorm
+
+1. make sure the "Codeception Framework" plugin is activated
+2. right-click on `Tests/Acceptance`
+
 ## Creating new extensions with automated tests
 
 For creating new extensions, I recommend taking
diff --git a/Tests/Acceptance/StarterCest.php b/Tests/Acceptance/StarterCest.php
new file mode 100644
index 0000000..6f3bfad
--- /dev/null
+++ b/Tests/Acceptance/StarterCest.php
@@ -0,0 +1,28 @@
+<?php
+declare(strict_types = 1);
+namespace OliverKlee\Tea\Tests\Acceptance;
+
+/**
+ * Test case.
+ *
+ * @author Oliver Klee <typo3-coding@oliverklee.de>
+ */
+class StarterCest
+{
+    public function _before(\AcceptanceTester $I)
+    {
+        $I->amOnPage('/');
+    }
+
+    public function seeAuthorName(\AcceptanceTester $I)
+    {
+        $I->see('Oliver Klee');
+    }
+
+    public function canNavigateToPastWorkshops(\AcceptanceTester $I)
+    {
+        $I->click('Workshops');
+        $I->click('Rückblick');
+        $I->see('2017 (17)');
+    }
+}
diff --git a/Tests/Acceptance/_support/AcceptanceTester.php b/Tests/Acceptance/_support/AcceptanceTester.php
new file mode 100644
index 0000000..4c7dcbb
--- /dev/null
+++ b/Tests/Acceptance/_support/AcceptanceTester.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 AcceptanceTester extends \Codeception\Actor
+{
+    use _generated\AcceptanceTesterActions;
+
+   /**
+    * Define custom actions here
+    */
+}
diff --git a/Tests/Acceptance/_support/Helper/Acceptance.php b/Tests/Acceptance/_support/Helper/Acceptance.php
new file mode 100644
index 0000000..65b9421
--- /dev/null
+++ b/Tests/Acceptance/_support/Helper/Acceptance.php
@@ -0,0 +1,10 @@
+<?php
+namespace Helper;
+
+// here you can define custom actions
+// all public methods declared in helper class will be available in $I
+
+class Acceptance extends \Codeception\Module
+{
+
+}
diff --git a/Tests/Acceptance/_support/_generated/.gitignore b/Tests/Acceptance/_support/_generated/.gitignore
new file mode 100644
index 0000000..c96a04f
--- /dev/null
+++ b/Tests/Acceptance/_support/_generated/.gitignore
@@ -0,0 +1,2 @@
+*
+!.gitignore
\ No newline at end of file
diff --git a/codeception.yml b/codeception.yml
new file mode 100644
index 0000000..0577a62
--- /dev/null
+++ b/codeception.yml
@@ -0,0 +1,41 @@
+# suite config
+suites:
+    acceptance:
+        actor: AcceptanceTester
+        path: .
+        modules:
+            enabled:
+                - WebDriver:
+                    url: https://www.oliverklee.de
+                    browser: chrome
+                - \Helper\Acceptance
+
+extensions:
+    enabled: [Codeception\Extension\RunFailed]
+
+params:
+    - env
+
+gherkin: []
+
+# additional paths
+paths:
+    tests: Tests/Acceptance
+    output: .Build/public/typo3temp/var/tests/_output
+    data: .Build/public/typo3temp/var/tests/_data
+    support: Tests/Acceptance/_support
+    envs: .Build/public/typo3temp/var/tests/_envs
+
+settings:
+    shuffle: false
+    lint: true
+
+modules:
+  config:
+    WebDriver:
+      browser: chrome
+      port: 9515 # ChromeDriver port
+      window_size: false
+      capabilities:
+        chromeOptions:
+          args: ["--headless", "--disable-gpu"]
diff --git a/composer.json b/composer.json
index 4d8fa7b..067035a 100644
--- a/composer.json
+++ b/composer.json
@@ -36,6 +36,8 @@
         "helhum/typo3-composer-setup": "^0.5.1",
         "helmich/typo3-typoscript-lint": "^1.4.4",
         "nimut/testing-framework": "^3.0",
+        "codeception/codeception": "^2.4",
+        "enm1989/chromedriver": "^2.38",
         "roave/security-advisories": "dev-master"
     },
     "replace": {