POSITIONAL ARGUMENTS

[ARGSPEC]

An ARG_FILE:ARG_GROUP_NAME pair, where ARG_FILE is the path to a file containing groups of test arguments in yaml format, and ARG_GROUP_NAME is the particular yaml object holding a group of arg:value pairs to use. Run $ gcloud topic arg-files for more information and examples.

COMMONLY USED FLAGS

--device=DIMENSION=VALUE,[...]

A list of DIMENSION=VALUE pairs which specify a target device to test against. This flag may be repeated to specify multiple devices. The device dimensions are: model, version, locale, and orientation. If any dimensions are omitted, they will use a default value. The default value, and all possible values, for each dimension can be found with the list command for that dimension, such as $ gcloud alpha firebase test ios models list. Omitting this flag entirely will run tests against a single device using defaults for every dimension.
Examples:

--device model=iphone8plus --device version=11.2 --device model=ipadmini4,version=11.2,locale=zh_CN,orientation=landscape

--test=XCTEST_ZIP

The path to the test package (a zip file containing the iOS app and XCTest files). The given path may be in the local filesystem or in Google Cloud Storage using a URL beginning with gs://. Note: any .xctestrun file in this zip file will be ignored if --xctestrun-file is specified.

--timeout=TIMEOUT

The max time this test execution can run before it is cancelled (default: 15m). It does not include any time necessary to prepare and clean up the target device. The maximum possible testing time is 30m on physical devices and 60m on virtual devices. The TIMEOUT units can be h, m, or s. If no unit is given, seconds are assumed. Examples:

---

--timeout 1h is 1 hour

---

--timeout 5m is 5 minutes

---

--timeout 200s is 200 seconds

---

--timeout 100 is 100 seconds

--xcode-version=XCODE_VERSION

The version of Xcode that should be used to run an XCTest. Defaults to the latest Xcode version supported in Firebase Test Lab. This Xcode version must be supported by all iOS versions selected in the test matrix. The list of Xcode versions supported by each version of iOS can be viewed by running $ gcloud alpha firebase test ios versions list.

--xctestrun-file=XCTESTRUN_FILE

The path to an .xctestrun file that will override any .xctestrun file contained in the --test package. Because the .xctestrun file contains environment variables along with test methods to run and/or ignore, this can be useful for customizing or sharding test suites. The given path may be in the local filesystem or in Google Cloud Storage using a URL beginning with gs://.

FLAGS

--async

Invoke a test asynchronously without waiting for test results.

--record-video

Enable video recording during the test. Enabled by default, use --no-record-video to disable.

--results-bucket=RESULTS_BUCKET

The name of a Google Cloud Storage bucket where raw test results will be stored (default: "test-lab-<random-UUID>"). Note that the bucket must be owned by a billing-enabled project, and that using a non-default bucket will result in billing charges for the storage used.

--results-dir=RESULTS_DIR

The name of a unique Google Cloud Storage object within the results bucket where raw test results will be stored (default: a timestamp with a random suffix). Caution: if specified, this argument must be unique for each test matrix you create, otherwise results from multiple test matrices will be overwritten or intermingled.

--results-history-name=RESULTS_HISTORY_NAME

The history name for your test results (an arbitrary string label; default: the bundle ID for the iOS application). All tests which use the same history name will have their results grouped together in the Firebase console in a time-ordered test history list.

LIST COMMAND FLAGS

--filter=EXPRESSION

Apply a Boolean filter EXPRESSION to each resource item to be listed. If the expression evaluates True, then that item is listed. For more details and examples of filter expressions, run $ gcloud topic filters. This flag interacts with other flags that are applied in this order: --flatten, --sort-by, --filter, --limit.

--limit=LIMIT

Maximum number of resources to list. The default is unlimited. This flag interacts with other flags that are applied in this order: --flatten, --sort-by, --filter, --limit.

--page-size=PAGE_SIZE

Some services group resource list output into pages. This flag specifies the maximum number of resources per page. The default is determined by the service if it supports paging, otherwise it is unlimited (no paging). Paging may be applied before or after --filter and --limit depending on the service.

--sort-by=[FIELD,...]

Comma-separated list of resource field key names to sort by. The default order is ascending. Prefix a field with ``~'' for descending order on that field. This flag interacts with other flags that are applied in this order: --flatten, --sort-by, --filter, --limit.

GCLOUD WIDE FLAGS

EXAMPLES

$ gcloud alpha firebase test ios run --test XCTEST_ZIP --timeout 5m

$ gcloud alpha firebase test ios run --test XCTEST_ZIP \
    --device model=ipad5,version=11.2

$ gcloud alpha firebase test ios run --test XCTEST_ZIP \
      --device model=iphone7               \
    --device model=ipadmini4,version=11.2               \
    --device model=iphonese

$ gcloud alpha firebase test ios run --test XCTEST_ZIP \
    --xcode-version=9.4.1

$ gcloud alpha firebase test ios run \
    path/to/excelsior_app_args:ios-args

NOTES

$ gcloud firebase test ios run $ gcloud beta firebase test ios run