Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 4.11 KB

advanced-usage.md

File metadata and controls

63 lines (38 loc) · 4.11 KB
Raw

Advanced Usage

Altering ORCA's behavior

Various aspects of ORCA's behavior can be altered at runtime through the use of environment variables. These can be set or exported in a local terminal session or in various ways on GitHub Actions.

Command-line application

These affect ORCA in all contexts.

  • ORCA_COVERAGE_CLOVER: Change the path where ORCA saves the PHPUnit test coverage Clover XML file.

  • ORCA_COVERAGE_CLOVER_ENABLE: Set to TRUE to generate test coverage data in Clover format.

  • ORCA_COVERAGE_COBERTURA: Change the path where ORCA saves the PHPUnit test coverage Cobertura XML file.

  • ORCA_COVERAGE_COBERTURA_ENABLE: Set to TRUE to generate test coverage data in Cobertura format instead of the default Clover format.

  • ORCA_COVERAGE_ENABLE: Deprecated. Alias of ORCA_COVERAGE_CLOVER_ENABLE.

  • ORCA_FIXTURE_DIR: Change the directory ORCA uses for test fixtures. Acceptable values are any valid, local directory reference, e.g., /var/www/example, or ../example.

  • ORCA_PACKAGES_CONFIG: Completely replace the list of packages ORCA installs in fixtures and runs tests on. Acceptable values are any valid path to a YAML file relative to ORCA itself, e.g., ../example/tests/packages.yml. See config/packages.yml for an example and explanation of the schema.

  • ORCA_PACKAGES_CONFIG_ALTER: Alter the main list of packages ORCA installs in fixtures and runs tests on (add, remove, or change packages and their properties). Acceptable values are any valid path to a YAML file relative to ORCA itself, e.g., ../example/tests/packages_alter.yml. See orca.yml and example/tests/packages_alter.yml for an example and explanation of the schema. Note: This option should be used conservatively as it erodes the uniformity at the heart of ORCA's representative nature.

  • ORCA_PHPCS_STANDARD: Change the PHP Code Sniffer standard used by the qa:static-analysis and qa:fixer commands. Acceptable values are AcquiaPHP, AcquiaDrupalStrict, and AcquiaDrupalTransitional. See Acquia Coding Standards for PHP for details.

  • ORCA_SUT_DIR: Change the path where ORCA looks for the SUT. Accepted values are any valid directory path, e.g., /var/www/example, or ../example.

  • ORCA_TELEMETRY_ENABLE: Set to TRUE to enable telemetry.

CI scripts

These affect ORCA only as invoked via the CI scripts.

  • ORCA_FIXTURE_PROFILE: Change the Drupal installation profile ORCA installs in fixtures. Note: Changing this value will cause non-SUT automated tests to be skipped in all jobs to avoid failures from changing such a fundamental assumption.

  • ORCA_FIXTURE_PROJECT_TEMPLATE: Change the Composer project template used to create the fixture.

Adding and customizing jobs

For special testing needs, custom jobs can be added and existing ones modified through the addition of scripts to your .orca.yml, e.g.:

before_script:
  - ../orca/bin/ci/before_script.sh
  # Your custom script:
  - ./bin/ci/before_script.sh

See the example script for more details.

README | Understanding ORCA | Getting Started | CLI Commands | Advanced Usage | Project Glossary | FAQ | Contribution Guide