Skip to content

advanced-usage.md

Latest commit

 

History

History
47 lines (31 loc) · 2.83 KB

advanced-usage.md

File metadata and controls

47 lines (31 loc) · 2.83 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 Travis CI.

Command-line application

These affect ORCA in all contexts.

  • 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 .travis.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.

Travis CI scripts

These affect ORCA only as invoked via the Travis CI scripts.

  • ORCA_CUSTOM_FIXTURE_INIT_ARGS: Add command-line arguments to fixture:init invocation in the install build phase of a custom job. Example:

    matrix:
  include:
    - { name: "Custom job", env: ORCA_JOB=CUSTOM ORCA_CUSTOM_FIXTURE_INIT_ARGS="--profile=lightning" }

  • ORCA_CUSTOM_TESTS_RUN_ARGS: Add command-line arguments to the qa:automated-tests invocation in the script build phase of a custom job. Example:

    matrix:
  include:
    - { name: "Custom job", env: ORCA_JOB=CUSTOM ORCA_CUSTOM_TESTS_RUN_ARGS="--sut-only" }

  • 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.

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