Ruby Tests

Ruby Tests

CI Visibility is not available in the selected site () at this time.

Ruby test instrumentation is in beta. There are no billing implications for instrumenting Ruby tests during this period.

Compatibility

Supported Ruby interpreters:

  • Ruby >= 2.1
  • JRuby >= 9.2

Supported test frameworks:

  • Cucumber >= 3.0
  • RSpec >= 3.0.0

Prerequisites

Install the Datadog Agent to collect tests data.

Installing the Ruby tracer

To install the Ruby tracer:

  1. Add the ddtrace gem to your Gemfile:

    Gemfile

    source 'https://rubygems.org'
gem 'ddtrace', ">=0.53.0"

  2. Install the gem by running bundle install

See the Ruby tracer installation docs for more details.

Instrumenting your tests

    The Cucumber integration traces executions of scenarios and steps when using the cucumber framework.

    To activate your integration, add the following code to your application:

    require 'cucumber'
require 'datadog/ci'

Datadog.configure do |c|
  # Only activates test instrumentation on CI
  c.tracer.enabled = (ENV["DD_ENV"] == "ci")

  # Configures the tracer to ensure results delivery
  c.ci_mode.enabled = true

  # The name of the service or library under test
  c.service = 'my-ruby-app'

  # Enables the Cucumber instrumentation
  c.use :cucumber
end

    Run your tests as you normally do, specifying the environment where test are being run (for example, local when running tests on a developer workstation, or ci when running them on a CI provider) in the DD_ENV environment variable. For example:

    DD_ENV=ci bundle exec rake cucumber

    The RSpec integration traces all executions of example groups and examples when using the rspec test framework.

    To activate your integration, add this to the spec_helper.rb file:

    require 'rspec'
require 'datadog/ci'

Datadog.configure do |c|
  # Only activates test instrumentation on CI
  c.tracer.enabled = (ENV["DD_ENV"] == "ci")

  # Configures the tracer to ensure results delivery
  c.ci_mode.enabled = true

  # The name of the service or library under test
  c.service = 'my-ruby-app'

  # Enables the RSpec instrumentation
  c.use :rspec
end

    Run your tests as you normally do, specifying the environment where test are being run (for example, local when running tests on a developer workstation, or ci when running them on a CI provider) in the DD_ENV environment variable. For example:

    DD_ENV=ci bundle exec rake spec

    Configuration settings

    The following is a list of the most important configuration settings that can be used with the tracer, either in code by using a Datadog.configure block, or using environment variables:

    service
    Name of the service or library under test.
    Environment variable: DD_SERVICE
    Default: $PROGRAM_NAME
    Example: my-ruby-app
    env
    Name of the environment where tests are being run.
    Environment variable: DD_ENV
    Default: none
    Examples: local, ci

    The following environment variable can be used to configure the location of the Datadog Agent:

    DD_TRACE_AGENT_URL
    Datadog Agent URL for trace collection in the form http://hostname:port.
    Default: http://localhost:8126

    All other Datadog Tracer configuration options can also be used.

    Collecting Git metadata

    Datadog uses Git information for visualizing your test results and grouping them by repository, branch, and commit. Git metadata is automatically collected by the test instrumentation from CI provider environment variables and the local .git folder in the project path, if available.

    If you are running tests in non-supported CI providers or with no .git folder, you can set the Git information manually using environment variables. These environment variables take precedence over any auto-detected information. Set the following environment variables to provide Git information:

    DD_GIT_REPOSITORY_URL
    URL of the repository where the code is stored. Both HTTP and SSH URLs are supported.
    Example: git@github.com:MyCompany/MyApp.git, https://github.com/MyCompany/MyApp.git
    DD_GIT_BRANCH
    Git branch being tested. Leave empty if providing tag information instead.
    Example: develop
    DD_GIT_TAG
    Git tag being tested (if applicable). Leave empty if providing branch information instead.
    Example: 1.0.1
    DD_GIT_COMMIT_SHA
    Full commit hash.
    Example: a18ebf361cc831f5535e58ec4fae04ffd98d8152
    DD_GIT_COMMIT_MESSAGE
    Commit message.
    Example: Set release number
    DD_GIT_COMMIT_AUTHOR_NAME
    Commit author name.
    Example: John Smith
    DD_GIT_COMMIT_AUTHOR_EMAIL
    Commit author email.
    Example: john@example.com
    DD_GIT_COMMIT_AUTHOR_DATE
    Commit author date in ISO 8601 format.
    Example: 2021-03-12T16:00:28Z
    DD_GIT_COMMIT_COMMITTER_NAME
    Commit committer name.
    Example: Jane Smith
    DD_GIT_COMMIT_COMMITTER_EMAIL
    Commit committer email.
    Example: jane@example.com
    DD_GIT_COMMIT_COMMITTER_DATE
    Commit committer date in ISO 8601 format.
    Example: 2021-03-12T16:00:28Z

    Further reading

    Additional helpful documentation, links, and articles:

    Explore Test Results and PerformanceDOCUMENTATION more more Troubleshooting CIDOCUMENTATION more more