Merge pull request #4772 from putyourlightson/patch-19

Testing: fix deprecation warning and error in PhpStorm
craftcms · Aug 28, 2019 · e09c5c8 · e09c5c8
2 parents 72a3873 + 1755a98
commit e09c5c8
Show file tree

Hide file tree

Showing 10 changed files with 15 additions and 26 deletions.
diff --git a/codeception.yml b/codeception.yml
@@ -5,8 +5,8 @@ paths:
   data: tests/_data
   support: tests/_support
   envs: tests/_envs
+bootstrap: _bootstrap.php
 settings:
-  bootstrap: _bootstrap.php
   colors: true
   memory_limit: 2048M
 coverage:
@@ -65,4 +65,4 @@ groups:
     - 'tests/unit/gql'
     - 'tests/unit/services/GqlTest'
     - 'tests/unit/helpers/GqlHelperTest'
-    - 'tests/gql/GqlCest'
+    - 'tests/gql/GqlCest'
diff --git a/composer.json b/composer.json
@@ -53,7 +53,7 @@
     "zendframework/zend-feed": "^2.8.0"
   },
   "require-dev": {
-    "codeception/codeception": "^3.0",
+    "codeception/codeception": "^3.1",
     "codeception/mockery-module": "^0.3",
     "codeception/phpunit-wrapper": "^7.7",
     "codeception/specify": "^0.4",
@@ -79,7 +79,8 @@
   },
   "autoload": {
     "psr-4": {
-      "craft\\": "src/"
+      "craft\\": "src/",
+      "crafttests\\fixtures\\": "tests/fixtures/"
     }
   }
 }
diff --git a/docs/testing/testing-craft/getting-started.md b/docs/testing/testing-craft/getting-started.md
@@ -11,9 +11,11 @@ This guide can be used for setting up tests for a Craft site & Modules/Plugins.
 
 [[toc]]
 
-## Step 1: Install Codeception 3.x
+## Step 1: Install Codeception 3.1 or higher
+
+Follow instruction 1 and 2 Codeception's [website](https://codeception.com/quickstart). Ensure you install 
+`codeception/codeception` at `3.1`or higher.
 
-Follow instruction 1 and 2 Codeception's [website](https://codeception.com/quickstart)
 ::: tip
 If you are setting up tests for a Craft CMS Site and not a module/plugin, 
 when running `composer install` on production, add the `--no-dev` flag to avoid
@@ -49,8 +51,7 @@ paths:
     data: tests/_data
     support: tests/_support
     envs: tests/_envs
-settings:
-    bootstrap: _bootstrap.php
+bootstrap: _bootstrap.php
 params:
     - tests/.env
 modules:

diff --git a/src/test/TestSetup.php b/src/test/TestSetup.php
@@ -320,6 +320,10 @@ public static function configureCraft(): bool
         Craft::setAlias('@templates', $templatesPath);
         Craft::setAlias('@translations', $translationsPath);
 
+        // Prevent `headers already sent` error when running tests in PhpStorm
+        // https://stackoverflow.com/questions/31175636/headers-already-sent-running-unit-tests-in-phpstorm
+        ob_start ();
+
         return true;
     }
 

diff --git a/src/test/internal/example-test-suite/codeception.yml b/src/test/internal/example-test-suite/codeception.yml
@@ -5,8 +5,8 @@ paths:
   data: tests/_data
   support: tests/_support
   envs: tests/_envs
+bootstrap: _bootstrap.php
 settings:
-  bootstrap: _bootstrap.php
 params:
   - tests/.env
 modules:

diff --git a/src/test/internal/example-test-suite/tests/functional/_bootstrap.php b/src/test/internal/example-test-suite/tests/functional/_bootstrap.php
diff --git a/src/test/internal/example-test-suite/tests/unit/_bootstrap.php b/src/test/internal/example-test-suite/tests/unit/_bootstrap.php
diff --git a/tests/acceptance/_bootstrap.php b/tests/acceptance/_bootstrap.php
diff --git a/tests/functional/_bootstrap.php b/tests/functional/_bootstrap.php
diff --git a/tests/unit/_bootstrap.php b/tests/unit/_bootstrap.php