uiii / tense
Easy testing against multiple versions of ProcessWire CMF
Installs: 175
Dependents: 1
Suggesters: 0
Security: 0
Stars: 8
Watchers: 4
Forks: 1
Open Issues: 2
Type:project
Requires
- php: >=5.6
- justinrainbow/json-schema: ^5.2
- symfony/console: ^3.2
- symfony/yaml: ^3.2
Requires (Dev)
- nette/tester: ^1.7
- phpunit/phpunit: ^5.7
This package is auto-updated.
Last update: 2024-10-29 05:10:32 UTC
README
Tense (Test ENvironment Setup & Execution) is a command-line tool to easily run tests agains multiple versions of ProcessWire CMF.
Are you building a module, or a template and you need to make sure it works in all supported ProcessWire versions?
Then Tense
is exactly what you need. Write the tests in any testing framework, tell Tense
which ProcessWire versions you are interested in and it will do the rest for you.
See example or see usage in a real project.
Table of Contents
Requirements
- PHP 5.6 or higher
- Composer (https://getcomposer.org)
- Git (https://git-scm.com)
- MySQL or MariaDB 5.0.15 or higher
php.ini
php.ini
used by php
cli command must have enabled these extensions:
- curl
- gd2
- mbstring
- mysqli
- openssl
- pdo_mysql
Installation
Don't forget to setup all requirements first.
Install globally:
composer global require uiii/tense
or install as a project dependency:
cd <your-project>
composer require --dev uiii/tense
Usage
Go to your project's root directory.
-
create config file
tense.yml
:tense init
-
run tests:
tense run
if you've installed
Tense
locally as project's dependecy, usevendor/bin/tense
instead oftense
Configuration
Tense uses YAML configuration files. There are two types of config files:
- project (
tense.yml
): It should contain options directly related to the project's testing. This config is intended to be shared (VCS, ...). - local (
tense.local.yml
): It should contain options related to the machine's environment setup (database connection, ...), overwrites options from project's config. This is not intended to be shared.
The project's config can be created either manually or interactively by running the command:
tense init
The local config is automatically initialized on each tense run
when missing.
tmpDir
optional, config: project, local
Path to a directory where files needed for testing (e.g ProcessWire installation, ...) are stored.
Path is relative to the config file's parent directory.
Default is .tense
db
required, config: local
Database connection parameters.
They are used to create the database for ProcessWire installation, so the user must have the privileges to create a database.
db.name
is a name of the database.
Example:
db: host: localhost port: 3306 user: root pass: "" name: tense
testTags
required, config: project
List of ProcessWire tags/versions used for testing.
It doesn't have to be exact version number.
For each tag/version will be found latest matching
existing tag (e.g. 3.0
-> 3.0.42
).
Versions are tested in the specified order.
Minimal supported version is
2.5
.
Version
2.8
is not currently supported.
Example:
testTags: - "2.5" - "2.6" - "2.7.1" - "3.0"
copySources
optional, config: project
Copy source files into ProcessWire's' installation before testing.
It is a list of objects with destination
and source
properties.
Destination paths are relative to ProcessWire's installation root.
Source paths are relative to the config file's parent directory.
Sources can either be a single string or an array of strings. If the source is a string, file to file copy is used. If the source is an array of strings, the destination is considered to be a directory where all sources are copied into.
If source item is a directory, it will be copied recursively.
Example:
copySources: - destination: "site/templates/HomeTemplate.php" source: "src/templates/home.php" - destination: "site/modules/Module" source: - "Libs" - "Module.module"
Consider tense.yml
is in project's root and <project-root>/Libs
is a directory. In this example these files will be copied:
<project-root>/templates/home.php
to<pw-path>/site/templates/HomeTemplate.php
<project-root>/Libs/*
to<pw-path>/site/modules/Module/Libs
<project-root>/Module.module
to<pw-path>/site/modules/Module/Module.module
beforeCmd
optional, config: project, local
Command to execute before a test suite, but after a PW instance is installed and sources are copied.
This is just a single command, if you need to run multiple commands, put them into an external script.
Remember, the command should be platform independent, so using
.sh
or.bat
files are not recommended. Best option is to use PHP as you can see in the example, but you can use any other platform independent scripting language.
Path to the ProcessWire installation will be in
PW_PATH
environment variable.
Example:
beforeCmd: "composer install"
testCmd
required, config: project
Command to execute a test suite.
Path to the ProcessWire installation will be in
PW_PATH
environment variable.
Example:
testCmd: "vendor/bin/phpunit --bootstrap vendor/autoload.php tests/Test.php"
pause
optional, config: local
After each test suite against a ProcessWire instance but before a clean up test runner can pause and ask the user what to do.
This is useful e.g. to examine the installed ProcessWire instance.
Possible values are:
never
- never pause (default)onFailure
- pause after failed test suitealways
- always pause after a test suite
Troubleshooting
cURL error: SSL certificate problem: unable to get local issuer certificate
If you got this error, you haven't properly configured PHP's curl
extension. You can solve this e.g. by
- download the https://curl.haxx.se/ca/cacert.pem file
- place it somewhere, e.g. in PHP's installation directory
- edit
php.ini
file and setcurl.cainfo = <aboslute-path-to-cacert-file>