chore: Add docker compose and test services scripts #2886

david-luna · 2025-06-16T14:40:50Z

Which problem is this PR solving?

another attempt to improve the testing experience. ref [internal] improve local testing experience #2038
based on previous work from @trentm. ref test: add 'test-services' system for running tests locally with requisite services in Docker #2214
this PR also it will help to finish chore: add new PR workflow #2866. A 1st local run and coverage upload with flags is needed
a difference form Trent's work is that there are no scripts at the package level, only in root. I'm planning to add them in a follow up PR

Short description of the changes

add docker compose file & .env file for testing
add script to spin up services for testing
move MySQL log config command from workflow to tests

codecov · 2025-06-16T14:58:10Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.82%. Comparing base (50af7ec) to head (d049606).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2886      +/-   ##
==========================================
+ Coverage   89.77%   89.82%   +0.04%     
==========================================
  Files         187      187              
  Lines        9147     9147              
  Branches     1884     1884              
==========================================
+ Hits         8212     8216       +4     
+ Misses        935      931       -4

see 1 file with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions · 2025-06-17T06:41:57Z

This package does not have an assigned component owner and is considered unmaintained. As such this package is in feature-freeze and this PR will be closed with 14 days unless a new owner or a sponsor (a member of @open-telemetry/javascript-approvers) for the feature is found. It is the responsibility of the author to find a sponsor for this feature.
Are you familiar with this package? Consider becoming a component owner.

david-luna · 2025-06-18T10:30:21Z

.github/workflows/test-all-versions.yml

@@ -163,8 +163,6 @@ jobs:
      - uses: actions/setup-node@v4
        with:
          node-version: ${{ matrix.node }}
-      - name: Set MySQL variables


note for reviewer: this is required only for testing @opentelemetry/instrumentation-mysql and can be executed as a query using the client. Hence is removed from there and added in plugins/node/opentelemetry-instrumentation-mysql/test/mysql.test.ts

david-luna · 2025-06-18T10:30:49Z

.github/workflows/unit-test.yml

@@ -176,8 +176,6 @@ jobs:
      - uses: actions/setup-node@v4
        with:
          node-version: ${{ matrix.node }}
-      - name: Set MySQL variables


note for reviewer: same here

david-luna · 2025-06-18T10:32:46Z

plugins/node/opentelemetry-instrumentation-mysql2/test/mysql.test.ts

