Compare commits
31 Commits
Author | SHA1 | Date |
---|---|---|
Maxime Rainville | ee49a440fb | |
Steve Boyd | cb34aa869f | |
Steve Boyd | 5c8070044c | |
Maxime Rainville | 8e3f71afb7 | |
Steve Boyd | fe5e87598f | |
Sabina Talipova | ffe1bc8fa2 | |
Steve Boyd | 132c00f122 | |
Steve Boyd | 9b91b2de98 | |
Steve Boyd | ecac4295af | |
Guy Sartorelli | c4786cd955 | |
Steve Boyd | ffe829485e | |
Steve Boyd | fc63ebe8a9 | |
Steve Boyd | 8535a680ca | |
Guy Sartorelli | 8db444605a | |
Guy Sartorelli | cefce74559 | |
Steve Boyd | a1e8643ea7 | |
Guy Sartorelli | 0f5cb30743 | |
Steve Boyd | 7733cc7c95 | |
Steve Boyd | 22b9ca23cb | |
Steve Boyd | 5e2ef7e52c | |
Guy Sartorelli | 44e5364ec2 | |
Ingo Schommer | e44774dbf0 | |
Serge Latyntsev | 0c479ad2eb | |
Guy Marriott | efb6777ee9 | |
pjayme | 81c2417414 | |
Bernard Hamlin | 075d960e5d | |
Serge Latyntsev | 61d12ec08a | |
UndefinedOffset | e957d1e0fd | |
Serge Latyntsev | 8827e97417 | |
Serge Latyntcev | f54baefb5a | |
Serge Latyntcev | 32c8e6a3b1 |
|
@ -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
|
|
@ -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
|
|
@ -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
|
|
@ -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/*]
|
|
24
README.md
24
README.md
|
@ -1,6 +1,6 @@
|
||||||
# Browser Test Session Module
|
# 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
|
## 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.*
|
*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,
|
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.
|
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.
|
Further data can be loaded from YAML fixtures or database dumps.
|
||||||
|
|
||||||
|
@ -26,7 +26,7 @@ E.g. the silverstripe-behat-extension may use it through this module APIs,
|
||||||
allowing us to introduce some grey-box testing techniques.
|
allowing us to introduce some grey-box testing techniques.
|
||||||
|
|
||||||
The module also serves as an initializer for the
|
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
|
It is required for Behat because the Behat CLI test runner needs to persist
|
||||||
test configuration just for the tested browser connection,
|
test configuration just for the tested browser connection,
|
||||||
available on arbitary URL endpoints. For example,
|
available on arbitary URL endpoints. For example,
|
||||||
|
@ -35,7 +35,7 @@ into a temporary database table for inspection by the CLI-based process.
|
||||||
|
|
||||||
## Setup
|
## 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
|
composer require --dev silverstripe/behat-extension
|
||||||
|
|
||||||
|
@ -47,7 +47,7 @@ and interact with it through other URL endpoints.
|
||||||
Commands:
|
Commands:
|
||||||
|
|
||||||
* `dev/testsession`: Shows options for starting a test session
|
* `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.
|
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/end`: Removes the test state, and resets to the original database.
|
||||||
* `dev/testsession/loadfixture?fixture=<path>`: Loads a fixture into an existing test state.
|
* `dev/testsession/loadfixture?fixture=<path>`: Loads a fixture into an existing test state.
|
||||||
|
@ -59,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
|
it can be useful to set them programmatically through query parameters
|
||||||
on "dev/testsession/start":
|
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.
|
The path should be relative to the webroot.
|
||||||
* `createDatabase`: Create a temporary database.
|
* `createDatabase`: Create a temporary database.
|
||||||
* `importDatabasePath`: Absolute path to a database dump to load into a newly created 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`
|
* `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)
|
* `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()`.
|
that's usually handled by `SapphireTest::create_temp_db()`.
|
||||||
Note: The database names are limited to a specific naming convention as a security measure:
|
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.
|
The "ss_tmpdb" prefix and a random sequence of seven digits.
|
||||||
|
@ -76,9 +76,9 @@ on "dev/testsession/start":
|
||||||
* `datetime`: Sets a simulated date used for all framework operations.
|
* `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").
|
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,
|
* `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.
|
a global session somewhere else, that non-global session will take priority in that browser.
|
||||||
|
|
||||||
Example usage with parameters:
|
Example usage with parameters:
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
---
|
---
|
||||||
Name: testsessionroutes
|
Name: testsessionroutes
|
||||||
---
|
---
|
||||||
SilverStripe\Control\Director:
|
SilverStripe\Dev\DevelopmentAdmin:
|
||||||
rules:
|
registered_controllers:
|
||||||
dev/testsession: SilverStripe\TestSession\TestSessionController
|
testsession:
|
||||||
|
controller: SilverStripe\TestSession\TestSessionController
|
||||||
|
|
|
@ -19,10 +19,10 @@
|
||||||
"silverstripe/framework": "^4@dev",
|
"silverstripe/framework": "^4@dev",
|
||||||
"silverstripe/vendor-plugin": "^1.3"
|
"silverstripe/vendor-plugin": "^1.3"
|
||||||
},
|
},
|
||||||
|
"require-dev": {
|
||||||
|
"squizlabs/php_codesniffer": "^3.5"
|
||||||
|
},
|
||||||
"extra": {
|
"extra": {
|
||||||
"branch-alias": {
|
|
||||||
"2.x-dev": "2.2.x-dev"
|
|
||||||
},
|
|
||||||
"expose": [
|
"expose": [
|
||||||
"client"
|
"client"
|
||||||
]
|
]
|
||||||
|
|
|
@ -2,6 +2,8 @@
|
||||||
<ruleset name="SilverStripe">
|
<ruleset name="SilverStripe">
|
||||||
<description>CodeSniffer ruleset for SilverStripe coding conventions.</description>
|
<description>CodeSniffer ruleset for SilverStripe coding conventions.</description>
|
||||||
|
|
||||||
|
<file>src</file>
|
||||||
|
|
||||||
<!-- base rules are PSR-2 -->
|
<!-- base rules are PSR-2 -->
|
||||||
<rule ref="PSR2" >
|
<rule ref="PSR2" >
|
||||||
<!-- Current exclusions -->
|
<!-- Current exclusions -->
|
||||||
|
|
|
@ -104,7 +104,7 @@ class TestSessionController extends Controller
|
||||||
$id = null;
|
$id = null;
|
||||||
} else {
|
} else {
|
||||||
$generator = Injector::inst()->get(RandomGenerator::class);
|
$generator = Injector::inst()->get(RandomGenerator::class);
|
||||||
$id = substr($generator->randomToken(), 0, 10);
|
$id = substr($generator->randomToken() ?? '', 0, 10);
|
||||||
$this->getRequest()->getSession()->set('TestSessionId', $id);
|
$this->getRequest()->getSession()->set('TestSessionId', $id);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -113,7 +113,7 @@ class TestSessionController extends Controller
|
||||||
|
|
||||||
// Remove unnecessary items of form-specific data from being saved in the test session
|
// Remove unnecessary items of form-specific data from being saved in the test session
|
||||||
$params = array_diff_key(
|
$params = array_diff_key(
|
||||||
$params,
|
$params ?? [],
|
||||||
array(
|
array(
|
||||||
'action_set' => true,
|
'action_set' => true,
|
||||||
'action_start' => true,
|
'action_start' => true,
|
||||||
|
@ -170,7 +170,7 @@ class TestSessionController extends Controller
|
||||||
throw new LogicException("No test session in progress.");
|
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) {
|
if (!$newSessionStates) {
|
||||||
throw new LogicException('No query parameters detected');
|
throw new LogicException('No query parameters detected');
|
||||||
}
|
}
|
||||||
|
@ -288,7 +288,7 @@ class TestSessionController extends Controller
|
||||||
|
|
||||||
// Remove unnecessary items of form-specific data from being saved in the test session
|
// Remove unnecessary items of form-specific data from being saved in the test session
|
||||||
$params = array_diff_key(
|
$params = array_diff_key(
|
||||||
$params,
|
$params ?? [],
|
||||||
array(
|
array(
|
||||||
'action_set' => true,
|
'action_set' => true,
|
||||||
'action_start' => true,
|
'action_start' => true,
|
||||||
|
@ -399,7 +399,7 @@ class TestSessionController extends Controller
|
||||||
$path = BASE_PATH . '/' . $path;
|
$path = BASE_PATH . '/' . $path;
|
||||||
}
|
}
|
||||||
|
|
||||||
if ($path && file_exists($path)) {
|
if ($path && file_exists($path ?? '')) {
|
||||||
$it = new FilesystemIterator($path);
|
$it = new FilesystemIterator($path);
|
||||||
foreach ($it as $fileinfo) {
|
foreach ($it as $fileinfo) {
|
||||||
if ($fileinfo->getExtension() != 'sql') {
|
if ($fileinfo->getExtension() != 'sql') {
|
||||||
|
|
|
@ -80,7 +80,6 @@ class TestSessionEnvironment
|
||||||
|
|
||||||
public function __construct($id = null)
|
public function __construct($id = null)
|
||||||
{
|
{
|
||||||
$this->constructExtensions();
|
|
||||||
if ($id) {
|
if ($id) {
|
||||||
$this->id = $id;
|
$this->id = $id;
|
||||||
}
|
}
|
||||||
|
@ -102,7 +101,7 @@ class TestSessionEnvironment
|
||||||
public function getFilePath()
|
public function getFilePath()
|
||||||
{
|
{
|
||||||
if ($this->id) {
|
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 {
|
} else {
|
||||||
$path = Director::getAbsFile($this->config()->get('test_state_file'));
|
$path = Director::getAbsFile($this->config()->get('test_state_file'));
|
||||||
}
|
}
|
||||||
|
@ -115,7 +114,7 @@ class TestSessionEnvironment
|
||||||
*/
|
*/
|
||||||
public function isRunningTests()
|
public function isRunningTests()
|
||||||
{
|
{
|
||||||
return (file_exists($this->getFilePath()));
|
return (file_exists($this->getFilePath() ?? ''));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -161,7 +160,7 @@ class TestSessionEnvironment
|
||||||
|
|
||||||
// Convert to JSON and back so we can share the applyState() code between this and ->loadFromFile()
|
// Convert to JSON and back so we can share the applyState() code between this and ->loadFromFile()
|
||||||
$json = json_encode($state, JSON_FORCE_OBJECT);
|
$json = json_encode($state, JSON_FORCE_OBJECT);
|
||||||
$state = json_decode($json);
|
$state = json_decode($json ?? '');
|
||||||
|
|
||||||
$this->applyState($state);
|
$this->applyState($state);
|
||||||
|
|
||||||
|
@ -177,7 +176,7 @@ class TestSessionEnvironment
|
||||||
|
|
||||||
// Convert to JSON and back so we can share the appleState() code between this and ->loadFromFile()
|
// Convert to JSON and back so we can share the appleState() code between this and ->loadFromFile()
|
||||||
$json = json_encode($state, JSON_FORCE_OBJECT);
|
$json = json_encode($state, JSON_FORCE_OBJECT);
|
||||||
$state = json_decode($json);
|
$state = json_decode($json ?? '');
|
||||||
|
|
||||||
$this->applyState($state);
|
$this->applyState($state);
|
||||||
|
|
||||||
|
@ -192,7 +191,7 @@ class TestSessionEnvironment
|
||||||
{
|
{
|
||||||
// Ensure files backed up to assets dir
|
// Ensure files backed up to assets dir
|
||||||
$backupFolder = $this->getAssetsBackupfolder();
|
$backupFolder = $this->getAssetsBackupfolder();
|
||||||
if (!is_dir($backupFolder)) {
|
if (!is_dir($backupFolder ?? '')) {
|
||||||
Filesystem::makeFolder($backupFolder);
|
Filesystem::makeFolder($backupFolder);
|
||||||
}
|
}
|
||||||
$this->moveRecursive(ASSETS_PATH, $backupFolder, ['.htaccess', 'web.config', '.protected']);
|
$this->moveRecursive(ASSETS_PATH, $backupFolder, ['.htaccess', 'web.config', '.protected']);
|
||||||
|
@ -206,7 +205,7 @@ class TestSessionEnvironment
|
||||||
{
|
{
|
||||||
// Ensure files backed up to assets dir
|
// Ensure files backed up to assets dir
|
||||||
$backupFolder = $this->getAssetsBackupfolder();
|
$backupFolder = $this->getAssetsBackupfolder();
|
||||||
if (is_dir($backupFolder)) {
|
if (is_dir($backupFolder ?? '')) {
|
||||||
// Move all files
|
// Move all files
|
||||||
Filesystem::makeFolder(ASSETS_PATH);
|
Filesystem::makeFolder(ASSETS_PATH);
|
||||||
$this->moveRecursive($backupFolder, ASSETS_PATH);
|
$this->moveRecursive($backupFolder, ASSETS_PATH);
|
||||||
|
@ -224,12 +223,12 @@ class TestSessionEnvironment
|
||||||
protected function moveRecursive($src, $dest, $ignore = [])
|
protected function moveRecursive($src, $dest, $ignore = [])
|
||||||
{
|
{
|
||||||
// If source is not a directory stop processing
|
// If source is not a directory stop processing
|
||||||
if (!is_dir($src)) {
|
if (!is_dir($src ?? '')) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
// If the destination directory does not exist create it
|
// If the destination directory does not exist create it
|
||||||
if (!is_dir($dest) && !mkdir($dest)) {
|
if (!is_dir($dest ?? '') && !mkdir($dest ?? '')) {
|
||||||
// If the destination directory could not be created stop processing
|
// If the destination directory could not be created stop processing
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
@ -238,13 +237,13 @@ class TestSessionEnvironment
|
||||||
$iterator = new DirectoryIterator($src);
|
$iterator = new DirectoryIterator($src);
|
||||||
foreach ($iterator as $file) {
|
foreach ($iterator as $file) {
|
||||||
if ($file->isFile()) {
|
if ($file->isFile()) {
|
||||||
if (!in_array($file->getFilename(), $ignore)) {
|
if (!in_array($file->getFilename(), $ignore ?? [])) {
|
||||||
rename($file->getRealPath(), $dest . DIRECTORY_SEPARATOR . $file->getFilename());
|
rename($file->getRealPath() ?? '', $dest . DIRECTORY_SEPARATOR . $file->getFilename());
|
||||||
}
|
}
|
||||||
} elseif (!$file->isDot() && $file->isDir()) {
|
} elseif (!$file->isDot() && $file->isDir()) {
|
||||||
// If a dir is ignored, still move children but don't remove self
|
// If a dir is ignored, still move children but don't remove self
|
||||||
$this->moveRecursive($file->getRealPath(), $dest . DIRECTORY_SEPARATOR . $file);
|
$this->moveRecursive($file->getRealPath(), $dest . DIRECTORY_SEPARATOR . $file);
|
||||||
if (!in_array($file->getFilename(), $ignore)) {
|
if (!in_array($file->getFilename(), $ignore ?? [])) {
|
||||||
Filesystem::removeFolder($file->getRealPath());
|
Filesystem::removeFolder($file->getRealPath());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -284,26 +283,7 @@ class TestSessionEnvironment
|
||||||
}
|
}
|
||||||
|
|
||||||
// ensure we have a connection to the database
|
// 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
|
// Database
|
||||||
if (!$this->isRunningTests()) {
|
if (!$this->isRunningTests()) {
|
||||||
|
@ -324,8 +304,8 @@ class TestSessionEnvironment
|
||||||
|
|
||||||
// Set existing one, assumes it already has been created
|
// Set existing one, assumes it already has been created
|
||||||
$prefix = Environment::getEnv('SS_DATABASE_PREFIX') ?: 'ss_';
|
$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");
|
throw new InvalidArgumentException("Invalid database name format");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -343,7 +323,7 @@ class TestSessionEnvironment
|
||||||
$mailer = (isset($state->mailer)) ? $state->mailer : null;
|
$mailer = (isset($state->mailer)) ? $state->mailer : null;
|
||||||
|
|
||||||
if ($mailer) {
|
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(
|
throw new InvalidArgumentException(sprintf(
|
||||||
'Class "%s" is not a valid class, or subclass of Mailer',
|
'Class "%s" is not a valid class, or subclass of Mailer',
|
||||||
$mailer
|
$mailer
|
||||||
|
@ -377,13 +357,13 @@ class TestSessionEnvironment
|
||||||
*/
|
*/
|
||||||
public function importDatabase($path, $requireDefaultRecords = false)
|
public function importDatabase($path, $requireDefaultRecords = false)
|
||||||
{
|
{
|
||||||
$sql = file_get_contents($path);
|
$sql = file_get_contents($path ?? '');
|
||||||
|
|
||||||
// Split into individual query commands, removing comments
|
// Split into individual query commands, removing comments
|
||||||
$sqlCmds = array_filter(preg_split(
|
$sqlCmds = array_filter(preg_split(
|
||||||
'/;\n/',
|
'/;\n/',
|
||||||
preg_replace(array('/^$\n/m', '/^(\/|#).*$\n/m'), '', $sql)
|
preg_replace(array('/^$\n/m', '/^(\/|#).*$\n/m'), '', $sql ?? '') ?? ''
|
||||||
));
|
) ?? []);
|
||||||
|
|
||||||
// Execute each query
|
// Execute each query
|
||||||
foreach ($sqlCmds as $sqlCmd) {
|
foreach ($sqlCmds as $sqlCmd) {
|
||||||
|
@ -420,7 +400,7 @@ class TestSessionEnvironment
|
||||||
$content = json_encode($state);
|
$content = json_encode($state);
|
||||||
}
|
}
|
||||||
$old = umask(0);
|
$old = umask(0);
|
||||||
file_put_contents($this->getFilePath(), $content, LOCK_EX);
|
file_put_contents($this->getFilePath() ?? '', $content, LOCK_EX);
|
||||||
umask($old);
|
umask($old);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -428,8 +408,8 @@ class TestSessionEnvironment
|
||||||
{
|
{
|
||||||
if ($this->isRunningTests()) {
|
if ($this->isRunningTests()) {
|
||||||
try {
|
try {
|
||||||
$contents = file_get_contents($this->getFilePath());
|
$contents = file_get_contents($this->getFilePath() ?? '');
|
||||||
$json = json_decode($contents);
|
$json = json_decode($contents ?? '');
|
||||||
|
|
||||||
$this->applyState($json);
|
$this->applyState($json);
|
||||||
} catch (Exception $e) {
|
} catch (Exception $e) {
|
||||||
|
@ -447,8 +427,8 @@ class TestSessionEnvironment
|
||||||
{
|
{
|
||||||
$file = $this->getFilePath();
|
$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 '
|
throw new \Exception('Unable to remove the testsession state file, please remove it manually. File '
|
||||||
. 'path: ' . $file);
|
. 'path: ' . $file);
|
||||||
}
|
}
|
||||||
|
@ -503,14 +483,14 @@ class TestSessionEnvironment
|
||||||
public function loadFixtureIntoDb($fixtureFile)
|
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");
|
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");
|
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");
|
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.");
|
throw new LogicException("Fixture file must be inside the tests subfolder of one of your modules.");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -549,7 +529,10 @@ class TestSessionEnvironment
|
||||||
public function getState()
|
public function getState()
|
||||||
{
|
{
|
||||||
$path = Director::getAbsFile($this->getFilePath());
|
$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;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -562,6 +545,40 @@ class TestSessionEnvironment
|
||||||
return PUBLIC_PATH . DIRECTORY_SEPARATOR . 'assets_backup';
|
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
|
* Wait for pending requests
|
||||||
|
@ -573,24 +590,22 @@ class TestSessionEnvironment
|
||||||
*/
|
*/
|
||||||
public function waitForPendingRequests($await = 700, $timeout = 10000)
|
public function waitForPendingRequests($await = 700, $timeout = 10000)
|
||||||
{
|
{
|
||||||
$now = static function () {
|
$timeout = TestSessionState::millitime() + $timeout;
|
||||||
return microtime(true) * 10000;
|
|
||||||
};
|
|
||||||
|
|
||||||
$timeout = $now() + $timeout;
|
|
||||||
$interval = max(300, $await);
|
$interval = max(300, $await);
|
||||||
|
|
||||||
do {
|
do {
|
||||||
|
$now = TestSessionState::millitime();
|
||||||
|
|
||||||
|
if ($timeout < $now) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
$model = TestSessionState::get()->byID(1);
|
$model = TestSessionState::get()->byID(1);
|
||||||
|
|
||||||
$pendingRequests = $model->PendingRequests > 0;
|
$pendingRequests = $model->PendingRequests > 0;
|
||||||
$lastRequestAwait = ($model->LastResponseTimestamp + $await) > $now();
|
$lastRequestAwait = ($model->LastResponseTimestamp + $await) > $now;
|
||||||
|
|
||||||
$pending = $pendingRequests || $lastRequestAwait;
|
$pending = $pendingRequests || $lastRequestAwait;
|
||||||
|
|
||||||
if ($timeout < $now()) {
|
|
||||||
// timed out
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
} while ($pending && (usleep($interval * 1000) || true));
|
} while ($pending && (usleep($interval * 1000) || true));
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
|
|
|
@ -69,8 +69,12 @@ class TestSessionHTTPMiddleware implements HTTPMiddleware
|
||||||
$mailer = $testState->mailer;
|
$mailer = $testState->mailer;
|
||||||
Injector::inst()->registerService(new $mailer(), Mailer::class);
|
Injector::inst()->registerService(new $mailer(), Mailer::class);
|
||||||
Email::config()->set("send_all_emails_to", null);
|
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
|
// Allows inclusion of a PHP file, usually with procedural commands
|
||||||
// to set up required test state. The file can be generated
|
// to set up required test state. The file can be generated
|
||||||
// through {@link TestSessionStubCodeWriter}, and the session state
|
// through {@link TestSessionStubCodeWriter}, and the session state
|
||||||
|
@ -78,12 +82,7 @@ class TestSessionHTTPMiddleware implements HTTPMiddleware
|
||||||
// 'testsession.stubfile' state parameter.
|
// 'testsession.stubfile' state parameter.
|
||||||
if (isset($testState->stubfile)) {
|
if (isset($testState->stubfile)) {
|
||||||
$file = $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);
|
include_once($file);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -53,8 +53,18 @@ class TestSessionState extends DataObject
|
||||||
$update = SQLUpdate::create(sprintf('"%s"', $schema->tableName(self::class)))
|
$update = SQLUpdate::create(sprintf('"%s"', $schema->tableName(self::class)))
|
||||||
->addWhere(['ID' => 1])
|
->addWhere(['ID' => 1])
|
||||||
->assignSQL('"PendingRequests"', '"PendingRequests" - 1')
|
->assignSQL('"PendingRequests"', '"PendingRequests" - 1')
|
||||||
->assign('"LastResponseTimestamp"', microtime(true) * 10000);
|
->assign('"LastResponseTimestamp"', self::millitime());
|
||||||
|
|
||||||
$update->execute();
|
$update->execute();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns unix timestamp in milliseconds
|
||||||
|
*
|
||||||
|
* @return float milliseconds since 1970
|
||||||
|
*/
|
||||||
|
public static function millitime()
|
||||||
|
{
|
||||||
|
return round(microtime(true) * 1000);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -39,8 +39,8 @@ class TestSessionStubCodeWriter
|
||||||
$header = '';
|
$header = '';
|
||||||
|
|
||||||
// Create file incl. header if it doesn't exist
|
// 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) {
|
if ($this->debug) {
|
||||||
$header .= "<?php\n// Generated by " . $trace[1]['class'] . " on " . date('Y-m-d H:i:s') . "\n\n";
|
$header .= "<?php\n// Generated by " . $trace[1]['class'] . " on " . date('Y-m-d H:i:s') . "\n\n";
|
||||||
} else {
|
} else {
|
||||||
|
@ -52,13 +52,13 @@ class TestSessionStubCodeWriter
|
||||||
if ($this->debug) {
|
if ($this->debug) {
|
||||||
$header .= "// Added by " . $trace[1]['class'] . '::' . $trace[1]['function'] . "\n";
|
$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()
|
public function reset()
|
||||||
{
|
{
|
||||||
if (file_exists($this->getFilePath())) {
|
if (file_exists($this->getFilePath() ?? '')) {
|
||||||
unlink($this->getFilePath());
|
unlink($this->getFilePath() ?? '');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue