chore: add test-services scripts per package #2932

david-luna · 2025-07-09T14:47:04Z

Which problem is this PR solving?

This PR is a follow-up of #2886 which aims to provide all the necessary tools/scripts in each package to work independently from others. As described in CONTRIBUTING.md with the added scripts a developer could start and stop the necessary services to test an instrumentation.

Supersedes: #2214

Short description of the changes

add test-services:start and test-services:stop script in each package that requires services to run the tests. These scripts start/stop only the necessary services instead of all the ones defined in /test/docker-compose.yml.
add test:with-services-env where applies. The script sets the necessary environment variables for testing and runs the tests
add test-all-versions:with-services-env script where applies. The script does like tes:with-services-env but runs tav instead.
intr-mongodb test script changes to test current version installed (v5-v6 tests). Other versions will be tests using test-all-versions script and the coverage will be collected and reported in chore: add new PR workflow #2866

Other changes

The scripts section of each package has been reordered to be grouped by topic: compilation, linting, test, ...

All packages now have a structure similar to this

{
    // compile topic
    "clean": "tsc --build --clean tsconfig.json tsconfig.esm.json",
    "compile": "tsc -p .",
    "compile:with-dependencies": "nx run-many -t compile -p @opentelemetry/sampler-aws-xray",
    // linting topic
    "lint": "eslint . --ext .ts",
    "lint:fix": "eslint . --ext .ts --fix",
    // publish topic
    "prepublishOnly": "npm run compile",
    // test topic
    "tdd": "npm run test -- --watch-extensions ts --watch",
    "test": "nyc mocha 'test/**/*.test.ts'",
    // others topic
    "version:update": "node ../../scripts/version-update.js",
    "watch": "tsc --build --watch tsconfig.json tsconfig.esm.json"
}

david-luna · 2025-07-09T14:48:54Z

CONTRIBUTING.md

-npm run test:with-services-config # runs 'npm test' with envvars from test/test-services.env
-npm run test-services:stop        # stops services in Docker
+npm run test-services:start    # starts services in Docker
+npm run test:with-services-env # runs 'npm test' with envvars from test/test-services.env


note to reviewer: this was a typo from #2886

david-luna · 2025-07-09T14:49:26Z

CONTRIBUTING.md

