Skip to content

Commit

Permalink
Give explicit name to integration tests
Browse files Browse the repository at this point in the history
  • Loading branch information
RomainMuller committed Jan 13, 2025
1 parent ed2a485 commit 12fbc6d
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .github/workflows/validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -245,8 +245,9 @@ jobs:
##############################################################################
# Run all integration tests and gather extensive coverage
integration-tests:
name: Integration Tests
needs: generate
uses: DataDog/dd-trace-go/.github/workflows/orchestrion.yml@839cfba31e8d5709c05954669857ad2d2e9af59c
uses: DataDog/dd-trace-go/.github/workflows/orchestrion.yml@0154cab4fb7a9b71875da985ef091b4eac924b45
with:
collect-coverage: ${{ github.event_name != 'merge_group' }}
orchestrion-version: ${{ github.sha }}
Expand Down
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,22 @@ We expect PRs to include new tests for any added or significantly updated functi
adequate coverage for the changed surface. The CodeCov integration can help you get a sense of what the test coverage
for your change is. Reviewers may request additional tests be added before approving a change.

#### Integration Tests

There is [an `orchestrion` integration test suite in `dd-trace-go`][dd-trace-go] that validates provided integration
configurations. This test suite is executed as part of orchestrion's CI. It can be executed locally using the following
commands:

```console
$ git clone github.com:DataDog/dd-trace-go # Clone the DataDog/dd-trace-go repository
$ cd dd-trace-go/internal/orchestrion/_integration # Move into the integration tests directory
$ go mod edit \ # Use the local copy of orchestrion
-replace "github.com/DataDog/orchestrion=>${orchestrion_dir}"
$ go mod tidy # Make sure go.mod & go.sum are up-to-date
$ go run github.com/DataDog/orchestrion \ # Run integration test suite with orchestrion
go test -shuffle=on ./...
```

### What to expect

We try to review new PRs within a week or so of creation. If your PR passes all automated tests and has been waiting for
Expand All @@ -71,3 +87,4 @@ our automated testing suite.
<!-- Links -->
[new-issue]: https://github.com/DataDog/orchestrion/issues/new/choose
[conventional-commits]: https://www.conventionalcommits.org/en/v1.0.0/
[dd-trace-go]: https://github.com/DataDog/dd-trace-go/internal/orchestrion/_integration
14 changes: 14 additions & 0 deletions internal/injector/builtin/all.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Unless explicitly stated otherwise all files in this repository are licensed
# under the Apache License Version 2.0.
# This product includes software developed at Datadog (https://www.datadoghq.com/).
# Copyright 2023-present Datadog, Inc.
---
# yaml-language-server: $schema=../config/schema.json
meta:
name: github.com/DataDog/orchestrion/instrument
description: |-
Built-in instrumentation from orchestrion. This will eventually be moved to
the gopkg.in/DataDog/dd-trace-go.v1 package.
extends:
- ./yaml/directive/orchestrion-enabled.yml

0 comments on commit 12fbc6d

Please sign in to comment.