Merge pull request #86 from creative-commoners/pulls/2/dispatch-ci

MNT Use gha-dispatch-ci

.editorconfig

@@ -13,5 +13,8 @@ trim_trailing_whitespace = true
 [{*.yml,*.json}]
 indent_size = 2
 
+[composer.json]
+indent_size = 4
+
 # The indent size used in the package.json file cannot be changed:
 # https://github.com/npm/npm/pull/3180#issuecomment-16336516

.github/workflows/ci.yml

@@ -0,0 +1,11 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  ci:
+    name: CI
+    uses: silverstripe/gha-ci/.github/workflows/ci.yml@v1

.github/workflows/dispatch-ci.yml

@@ -0,0 +1,16 @@
+name: Dispatch CI
+
+on:
+  # At 2:30 PM UTC, only on Monday and Tuesday
+  schedule:
+    - cron: '30 14 * * 1,2'
+
+jobs:
+  dispatch-ci:
+    name: Dispatch CI
+    # Only run cron on the silverstripe account
+    if: (github.event_name == 'schedule' && github.repository_owner == 'silverstripe') || (github.event_name != 'schedule')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dispatch CI
+        uses: silverstripe/gha-dispatch-ci@v1

.github/workflows/keepalive.yml

@@ -0,0 +1,17 @@
+name: Keepalive
+
+on:
+  workflow_dispatch:
+  # The 4th of every month at 10:50am UTC
+  schedule:
+    - cron: '50 10 4 * *'
+
+jobs:
+  keepalive:
+    name: Keepalive
+    # Only run cron on the silverstripe account
+    if: (github.event_name == 'schedule' && github.repository_owner == 'silverstripe') || (github.event_name != 'schedule')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Keepalive
+        uses: silverstripe/gha-keepalive@v1

.scrutinizer.yml

