Sha256: d385cc30c02cc49baae127b2b24aff37e7b48ebbc096819d908f5fa5642ff8e8

Contents?: true

Size: 1.84 KB

Versions: 5

Compression:

Stored size: 1.84 KB

Contents

# Development

This repository contains code that is autogenerated via the
[openapi-generator](https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources/ruby) project.

As such, this repository should only contain development for adding or fixing tests, for improving development tooling and documentation

## Testing

### Prerequisite

Export the following environment variables:
* `DD_TEST_CLIENT_API_KEY`: The Datadog API key to run integration tests against
* `DD_TEST_CLIENT_APP_KEY`: The Datadog Application key to run integration tests against

**IMPORTANT**: Do not use production keys.

<!---
Tests can be run againts different site (EU, staging, local):
* `DD_TEST_SITE`: The base URL for test site (e.g. `datadoghq.eu`)

**NOTE**: All recorded URLs will be replaced by `datadoghq.com`. Please make sure that you do NOT leak any
any sensitive information.
--->

### Commands

This project contains BDD tests.
__Never__ run the test suite against an organization with production data.

Tests can be executed via [`cucumber`](https://cucumber.io/docs/guides/).
You can optionally add `features/v<NUMBER>/<FILENAME>.feature:<LINE_NUMBER>` to filter individual tests.

By default integration tests use recorded API responses stored in cassettes. To record new API responses run the tests with `RECORD=true`. To run integration tests against API without recording cassettes, run the tests with `RECORD=none`.

**IMPORTANT**:
When creating a PR that adds or updates a test, __never__ commit
generated code, only commit test files being updated and any updated cassettes.

### CI

In rare ocassions, the test suite may fail due to a corrupted cache in `ruby/setup-ruby` action.
Please update `CACHE_VERSION` secret in https://github.com/DataDog/datadog-api-client-ruby/settings/secrets/actions/CACHE_VERSION with a new unique value.

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
datadog_api_client-1.7.0 DEVELOPMENT.md
datadog_api_client-1.6.0 DEVELOPMENT.md
datadog_api_client-1.5.0 DEVELOPMENT.md
datadog_api_client-1.4.0 DEVELOPMENT.md
datadog_api_client-1.3.0 DEVELOPMENT.md