Environments and variables

Manage dynamic test configurations in Maestro Studio. Use Environment Variables and Tags to run tests across different platforms and environments.

Maestro Studio allows you to manage dynamic configurations through Environments. This is essential for running the same tests across different app variants, server environments, or localized settings without hardcoding values into your tests.

Organize your environments

To keep your tests maintainable, it is recommended to separate your environment configurations. Common use cases for different environments include:

• Platform Variants: Running tests against the same app on multiple platforms with different properties, such as a unique appId for Android vs. iOS.

• Host Environments: Testing against different backends (e.g., Staging vs. Production) using different credentials or API endpoints.

• Whitelabel Variants: Running tests against variants of a whitelabelled application that require different test data or theme settings.

Add environments

Environments in Maestro enable you to define two key types of configurations:

• Environment Variables: Key-value pairs used to inject dynamic data into your tests (e.g., BASE_URL, USER_EMAIL).

• Configure Tags: Specify the tags to be included and excluded when running the tests. This allows you to create specific labels used to filter which tests are executed during a run (e.g., smoke, regression).

When you start using Maestro Studio, you have the default environment, called None. But, to better organize your tests, it's recommended to have environments and environment variables separated.

To add a new environment, follow these steps:

1. Open the Maestro Studio.

2. In Maestro Studio, click the Env icon.

3. Click on Manage Environments, then click Create.

1. Specify the Included and Excluded tags for this environment.

2. Add your variables as Key-Value pairs.

Example

Imagine you have created a set of generic test to be used across all available operating systems. To ensure the correct tests run for a specific platform, you can create a dedicated Android Environment:

• Filter with Tags: Add Android to includedTags. This ensures that only tests applicable to Android are executed. Alternatively, add iOS and Web to excludedTags.

• Define Variables: Specify an appId variable containing the unique package name for your Android app (e.g., com.example.android).

Using variables in your Tests

Environment variables are available throughout your test wherever a JavaScript expression is supported. You are not limited to a specific env section; you can use them directly in UI commands or logic gates.

You can use the variables as direct iputs, using ${variableName} to inject values into text fields:

- inputText: ${email}

You can also use the variables to control test execution based on the environment:

- runFlow:
    when:
      true: ${APP_ID == "com.example.android"}
    commands:
      - tapOn: "Start"

Next steps

To take the next step with Maestro Studio, learn how to run your tests using the Maestro Cloud solution.

If you want to deepen your understanding of how Maestro works, explore the related documentation:

• Parameters and constants: Pass dynamic values to tests using parameters and inline constants.

• Test discovery and tags: Organize tests with tags and control which tests run using include/exclude filters.

• Conditions: Execute commands conditionally based on visibility, platform, or custom expressions.