Various fixes

* Make contract tests runnable from project root
* Use public ecr version of python
* Fix py3.8 issues (dict/list/set not subscriptable, need to use Dict/List/Set)
* Remove `--no-isolation` from set up script (initially added as it solves a local problem with my set up, but causes general problems)

Author: thpierce

contract-tests/README.md

@@ -32,12 +32,11 @@ The steps to add a new test for a library or framework are:
 
 Pre-requirements:
 * Have `docker` installed and running - verify by running the `docker` command.
-* Create `aws-otel-python-instrumentation/contract-tests/dist` folder
-* Copy the `aws_opentelemetry_distro` wheel file to `aws-otel-python-instrumentation/contract-tests/dist` folder
+* Ensure the `aws_opentelemetry_distro` wheel file exists in to `aws-otel-python-instrumentation/dist` folder
 
-From `aws-otel-python-instrumentation/contract-tests` execute:
+From `aws-otel-python-instrumentation` dir, execute:
 
 ```
-./set-up-contract-tests.sh
-pytest tests
+./contract-tests/set-up-contract-tests.sh
+pytest contract-tests/tests
 ```

contract-tests/images/applications/requests/Dockerfile

@@ -1,10 +1,10 @@
 # Meant to be run from aws-otel-python-instrumentation/contract-tests.
 # Assumes existence of dist/aws_opentelemetry_distro-<pkg_version>-py3-none-any.whl.
 # Assumes filename of aws_opentelemetry_distro-<pkg_version>-py3-none-any.whl is passed in as "DISTRO" arg.
-FROM python:3.9-slim
+FROM public.ecr.aws/docker/library/python:3.11-slim
 WORKDIR /requests
-COPY ./dist /requests
-COPY ./images/applications/requests /requests
+COPY ./dist/$DISTRO /requests
+COPY ./contract-tests/images/applications/requests /requests
 
 ARG DISTRO
 RUN pip install -r requirements.txt && pip install ${DISTRO} --force-reinstall

contract-tests/images/mock-collector/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.9-slim
+FROM public.ecr.aws/docker/library/python:3.11-slim
 WORKDIR /mock-collector
 COPY . /mock-collector
 

contract-tests/images/mock-collector/mock_collector_client.py

@@ -3,7 +3,7 @@
 from datetime import datetime, timedelta
 from logging import Logger, getLogger
 from time import sleep
-from typing import Callable, List, TypeVar
+from typing import Callable, List, Set, TypeVar
 
 from google.protobuf.internal.containers import RepeatedScalarFieldContainer
 from grpc import Channel, insecure_channel
