Minor contract test and pr_build improvements (#57)

In this commit we are making a few small changes to contract tests and
pr_build:
* In image Dockerfile upgrade pip and use PIP_ROOT_USER_ACTION=ignore to
avoid unneeded warnings in image build process
* In contract test base, make use of `addCleanup`, which (based on
TestCase documentation) will always run, even if `setUp` fails, (unlike
tearDown). This ensures tests reliably clean up and avoids issues with
failures in setup.
* In PR build, break out lint/spellcheck into their own jobs to keep
workflow clean and lean. Add the ability to optionally run unit tests to
setup steps, for saving some runtime of lint/spellcheck.
* In PR build, disable fail-fast. If one matrix invocation fails, we
still want to see the others to catch multiple issues if they are
present.

By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice.

Author: thpierce

.github/actions/artifacts_build/action.yml

@@ -1,6 +1,6 @@
-name: Build and Push aws-opentelemetry-distro Wheel and Image files according inputs
+name: Build and Push aws-opentelemetry-distro
 description: |
-  This action assumes that Repo was checked out and Python was set correctly
+  This action assumes that the repo was checked out. Builds and pushes/loads wheel and image files.
 
 inputs:
   aws-region:
@@ -35,27 +35,13 @@ inputs:
 runs:
   using: "composite"
   steps:
-    - name: Set up Python
-      uses: actions/setup-python@v4
+    - name: Set up
+      uses: ./.github/actions/set_up
       with:
-        python-version: ${{ inputs.python_version }}
-
-    - name: Install tox
-      shell: bash
-      run: pip install tox==3.27.1 tox-factor
-
-    - name: Cache tox environment
-      # Preserves .tox directory between runs for faster installs
-      uses: actions/cache@v1
-      with:
-        path: |
-          .tox
-          ~/.cache/pip
-        key: v7-build-tox-cache-${{ inputs.python_version }}-${{ inputs.package_name }}-${{ inputs.os }}-${{ hashFiles('tox.ini', 'dev-requirements.txt') }}
-
-    - name: run tox
-      shell: bash
-      run: tox -f ${{ inputs.python_version }}-${{ inputs.package_name }} -- -ra --benchmark-json=${{ inputs.python_version }}-${{ inputs.package_name }}-${{ inputs.os }}-benchmark.json
+        python_version: ${{ inputs.python_version }}
+        package_name: ${{ inputs.package_name }}
+        os: ${{ inputs.os }}
+        run_unit_tests: true
 
     - name: Configure AWS Credentials
       uses: aws-actions/configure-aws-credentials@v4

.github/actions/set_up/action.yml

@@ -0,0 +1,44 @@
+name: Set up
+description: |
+  This action assumes that the repo was checked out. Installs python and tox, then runs tox to trigger unit tests.
+
+inputs:
+  python_version:
+    required: true
+    description: "The python version used in actions"
+  package_name:
+    required: true
+    description: "The package name"
+  os:
+    required: true
+    description: "The os"
+  run_unit_tests:
+    required: true
+    description: "true/false flag indicating if we should run unit tests/benchmarks with tox"
+
+
+runs:
+  using: "composite"
+  steps:
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ inputs.python_version }}
+
+    - name: Install tox
+      shell: bash
+      run: pip install tox==3.27.1 tox-factor
+
+    - name: Cache tox environment
+      # Preserves .tox directory between runs for faster installs
+      uses: actions/cache@v1
+      with:
+        path: |
+          .tox
+          ~/.cache/pip
+        key: v7-build-tox-cache-${{ inputs.python_version }}-${{ inputs.package_name }}-${{ inputs.os }}-${{ hashFiles('tox.ini', 'dev-requirements.txt') }}
+
+    - name: Run unit tests/benchmarks with tox
+      if: ${{ inputs.python_version == 'true' }}
+      shell: bash
+      run: tox -f ${{ inputs.python_version }}-${{ inputs.package_name }} -- -ra --benchmark-json=${{ inputs.python_version }}-${{ inputs.package_name }}-${{ inputs.os }}-benchmark.json