@@ -1,69 +0,0 @@
-inherit: true
-
-checks:
-  php:
-    verify_property_names: true
-    verify_argument_usable_as_reference: true
-    verify_access_scope_valid: true
-    useless_calls: true
-    use_statement_alias_conflict: true
-    variable_existence: true
-    unused_variables: true
-    unused_properties: true
-    unused_parameters: true
-    unused_methods: true
-    unreachable_code: true
-    too_many_arguments: true
-    sql_injection_vulnerabilities: true
-    simplify_boolean_return: true
-    side_effects_or_types: true
-    security_vulnerabilities: true
-    return_doc_comments: true
-    return_doc_comment_if_not_inferrable: true
-    require_scope_for_properties: true
-    require_scope_for_methods: true
-    require_php_tag_first: true
-    psr2_switch_declaration: true
-    psr2_class_declaration: true
-    property_assignments: true
-    prefer_while_loop_over_for_loop: true
-    precedence_mistakes: true
-    precedence_in_conditions: true
-    phpunit_assertions: true
-    php5_style_constructor: true
-    parse_doc_comments: true
-    parameter_non_unique: true
-    parameter_doc_comments: true
-    param_doc_comment_if_not_inferrable: true
-    optional_parameters_at_the_end: true
-    one_class_per_file: true
-    no_unnecessary_if: true
-    no_trailing_whitespace: true
-    no_property_on_interface: true
-    no_non_implemented_abstract_methods: true
-    no_error_suppression: true
-    no_duplicate_arguments: true
-    no_commented_out_code: true
-    newline_at_end_of_file: true
-    missing_arguments: true
-    method_calls_on_non_object: true
-    instanceof_class_exists: true
-    foreach_traversable: true
-    fix_line_ending: true
-    fix_doc_comments: true
-    duplication: true
-    deprecated_code_usage: true
-    deadlock_detection_in_loops: true
-    code_rating: true
-    closure_use_not_conflicting: true
-    catch_class_exists: true
-    blank_line_after_namespace_declaration: false
-    avoid_multiple_statements_on_same_line: true
-    avoid_duplicate_types: true
-    avoid_conflicting_incrementers: true
-    avoid_closing_tag: true
-    assignment_of_null_return: true
-    argument_type_checks: true
-
-filter:
-  paths: [code/*, tests/*]

README.md

@@ -1,6 +1,6 @@
 # Browser Test Session Module
 
-[![Build Status](https://travis-ci.org/silverstripe-labs/silverstripe-testsession.svg)](https://travis-ci.org/silverstripe-labs/silverstripe-testsession)
+[![CI](https://github.com/silverstripe/silverstripe-testsession/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-testsession/actions/workflows/ci.yml)
 
 ## Overview
 
@@ -8,7 +8,7 @@
 *It's completely possible to allow any user to become an admin, or do other nefarious things, if this is installed on a live site.*
 
 This module starts a testing session in a browser,
-in order to test a SilverStripe application in a clean state.
+in order to test a Silverstripe application in a clean state.
 Usually the session is started on a fresh database with only default records loaded.
 Further data can be loaded from YAML fixtures or database dumps.
 
@@ -20,8 +20,13 @@ is a random token stored in the browser session, in order to make the
 test session specific to the executing browser, and allow multiple
 people using their own test session in the same webroot.
 
+The module also keeps some metadata about the session state in the database,
+so that it may be available for the clients as well.
+E.g. the silverstripe-behat-extension may use it through this module APIs,
+allowing us to introduce some grey-box testing techniques.
+
 The module also serves as an initializer for the
-[SilverStripe Behat Extension](https://github.com/silverstripe-labs/silverstripe-behat-extension/).
+[Silverstripe Behat Extension](https://github.com/silverstripe-labs/silverstripe-behat-extension/).
 It is required for Behat because the Behat CLI test runner needs to persist
 test configuration just for the tested browser connection,
 available on arbitary URL endpoints. For example,
@@ -30,7 +35,7 @@ into a temporary database table for inspection by the CLI-based process.
 
 ## Setup
 
-Simply require the module in a SilverStripe webroot (3.0 or newer):
+Simply require the module in a Silverstripe webroot (3.0 or newer):
 
 	composer require --dev silverstripe/behat-extension
 
@@ -42,7 +47,7 @@ and interact with it through other URL endpoints.
 Commands:
 
  * `dev/testsession`: Shows options for starting a test session
- * `dev/testsession/start`: Sets up test state, most commonly a test database will be constructed, 
+ * `dev/testsession/start`: Sets up test state, most commonly a test database will be constructed,
     and your browser session will be amended to use this database. See "Parameters" documentation below.
  * `dev/testsession/end`: Removes the test state, and resets to the original database.
  * `dev/testsession/loadfixture?fixture=<path>`: Loads a fixture into an existing test state.
@@ -54,15 +59,15 @@ While you can use the interface to set the test session state,
 it can be useful to set them programmatically through query parameters
 on "dev/testsession/start":
 
- * `fixture`: Loads a YAML fixture in the format generally accepted by `SapphireTest` 
+ * `fixture`: Loads a YAML fixture in the format generally accepted by `SapphireTest`
-   (see [fixture format docs](http://doc.silverstripe.org/en/developer_guides/testing/fixtures/)). 
+   (see [fixture format docs](http://doc.silverstripe.org/en/developer_guides/testing/fixtures/)).
    The path should be relative to the webroot.
  * `createDatabase`: Create a temporary database.
  * `importDatabasePath`: Absolute path to a database dump to load into a newly created temporary database.
  * `importDatabaseFilename`: File name for a database dump to load, relative to `TestSessionController.database_templates_path`
  * `requireDefaultRecords`: Include default records as defined on the model classes (in PHP)
- * `database`: Set an alternative database name in the current 
+ * `database`: Set an alternative database name in the current
-    browser session as a cookie. Does not actually create the database, 
+    browser session as a cookie. Does not actually create the database,
     that's usually handled by `SapphireTest::create_temp_db()`.
     Note: The database names are limited to a specific naming convention as a security measure:
     The "ss_tmpdb" prefix and a random sequence of seven digits.
@@ -71,9 +76,9 @@ on "dev/testsession/start":
  * `datetime`: Sets a simulated date used for all framework operations.
     Format as "yyyy-MM-dd HH:mm:ss" (Example: "2012-12-31 18:40:59").
  * `globalTestSession`: Activate test session independently of the current browser session,
-    effectively setting the site into test session mode for all users across different browsers. 
+    effectively setting the site into test session mode for all users across different browsers.
-	Only available in "dev" mode. For example, create a global test session in Chrome, then you can share 
+	Only available in "dev" mode. For example, create a global test session in Chrome, then you can share
-	the session data in Firefox. But if you have started a non-global session in a browser before starting 
+	the session data in Firefox. But if you have started a non-global session in a browser before starting
 	a global session somewhere else, that non-global session will take priority in that browser.
 
 Example usage with parameters:

_config/routes.yml

@@ -1,6 +1,7 @@
 ---
 Name: testsessionroutes
 ---
-SilverStripe\Control\Director:
+SilverStripe\Dev\DevelopmentAdmin:
-  rules:
+  registered_controllers:
-    dev/testsession: SilverStripe\TestSession\TestSessionController
+    testsession:
+      controller: SilverStripe\TestSession\TestSessionController

composer.json

@@ -1,36 +1,40 @@
 {
-  "name": "silverstripe/testsession",
+    "name": "silverstripe/testsession",
-  "type": "silverstripe-module",
+    "type": "silverstripe-vendormodule",
-  "description": "Support module for browser-based test sessions, e.g. for Behat behaviour testing",
+    "description": "Support module for browser-based test sessions, e.g. for Behat behaviour testing",
-  "homepage": "http://silverstripe.org",
+    "homepage": "http://silverstripe.org",
-  "license": "BSD-3-Clause",
+    "license": "BSD-3-Clause",
-  "keywords": [
+    "keywords": [
-    "silverstripe",
+        "silverstripe",
-    "testing"
+        "testing"
-  ],
+    ],
-  "authors": [
+    "authors": [
-    {
+        {
-      "name": "SilverStripe",
+            "name": "SilverStripe",
-      "homepage": "http://silverstripe.com"
+            "homepage": "http://silverstripe.com"
-    }
+        }
-  ],
+    ],
-  "require": {
+    "require": {
-    "composer/installers": "*",
+        "composer/installers": "*",
-    "silverstripe/framework": "^4@dev"
+        "silverstripe/framework": "^4@dev",
-  },
+        "silverstripe/vendor-plugin": "^1.3"
-  "extra": {
+    },
-    "branch-alias": {
+    "require-dev": {
-      "dev-master": "2.0.x-dev"
+        "squizlabs/php_codesniffer": "^3.5"
-    }
+    },
-  },
+    "extra": {
-  "scripts": {
+        "expose": [
-    "lint": "phpcs -s src/ tests/"
+            "client"
-  },
+        ]
-  "autoload": {
+    },
-    "psr-4": {
+    "scripts": {
-      "SilverStripe\\TestSession\\": "src/",
+        "lint": "phpcs -s src/ tests/"
-      "SilverStripe\\TestSession\\Tests\\": "tests/"
+    },
-    }
+    "autoload": {
-  },
+        "psr-4": {
-  "minimum-stability": "dev"
+            "SilverStripe\\TestSession\\": "src/",
+            "SilverStripe\\TestSession\\Tests\\": "tests/"
+        }
+    },
+    "minimum-stability": "dev"
 }

phpcs.xml.dist

@@ -2,6 +2,8 @@
 <ruleset name="SilverStripe">
 	<description>CodeSniffer ruleset for SilverStripe coding conventions.</description>
 
+	<file>src</file>
+
 	<!-- base rules are PSR-2 -->
 	<rule ref="PSR2" >
 		<!-- Current exclusions -->

src/TestSessionController.php

@@ -31,6 +31,7 @@ use SilverStripe\View\Requirements;
  */
 class TestSessionController extends Controller
 {
+    private static $url_segment = 'dev/testsession';
 
     private static $allowed_actions = array(
         'index',
@@ -77,13 +78,8 @@ class TestSessionController extends Controller
             return;
         }
 
-        Requirements::javascript('http://code.jquery.com/jquery-1.7.2.min.js');
+        Requirements::javascript('//code.jquery.com/jquery-1.7.2.min.js');
-        Requirements::javascript('testsession/client/js/testsession.js');
+        Requirements::javascript('silverstripe/testsession:client/js/testsession.js');
-    }
-
-    public function Link($action = null)
-    {
-        return Controller::join_links(Director::baseURL(), 'dev/testsession', $action);
     }
 
     public function index()
@@ -108,7 +104,7 @@ class TestSessionController extends Controller
             $id = null;
         } else {
             $generator = Injector::inst()->get(RandomGenerator::class);
-            $id = substr($generator->randomToken(), 0, 10);
+            $id = substr($generator->randomToken() ?? '', 0, 10);
             $this->getRequest()->getSession()->set('TestSessionId', $id);
         }
 
