test(gcp-detector): properly isolate GcpDetectorIntegration.test.ts (#3005)

Author: aabmass

packages/resource-detector-gcp/test/detectors/GcpDetectorIntegration.test.ts

@@ -14,64 +14,32 @@
  * limitations under the License.
  */
 
-// NOTE: in other test the modules have already been required and cached (`GcpDetector.test.ts`)
-// so SDK cannot instrument them. We make sure we load fresh copies so RITM hook does its work.
-// we remove all the require chain: detector -> gcp-metadata -> gaxios -> node-fetch
-// but kepp other cache entries to not slow down the test more than necessary
-const modules = [
-  'opentelemetry-resource-detector-gcp',
-  'gcp-metadata',
-  'gaxios',
-  'node-fetch',
-];
-Object.keys(require.cache)
-  .filter(path => modules.some(m => path.includes(m)))
-  .forEach(key => {
-    delete require.cache[key];
-  });
-
-import * as assert from 'assert';
-
-import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
 import {
-  InMemorySpanExporter,
-  SimpleSpanProcessor,
-} from '@opentelemetry/sdk-trace-base';
-import { NodeSDK } from '@opentelemetry/sdk-node';
-import { detectResources } from '@opentelemetry/resources';
+  runTestFixture,
+  TestCollector,
+} from '@opentelemetry/contrib-test-utils';
+import * as assert from 'assert';
 
-describe('[Integration] GcpDetector', () => {
+describe('[Integration] GcpDetector', async () => {
   it('should not start spans for detector requests', async () => {
-    const memoryExporter = new InMemorySpanExporter();
-    const sdk = new NodeSDK({
-      instrumentations: [new HttpInstrumentation()],
-      spanProcessors: [new SimpleSpanProcessor(memoryExporter)],
+    await runTestFixture({
+      cwd: __dirname,
+      argv: ['fixtures/detect-with-http-instrumentation.mjs'],
+      env: {
+        NODE_OPTIONS:
+          '--experimental-loader=@opentelemetry/instrumentation/hook.mjs',
+        METADATA_SERVER_DETECTION: 'assume-present',
+      },
+      checkResult: (err, stdout, stderr) => {
+        assert.ifError(err);
+      },
+      checkCollector: (collector: TestCollector) => {
+        assert.equal(
+          collector.spans.length,
+          0,
+          'no spans exported for GcpDetector'
+        );
+      },
     });
-
-    sdk.start();
-
-    process.env.METADATA_SERVER_DETECTION = 'assume-present';
-
-    // NOTE: detectors implementing the `DetectorSync` interface and starting
-    // HTTP requests within the `detect` method will produce Noop Spans since
-    // the SDK resolves the trace provider after resource detectors are triggered.
-    // Ref: https://github.com/open-telemetry/opentelemetry-js/blob/38f6689480d28dcbdafcb7b5ba4b14025328ffda/experimental/packages/opentelemetry-sdk-node/src/sdk.ts#L210-L240
-    //
-    // So having the detector in the config would result in no spans for Azure requests
-    // being exported which is what we want. Although we may think we're safe of sending
-    // internal tracing any change that delays these request will result in internal
-    // tracing being exported. We do the detection outside the SDK constructor to have such
-    // scenario.
-    const { gcpDetector } = require('../../build/src/detectors/GcpDetector');
-    const resource = detectResources({ detectors: [gcpDetector] });
-    await resource.waitForAsyncAttributes?.();
-
-    // Wait for the next loop to let the span close properly
-    await new Promise(r => setTimeout(r, 0));
-    const spans = memoryExporter.getFinishedSpans();
-
-    assert.equal(spans.length, 0, 'no spans exported for GcpDetector');
-
-    await sdk.shutdown();
   }).timeout(15000);
 });

packages/resource-detector-gcp/test/detectors/fixtures/detect-with-http-instrumentation.mjs

@@ -0,0 +1,34 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
+import { NodeSDK } from '@opentelemetry/sdk-node';
+import { detectResources } from '@opentelemetry/resources';
+
+const sdk = new NodeSDK({
+  instrumentations: [new HttpInstrumentation()],
+});
+sdk.start();
+
+// Defer import until after instrumentation is added
+const { gcpDetector } = await import(
+  '../../../build/src/detectors/GcpDetector.js'
+);
+const resource = detectResources({ detectors: [gcpDetector] });
+await resource.waitForAsyncAttributes?.();
+
+console.log(resource);
+
+await sdk.shutdown();