.github/workflows/pr_build.yml

@@ -17,17 +17,13 @@ jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false # ensures the entire test matrix is run, even if one permutation fails
       matrix:
         python-version: ["3.8", "3.9", "3.10", "3.11"]
-        tox-environment: ["spellcheck", "lint"]
     steps:
       - name: Checkout Contrib Repo @ SHA - ${{ github.sha }}
         uses: actions/checkout@v4
 
-      - name: Install libsnappy-dev
-        if: ${{ matrix.tox-environment == 'lint' }}
-        run: sudo apt-get update && sudo apt-get install -y libsnappy-dev
-
       - name: Build Wheel and Image Files
         uses: ./.github/actions/artifacts_build
         with:
@@ -41,11 +37,33 @@ jobs:
           package_name: aws-opentelemetry-distro
           os: ubuntu-latest
 
-      - name: run spell check tox
-        run: tox -e ${{ matrix.tox-environment }}
-
       - name: Set up and run contract tests with pytest
         run: |
           bash contract-tests/set-up-contract-tests.sh
           pip install pytest
-          pytest contract-tests/tests
+          pytest contract-tests/tests
+
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false # ensures the entire test matrix is run, even if one permutation fails
+      matrix:
+        tox-environment: ["spellcheck", "lint"]
+    steps:
+      - name: Checkout Contrib Repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Install libsnappy-dev
+        if: ${{ matrix.tox-environment == 'lint' }}
+        run: sudo apt-get update && sudo apt-get install -y libsnappy-dev
+
+      - name: Set up
+        uses: ./.github/actions/set_up
+        with:
+          python_version: 3.11
+          package_name: aws-opentelemetry-distro
+          os: ubuntu-latest
+          run_unit_tests: false
+
+      - name: Run ${{ matrix.tox-environment }} with tox
+        run: tox -e ${{ matrix.tox-environment }}

contract-tests/images/applications/requests/Dockerfile

@@ -6,8 +6,9 @@ WORKDIR /requests
 COPY ./dist/$DISTRO /requests
 COPY ./contract-tests/images/applications/requests /requests
 
+ENV PIP_ROOT_USER_ACTION=ignore
 ARG DISTRO
-RUN pip install -r requirements.txt && pip install ${DISTRO} --force-reinstall
+RUN pip install --upgrade pip && pip install -r requirements.txt && pip install ${DISTRO} --force-reinstall
 RUN opentelemetry-bootstrap -a install
 
 # Without `-u`, logs will be buffered and `wait_for_logs` will never return.

contract-tests/images/mock-collector/Dockerfile

@@ -2,7 +2,8 @@ FROM public.ecr.aws/docker/library/python:3.11-slim
 WORKDIR /mock-collector
 COPY . /mock-collector
 
-RUN pip install -r requirements.txt
+ENV PIP_ROOT_USER_ACTION=ignore
+RUN pip install --upgrade pip && pip install -r requirements.txt
 
 # Without `-u`, logs will be buffered and `wait_for_logs` will never return.
 CMD ["python", "-u", "./mock_collector_server.py"]

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

@@ -75,6 +75,7 @@ def class_tear_down(cls) -> None:
 
     @override
     def setUp(self) -> None:
+        self.addCleanup(self.tear_down)
         application_networking_config: Dict[str, EndpointConfig] = {
             NETWORK_NAME: EndpointConfig(version="1.22", aliases=self.get_application_network_aliases())
         }
@@ -102,8 +103,7 @@ def setUp(self) -> None:
             self.mock_collector.get_container_host_ip(), self.mock_collector.get_exposed_port(_MOCK_COLLECTOR_PORT)
         )
 
-    @override
-    def tearDown(self) -> None:
+    def tear_down(self) -> None:
         try:
             _logger.info("Application stdout")
             _logger.info(self.application.get_logs()[0].decode())