+  const shouldTest = process.env.RUN_MYSQL_TESTS;
+
+  before(async function () {
+    const connection = createConnection({


note for reviewer: enabling here the general_log setting instead of doing it in the workflows

david-luna · 2025-06-18T10:35:48Z

plugins/node/opentelemetry-instrumentation-pg/test/pg.test.ts

@@ -64,7 +64,7 @@ const memoryExporter = new InMemorySpanExporter();
 const CONFIG = {
  user: process.env.POSTGRES_USER || 'postgres',
  password: process.env.POSTGRES_PASSWORD || 'postgres',
-  database: process.env.POSTGRES_DB || 'postgres',
+  database: process.env.POSTGRES_DB || 'otel_pg_database',


note for reviewer: align the value with the one in workflow services

raphael-theriault-swi

Love this, small nit tho.

package.json

trentm

Should do the cross-env thing. Else I just have nits. Thanks for picking this up!

trentm · 2025-06-24T21:00:35Z

CONTRIBUTING.md

+If you only want to test a sigle package (e.g. the `instrumentation-mongodb`) you can `cd` into it and run the tests after you started the services.
+
+```sh
+npm run test-services:start                           # starts services in Docker


This could optionally be npm run test-services:start mongodb but probably don't need to bother mentioning this. Easier to keep it simple.

I'm planning to do a follow up PR to add scripts for each package which will use this feature. I'll remember to update this description.

plugins/node/opentelemetry-instrumentation-mysql/test/index.test.ts

test/docker-compose.yaml

test/test-services.env

CONTRIBUTING.md

…st.ts Co-authored-by: Trent Mick <trentm@gmail.com>

Co-authored-by: Trent Mick <trentm@gmail.com>

pichlermarc

thank you for working on this! 🙂

CONTRIBUTING.md

Co-authored-by: Marc Pichler <marc.pichler@dynatrace.com>

david-luna added 2 commits June 16, 2025 16:37

chore: add docker file to test with services locally

b99f3d6

chore: remove mysql config step in workflows

8666907

github-actions bot assigned raphael-theriault-swi Jun 16, 2025

github-actions bot added pkg:instrumentation-mysql pkg:instrumentation-mysql2 pkg-status:unmaintained This package is unmaintained. Only bugfixes may be acceped until a new owner has been found. labels Jun 16, 2025

github-actions bot requested a review from raphael-theriault-swi June 16, 2025 14:41

david-luna added 2 commits June 16, 2025 16:42

chore: fix lint issues

b2cea62

Merge branch 'main' into add-docker-compose-and-test-serivces-scripts

2a41b7f

david-luna changed the title ~~Add docker compose and test serivces scripts~~ chore: Add docker compose and test services scripts Jun 16, 2025

fix: fix compilation issue

b75a0c1

github-actions bot added the pkg-status:unmaintained:autoclose-scheduled label Jun 17, 2025

david-luna added 2 commits June 17, 2025 10:49

chore: fix databae and port for mysql service

38ef4fe

chore: fix env for pg instrumentation tests

864fe05

github-actions bot assigned maryliag Jun 17, 2025

github-actions bot added the pkg:instrumentation-pg label Jun 17, 2025

github-actions bot requested a review from maryliag June 17, 2025 13:39

chore: update docs

42a1123

david-luna marked this pull request as ready for review June 18, 2025 10:16

david-luna requested a review from a team as a code owner June 18, 2025 10:16

david-luna commented Jun 18, 2025

View reviewed changes

chore: remove logs

3815bca

david-luna mentioned this pull request Jun 18, 2025

chore: add new PR workflow #2866

Draft

3 tasks

Merge branch 'main' into add-docker-compose-and-test-serivces-scripts

2c24405

raphael-theriault-swi reviewed Jun 20, 2025

View reviewed changes

package.json Outdated Show resolved Hide resolved

trentm approved these changes Jun 24, 2025

View reviewed changes

trentm reviewed Jun 24, 2025

View reviewed changes

CONTRIBUTING.md Show resolved Hide resolved

pichlermarc added has:sponsor This package or feature has a sponsor that has volunteered to review PRs and respond to questions and removed pkg-status:unmaintained:autoclose-scheduled labels Jun 25, 2025

david-luna and others added 5 commits June 25, 2025 14:35

Update plugins/node/opentelemetry-instrumentation-mysql/test/index.te…

7bf72e9

…st.ts Co-authored-by: Trent Mick <trentm@gmail.com>

Update test/docker-compose.yaml

642e9a9

Co-authored-by: Trent Mick <trentm@gmail.com>

Update test/docker-compose.yaml

9b6a94d

Co-authored-by: Trent Mick <trentm@gmail.com>

Update test/docker-compose.yaml

2ba1b11

Co-authored-by: Trent Mick <trentm@gmail.com>

chore: add cross-env in test script

f832c97

pichlermarc approved these changes Jun 25, 2025

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

david-luna and others added 2 commits June 25, 2025 20:41

Update CONTRIBUTING.md

daee887

Co-authored-by: Marc Pichler <marc.pichler@dynatrace.com>

Merge branch 'main' into add-docker-compose-and-test-serivces-scripts

d049606

david-luna merged commit 2aef158 into open-telemetry:main Jun 26, 2025
23 checks passed

david-luna mentioned this pull request Jul 9, 2025

chore: add test-services scripts per package #2932

Merged

chore: Add docker compose and test services scripts #2886

chore: Add docker compose and test services scripts #2886

Uh oh!

Conversation

david-luna commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Which problem is this PR solving?

Short description of the changes

Uh oh!

codecov bot commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Jun 17, 2025

Uh oh!

david-luna Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

david-luna Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

david-luna Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

david-luna Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

raphael-theriault-swi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

trentm left a comment

Choose a reason for hiding this comment

Uh oh!

trentm Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

david-luna Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pichlermarc left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

david-luna commented Jun 16, 2025 •

edited

Loading

codecov bot commented Jun 16, 2025 •

edited

Loading