> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# fluidicanalytics/fluidity-orb

## Commands

### junit_zapi_integration

synchronise results with zephyr. Only needed for release tests

| Parameter | Type | Default | Description |
|---|---|---|---|
| `junit-xml-location` | string |  | space separated list of result files to process |
| `requirements-location` | string | zapi-integration/requirements.txt |  |
| `git-branch` | string |  | use <<parameters.git.branch>>, this is used to name the test cycle |

### run_filtered_integration_test

run any integration test for a specific board and flavor

| Parameter | Type | Default | Description |
|---|---|---|---|
| `flavor` | string |  | currently only oneW is used for  paths |
| `board_revision` | enum | rev3 | Board revision |
| `test_type` | string |  | Integration test type |

### run_filtered_unit_tests

run unit tests for a specific board

| Parameter | Type | Default | Description |
|---|---|---|---|
| `flavor` | string |  | currently only oneW is used for  paths |
| `board_revision` | enum | rev3 | Board revision |

### run_filtered_unit_tests_on_multiple_variants

run unit tests on a matrix of flavors and board revisions

| Parameter | Type | Default | Description |
|---|---|---|---|
| `flavor_list` | string | One OneW | space separated list of apk flavors |
| `board_revision_list` | string | rev3 rev4 | space separated list of board revisions |

### build_instrumentation_tests

| Parameter | Type | Default | Description |
|---|---|---|---|
| `flavor` | string |  | currently only oneW is used for  paths |

### initialise_gcloud

authenticate with gcloud and set project

### run_instrumentation_smoke_test

run instrumentation smoke test for oneW

| Parameter | Type | Default | Description |
|---|---|---|---|
| `test-suite` | string | com.fluidicanalytics.mk1app.tests.Miscellaneous.InstrumentationSmokeTest | "Bash command which will run the UI smoke test"
 |
| `flavor` | string |  | currently only oneW is used for  paths |

### run_instrumentation_tests

run any instrumentation test for a specific flavor

| Parameter | Type | Default | Description |
|---|---|---|---|
| `test-suite` | string | $(circleci tests split app/src/androidTest${FLAVOR^}/java/com/fluidicanalytics/mk1app/list_of_test_classes.txt) | "Bash command which will output the test classes we wish to run, comma separated list with no spaces, if nothing provided we will try to split the test classes that we find in app/src/androidTest/java/com/fluidicanalytics/mk1app/list_of_test_classes.txt."
 |
| `flavor` | string |  | currently only oneW is used for  paths |

### repo_init

recursively init git submodules

### checkout_full

Checkout fresh copy of code with submodules

### reattach_environment

reattach to a workspace

### install_cmake

install CMake 3.6

### install_apksigner

Install Apk signer

### save_and_restore_cache

download dependencies and cache them, or use the existing cache if valid.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `additional_key` | string | none | Key to use in addition to checksum of common build file |

### save_dependency_cache

| Parameter | Type | Default | Description |
|---|---|---|---|
| `additional_key` | string | none | Key to use in addition to checksum of common build file |

### restore_dependency_cache

| Parameter | Type | Default | Description |
|---|---|---|---|
| `additional_key` | string | none | Key to use in addition to checksum of common build file |

### download_dependencies

### sign_apks

send apks to signer service to get them signed, needs SIGNER_AUTH_TOKEN and M_SIGNER_AUTH_TOKEN set from fpass, also $SIGNER_URL and $M_SIGNER_URL

| Parameter | Type | Default | Description |
|---|---|---|---|
| `apk-location` | string |  | location of the apks to sign |
| `instrument-type` | enum | oneM | which instrument is the apk signed for |

## Jobs

### gradle_run

Checkout and run task in a gradle project.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `executor` | executor | gradle | The name of custom executor to use |
| `command` | string | build |  |
| `artifacts_path` | string |  |  |
| `artifacts_destination` | string |  |  |