@@ -87,7 +87,7 @@ def wait_condition(exported: List[ExportTraceServiceRequest], current: List[Expo
                         spans.append(ResourceScopeSpan(resource_span, scope_span, span))
         return spans
 
-    def get_metrics(self, present_metrics: set[str]) -> List[ResourceScopeMetric]:
+    def get_metrics(self, present_metrics: Set[str]) -> List[ResourceScopeMetric]:
         """Get all metrics that are currently stored in the mock collector.
 
         Returns:
@@ -103,7 +103,7 @@ def get_export() -> List[ExportMetricsServiceRequest]:
         def wait_condition(
             exported: List[ExportMetricsServiceRequest], current: List[ExportMetricsServiceRequest]
         ) -> bool:
-            received_metrics: set[str] = set()
+            received_metrics: Set[str] = set()
             for exported_metric in current:
                 for resource_metric in exported_metric.resource_metrics:
                     for scope_metric in resource_metric.scope_metrics:
@@ -121,7 +121,7 @@ def wait_condition(
         return metrics
 
 
-def _wait_for_content(get_export: Callable[[], List[T]], wait_condition: Callable[[list[T], List[T]], bool]) -> List[T]:
+def _wait_for_content(get_export: Callable[[], List[T]], wait_condition: Callable[[List[T], List[T]], bool]) -> List[T]:
     # Verify that there is no more data to be received
     deadline: datetime = datetime.now() + _TIMEOUT_DELAY
     exported: List[T] = []

contract-tests/set-up-contract-tests.sh

@@ -2,8 +2,8 @@
 # Check script is running in contract-tests
 current_path=`pwd`
 current_dir="${current_path##*/}"
-if [ "$current_dir" != "contract-tests" ]; then
-  echo "Please run from contract-tests dir"
+if [ "$current_dir" != "aws-otel-python-instrumentation" ]; then
+  echo "Please run from aws-otel-python-instrumentation dir"
   exit
 fi
 
@@ -12,38 +12,36 @@ rm -rf dist/mock_collector*
 rm -rf dist/contract_tests*
 
 # Create mock-collector image
-cd images/mock-collector
+cd contract-tests/images/mock-collector
 docker build . -t aws-appsignals-mock-collector-python
-cd ../..
+
 
 # Find and store aws_opentelemetry_distro whl file
-cd dist
-DISTRO=(aws_opentelemetry_distro*.whl)
-if [ "$DISTRO" = "aws_opentelemetry_distro*.whl" ]; then
+cd ../../../dist
+DISTRO=(aws_opentelemetry_distro-*-py3-none-any.whl)
+if [ "$DISTRO" = "aws_opentelemetry_distro-*-py3-none-any.whl" ]; then
  echo "Could not find aws_opentelemetry_distro whl file in dist dir."
  exit 1
 fi
-cd ..
 
 # Create application images
-for dir in images/applications/*
+cd ..
+for dir in contract-tests/images/applications/*
 do
   application="${dir##*/}"
   docker build . -t aws-appsignals-tests-${application}-app -f ${dir}/Dockerfile --build-arg="DISTRO=${DISTRO}"
 done
 
 # Build and install mock-collector
-cd images/mock-collector
-python3 -m build --outdir ../../dist --no-isolation
-cd ../../dist
+cd contract-tests/images/mock-collector
+python3 -m build --outdir ../../../dist
+cd ../../../dist
 pip install mock_collector-1.0.0-py3-none-any.whl --force-reinstall
 
 # Build and install contract-tests
-cd ../tests
-python3 -m build --outdir ../dist --no-isolation
-cd ../dist
+cd ../contract-tests/tests
+python3 -m build --outdir ../../dist
+cd ../../dist
 # --force-reinstall causes `ERROR: No matching distribution found for mock-collector==1.0.0`, but uninstalling and reinstalling works pretty reliably.
 pip uninstall contract-tests -y
-pip install contract_tests-1.0.0-py3-none-any.whl
-
-cd ..
+pip install contract_tests-1.0.0-py3-none-any.whl

contract-tests/tests/test/amazon/base/contract_test_base.py

@@ -1,7 +1,7 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 from logging import INFO, Logger, getLogger
-from typing import List
+from typing import Dict, List
 from unittest import TestCase
 
 from docker import DockerClient
@@ -71,7 +71,7 @@ def setUp(self) -> None:
             .with_name(self.get_application_image_name())
         )
 
-        extra_env: dict[str, str] = self.get_application_extra_environment_variables()
+        extra_env: Dict[str, str] = self.get_application_extra_environment_variables()
         for key in extra_env:
             self._application.with_env(key, extra_env.get(key))
         self._application.start()
@@ -96,7 +96,7 @@ def tearDown(self) -> None:
     def get_application_port(self) -> int:
         return 8080
 
-    def get_application_extra_environment_variables(self) -> dict[str, str]:
+    def get_application_extra_environment_variables(self) -> Dict[str, str]:
         return {}
 
     def get_application_network_aliases(self) -> List[str]:

contract-tests/tests/test/amazon/requests/requests_test.py

@@ -1,6 +1,6 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
-from typing import List
+from typing import Dict, List
 
 from mock_collector_client import ResourceScopeMetric, ResourceScopeSpan
 from requests import Response, request
@@ -37,7 +37,7 @@ def get_application_network_aliases(self) -> List[str]:
         return ["backend"]
 
     @override
-    def get_application_extra_environment_variables(self) -> dict[str, str]:
+    def get_application_extra_environment_variables(self) -> Dict[str, str]:
         """
         This does not appear to do anything, as it does not seem that OTEL supports peer service for Python. Keeping
         for consistency at this time.
@@ -96,7 +96,7 @@ def _assert_aws_span_attributes(
         self._assert_aws_attributes(target_spans[0].attributes, method, path)
 
     def _assert_aws_attributes(self, attributes_list: List[KeyValue], method: str, endpoint: str) -> None:
-        attributes_dict: dict[str, AnyValue] = self._get_attributes_dict(attributes_list)
+        attributes_dict: Dict[str, AnyValue] = self._get_attributes_dict(attributes_list)
         self._assert_str_attribute(attributes_dict, AWS_LOCAL_SERVICE, self.get_application_otel_service_name())
         # InternalOperation as OTEL does not instrument the basic server we are using, so the client span is a local
         # root.
@@ -108,8 +108,8 @@ def _assert_aws_attributes(self, attributes_list: List[KeyValue], method: str, e
         # See comment above AWS_LOCAL_OPERATION
         self._assert_str_attribute(attributes_dict, AWS_SPAN_KIND, "LOCAL_ROOT")
 
-    def _get_attributes_dict(self, attributes_list: List[KeyValue]) -> dict[str, AnyValue]:
-        attributes_dict: dict[str, AnyValue] = {}
+    def _get_attributes_dict(self, attributes_list: List[KeyValue]) -> Dict[str, AnyValue]:
+        attributes_dict: Dict[str, AnyValue] = {}
         for attribute in attributes_list:
             key: str = attribute.key
             value: AnyValue = attribute.value
@@ -119,13 +119,13 @@ def _get_attributes_dict(self, attributes_list: List[KeyValue]) -> dict[str, Any
             attributes_dict[key] = value
         return attributes_dict
 
-    def _assert_str_attribute(self, attributes_dict: dict[str, AnyValue], key: str, expected_value: str):
+    def _assert_str_attribute(self, attributes_dict: Dict[str, AnyValue], key: str, expected_value: str):
         self.assertIn(key, attributes_dict)
         actual_value: AnyValue = attributes_dict[key]
         self.assertIsNotNone(actual_value)
         self.assertEqual(expected_value, actual_value.string_value)
 
-    def _assert_int_attribute(self, attributes_dict: dict[str, AnyValue], key: str, expected_value: int) -> None:
+    def _assert_int_attribute(self, attributes_dict: Dict[str, AnyValue], key: str, expected_value: int) -> None:
         actual_value: AnyValue = attributes_dict[key]
         self.assertIsNotNone(actual_value)
         self.assertEqual(expected_value, actual_value.int_value)
@@ -146,7 +146,7 @@ def _assert_semantic_conventions_span_attributes(
     def _assert_semantic_conventions_attributes(
         self, attributes_list: List[KeyValue], method: str, endpoint: str, status_code: int
     ) -> None:
-        attributes_dict: dict[str, AnyValue] = self._get_attributes_dict(attributes_list)
+        attributes_dict: Dict[str, AnyValue] = self._get_attributes_dict(attributes_list)
         # TODO: requests instrumentation is not populating net peer attributes
         # self._assert_str_attribute(attributes_dict, SpanAttributes.NET_PEER_NAME, "backend")
         # self._assert_int_attribute(attributes_dict, SpanAttributes.NET_PEER_PORT, 8080)
@@ -177,7 +177,7 @@ def _assert_metric_attributes(
         dp: ExponentialHistogramDataPoint = dp_list[0]
         if len(dp_list[1].attributes) > len(dp_list[0].attributes):
             dp = dp_list[1]
-        attribute_dict: dict[str, AnyValue] = self._get_attributes_dict(dp.attributes)
+        attribute_dict: Dict[str, AnyValue] = self._get_attributes_dict(dp.attributes)
         self._assert_str_attribute(attribute_dict, AWS_LOCAL_SERVICE, self.get_application_otel_service_name())
         # See comment on AWS_LOCAL_OPERATION in _assert_aws_attributes
         self._assert_str_attribute(attribute_dict, AWS_LOCAL_OPERATION, "InternalOperation")