add contract tests for instrumentation of the following:

* aws sdk
* http
* mongoose
* mongodb
* mysql2

Author: pxaws

.idea/.gitignore

@@ -1,42 +1,55 @@
-# Introduction
+## Introduction
 
 This directory contain contract tests that exist to prevent regressions. They cover:
+
 * [OpenTelemetry semantic conventions](https://github.com/open-telemetry/semantic-conventions/).
 * Application Signals-specific attributes.
 
-# How it works?
+## How it works?
 
 The tests present here rely on the auto-instrumentation of a sample application which will send telemetry signals to a mock collector. The tests will use the data collected by the mock collector to perform assertions and validate that the contracts are being respected.
 
-# Types of tested frameworks
+## Types of tested frameworks
 
 The frameworks and libraries that are tested in the contract tests should fall in the following categories (more can be added on demand):
-* http-servers - applications meant to test http servers (e.g. Django).
-* http-clients - applications meant to test http clients (e.g. requests).
-* aws-sdk - Applications meant to test the AWS SDK (e.g. botocore).
-* database-clients - Applications meant to test database clients (e.g. psychopg2).
+
+* http-servers - applications meant to test http servers (e.g. http module in node.js).
+* aws-sdk - Applications meant to test the AWS SDK (e.g. AWS SDK for JavaScript v3).
+* database-clients - Applications meant to test database clients (e.g. mysql2, Mongoose, Mongodb).
 
 When testing a framework, we will create a sample application. The sample applications are stored following this convention: `contract-tests/images/applications/<framework-name>`.
 
-# Adding tests for a new library or framework
+## Adding tests for a new library or framework
 
 The steps to add a new test for a library or framework are:
+
 * Create a sample application.
-    * The sample application should be created in `contract-tests/images/applications/<framework-name>`.
-    * Implement a `pyproject.toml` (to ensure code style checks run), `Dockerfile`, and `requirements.txt` file. See the `requests` application for an example of this.
+  * The sample application should be created in `contract-tests/images/applications/<framework-name>`.
+  * Implement a node.js application and create a `Dockerfile` to containerize the application
 * Add a test class for the sample application.
-    * The test class should be created in `contract-tests/tests/amazon/<framework-name>`.
-    * The test class should extend `contract_test_base.py`
+  * The test class should be created in `contract-tests/tests/amazon/<framework-name>`.
+  * The test class should extend `contract_test_base.py`
 
-# How to run the tests locally?
+## How to run the tests locally?
 
 Pre-requirements:
+
 * Have `docker` installed and running - verify by running the `docker` command.
 
 Steps:
-* From `aws-otel-python-instrumentation` dir, execute:
+
+* From `aws-otel-js-instrumentation` dir, execute:
+
 ```sh
+# create a virtual environment in python for the tests
+python3 -m venv venv
+source venv/bin/activate
+# build the instrumentation SDK
 ./scripts/build_and_install_distro.sh
+# build the relevant images for sample app and build the contract tests
 ./scripts/set-up-contract-tests.sh
+# run all the tests
 pytest contract-tests/tests
-```
+# exit the virtual python environment
+deactivate
+```

.idea/aws-otel-js-instrumentation.iml

@@ -0,0 +1,22 @@
+# Use an official Node.js runtime as the base image
+FROM node:20-alpine
+#FROM node:20
+
+# Set the working directory inside the container
+WORKDIR /aws-sdk
+
+# Copy the relevant files
+COPY ./dist/$DISTRO /aws-sdk
+COPY ./contract-tests/images/applications/aws-sdk /aws-sdk
+
+
+ARG DISTRO
+# Install dependencies
+RUN npm install
+RUN npm install ./${DISTRO}
+
+# Expose the port the app runs on
+EXPOSE 8080
+
+# Run the app with nodejs auto instrumentation
+CMD ["node", "--require", "@aws/aws-distro-opentelemetry-node-autoinstrumentation/register", "server.js"]