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

# dwave/orb-examples

Orb contains jobs for running tests in dwave-examples.


## Jobs

### test-linux

Runs tests on linux


| Parameter | Type | Default | Description |
|---|---|---|---|
| `build-ext-inplace` | boolean | false | Whether or not an inplace extension build is required for testing. |
| `cache` | boolean | true |  |
| `dwave-log-level` | string | warning | Determines logging level in dwave.cloud.client |
| `integration-tests` | enum | all | Determines which environments to run integration tests on. |
| `testing-framework` | enum | unittest | Testing framework used. |

### test-linux-single-python

Runs tests on Linux for a single Python version (on all Ocean supported platforms).


| Parameter | Type | Default | Description |
|---|---|---|---|
| `build-ext-inplace` | boolean | false | Whether or not an inplace extension build is required for testing. |
| `cache` | boolean | true |  |
| `dwave-log-level` | string | warning | Determines logging level in dwave.cloud.client |
| `python-version` | string |  |  |
| `testing-framework` | enum | unittest | Testing framework used. |

### test-osx

Runs tests on osx


| Parameter | Type | Default | Description |
|---|---|---|---|
| `build-ext-inplace` | boolean | false | Whether or not an inplace extension build is required for testing. |
| `cache` | boolean | true |  |
| `dwave-log-level` | string | warning | Determines logging level in dwave.cloud.client |
| `integration-tests` | enum | all | Determines which environments to run integration tests on. |
| `testing-framework` | enum | unittest | Testing framework used. |
| `xcode-version` | string | 16.4.0 |  |

### test-osx-single-python

Runs tests on OSX for a single Python version (on all Ocean supported platforms).


| Parameter | Type | Default | Description |
|---|---|---|---|
| `build-ext-inplace` | boolean | false | Whether or not an inplace extension build is required for testing. |
| `cache` | boolean | true |  |
| `dwave-log-level` | string | warning | Determines logging level in dwave.cloud.client |
| `python-version` | string |  |  |
| `testing-framework` | enum | unittest | Testing framework used. |
| `xcode-version` | string | 16.4.0 |  |

### test-win

Runs tests on windows


| Parameter | Type | Default | Description |
|---|---|---|---|
| `build-ext-inplace` | boolean | false | Whether or not an inplace extension build is required for testing. |
| `cache` | boolean | true |  |
| `dwave-log-level` | string | warning | Determines logging level in dwave.cloud.client |
| `e` | executor | win/default |  |
| `integration-tests` | enum | all | Determines which environments to run integration tests on. |
| `testing-framework` | enum | unittest | Testing framework used. |

### test-win-single-python

Runs tests on Windows for a single Python version (on all Ocean supported platforms).


| Parameter | Type | Default | Description |
|---|---|---|---|
| `build-ext-inplace` | boolean | false | Whether or not an inplace extension build is required for testing. |
| `cache` | boolean | true |  |
| `dwave-log-level` | string | warning | Determines logging level in dwave.cloud.client |
| `executor` | executor | win/default |  |
| `python-version` | string |  |  |
| `testing-framework` | enum | unittest | Testing framework used. |

## Examples

### example

How to use the jobs in orb-examples.


```yaml
version: '2.1'
orbs:
  dwave: dwave/orb-examples@2
workflows:
  tests:
    jobs:
      - dwave/test-linux
      - dwave/test-osx
      - dwave/test-win
  version: 2.1
```

### example-single

How to use the single-python jobs in orb-examples.


```yaml
version: '2.1'
orbs:
  dwave: dwave/orb-examples@2
workflows:
  tests:
    jobs:
      - dwave/test-linux-single-python:
          python-version: 3.9.18
      - dwave/test-win-single-python:
          python-version: 3.10.13
      - dwave/test-osx-single-python:
          python-version: 3.11.5
  version: 2.1
```