Download the PHP package tr33m4n/codeception-module-percy without Composer
On this page you can find all versions of the php package tr33m4n/codeception-module-percy. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tr33m4n/codeception-module-percy
More information about tr33m4n/codeception-module-percy
Files in tr33m4n/codeception-module-percy
Package codeception-module-percy
Short Description Percy https://percy.io module for Codeception
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package codeception-module-percy
codeception-module-percy
Percy https://percy.io module for Codeception
Requirements
- Node.js
>=14.0.0 - PHP
>= 7.4 - Composer
v2
Installation
Example Configuration
The following example acceptance.suite.yml configuration assumes the WebDriver module has been configured correctly for your test suite and
shows enabling the Percy module and setting some basic configuration:
The following example shows how to configure the percy:process-snapshots in the codeception.yml file:
Configuration Options
| Parameter | Type | Default | Description |
|---|---|---|---|
snapshotConfig |
object | {} |
Additional configuration to pass to the "snapshot" functionality |
snapshotConfig.percyCSS |
string | null |
Percy specific CSS to apply to the "snapshot" |
snapshotConfig.minHeight |
int | null |
Minimum height of the resulting "snapshot" in pixels |
snapshotConfig.enableJavaScript |
bool | false |
Enable JavaScript in the Percy rendering environment |
snapshotConfig.widths |
array | null |
An array of integers representing the browser widths at which you want to take snapshots |
serializeConfig |
object | {"enableJavaScript": true} |
Additional configuration to pass to the PercyDOM.serialize method injected into the web driver DOM |
collectOnly |
bool | false |
Setting this to true will only collect snapshots, rather than collect and then send at the end of the run. They can then be sent manually by calling the vendor/bin/codecept percy:process-snapshots command |
snapshotServerTimeout |
int | 30 |
[debug] The length of the time the Percy snapshot server will listen for incoming snapshots and send on to Percy.io (the amount of time needed to send all snapshots after a successful test suite run). No timeout is set by default |
snapshotServerPort |
int | 5338 |
[debug] The port the Percy snapshot server will listen on |
snapshotServerDebug |
bool | false |
[debug] Output verbosely when running the underlying Node Percy library |
snapshotFolder |
string | null |
[debug] Specify a snapshot folder to use when loading or sending snapshots. Folder respects basic glob patterns. Useful if moving snapshots around on the server before sending them with the CLI command |
throwOnError |
bool | false |
[debug] Throw exception on adapter error |
instanceId |
string | null |
[debug] An ID is used to differentiate between one Codeception runs output files to another, ensuring only the current runs output files are cleared on failure. Use this config to pass a custom instance ID |
Running
The Percy integration runs automatically with the test suite but will need your PERCY_TOKEN to be set to successfully send snapshots. For more information, see https://docs.percy.io/docs/environment-variables#section-required
Overriding the node path
By default, the node executable used will be the one defined within the PATH of the user running the test suite. This can be overridden however, by setting the environment variable PERCY_NODE_PATH to your preferred location.
Collect only
In some advanced CI setups, it might make sense to collect all snapshots for multiple runs with different parameters and then send them a single time when all runs are complete. This can be achieved by setting the collectOnly config to true. Once all runs are complete, running the command vendor/bin/codecept percy:process-snapshots
will then iterate all collected snapshots, send to Percy and then clean up the snapshot folder. The percy:process-snapshots command needs to be configured in the codeception.yml file, see the "Example Configuration" section
Example Test
$I->takeAPercySnapshot can optionally be passed an array of additional arguments to override the global settings for percyCSS, minHeight, enableJavaScript and widths on the fly, for example:
All versions of codeception-module-percy with dependencies
ext-curl Version *
ext-json Version *
composer-plugin-api Version ^2
composer-runtime-api Version ^2
codeception/codeception Version ^4.1.22||^5.0
codeception/module-webdriver Version ^2.0||^3.0||^4.0
eloquent/composer-npm-bridge Version ^5.0
guzzlehttp/guzzle Version >=6.5.8
ramsey/uuid Version ^4.1
symfony/process Version ^5.2||^6.0||^7.0
tr33m4n/codeception-module-percy-environment Version ^1.0