feat: test-utils

[naseemkullah]

Which problem is this PR solving?

#617

Short description of the changes

A common @opentelemetry/test-utils to start and stop docker containers required for tests. The functions require a db argument to indicate which container to start/stop. The allowed values are redis, mysql and postgres.

Currently used in redis, mysql and postgres plugins.
If merged, it would have to be applied to ioredis(not yet merged) as well.

P.S. Excuse the amends/force-pushes I presume nobody has looked at this yet and wanted a cleaner history.

[codecov-io]

Codecov Report

Merging #644 into master will decrease coverage by <.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #644      +/-   ##
==========================================
- Coverage   89.52%   89.52%   -0.01%     
==========================================
  Files         188      188              
  Lines        9656     9691      +35     
  Branches      902      897       -5     
==========================================
+ Hits         8645     8676      +31     
- Misses       1011     1015       +4

Impacted Files	Coverage Δ
...ages/opentelemetry-plugin-http/test/utils/utils.ts	33.33% <0%> (-26.67%)	⬇️
...ges/opentelemetry-plugin-https/test/utils/utils.ts	33.33% <0%> (-26.67%)	⬇️
...es/opentelemetry-node/src/instrumentation/utils.ts	90.47% <0%> (-9.53%)	⬇️
packages/opentelemetry-plugin-mysql/src/utils.ts	90.9% <0%> (-4.55%)	⬇️
...opentelemetry-base/test/resources/resource.test.ts	100% <0%> (ø)	⬆️
packages/opentelemetry-tracing/src/config.ts	100% <0%> (ø)	⬆️
packages/opentelemetry-tracing/src/utility.ts	100% <0%> (ø)	⬆️
...ges/opentelemetry-exporter-zipkin/src/transform.ts	100% <0%> (ø)	⬆️
packages/opentelemetry-tracing/test/Span.test.ts	100% <0%> (ø)	⬆️
.../opentelemetry-plugin-dns/test/utils/assertSpan.ts	100% <0%> (ø)	⬆️
... and 13 more

[dyladan]

Please add fix and check npm scripts

[naseemkullah]

Please add fix and check npm scripts

✅

[naseemkullah]

Would it make sense to include assertSpan and assertPropagation in the test-utils package?
The ones used in pg and redis are very similar and could potentially be used for future plugins.
e.g.:

https://github.com/open-telemetry/opentelemetry-js/blob/fa583fde07425f0aca75d3902d13e5a7d9a5dc65/packages/opentelemetry-plugin-redis/test/assertionUtils.ts

https://github.com/open-telemetry/opentelemetry-js/blob/2bfa6c028331ca5da5113c5b10c41d045f624939/packages/opentelemetry-plugin-postgres/opentelemetry-plugin-pg/test/assertionUtils.ts

[naseemkullah]

Other plugins such as dns and http have a different assertSpan function however.
e.g. http and dns

opentelemetry-js/packages/opentelemetry-plugin-dns/test/utils/assertSpan.ts

Line 25 in 502f9e4

export const assertSpan = (

https://github.com/open-telemetry/opentelemetry-js/blob/06d21e348476e2be04480ba76e719efb1d242c4b/packages/opentelemetry-plugin-http/test/utils/assertSpan.ts

But the function could potentially work for those as well provided it is configurable to the needs of those plugins.

[dyladan]

Would it make sense to include assertSpan and assertPropagation in the test-utils package?
The ones used in pg and redis are very similar and could potentially be used for future plugins.

Yes definitely.

[mayurkale22]

Could you please do the same thing on pg-pool plugin?

[mayurkale22]

Would it make sense to include assertSpan and assertPropagation in the test-utils package?
The ones used in pg and redis are very similar and could potentially be used for future plugins.

What's your plan on this? Are you planning to do it separate PR?

[naseemkullah]

Would it make sense to include assertSpan and assertPropagation in the test-utils package?
The ones used in pg and redis are very similar and could potentially be used for future plugins.

What's your plan on this? Are you planning to do it separate PR?

I will include for pg, redis and mysql momentarily. Not sure about other ones such as http and dns, what do you suggest?

[mayurkale22]

I will include for pg, redis and mysql momentarily. Not sure about other ones such as http and dns, what do you suggest?

I was thinking to handle http and dns use-case in separate PR and not pollute this one. Looks like we need to do some extra refactoring to achieve that. @dyladan WDYT?

[OlivierAlbertini]

Thanks you!

[naseemkullah]

Alright I think I will stop here with this PR, we can look into adding it to mysql,dns,http and other plugins in a separate PR.

[mayurkale22]

This is nice, thank you @naseemkullah :)

[naseemkullah]

My pleasure @mayurkale22 !