1
0
mirror of https://github.com/e107inc/e107.git synced 2025-01-17 20:58:30 +01:00
php-e107/e107_tests/config.sample.yml

84 lines
2.4 KiB
YAML
Raw Normal View History

---
# Path (absolute or relative) to the app intended to be tested
# Absolute path begins with "/"; relative path does not begin with "/"
app_path: '../'
# Which deployer to use to set up tests. Options:
Major improvements to Deployer system (backwards-incompatible) Deployers, a concept unique to this repository, are now more separated from Codeception modules. This commit adds NoopDeployer, LocalDeployer, and SFTPDeployer to address the three deployment target types in use by testers today. The changes are backwards-incompatible because the structure of config.sample.yml has changed, and all testers need to change their config.yml or config.local.yml to continue testing. The reason for this change is that the section "manual" no longer makes sense now that Deployers are on a spectrum of automation levels. The subsections under "manual" have been broken out into the root level. The "db_dump" section has been merged into the new "db" root section. There is a new "fs" root section used by the SFTP Deployer. Other changes, enhancements, and bugfixes: * cPanelDeployer no longer downgrades to "manual" mode when credentials are missing or an unsupported component is requested. It now throws an exception. * Deployer::unlinkAppFile() was implemented for acceptance tests out of necessity because the app requires a configuration file to be deleted before re-running the app's installer. * If a Deployer subclass does not implement the unlinkAppFile() method, tests that depend on the method will be skipped gracefully. * DeployerFactory now has a better autoload mechanism. * A logical error in lib/config.php prevented missing nested array items from using their default values. * The Base Helper no longer pointlessly caches the DelayedDb module * _bootstrap.php serializes the config.yml params into a global constant so that the DeployerFactory can freely access the information.
2018-08-15 23:04:59 -05:00
#
# 'none'
# Dummy deployer that does nothing. Tests that depend on a deployer will fail.
# 'local'
# Use this if the acceptance test web server directly serves files from "app_path".
# Configure the "url" and "db" sections.
# 'sftp'
# Deploys the files in "app_path" to an SFTP account.
# Configure the "url", "db", and "fs" sections.
# 'cpanel'
# Deploys the files in "app_path" to a cPanel account's main domain.
# Configure the "hosting" section.
Major improvements to Deployer system (backwards-incompatible) Deployers, a concept unique to this repository, are now more separated from Codeception modules. This commit adds NoopDeployer, LocalDeployer, and SFTPDeployer to address the three deployment target types in use by testers today. The changes are backwards-incompatible because the structure of config.sample.yml has changed, and all testers need to change their config.yml or config.local.yml to continue testing. The reason for this change is that the section "manual" no longer makes sense now that Deployers are on a spectrum of automation levels. The subsections under "manual" have been broken out into the root level. The "db_dump" section has been merged into the new "db" root section. There is a new "fs" root section used by the SFTP Deployer. Other changes, enhancements, and bugfixes: * cPanelDeployer no longer downgrades to "manual" mode when credentials are missing or an unsupported component is requested. It now throws an exception. * Deployer::unlinkAppFile() was implemented for acceptance tests out of necessity because the app requires a configuration file to be deleted before re-running the app's installer. * If a Deployer subclass does not implement the unlinkAppFile() method, tests that depend on the method will be skipped gracefully. * DeployerFactory now has a better autoload mechanism. * A logical error in lib/config.php prevented missing nested array items from using their default values. * The Base Helper no longer pointlessly caches the DelayedDb module * _bootstrap.php serializes the config.yml params into a global constant so that the DeployerFactory can freely access the information.
2018-08-15 23:04:59 -05:00
deployer: 'local'
# Configure this section for fully automated test deployments to a hosting control panel
hosting:
# Control panel domain without the port number
hostname: ''
# Control panel account username
username: ''
# Control panel account password
password: ''
Major improvements to Deployer system (backwards-incompatible) Deployers, a concept unique to this repository, are now more separated from Codeception modules. This commit adds NoopDeployer, LocalDeployer, and SFTPDeployer to address the three deployment target types in use by testers today. The changes are backwards-incompatible because the structure of config.sample.yml has changed, and all testers need to change their config.yml or config.local.yml to continue testing. The reason for this change is that the section "manual" no longer makes sense now that Deployers are on a spectrum of automation levels. The subsections under "manual" have been broken out into the root level. The "db_dump" section has been merged into the new "db" root section. There is a new "fs" root section used by the SFTP Deployer. Other changes, enhancements, and bugfixes: * cPanelDeployer no longer downgrades to "manual" mode when credentials are missing or an unsupported component is requested. It now throws an exception. * Deployer::unlinkAppFile() was implemented for acceptance tests out of necessity because the app requires a configuration file to be deleted before re-running the app's installer. * If a Deployer subclass does not implement the unlinkAppFile() method, tests that depend on the method will be skipped gracefully. * DeployerFactory now has a better autoload mechanism. * A logical error in lib/config.php prevented missing nested array items from using their default values. * The Base Helper no longer pointlessly caches the DelayedDb module * _bootstrap.php serializes the config.yml params into a global constant so that the DeployerFactory can freely access the information.
2018-08-15 23:04:59 -05:00
# URL (with trailing slash) at which the app can be reached for acceptance tests
url: 'http://set-this-to-your-acceptance-test-url.local/'
# Only MySQL/MariaDB is supported
db:
Major improvements to Deployer system (backwards-incompatible) Deployers, a concept unique to this repository, are now more separated from Codeception modules. This commit adds NoopDeployer, LocalDeployer, and SFTPDeployer to address the three deployment target types in use by testers today. The changes are backwards-incompatible because the structure of config.sample.yml has changed, and all testers need to change their config.yml or config.local.yml to continue testing. The reason for this change is that the section "manual" no longer makes sense now that Deployers are on a spectrum of automation levels. The subsections under "manual" have been broken out into the root level. The "db_dump" section has been merged into the new "db" root section. There is a new "fs" root section used by the SFTP Deployer. Other changes, enhancements, and bugfixes: * cPanelDeployer no longer downgrades to "manual" mode when credentials are missing or an unsupported component is requested. It now throws an exception. * Deployer::unlinkAppFile() was implemented for acceptance tests out of necessity because the app requires a configuration file to be deleted before re-running the app's installer. * If a Deployer subclass does not implement the unlinkAppFile() method, tests that depend on the method will be skipped gracefully. * DeployerFactory now has a better autoload mechanism. * A logical error in lib/config.php prevented missing nested array items from using their default values. * The Base Helper no longer pointlessly caches the DelayedDb module * _bootstrap.php serializes the config.yml params into a global constant so that the DeployerFactory can freely access the information.
2018-08-15 23:04:59 -05:00
# Hostname or IP address; use 'localhost' for a local server
host: 'set-this-to-your-test-database-hostname.local'
Major improvements to Deployer system (backwards-incompatible) Deployers, a concept unique to this repository, are now more separated from Codeception modules. This commit adds NoopDeployer, LocalDeployer, and SFTPDeployer to address the three deployment target types in use by testers today. The changes are backwards-incompatible because the structure of config.sample.yml has changed, and all testers need to change their config.yml or config.local.yml to continue testing. The reason for this change is that the section "manual" no longer makes sense now that Deployers are on a spectrum of automation levels. The subsections under "manual" have been broken out into the root level. The "db_dump" section has been merged into the new "db" root section. There is a new "fs" root section used by the SFTP Deployer. Other changes, enhancements, and bugfixes: * cPanelDeployer no longer downgrades to "manual" mode when credentials are missing or an unsupported component is requested. It now throws an exception. * Deployer::unlinkAppFile() was implemented for acceptance tests out of necessity because the app requires a configuration file to be deleted before re-running the app's installer. * If a Deployer subclass does not implement the unlinkAppFile() method, tests that depend on the method will be skipped gracefully. * DeployerFactory now has a better autoload mechanism. * A logical error in lib/config.php prevented missing nested array items from using their default values. * The Base Helper no longer pointlessly caches the DelayedDb module * _bootstrap.php serializes the config.yml params into a global constant so that the DeployerFactory can freely access the information.
2018-08-15 23:04:59 -05:00
# Port number of the server
port: '3306'
Major improvements to Deployer system (backwards-incompatible) Deployers, a concept unique to this repository, are now more separated from Codeception modules. This commit adds NoopDeployer, LocalDeployer, and SFTPDeployer to address the three deployment target types in use by testers today. The changes are backwards-incompatible because the structure of config.sample.yml has changed, and all testers need to change their config.yml or config.local.yml to continue testing. The reason for this change is that the section "manual" no longer makes sense now that Deployers are on a spectrum of automation levels. The subsections under "manual" have been broken out into the root level. The "db_dump" section has been merged into the new "db" root section. There is a new "fs" root section used by the SFTP Deployer. Other changes, enhancements, and bugfixes: * cPanelDeployer no longer downgrades to "manual" mode when credentials are missing or an unsupported component is requested. It now throws an exception. * Deployer::unlinkAppFile() was implemented for acceptance tests out of necessity because the app requires a configuration file to be deleted before re-running the app's installer. * If a Deployer subclass does not implement the unlinkAppFile() method, tests that depend on the method will be skipped gracefully. * DeployerFactory now has a better autoload mechanism. * A logical error in lib/config.php prevented missing nested array items from using their default values. * The Base Helper no longer pointlessly caches the DelayedDb module * _bootstrap.php serializes the config.yml params into a global constant so that the DeployerFactory can freely access the information.
2018-08-15 23:04:59 -05:00
# Database name; must exist already
dbname: 'e107'
Major improvements to Deployer system (backwards-incompatible) Deployers, a concept unique to this repository, are now more separated from Codeception modules. This commit adds NoopDeployer, LocalDeployer, and SFTPDeployer to address the three deployment target types in use by testers today. The changes are backwards-incompatible because the structure of config.sample.yml has changed, and all testers need to change their config.yml or config.local.yml to continue testing. The reason for this change is that the section "manual" no longer makes sense now that Deployers are on a spectrum of automation levels. The subsections under "manual" have been broken out into the root level. The "db_dump" section has been merged into the new "db" root section. There is a new "fs" root section used by the SFTP Deployer. Other changes, enhancements, and bugfixes: * cPanelDeployer no longer downgrades to "manual" mode when credentials are missing or an unsupported component is requested. It now throws an exception. * Deployer::unlinkAppFile() was implemented for acceptance tests out of necessity because the app requires a configuration file to be deleted before re-running the app's installer. * If a Deployer subclass does not implement the unlinkAppFile() method, tests that depend on the method will be skipped gracefully. * DeployerFactory now has a better autoload mechanism. * A logical error in lib/config.php prevented missing nested array items from using their default values. * The Base Helper no longer pointlessly caches the DelayedDb module * _bootstrap.php serializes the config.yml params into a global constant so that the DeployerFactory can freely access the information.
2018-08-15 23:04:59 -05:00
# Username; must exist already
user: 'root'
Major improvements to Deployer system (backwards-incompatible) Deployers, a concept unique to this repository, are now more separated from Codeception modules. This commit adds NoopDeployer, LocalDeployer, and SFTPDeployer to address the three deployment target types in use by testers today. The changes are backwards-incompatible because the structure of config.sample.yml has changed, and all testers need to change their config.yml or config.local.yml to continue testing. The reason for this change is that the section "manual" no longer makes sense now that Deployers are on a spectrum of automation levels. The subsections under "manual" have been broken out into the root level. The "db_dump" section has been merged into the new "db" root section. There is a new "fs" root section used by the SFTP Deployer. Other changes, enhancements, and bugfixes: * cPanelDeployer no longer downgrades to "manual" mode when credentials are missing or an unsupported component is requested. It now throws an exception. * Deployer::unlinkAppFile() was implemented for acceptance tests out of necessity because the app requires a configuration file to be deleted before re-running the app's installer. * If a Deployer subclass does not implement the unlinkAppFile() method, tests that depend on the method will be skipped gracefully. * DeployerFactory now has a better autoload mechanism. * A logical error in lib/config.php prevented missing nested array items from using their default values. * The Base Helper no longer pointlessly caches the DelayedDb module * _bootstrap.php serializes the config.yml params into a global constant so that the DeployerFactory can freely access the information.
2018-08-15 23:04:59 -05:00
# Password; set to blank string for no password
password: ''
# If set to true, the database populator will populate the database with the dump specified in the "dump_path" key
# If set to false, the test database needs to be set up separately
# Affects all tests and modes of deployment
populate: true
# Path (absolute or relative) to the database dump of a testable installation of the app
# Absolute path begins with "/"; relative path does not begin with "/"
dump_path: 'tests/_data/e107_v2.3.0.sample.sql'
Major improvements to Deployer system (backwards-incompatible) Deployers, a concept unique to this repository, are now more separated from Codeception modules. This commit adds NoopDeployer, LocalDeployer, and SFTPDeployer to address the three deployment target types in use by testers today. The changes are backwards-incompatible because the structure of config.sample.yml has changed, and all testers need to change their config.yml or config.local.yml to continue testing. The reason for this change is that the section "manual" no longer makes sense now that Deployers are on a spectrum of automation levels. The subsections under "manual" have been broken out into the root level. The "db_dump" section has been merged into the new "db" root section. There is a new "fs" root section used by the SFTP Deployer. Other changes, enhancements, and bugfixes: * cPanelDeployer no longer downgrades to "manual" mode when credentials are missing or an unsupported component is requested. It now throws an exception. * Deployer::unlinkAppFile() was implemented for acceptance tests out of necessity because the app requires a configuration file to be deleted before re-running the app's installer. * If a Deployer subclass does not implement the unlinkAppFile() method, tests that depend on the method will be skipped gracefully. * DeployerFactory now has a better autoload mechanism. * A logical error in lib/config.php prevented missing nested array items from using their default values. * The Base Helper no longer pointlessly caches the DelayedDb module * _bootstrap.php serializes the config.yml params into a global constant so that the DeployerFactory can freely access the information.
2018-08-15 23:04:59 -05:00
# Configure this section for deployers that need file upload configuration
fs:
# Hostname or IP address to the remote destination
host: ''
# Port number of the file transfer server
port: '22'
# Username used for the file transfer
user: ''
# Path to the private key of the user. Takes precedence over "fs.password"
privkey_path: ''
# Password of the file transfer user. Ignored if "fs.privkey_path" is specified
password: ''
Major improvements to Deployer system (backwards-incompatible) Deployers, a concept unique to this repository, are now more separated from Codeception modules. This commit adds NoopDeployer, LocalDeployer, and SFTPDeployer to address the three deployment target types in use by testers today. The changes are backwards-incompatible because the structure of config.sample.yml has changed, and all testers need to change their config.yml or config.local.yml to continue testing. The reason for this change is that the section "manual" no longer makes sense now that Deployers are on a spectrum of automation levels. The subsections under "manual" have been broken out into the root level. The "db_dump" section has been merged into the new "db" root section. There is a new "fs" root section used by the SFTP Deployer. Other changes, enhancements, and bugfixes: * cPanelDeployer no longer downgrades to "manual" mode when credentials are missing or an unsupported component is requested. It now throws an exception. * Deployer::unlinkAppFile() was implemented for acceptance tests out of necessity because the app requires a configuration file to be deleted before re-running the app's installer. * If a Deployer subclass does not implement the unlinkAppFile() method, tests that depend on the method will be skipped gracefully. * DeployerFactory now has a better autoload mechanism. * A logical error in lib/config.php prevented missing nested array items from using their default values. * The Base Helper no longer pointlessly caches the DelayedDb module * _bootstrap.php serializes the config.yml params into a global constant so that the DeployerFactory can freely access the information.
2018-08-15 23:04:59 -05:00
# Absolute path to where the remote web server serves "url"
path: ''