refactor(instrumentation): change tests to allow use of mocha context (#5591)

Signed-off-by: Adrien Raimbault <[email protected]>

Author: Assstra

experimental/packages/opentelemetry-instrumentation/test/common/Instrumentation.test.ts

@@ -45,26 +45,26 @@ class TestInstrumentation extends InstrumentationBase<TestInstrumentationConfig>
   }
 }
 
-describe('BaseInstrumentation', () => {
+describe('BaseInstrumentation', function () {
   let instrumentation: Instrumentation;
   beforeEach(() => {
     instrumentation = new TestInstrumentation();
   });
 
-  it('should create an instance', () => {
+  it('should create an instance', function () {
     assert.ok(instrumentation instanceof InstrumentationBase);
   });
 
-  it('should have a name', () => {
+  it('should have a name', function () {
     assert.deepStrictEqual(instrumentation.instrumentationName, 'test');
   });
 
-  it('should have a version', () => {
+  it('should have a version', function () {
     assert.deepStrictEqual(instrumentation.instrumentationVersion, '1.0.0');
   });
 
-  describe('constructor', () => {
-    it('should enable instrumentation by default', () => {
+  describe('constructor', function () {
+    it('should enable instrumentation by default', function () {
       let enableCalled = false;
       let updateMetricInstrumentsCalled = false;
       class TestInstrumentation2 extends TestInstrumentation {
@@ -81,12 +81,12 @@ describe('BaseInstrumentation', () => {
     });
   });
 
-  describe('setMeterProvider', () => {
+  describe('setMeterProvider', function () {
     let otelTestingMeterProvider: MeterProvider;
     beforeEach(() => {
       otelTestingMeterProvider = new MeterProvider();
     });
-    it('should call _updateMetricInstruments', () => {
+    it('should call _updateMetricInstruments', function () {
       let called = true;
       class TestInstrumentation2 extends TestInstrumentation {
         override _updateMetricInstruments() {
@@ -99,8 +99,8 @@ describe('BaseInstrumentation', () => {
     });
   });
 
-  describe('setLoggerProvider', () => {
-    it('should get a logger from provider', () => {
+  describe('setLoggerProvider', function () {
+    it('should get a logger from provider', function () {
       let called = true;
       class TestLoggerProvider extends LoggerProvider {
         override getLogger(name: any, version?: any, options?: any) {
@@ -116,8 +116,8 @@ describe('BaseInstrumentation', () => {
     });
   });
 
-  describe('getConfig', () => {
-    it('should return instrumentation config, "enabled" should be true by default', () => {
+  describe('getConfig', function () {
+    it('should return instrumentation config, "enabled" should be true by default', function () {
       const instrumentation: Instrumentation = new TestInstrumentation({
         isActive: false,
       });
@@ -129,8 +129,8 @@ describe('BaseInstrumentation', () => {
     });
   });
 
-  describe('setConfig', () => {
-    it('should set a new config for instrumentation', () => {
+  describe('setConfig', function () {
+    it('should set a new config for instrumentation', function () {
       const instrumentation: Instrumentation = new TestInstrumentation();
       const config: TestInstrumentationConfig = {
         isActive: true,
@@ -141,7 +141,7 @@ describe('BaseInstrumentation', () => {
       assert.strictEqual(configuration.isActive, true);
     });
 
-    it('should ensure "enabled" defaults to true', () => {
+    it('should ensure "enabled" defaults to true', function () {
       const instrumentation: Instrumentation = new TestInstrumentation();
       const config: TestInstrumentationConfig = {
         isActive: true,
@@ -154,7 +154,7 @@ describe('BaseInstrumentation', () => {
     });
   });
 
-  describe('getModuleDefinitions', () => {
+  describe('getModuleDefinitions', function () {
     const moduleDefinition: InstrumentationModuleDefinition = {
       name: 'foo',
       patch: moduleExports => {},
@@ -164,7 +164,7 @@ describe('BaseInstrumentation', () => {
       supportedVersions: ['*'],
     };
 
-    it('should return single module definition from init() as array ', () => {
+    it('should return single module definition from init() as array ', function () {
       class TestInstrumentation2 extends TestInstrumentation {
         override init() {
           return moduleDefinition;
@@ -177,7 +177,7 @@ describe('BaseInstrumentation', () => {
       ]);
     });
 
-    it('should return multiple module definitions from init() as array ', () => {
+    it('should return multiple module definitions from init() as array ', function () {
       class TestInstrumentation2 extends TestInstrumentation {
         override init() {
           return [moduleDefinition, moduleDefinition, moduleDefinition];
@@ -192,7 +192,7 @@ describe('BaseInstrumentation', () => {
       ]);
     });
 
-    it('should return void from init() as empty array ', () => {
+    it('should return void from init() as empty array ', function () {
       class TestInstrumentation2 extends TestInstrumentation {
         override init() {
           return;
@@ -203,8 +203,8 @@ describe('BaseInstrumentation', () => {
       assert.deepStrictEqual(instrumentation.getModuleDefinitions(), []);
     });
 
-    describe('runInstrumentationEventHook', () => {
-      it('should call the hook', () => {
+    describe('runInstrumentationEventHook', function () {
+      it('should call the hook', function () {
         const instrumentation = new TestInstrumentation({});
         let called = false;
         const hook = () => {
@@ -214,12 +214,12 @@ describe('BaseInstrumentation', () => {
         assert.strictEqual(called, true);
       });
 
-      it('empty hook should work', () => {
+      it('empty hook should work', function () {
         const instrumentation = new TestInstrumentation({});
         instrumentation.testRunHook(undefined);
       });
 
-      it('exception in hook should not crash', () => {
+      it('exception in hook should not crash', function () {
         const instrumentation = new TestInstrumentation({});
         const hook = () => {
           throw new Error('test');

experimental/packages/opentelemetry-instrumentation/test/common/autoLoader.test.ts

@@ -52,7 +52,7 @@ class FooInstrumentation extends InstrumentationBase {
   override disable() {}
 }
 
-describe('autoLoader', () => {
+describe('autoLoader', function () {
   // eslint-disable-next-line @typescript-eslint/ban-types
   let unload: Function | undefined;
 
@@ -64,8 +64,8 @@ describe('autoLoader', () => {
     }
   });
 
-  describe('registerInstrumentations', () => {
-    describe('InstrumentationBase', () => {
+  describe('registerInstrumentations', function () {
+    describe('InstrumentationBase', function () {
       let instrumentation: InstrumentationBase;
       let enableSpy: sinon.SinonSpy;
       let setTracerProviderSpy: sinon.SinonSpy;
@@ -96,7 +96,7 @@ describe('autoLoader', () => {
         }
       });
 
-      it('should enable disabled instrumentation', () => {
+      it('should enable disabled instrumentation', function () {
         if (typeof unload === 'function') {
           unload();
           unload = undefined;
@@ -117,23 +117,23 @@ describe('autoLoader', () => {
         assert.strictEqual(enableSpy.callCount, 1);
       });
 
-      it('should NOT enable enabled instrumentation', () => {
+      it('should NOT enable enabled instrumentation', function () {
         assert.strictEqual(enableSpy.callCount, 0);
       });
 
-      it('should set TracerProvider', () => {
+      it('should set TracerProvider', function () {
         assert.strictEqual(setTracerProviderSpy.callCount, 1);
         assert.ok(setTracerProviderSpy.lastCall.args[0] === tracerProvider);
         assert.strictEqual(setTracerProviderSpy.lastCall.args.length, 1);
       });
 
-      it('should set MeterProvider', () => {
+      it('should set MeterProvider', function () {
         assert.strictEqual(setMeterProviderSpy.callCount, 1);
         assert.ok(setMeterProviderSpy.lastCall.args[0] === meterProvider);
         assert.strictEqual(setMeterProviderSpy.lastCall.args.length, 1);
       });
 
-      it('should set LoggerProvider', () => {
+      it('should set LoggerProvider', function () {
         assert.strictEqual(setLoggerProviderSpy.callCount, 1);
         assert.ok(setLoggerProviderSpy.lastCall.args[0] === loggerProvider);
         assert.strictEqual(setLoggerProviderSpy.lastCall.args.length, 1);

experimental/packages/opentelemetry-instrumentation/test/common/semver.test.ts

@@ -43,8 +43,8 @@ import { satisfies, SatisfiesOptions } from '../../src/semver';
 const rangeInclude = require('./third-party/node-semver/range-include.js');
 const rangeExclude = require('./third-party/node-semver/range-exclude.js');
 
-describe('SemVer', () => {
-  describe('satisfies', () => {
+describe('SemVer', function () {
+  describe('satisfies', function () {
     function isOptionsSupported(options: any): boolean {
       // We don't support
       // - boolean typed options
@@ -55,7 +55,7 @@ describe('SemVer', () => {
       return true;
     }
 
-    it('when range is included', () => {
+    it('when range is included', function () {
       rangeInclude.forEach(([range, ver, options]: [string, string, any]) => {
         if (!isOptionsSupported(options)) {
           return;
@@ -66,7 +66,7 @@ describe('SemVer', () => {
         );
       });
     });
-    it('when range is not included', () => {
+    it('when range is not included', function () {
       rangeExclude.forEach(([range, ver, options]: [string, string, any]) => {
         if (!isOptionsSupported(options)) {
           return;
@@ -77,7 +77,7 @@ describe('SemVer', () => {
         );
       });
     });
-    it('invalid ranges never satisfied (but do not throw)', () => {
+    it('invalid ranges never satisfied (but do not throw)', function () {
       const cases = [
         ['blerg', '1.2.3'],
         ['git+https://user:[email protected]/foo', '123.0.0', true],

experimental/packages/opentelemetry-instrumentation/test/common/utils.test.ts

@@ -21,9 +21,9 @@ import {
   safeExecuteInTheMiddleAsync,
 } from '../../src';
 
-describe('isWrapped', () => {
-  describe('when function is wrapped', () => {
-    it('should return true', () => {
+describe('isWrapped', function () {
+  describe('when function is wrapped', function () {
+    it('should return true', function () {
       const obj: any = {
         wrapMe: function () {},
       };
@@ -34,8 +34,8 @@ describe('isWrapped', () => {
       assert.deepStrictEqual(isWrapped(obj.wrapMe), true);
     });
   });
-  describe('when function is NOT wrapped', () => {
-    it('should return false', () => {
+  describe('when function is NOT wrapped', function () {
+    it('should return false', function () {
       const obj: any = {
         wrapMe: function () {},
       };
@@ -47,8 +47,8 @@ describe('isWrapped', () => {
   });
 });
 
-describe('safeExecuteInTheMiddle', () => {
-  it('should not throw error', () => {
+describe('safeExecuteInTheMiddle', function () {
+  it('should not throw error', function () {
     safeExecuteInTheMiddle(
       () => {
         return 'foo';
@@ -59,7 +59,7 @@ describe('safeExecuteInTheMiddle', () => {
       true
     );
   });
-  it('should throw error', () => {
+  it('should throw error', function () {
     const error = new Error('test');
     try {
       safeExecuteInTheMiddle(
@@ -74,7 +74,7 @@ describe('safeExecuteInTheMiddle', () => {
       assert.deepStrictEqual(error, err);
     }
   });
-  it('should return result', () => {
+  it('should return result', function () {
     const result = safeExecuteInTheMiddle(
       () => {
         return 1;
@@ -88,8 +88,8 @@ describe('safeExecuteInTheMiddle', () => {
   });
 });
 
-describe('safeExecuteInTheMiddleAsync', () => {
-  it('should not throw error', () => {
+describe('safeExecuteInTheMiddleAsync', function () {
+  it('should not throw error', function () {
     safeExecuteInTheMiddleAsync(
       async () => {
         await setTimeout(() => {}, 1);
@@ -101,7 +101,7 @@ describe('safeExecuteInTheMiddleAsync', () => {
       true
     );
   });
-  it('should throw error', async () => {
+  it('should throw error', async function () {
     const error = new Error('test');
     try {
       await safeExecuteInTheMiddleAsync(
@@ -117,7 +117,7 @@ describe('safeExecuteInTheMiddleAsync', () => {
       assert.deepStrictEqual(error, err);
     }
   });
-  it('should return result', async () => {
+  it('should return result', async function () {
     const result = await safeExecuteInTheMiddleAsync(
       async () => {
         await setTimeout(() => {}, 1);