@@ -117,7 +117,7 @@ The required steps to start development on a pacakge are:

 - `npm ci` from root folder to install dependencies ([see npm-ci docs](https://docs.npmjs.com/cli/v10/commands/npm-ci))
 - `cd` into the pacakge you want to apply changes.
- `npm run setup:dev` compiles the TypeScript files for this package and its dependencies within the repository.
+- `npm run compile:with-dependencies` compiles the TypeScript files for this package and its dependencies within the repository.


note for reviewer: script name has changed to be more explicit about what it does. you will see this change on each package.json that has it

david-luna · 2025-07-09T15:09:57Z

packages/instrumentation-amqplib/package.json

    "version:update": "node ../../scripts/version-update.js",
-    "watch": "tsc -w",
-    "test:docker:run": "docker run -d --hostname demo-amqplib-rabbit --name amqplib-unittests -p 22221:5672 --env RABBITMQ_DEFAULT_USER=username --env RABBITMQ_DEFAULT_PASS=password rabbitmq:3"


note for reviewer: scripts with docker commands have been deleted because now the service is controlled via test-services:start and test-services:stop

codecov · 2025-07-09T16:09:06Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.79%. Comparing base (952abc7) to head (8c2783d).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2932      +/-   ##
==========================================
- Coverage   89.89%   89.79%   -0.10%     
==========================================
  Files         188      188              
  Lines        9222     9222              
  Branches     1900     1900              
==========================================
- Hits         8290     8281       -9     
- Misses        932      941       +9

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.

david-luna · 2025-07-09T16:17:39Z

packages/contrib-test-utils/src/test-utils.ts

@@ -33,62 +32,6 @@ import * as path from 'path';
 import * as fs from 'fs';
 import { InstrumentationBase } from '@opentelemetry/instrumentation';

-const dockerRunCmds = {


note for reviewer: not needed anymore

david-luna · 2025-07-09T16:21:22Z

packages/instrumentation-cassandra-driver/package.json

+    "tdd": "npm run test -- --watch-extensions ts --watch",
+    "test": "nyc mocha 'test/**/*.test.ts'",
+    "test:with-services-env": "cross-env NODE_OPTIONS='-r dotenv/config' DOTENV_CONFIG_PATH=../../test/test-services.env npm test",
+    "//todo": "echo \"add test-all-versions\"",


note for reviewer: this is a reminder to configure test all versions in order to get the coverage reports. There is a follow up PR which will take care of it

Do we necessarily want to add TAV testing for the packages that don't currently have it? For example, memcached hasn't had a release since 2016.

I'd say is a nice to have.

github-actions · 2025-07-10T06:42:55Z

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.

…una/opentelemetry-js-contrib into add-services-scripts-per-package

trentm

I'm tearing up. This is beautiful.

trentm · 2025-07-30T19:22:40Z

packages/instrumentation-cassandra-driver/package.json

+    "tdd": "npm run test -- --watch-extensions ts --watch",
+    "test": "nyc mocha 'test/**/*.test.ts'",
+    "test:with-services-env": "cross-env NODE_OPTIONS='-r dotenv/config' DOTENV_CONFIG_PATH=../../test/test-services.env npm test",
+    "//todo": "echo \"add test-all-versions\"",


Do we necessarily want to add TAV testing for the packages that don't currently have it? For example, memcached hasn't had a release since 2016.

trentm · 2025-07-30T19:28:25Z

packages/instrumentation-mongodb/package.json

@@ -10,24 +10,24 @@
    "directory": "packages/instrumentation-mongodb"
  },
  "scripts": {
-    "docker:start": "docker run -e MONGODB_DB=opentelemetry-tests -e MONGODB_PORT=27017 -e MONGODB_HOST=127.0.0.1 -p 27017:27017 --rm mongo",
-    "test": "npm run test-v4 && npm run test-v5-v6",


Should perhaps mention in the description that this PR is chaning the instr-mongodb tests to just test v5-v6, and leaving testing of the old versions to TAV.

trentm · 2025-07-30T19:31:07Z

packages/instrumentation-winston/package.json

+    "test": "npm run test-v1-v2 && npm run test-v3 && nyc merge .nyc_output ./coverage/coverage-final.json",
+    "test-v1-v2": "tav winston 2.4.7 npm run test-run",
+    "test-v3": "npm run test-run",


Will need to deal with a merge conflict from my recent instr-winston testing change.

commit bb454f5

trentm · 2025-07-30T19:31:33Z

test/test-services.env

@@ -1,5 +1,5 @@
 RUN_CASSANDRA_TESTS=1
-CASSANDRA_HOST=localhostç
+CASSANDRA_HOST=localhost


trentm

Perhaps also git rm packages/instrumentation-mysql2/env. I only just noticed this file exists. It is (almost) a subset of test/test-services.env. "Almost" because the port is different.

david-luna · 2025-07-31T10:45:05Z

Perhaps also git rm packages/instrumentation-mysql2/env. I only just noticed this file exists. It is (almost) a subset of test/test-services.env. "Almost" because the port is different.

commit 8c2783d

david-luna added 8 commits July 9, 2025 10:09

chore: rename setup script

9f52a4e

chore: add scripts to cassandra driver instr

b71a1af

chore: add scripts to iosredis instrumentation

240359f

chore: update sceript to a batch of instrumentations

dafcf86

chore: updates cripts for oracle and pg instrumentations

6b88fdb

chore: update script for a batch of pacakges

9a8d2ac

chore: organize npm scripts

9785201

chore: fix lint issues

2eef913

david-luna requested a review from a team as a code owner July 9, 2025 14:47

github-actions bot assigned aabmass Jul 9, 2025

github-actions bot added pkg:instrumentation-ioredis pkg:instrumentation-graphql pkg:instrumentation-mysql pkg:instrumentation-mysql2 labels Jul 9, 2025

github-actions bot assigned abhee11 Jul 9, 2025

github-actions bot added pkg:instrumentation-fs pkg:instrumentation-restify pkg:instrumentation-dns pkg:resource-detector-alibaba-cloud pkg:resource-detector-aws pkg:resource-detector-gcp labels Jul 9, 2025

github-actions bot assigned blumamir Jul 9, 2025

github-actions bot added pkg:resource-detector-github pkg:resource-detector-instana pkg:auto-instrumentations-node pkg:auto-instrumentations-web pkg:host-metrics pkg:id-generator-aws-xray pkg:propagation-utils labels Jul 9, 2025

github-actions bot assigned d4nyll Jul 9, 2025

github-actions bot added the pkg:instrumentation-oracledb label Jul 9, 2025

Merge branch 'main' into add-services-scripts-per-package

536dab5

david-luna commented Jul 9, 2025

View reviewed changes

chore: add cros-env where needed

813a7c7

david-luna commented Jul 9, 2025

View reviewed changes

chore: remove unused test utils for docker

7d7d919

david-luna commented Jul 9, 2025

View reviewed changes

chore: update cassandra instr scripts

188d6a1

david-luna commented Jul 9, 2025

View reviewed changes

Merge branch 'main' into add-services-scripts-per-package

a2e0266

david-luna changed the title ~~chore: add test-services scripts~~ chore: add test-services scripts per package Jul 9, 2025

github-actions bot added the pkg-status:unmaintained:autoclose-scheduled label Jul 10, 2025

david-luna added 2 commits July 21, 2025 10:43

Merge branch 'main' into add-services-scripts-per-package

f9711f5

Merge branch 'main' into add-services-scripts-per-package

4e8e846

trentm added the has:sponsor This package or feature has a sponsor that has volunteered to review PRs and respond to questions label Jul 23, 2025

david-luna added 3 commits July 23, 2025 18:52

chore: cat file for debugging

76f9219

Merge branch 'add-services-scripts-per-package' of github.com:david-l…

2888fc4

…una/opentelemetry-js-contrib into add-services-scripts-per-package

chore: fix conflicts with main

a3ac2f2

trentm approved these changes Jul 30, 2025

View reviewed changes

trentm reviewed Jul 30, 2025

View reviewed changes

david-luna added 3 commits July 31, 2025 08:31

Merge branch 'main' into add-services-scripts-per-package

dc750b5

chore: revert instr-wiston test scripts to use the one from main

bb454f5

chore: remove env file in mysql2 instr

8c2783d

david-luna merged commit 9d90781 into open-telemetry:main Jul 31, 2025
23 checks passed

david-luna deleted the add-services-scripts-per-package branch July 31, 2025 10:47

trentm mentioned this pull request Aug 6, 2025

test: add 'test-services' system for running tests locally with requisite services in Docker #2214

Closed

chore: add test-services scripts per package #2932

chore: add test-services scripts per package #2932

Uh oh!

Conversation

david-luna commented Jul 9, 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

Other changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jul 10, 2025

Uh oh!

trentm left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

trentm left a comment

Choose a reason for hiding this comment

Uh oh!

david-luna commented Jul 31, 2025

Uh oh!

Uh oh!

Uh oh!

david-luna commented Jul 9, 2025 •

edited

Loading

david-luna Jul 9, 2025 •

edited

Loading

codecov bot commented Jul 9, 2025 •

edited

Loading