add unit tests

Author: liustve

aws-distro-opentelemetry-node-autoinstrumentation/src/exporter/otlp/aws/common/aws-authenticator.ts

@@ -37,7 +37,7 @@ export class AwsAuthenticator {
     if (dependenciesLoaded) {
       const url = new URL(endpoint);
 
-      if (serializedData == undefined) {
+      if (serializedData === undefined) {
         diag.error('Given serialized data is undefined. Not authenticating.');
         return headers;
       }

aws-distro-opentelemetry-node-autoinstrumentation/src/exporter/otlp/aws/logs/otlp-aws-log-exporter.ts

@@ -19,7 +19,7 @@ import { ExportResult } from '@opentelemetry/core';
 export class OTLPAwsLogExporter extends OTLPProtoLogExporter {
   private endpoint: string;
   private region: string;
-  private authenticator;
+  private authenticator: AwsAuthenticator;
 
   constructor(endpoint: string, config?: OTLPExporterNodeConfigBase) {
     super(changeUrlConfig(endpoint, config));

aws-distro-opentelemetry-node-autoinstrumentation/src/exporter/otlp/aws/traces/otlp-aws-span-exporter.ts

@@ -19,7 +19,7 @@ import { changeUrlConfig } from '../common/utils';
 export class OTLPAwsSpanExporter extends OTLPProtoTraceExporter {
   private endpoint: string;
   private region: string;
-  private authenticator;
+  private authenticator: AwsAuthenticator;
 
   constructor(endpoint: string, config?: OTLPExporterNodeConfigBase) {
     super(changeUrlConfig(endpoint, config));

aws-distro-opentelemetry-node-autoinstrumentation/test/exporter/otlp/aws/common/test-utils.test.ts

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export const AWS_AUTH_PATH = '../../../../../src/exporter/otlp/aws/common/aws-authenticator';
+export const AWS_SPAN_EXPORTER_PATH = '../../../../../src/exporter/otlp/aws/traces/otlp-aws-span-exporter';
+export const AWS_LOG_EXPORTER_PATH = '../../../../../src/exporter/otlp/aws/logs/otlp-aws-log-exporter';
+
+export const SIGNATURE_V4_MODULE = '@smithy/signature-v4';
+export const CREDENTIAL_PROVIDER_MODULE = '@aws-sdk/credential-provider-node';
+export const SHA_256_MODULE = '@aws-crypto/sha256-js';
+export const AWS_HTTP_MODULE = '@smithy/protocol-http';
+
+export const AWS_OTLP_TRACES_ENDPOINT = 'https://xray.us-east-1.amazonaws.com';
+export const AWS_OTLP_TRACES_ENDPOINT_PATH = '/v1/traces';
+
+export const AWS_OTLP_LOGS_ENDPOINT = 'https://logs.us-east-1.amazonaws.com';
+export const AWS_OTLP_LOGS_ENDPOINT_PATH = '/v1/logs';
+
+export const AUTHORIZATION_HEADER = 'authorization';
+export const X_AMZ_DATE_HEADER = 'x-amz-date';
+export const X_AMZ_SECURITY_TOKEN_HEADER = 'x-amz-security-token';

aws-distro-opentelemetry-node-autoinstrumentation/test/exporter/otlp/aws/logs/otlp-aws-log-exporter.test.ts

@@ -0,0 +1,78 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import expect from 'expect';
+import {
+  AWS_OTLP_LOGS_ENDPOINT,
+  AWS_OTLP_LOGS_ENDPOINT_PATH,
+  AUTHORIZATION_HEADER,
+  X_AMZ_DATE_HEADER,
+  X_AMZ_SECURITY_TOKEN_HEADER,
+  AWS_LOG_EXPORTER_PATH,
+} from '../common/test-utils.test';
+import * as sinon from 'sinon';
+import * as proxyquire from 'proxyquire';
+import * as nock from 'nock';
+
+const EXPECTED_AUTH_HEADER = 'AWS4-HMAC-SHA256 Credential=test_key/some_date/us-east-1/xray/aws4_request';
+const EXPECTED_AUTH_X_AMZ_DATE = 'some_date';
+const EXPECTED_AUTH_SECURITY_TOKEN = 'test_token';
+
+describe('OTLPAwsLogExporter', () => {
+  let sandbox: sinon.SinonSandbox;
+  let scope: nock.Scope;
+  let mockModule: any;
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox();
+
+    scope = nock(AWS_OTLP_LOGS_ENDPOINT)
+      .post(AWS_OTLP_LOGS_ENDPOINT_PATH)
+      .reply((uri: any, requestBody: any) => {
+        return [200, ''];
+      });
+
+    mockModule = proxyquire(AWS_LOG_EXPORTER_PATH, {
+      '../common/aws-authenticator': {
+        AwsAuthenticator: class MockAwsAuthenticator {
+          constructor() {}
+          async authenticate(endpoint: string, headers: Record<string, string>) {
+            return {
+              ...headers,
+              [AUTHORIZATION_HEADER]: EXPECTED_AUTH_HEADER,
+              [X_AMZ_DATE_HEADER]: EXPECTED_AUTH_X_AMZ_DATE,
+              [X_AMZ_SECURITY_TOKEN_HEADER]: EXPECTED_AUTH_SECURITY_TOKEN,
+            };
+          }
+        },
+      },
+    });
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+  });
+
+  it('Should inject SigV4 Headers successfully', done => {
+    const exporter = new mockModule.OTLPAwsLogExporter(AWS_OTLP_LOGS_ENDPOINT + AWS_OTLP_LOGS_ENDPOINT_PATH);
+
+    exporter
+      .export([], () => {})
+      .then(() => {
+        scope.on('request', (req, interceptor, body) => {
+          const headers = req.headers;
+          expect(headers).toHaveProperty(AUTHORIZATION_HEADER.toLowerCase());
+          expect(headers).toHaveProperty(X_AMZ_SECURITY_TOKEN_HEADER.toLowerCase());
+          expect(headers).toHaveProperty(X_AMZ_DATE_HEADER.toLowerCase());
+
+          expect(headers[AUTHORIZATION_HEADER.toLowerCase()]).toBe(EXPECTED_AUTH_HEADER);
+          expect(headers[X_AMZ_SECURITY_TOKEN_HEADER.toLowerCase()]).toBe(EXPECTED_AUTH_SECURITY_TOKEN);
+          expect(headers[X_AMZ_DATE_HEADER.toLowerCase()]).toBe(EXPECTED_AUTH_X_AMZ_DATE);
+
+          expect(headers['content-type']).toBe('application/x-protobuf');
+          expect(headers['user-agent']).toMatch(/^OTel-OTLP-Exporter-JavaScript\/\d+\.\d+\.\d+$/);
+          done();
+        });
+      });
+  });
+});

aws-distro-opentelemetry-node-autoinstrumentation/test/exporter/otlp/aws/traces/otlp-aws-span-exporter.test.ts

@@ -0,0 +1,77 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import expect from 'expect';
+import {
+  AWS_OTLP_TRACES_ENDPOINT,
+  AUTHORIZATION_HEADER,
+  X_AMZ_DATE_HEADER,
+  X_AMZ_SECURITY_TOKEN_HEADER,
+  AWS_OTLP_TRACES_ENDPOINT_PATH,
+  AWS_SPAN_EXPORTER_PATH,
+} from '../common/test-utils.test';
+import * as sinon from 'sinon';
+import * as proxyquire from 'proxyquire';
+import * as nock from 'nock';
+
+const EXPECTED_AUTH_HEADER = 'AWS4-HMAC-SHA256 Credential=test_key/some_date/us-east-1/xray/aws4_request';
+const EXPECTED_AUTH_X_AMZ_DATE = 'some_date';
+const EXPECTED_AUTH_SECURITY_TOKEN = 'test_token';
+
+describe('OTLPAwsSpanExporter', () => {
+  let sandbox: sinon.SinonSandbox;
+  let scope: nock.Scope;
+  let mockModule: any;
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox();
+
+    scope = nock(AWS_OTLP_TRACES_ENDPOINT)
+      .post(AWS_OTLP_TRACES_ENDPOINT_PATH)
+      .reply((uri: any, requestBody: any) => {
+        return [200, ''];
+      });
+
+    mockModule = proxyquire(AWS_SPAN_EXPORTER_PATH, {
+      '../common/aws-authenticator': {
+        AwsAuthenticator: class MockAwsAuthenticator {
+          constructor() {}
+          async authenticate(endpoint: string, headers: Record<string, string>) {
+            return {
+              ...headers,
+              [AUTHORIZATION_HEADER]: EXPECTED_AUTH_HEADER,
+              [X_AMZ_DATE_HEADER]: EXPECTED_AUTH_X_AMZ_DATE,
+              [X_AMZ_SECURITY_TOKEN_HEADER]: EXPECTED_AUTH_SECURITY_TOKEN,
+            };
+          }
+        },
+      },
+    });
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+  });
+
+  it('Should inject SigV4 Headers successfully', done => {
+    const exporter = new mockModule.OTLPAwsSpanExporter(AWS_OTLP_TRACES_ENDPOINT + AWS_OTLP_TRACES_ENDPOINT_PATH);
+
+    exporter
+      .export([], () => {})
+      .then(() => {
+        scope.on('request', (req, interceptor, body) => {
+          const headers = req.headers;
+          expect(headers).toHaveProperty(AUTHORIZATION_HEADER.toLowerCase());
+          expect(headers).toHaveProperty(X_AMZ_SECURITY_TOKEN_HEADER.toLowerCase());
+          expect(headers).toHaveProperty(X_AMZ_DATE_HEADER.toLowerCase());
+
+          expect(headers[AUTHORIZATION_HEADER.toLowerCase()]).toBe(EXPECTED_AUTH_HEADER);
+          expect(headers[X_AMZ_SECURITY_TOKEN_HEADER.toLowerCase()]).toBe(EXPECTED_AUTH_SECURITY_TOKEN);
+          expect(headers[X_AMZ_DATE_HEADER.toLowerCase()]).toBe(EXPECTED_AUTH_X_AMZ_DATE);
+
+          expect(headers['content-type']).toBe('application/x-protobuf');
+          expect(headers['user-agent']).toMatch(/^OTel-OTLP-Exporter-JavaScript\/\d+\.\d+\.\d+$/);
+          done();
+        });
+      });
+  });
+});