@@ -117,7 +113,7 @@ class TestSessionController extends Controller
 
         // Remove unnecessary items of form-specific data from being saved in the test session
         $params = array_diff_key(
-            $params,
+            $params ?? [],
             array(
                 'action_set' => true,
                 'action_start' => true,
@@ -174,7 +170,7 @@ class TestSessionController extends Controller
             throw new LogicException("No test session in progress.");
         }
 
-        $newSessionStates = array_diff_key($request->getVars(), array('url' => true));
+        $newSessionStates = array_diff_key($request->getVars() ?? [], array('url' => true));
         if (!$newSessionStates) {
             throw new LogicException('No query parameters detected');
         }
@@ -292,7 +288,7 @@ class TestSessionController extends Controller
 
         // Remove unnecessary items of form-specific data from being saved in the test session
         $params = array_diff_key(
-            $params,
+            $params ?? [],
             array(
                 'action_set' => true,
                 'action_start' => true,
@@ -403,7 +399,7 @@ class TestSessionController extends Controller
             $path = BASE_PATH . '/' . $path;
         }
 
-        if ($path && file_exists($path)) {
+        if ($path && file_exists($path ?? '')) {
             $it = new FilesystemIterator($path);
             foreach ($it as $fileinfo) {
                 if ($fileinfo->getExtension() != 'sql') {

src/TestSessionEnvironment.php

@@ -2,9 +2,11 @@
 
 namespace SilverStripe\TestSession;
 
+use DirectoryIterator;
 use Exception;
 use InvalidArgumentException;
 use LogicException;
+use SilverStripe\Assets\Filesystem;
 use SilverStripe\Core\Environment;
 use SilverStripe\Control\Director;
 use SilverStripe\Control\HTTPRequest;
@@ -78,7 +80,6 @@ class TestSessionEnvironment
 
     public function __construct($id = null)
     {
-        $this->constructExtensions();
         if ($id) {
             $this->id = $id;
         }
@@ -100,7 +101,7 @@ class TestSessionEnvironment
     public function getFilePath()
     {
         if ($this->id) {
-            $path = Director::getAbsFile(sprintf($this->config()->get('test_state_id_file'), $this->id));
+            $path = Director::getAbsFile(sprintf($this->config()->get('test_state_id_file') ?? '', $this->id));
         } else {
             $path = Director::getAbsFile($this->config()->get('test_state_file'));
         }
@@ -113,7 +114,7 @@ class TestSessionEnvironment
      */
     public function isRunningTests()
     {
-        return(file_exists($this->getFilePath()));
+        return (file_exists($this->getFilePath() ?? ''));
     }
 
     /**
@@ -159,10 +160,13 @@ class TestSessionEnvironment
 
         // Convert to JSON and back so we can share the applyState() code between this and ->loadFromFile()
         $json = json_encode($state, JSON_FORCE_OBJECT);
-        $state = json_decode($json);
+        $state = json_decode($json ?? '');
 
         $this->applyState($state);
 
+        // Back up /assets folder
+        $this->backupAssets();
+
         $this->extend('onAfterStartTestSession');
     }
 
@@ -172,13 +176,80 @@ class TestSessionEnvironment
 
         // Convert to JSON and back so we can share the appleState() code between this and ->loadFromFile()
         $json = json_encode($state, JSON_FORCE_OBJECT);
-        $state = json_decode($json);
+        $state = json_decode($json ?? '');
 
         $this->applyState($state);
 
         $this->extend('onAfterUpdateTestSession');
     }
 
+    /**
+     * Backup all assets from /assets to /assets_backup.
+     * Note: Only does file move, no files ever duplicated / deleted
+     */
+    protected function backupAssets()
+    {
+        // Ensure files backed up to assets dir
+        $backupFolder = $this->getAssetsBackupfolder();
+        if (!is_dir($backupFolder ?? '')) {
+            Filesystem::makeFolder($backupFolder);
+        }
+        $this->moveRecursive(ASSETS_PATH, $backupFolder, ['.htaccess', 'web.config', '.protected']);
+    }
+
+    /**
+     * Restore all assets to /assets folder.
+     * Note: Only does file move, no files ever duplicated / deleted
+     */
+    public function restoreAssets()
+    {
+        // Ensure files backed up to assets dir
+        $backupFolder = $this->getAssetsBackupfolder();
+        if (is_dir($backupFolder ?? '')) {
+            // Move all files
+            Filesystem::makeFolder(ASSETS_PATH);
+            $this->moveRecursive($backupFolder, ASSETS_PATH);
+            Filesystem::removeFolder($backupFolder);
+        }
+    }
+
+    /**
+     * Recursively move files from one directory to another
+     *
+     * @param string $src Source of files being moved
+     * @param string $dest Destination of files being moved
+     * @param array $ignore List of files to not move
+     */
+    protected function moveRecursive($src, $dest, $ignore = [])
+    {
+        // If source is not a directory stop processing
+        if (!is_dir($src ?? '')) {
+            return;
+        }
+
+        // If the destination directory does not exist create it
+        if (!is_dir($dest ?? '') && !mkdir($dest ?? '')) {
+            // If the destination directory could not be created stop processing
+            return;
+        }
+
+        // Open the source directory to read in files
+        $iterator = new DirectoryIterator($src);
+        foreach ($iterator as $file) {
+            if ($file->isFile()) {
+                if (!in_array($file->getFilename(), $ignore ?? [])) {
+                    rename($file->getRealPath() ?? '', $dest . DIRECTORY_SEPARATOR . $file->getFilename());
+                }
+            } elseif (!$file->isDot() && $file->isDir()) {
+                // If a dir is ignored, still move children but don't remove self
+                $this->moveRecursive($file->getRealPath(), $dest . DIRECTORY_SEPARATOR . $file);
+                if (!in_array($file->getFilename(), $ignore ?? [])) {
+                    Filesystem::removeFolder($file->getRealPath());
+                }
+            }
+        }
+    }
+
     /**
      * Assumes the database has already been created in startTestSession(), as this method can be called from
      * _config.php where we don't yet have a DB connection.
@@ -212,26 +283,7 @@ class TestSessionEnvironment
         }
 
         // ensure we have a connection to the database
-        if (isset($state->database) && $state->database) {
+        $this->connectToDatabase($state);
-            if (!DB::get_conn()) {
-                // No connection, so try and connect to tmpdb if it exists
-                if (isset($state->database)) {
-                    $this->oldDatabaseName = $databaseConfig['database'];
-                    $databaseConfig['database'] = $state->database;
-                }
-
-                // Connect to database
-                DB::connect($databaseConfig);
-            } else {
-                // We've already connected to the database, do a fast check to see what database we're currently using
-                $db = DB::get_conn()->getSelectedDatabase();
-                if (isset($state->database) && $db != $state->database) {
-                    $this->oldDatabaseName = $databaseConfig['database'];
-                    $databaseConfig['database'] = $state->database;
-                    DB::connect($databaseConfig);
-                }
-            }
-        }
 
         // Database
         if (!$this->isRunningTests()) {
@@ -252,8 +304,8 @@ class TestSessionEnvironment
 
                 // Set existing one, assumes it already has been created
                 $prefix = Environment::getEnv('SS_DATABASE_PREFIX') ?: 'ss_';
-                $pattern = strtolower(sprintf('#^%stmpdb.*#', preg_quote($prefix, '#')));
+                $pattern = strtolower(sprintf('#^%stmpdb.*#', preg_quote($prefix ?? '', '#')));
-                if (!preg_match($pattern, $dbName)) {
+                if (!preg_match($pattern ?? '', $dbName ?? '')) {
                     throw new InvalidArgumentException("Invalid database name format");
                 }
 
@@ -263,13 +315,15 @@ class TestSessionEnvironment
                 // Connect to the new database, overwriting the old DB connection (if any)
                 DB::connect($databaseConfig);
             }
+
+            TestSessionState::create()->write();  // initialize the session state
         }
 
         // Mailer
         $mailer = (isset($state->mailer)) ? $state->mailer : null;
 
         if ($mailer) {
-            if (!class_exists($mailer) || !is_subclass_of($mailer, 'SilverStripe\\Control\\Email\\Mailer')) {
+            if (!class_exists($mailer ?? '') || !is_subclass_of($mailer, 'SilverStripe\\Control\\Email\\Mailer')) {
                 throw new InvalidArgumentException(sprintf(
                     'Class "%s" is not a valid class, or subclass of Mailer',
                     $mailer
@@ -291,6 +345,7 @@ class TestSessionEnvironment
         }
 
         $this->saveState($state);
+
         $this->extend('onAfterApplyState');
     }
 
@@ -302,13 +357,13 @@ class TestSessionEnvironment
      */
     public function importDatabase($path, $requireDefaultRecords = false)
     {
-        $sql = file_get_contents($path);
+        $sql = file_get_contents($path ?? '');
 
         // Split into individual query commands, removing comments
         $sqlCmds = array_filter(preg_split(
             '/;\n/',
-            preg_replace(array('/^$\n/m', '/^(\/|#).*$\n/m'), '', $sql)
+            preg_replace(array('/^$\n/m', '/^(\/|#).*$\n/m'), '', $sql ?? '') ?? ''
-        ));
+        ) ?? []);
 
         // Execute each query
         foreach ($sqlCmds as $sqlCmd) {
@@ -345,7 +400,7 @@ class TestSessionEnvironment
             $content = json_encode($state);
         }
         $old = umask(0);
-        file_put_contents($this->getFilePath(), $content, LOCK_EX);
+        file_put_contents($this->getFilePath() ?? '', $content, LOCK_EX);
         umask($old);
     }
 
@@ -353,8 +408,8 @@ class TestSessionEnvironment
     {
         if ($this->isRunningTests()) {
             try {
-                $contents = file_get_contents($this->getFilePath());
+                $contents = file_get_contents($this->getFilePath() ?? '');
-                $json = json_decode($contents);
+                $json = json_decode($contents ?? '');
 
                 $this->applyState($json);
             } catch (Exception $e) {
@@ -372,8 +427,8 @@ class TestSessionEnvironment
     {
         $file = $this->getFilePath();
 
-        if (file_exists($file)) {
+        if (file_exists($file ?? '')) {
-            if (!unlink($file)) {
+            if (!unlink($file ?? '')) {
                 throw new \Exception('Unable to remove the testsession state file, please remove it manually. File '
                     . 'path: ' . $file);
             }
@@ -395,6 +450,10 @@ class TestSessionEnvironment
     {
         $this->extend('onBeforeEndTestSession');
 
+        // Restore assets
+        $this->restoreAssets();
+
+        // Reset DB
         $tempDB = new TempDatabase();
         if ($tempDB->isUsed()) {
             $state = $this->getState();
@@ -423,15 +482,15 @@ class TestSessionEnvironment
      */
     public function loadFixtureIntoDb($fixtureFile)
     {
-        $realFile = realpath(BASE_PATH.'/'.$fixtureFile);
+        $realFile = realpath(BASE_PATH . '/' . $fixtureFile);
-        $baseDir = realpath(Director::baseFolder());
+        $baseDir = realpath(Director::baseFolder() ?? '');
-        if (!$realFile || !file_exists($realFile)) {
+        if (!$realFile || !file_exists($realFile ?? '')) {
             throw new LogicException("Fixture file doesn't exist");
-        } elseif (substr($realFile, 0, strlen($baseDir)) != $baseDir) {
+        } elseif (substr($realFile ?? '', 0, strlen($baseDir ?? '')) != $baseDir) {
             throw new LogicException("Fixture file must be inside $baseDir");
-        } elseif (substr($realFile, -4) != '.yml') {
+        } elseif (substr($realFile ?? '', -4) != '.yml') {
             throw new LogicException("Fixture file must be a .yml file");
-        } elseif (!preg_match('/^([^\/.][^\/]+)\/tests\//', $fixtureFile)) {
+        } elseif (!preg_match('/^([^\/.][^\/]+)\/tests\//', $fixtureFile ?? '')) {
             throw new LogicException("Fixture file must be inside the tests subfolder of one of your modules.");
         }
 
@@ -470,6 +529,85 @@ class TestSessionEnvironment
     public function getState()
     {
         $path = Director::getAbsFile($this->getFilePath());
-        return (file_exists($path)) ? json_decode(file_get_contents($path)) : new stdClass;
+        if (file_exists($path ?? '')) {
+            return json_decode(file_get_contents($path)) ?: new stdClass;
+        }
+        return new stdClass;
+    }
+
+    /**
+     * Path where assets should be backed up during testing
+     *
+     * @return string
+     */
+    protected function getAssetsBackupfolder()
+    {
+        return PUBLIC_PATH . DIRECTORY_SEPARATOR . 'assets_backup';
+    }
+
+    /**
+     * Ensure that there is a connection to the database
+     *
+     * @param mixed $state
+     */
+    public function connectToDatabase($state = null)
+    {
+        if ($state == null) {
+            $state = $this->getState();
+        }
+
+        $databaseConfig = DB::getConfig();
+
+        if (isset($state->database) && $state->database) {
+            if (!DB::get_conn()) {
+                // No connection, so try and connect to tmpdb if it exists
+                if (isset($state->database)) {
+                    $this->oldDatabaseName = $databaseConfig['database'];
+                    $databaseConfig['database'] = $state->database;
+                }
+
+                // Connect to database
+                DB::connect($databaseConfig);
+            } else {
+                // We've already connected to the database, do a fast check to see what database we're currently using
+                $db = DB::get_conn()->getSelectedDatabase();
+                if (isset($state->database) && $db != $state->database) {
+                    $this->oldDatabaseName = $databaseConfig['database'];
+                    $databaseConfig['database'] = $state->database;
+                    DB::connect($databaseConfig);
+                }
+            }
+        }
+    }
+
+    /**
+     * Wait for pending requests
+     *
+     * @param int $await Time to wait (in ms) after the last response (to allow the browser react)
+     * @param int $timeout For how long (in ms) do we wait before giving up
+     *
+     * @return bool Whether there are no more pending requests
+     */
+    public function waitForPendingRequests($await = 700, $timeout = 10000)
+    {
+        $timeout = TestSessionState::millitime() + $timeout;
+        $interval = max(300, $await);
+
+        do {
+            $now = TestSessionState::millitime();
+
+            if ($timeout < $now) {
+                return false;
+            }
+
+            $model = TestSessionState::get()->byID(1);
+
+            $pendingRequests = $model->PendingRequests > 0;
+            $lastRequestAwait = ($model->LastResponseTimestamp + $await) > $now;
+
+            $pending = $pendingRequests || $lastRequestAwait;
+        } while ($pending && (usleep($interval * 1000) || true));
+
+        return true;
     }
 }

src/TestSessionHTTPMiddleware.php

@@ -39,12 +39,14 @@ class TestSessionHTTPMiddleware implements HTTPMiddleware
 
         // Load test state
         $this->loadTestState($request);
+        TestSessionState::incrementState();
 
         // Call with safe teardown
         try {
             return $delegate($request);
         } finally {
             $this->restoreTestState($request);
+            TestSessionState::decrementState();
         }
     }
 
@@ -67,8 +69,12 @@ class TestSessionHTTPMiddleware implements HTTPMiddleware
             $mailer = $testState->mailer;
             Injector::inst()->registerService(new $mailer(), Mailer::class);
             Email::config()->set("send_all_emails_to", null);
+            Email::config()->set('admin_email', 'no-reply@example.com');
         }
 
+        // Connect to the test session database
+        $this->testSessionEnvironment->connectToDatabase();
+
         // Allows inclusion of a PHP file, usually with procedural commands
         // to set up required test state. The file can be generated
         // through {@link TestSessionStubCodeWriter}, and the session state
@@ -76,12 +82,7 @@ class TestSessionHTTPMiddleware implements HTTPMiddleware
         // 'testsession.stubfile' state parameter.
         if (isset($testState->stubfile)) {
             $file = $testState->stubfile;
-            if (!Director::isLive() && $file && file_exists($file)) {
+            if (!Director::isLive() && $file && file_exists($file ?? '')) {
-                // Connect to the database so the included code can interact with it
-                $databaseConfig = DB::getConfig();
-                if ($databaseConfig) {
-                    DB::connect($databaseConfig);
-                }
                 include_once($file);
             }
         }

src/TestSessionState.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace SilverStripe\TestSession;
+
+use SilverStripe\ORM\DataObject;
+use SilverStripe\ORM\Queries\SQLUpdate;
+
+/**
+ * The session state keeps some metadata about the current test session.
+ * This may allow the client (Behat) to get some insight into the
+ * server side affairs (e.g. if the server is handling some number requests at the moment).
+ *
+ * The client side (Behat) must not use this class straightforwardly, but rather
+ * rely on the API of {@see TestSessionEnvironment} or {@see TestSessionController}.
+ *
+ * @property int PendingRequests keeps information about how many requests are in progress
+ * @property float LastResponseTimestamp microtime of the last response made by the server
+ */
+class TestSessionState extends DataObject
+{
+    private static $table_name = 'TestSessionState';
+
+    private static $db = [
+        'PendingRequests' => 'Int',
+        'LastResponseTimestamp' => 'Decimal(14, 0)'
+    ];
+
+    /**
+     * Increments TestSessionState.PendingRequests number by 1
+     * to indicate we have one more request in progress
+     */
+    public static function incrementState()
+    {
+        $schema = DataObject::getSchema();
+
+        $update = SQLUpdate::create(sprintf('"%s"', $schema->tableName(self::class)))
+            ->addWhere(['ID' => 1])
+            ->assignSQL('"PendingRequests"', '"PendingRequests" + 1');
+
+        $update->execute();
+    }
+
+    /**
+     * Decrements TestSessionState.PendingRequests number by 1
+     * to indicate we have one more request in progress.
+     * Also updates TestSessionState.LastResponseTimestamp
+     * to the current timestamp.
+     */
+    public static function decrementState()
+    {
+        $schema = DataObject::getSchema();
+
+        $update = SQLUpdate::create(sprintf('"%s"', $schema->tableName(self::class)))
+                ->addWhere(['ID' => 1])
+                ->assignSQL('"PendingRequests"', '"PendingRequests" - 1')
+                ->assign('"LastResponseTimestamp"', self::millitime());
+
+        $update->execute();
+    }
+
+    /**
+     * Returns unix timestamp in milliseconds
+     *
+     * @return float milliseconds since 1970
+     */
+    public static function millitime()
+    {
+        return round(microtime(true) * 1000);
+    }
+}

src/TestSessionStubCodeWriter.php

@@ -39,8 +39,8 @@ class TestSessionStubCodeWriter
         $header = '';
 
         // Create file incl. header if it doesn't exist
-        if (!file_exists($this->getFilePath())) {
+        if (!file_exists($this->getFilePath() ?? '')) {
-            touch($this->getFilePath());
+            touch($this->getFilePath() ?? '');
             if ($this->debug) {
                 $header .= "<?php\n// Generated by " . $trace[1]['class'] . " on " . date('Y-m-d H:i:s') . "\n\n";
             } else {
@@ -52,13 +52,13 @@ class TestSessionStubCodeWriter
         if ($this->debug) {
             $header .= "// Added by " . $trace[1]['class'] . '::' . $trace[1]['function'] . "\n";
         }
-        file_put_contents($path, $header . $php . "\n", FILE_APPEND);
+        file_put_contents($path ?? '', $header . $php . "\n", FILE_APPEND);
     }
 
     public function reset()
     {
-        if (file_exists($this->getFilePath())) {
+        if (file_exists($this->getFilePath() ?? '')) {
-            unlink($this->getFilePath());
+            unlink($this->getFilePath() ?? '');
         }
     }
 

templates/TestSession_end.ss

@@ -4,8 +4,8 @@
 		<meta charset="utf-8">
 		<% base_tag %>
 		$MetaTags
-		<% require css('framework/client/dist/styles/debug.css') %>
+		<% require css('silverstripe/framework:client/styles/debug.css') %>
-		<% require css('testsession/client/styles/styles.css') %>
+		<% require css('silverstripe/testsession:client/styles/styles.css') %>
 	</head>
 	<body>
 		<div class="info">

templates/TestSession_inprogress.ss

@@ -4,8 +4,8 @@
 		<meta charset="utf-8">
 		<% base_tag %>
 		$MetaTags
-        <% require css('framework/client/dist/styles/debug.css') %>
+        <% require css('silverstripe/framework:client/styles/debug.css') %>
-		<% require css('testsession/client/styles/styles.css') %>
+		<% require css('silverstripe/testsession:client/styles/styles.css') %>
 	</head>
 	<body>
 		<div class="info">

templates/TestSession_start.ss

@@ -4,8 +4,8 @@
 		<meta charset="utf-8">
 		<% base_tag %>
 		$MetaTags
-        <% require css('framework/client/dist/styles/debug.css') %>
+        <% require css('silverstripe/framework:client/styles/debug.css') %>
-		<% require css('testsession/client/styles/styles.css') %>
+		<% require css('silverstripe/testsession:client/styles/styles.css') %>
 	</head>
 	<body>
 		<div class="info">