Tests Ruby

If you are running tests on an on-premises CI provider, such as Jenkins or self-managed GitLab CI, install the Datadog Agent on each worker node by following the Agent installation instructions. This is the recommended option as it allows you to automatically link test results to logs and underlying host metrics.

If you are using a Kubernetes executor, Datadog recommends using the Datadog Operator. The operator includes Datadog Admission Controller which can automatically inject the tracer library into the build pods. Note: If you use the Datadog Operator, there is no need to download and inject the tracer library since the Admission Controller can do this for you, so you can skip the corresponding step below. However, you still need to make sure that your pods set the environment variables or command-line parameters necessary to enable Test Visibility.

If you are not using Kubernetes or can’t use the Datadog Admission Controller and the CI provider is using a container-based executor, set the DD_TRACE_AGENT_URL environment variable (which defaults to http://localhost:8126) in the build container running the tracer to an endpoint that is accessible from within that container. Note: Using localhost inside the build references the container itself and not the underlying worker node or any container where the Agent might be running in.

DD_TRACE_AGENT_URL includes the protocol and port (for example, http://localhost:8126) and takes precedence over DD_AGENT_HOST and DD_TRACE_AGENT_PORT, and is the recommended configuration parameter to configure the Datadog Agent’s URL for CI Visibility.

If you still have issues connecting to the Datadog Agent, use the Agentless Mode. Note: When using this method, tests are not correlated with logs and infrastructure metrics.

If you are using a cloud CI provider without access to the underlying worker nodes, such as GitHub Actions or CircleCI, configure the library to use the Agentless mode. For this, set the following environment variables:

DD_CIVISIBILITY_AGENTLESS_ENABLED=true (Required)

Enables or disables Agentless mode.
Default: false

DD_API_KEY (Required)

The Datadog API key used to upload the test results.
Default: (empty)

Additionally, configure the Datadog site to which you want to send data.

DD_SITE (Required)

The Datadog site to upload results to.
Default: datadoghq.com

L’intégration RSpec trace toutes les exécutions d’exemples et de groupes d’exemples lors de l’utilisation du framework de test rspec.

Pour activer votre intégration, ajoutez le code suivant à votre fichier spec_helper.rb :

require 'rspec'
require 'datadog/ci'

Datadog.configure do |c|
  # Activer uniquement l'instrumentation de tests sur l'environnement de CI
  c.tracing.enabled = (ENV["DD_ENV"] == "ci")

  # Configurer le traceur pour s'assurer de la transmission des résultats
  c.ci.enabled = true

  # Le nom du service ou de la bibliothèque testé(e)
  c.service = 'my-ruby-app'

  # Activer l'instrumentation RSpec
  c.ci.instrument :rspec
end

Exécutez vos tests normalement, en spécifiant l’environnement dans lequel les tests sont exécutés via la variable d’environnement DD_ENV.

Vous pouvez utiliser les environnements suivants :

• local pour des tests exécutés sur la machine d’un développeur
• ci pour des tests exécutés sur un fournisseur de CI

Par exemple :

DD_ENV=ci bundle exec rake spec

L’intégration Minitest trace toutes les exécutions de tests lors de l’utilisation du framework minitest.

Pour activer votre intégration, ajoutez les lignes suivantes à votre fichier test_helper.rb :

require 'minitest'
require 'datadog/ci'

Datadog.configure do |c|
  # Activer uniquement l'instrumentation de tests sur l'environnement de CI
  c.tracing.enabled = (ENV["DD_ENV"] == "ci")

  # Configurer le traceur pour s'assurer de la transmission des résultats
  c.ci.enabled = true

  # Le nom du service ou de la bibliothèque testé(e)
  c.service = 'my-ruby-app'

  c.ci.instrument :minitest
end

Exécutez vos tests normalement, en spécifiant l’environnement dans lequel les tests sont exécutés via la variable d’environnement DD_ENV.

Vous pouvez utiliser les environnements suivants :

• local pour des tests exécutés sur la machine d’un développeur
• ci pour des tests exécutés sur un fournisseur de CI

Par exemple :

DD_ENV=ci bundle exec rake test

L’intégration Cucumber trace les exécutions de scénarios et d’étapes à l’aide du framework cucumber.

Pour activer votre intégration, ajoutez le code suivant à votre application :

require 'cucumber'
require 'datadog/ci'

Datadog.configure do |c|
  # Activer uniquement l'instrumentation de tests sur l'environnement de CI
  c.tracing.enabled = (ENV["DD_ENV"] == "ci")

  # Configurer le traceur pour s'assurer de la transmission des résultats
  c.ci.enabled = true

  # Le nom du service ou de la bibliothèque testé(e)
  c.service = 'my-ruby-app'

  # Activer l'instrumentation Cucumber
  c.ci.instrument :cucumber
end

Exécutez vos tests normalement, en spécifiant l’environnement dans lequel les tests sont exécutés via la variable d’environnement DD_ENV. Vous pouvez utiliser les environnements suivants :

• local pour des tests exécutés sur la machine d’un développeur
• ci pour des tests exécutés sur un fournisseur de CI

Par exemple :

DD_ENV=ci bundle exec rake cucumber