CCM-13278: Create skeleton mesh-acknowledge lambda

gareth-allan · gareth-allan · commit 2f022326673c · 2026-01-06T09:47:57.000Z
diff --git a/.github/workflows/stage-2-test.yaml b/.github/workflows/stage-2-test.yaml
@@ -72,9 +72,10 @@ jobs:
       - uses: actions/setup-node@v6
         with:
           node-version: 24.10.0
-      - uses: actions/setup-python@v6
+      - name: "Setup Python"
+        uses: actions/setup-python@v6
         with:
-          python-version: '3.14'
+          python-version: ${{ inputs.python_version }}
       - name: "Run unit test suite"
         run: |
           make test-unit
@@ -94,14 +95,21 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: python-coverage-reports
-          path: "src/**/coverage.xml"
+          path: |
+            src/**/coverage.xml
+            utils/**/coverage.xml
+            lambdas/**/coverage.xml
   test-lint:
     name: "Linting"
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v5
+      - name: "Setup Python"
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ inputs.python_version }}
       - uses: actions/setup-node@v6
         with:
           node-version: 24.10.0
@@ -156,7 +164,7 @@ jobs:
         uses: actions/download-artifact@v5
         with:
           name: python-coverage-reports
-          path: src/
+          path: .
       - name: "Perform static analysis"
         uses: ./.github/actions/perform-static-analysis
         with:
diff --git a/.gitignore b/.gitignore
@@ -12,6 +12,15 @@ version.json
 
 # Please, add your custom content below!
 
+# Don't track ephemeral local build files
+target/
+
+# Python build artifacts
+*.egg-info/
+.eggs/
+build/
+dist/
+
 # dependencies
 node_modules
 .node-version
@@ -25,6 +34,7 @@ dist
 output
 /schemas
 .env
+**/__pycache__
 
 # Python
 __pycache__/
diff --git a/Makefile b/Makefile
@@ -9,15 +9,22 @@ include scripts/init.mk
 
 quick-start: config clean build serve-docs # Quick start target to setup, build and serve docs @Pipeline
 
-dependencies: # Install dependencies needed to build and test the project @Pipeline
-	# TODO: Implement installation of your project dependencies
+dependencies:: # Install dependencies needed to build and test the project @Pipeline
+	$(MAKE) -C src/cloudevents install
+	$(MAKE) -C src/eventcatalogasyncapiimporter install
+	$(MAKE) -C lambdas/mesh-acknowledge install
+	npm install --workspaces
+	$(MAKE) generate
 
-generate: # Generate any autogenerated output @Pipeline
-	npm run generate-dependencies
+dependencies-docs:: # Install documentation dependencies @Pipeline
+	$(MAKE) -C docs install
 
-build: # Build the project artefact @Pipeline
+build: dependencies-docs # Build the project artefact @Pipeline
 	$(MAKE) -C docs build
 
+generate: # Generate any autogenerated output @Pipeline
+	npm run generate-dependencies
+
 debug:
 	$(MAKE) -C docs debug
 
@@ -32,16 +39,12 @@ clean:: # Clean-up project resources (main) @Operations
 	$(MAKE) -C src/cloudevents clean && \
 	$(MAKE) -C src/eventcatalogasyncapiimporter clean && \
 	$(MAKE) -C src/eventcatalogasyncapiimporter clean-output && \
+	$(MAKE) -C lambdas/mesh-acknowledge clean && \
 	$(MAKE) -C src/python-schema-generator clean && \
 	rm -f .version
 	npm run clean
 
-config:: _install-dependencies version # Configure development environment (main) @Configuration
-	$(MAKE) -C docs install
-	$(MAKE) -C src/cloudevents install
-	$(MAKE) -C src/eventcatalogasyncapiimporter install
-	npm install
-	$(MAKE) generate
+config:: _install-dependencies version dependencies # Configure development environment (main) @Configuration
 
 serve-docs:
 	$(MAKE) -C docs s
diff --git a/infrastructure/terraform/components/dl/README.md b/infrastructure/terraform/components/dl/README.md
@@ -42,6 +42,7 @@ No requirements.
 | <a name="module_kms"></a> [kms](#module\_kms) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-kms.zip | n/a |
 | <a name="module_lambda_apim_key_generation"></a> [lambda\_apim\_key\_generation](#module\_lambda\_apim\_key\_generation) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
 | <a name="module_lambda_lambda_apim_refresh_token"></a> [lambda\_lambda\_apim\_refresh\_token](#module\_lambda\_lambda\_apim\_refresh\_token) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
+| <a name="module_mesh_acknowledge"></a> [mesh\_acknowledge](#module\_mesh\_acknowledge) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
 | <a name="module_mesh_poll"></a> [mesh\_poll](#module\_mesh\_poll) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
 | <a name="module_pdm_mock"></a> [pdm\_mock](#module\_pdm\_mock) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
 | <a name="module_pdm_uploader"></a> [pdm\_uploader](#module\_pdm\_uploader) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
diff --git a/lambdas/mesh-acknowledge/.gitignore b/lambdas/mesh-acknowledge/.gitignore
@@ -0,0 +1,2 @@
+__pycache__
+.venv
diff --git a/lambdas/mesh-acknowledge/Makefile b/lambdas/mesh-acknowledge/Makefile
@@ -0,0 +1,34 @@
+PACKAGE=mesh_acknowledge
+VERSION=0.1.0
+
+install:
+	pip install -r requirements.txt
+
+install-dev:
+	pip install -r requirements-dev.txt
+
+test:
+	cd ../.. && PYTHONPATH=lambdas/mesh-acknowledge:$$PYTHONPATH pytest lambdas/mesh-acknowledge/mesh_acknowledge/__tests__/ -v
+
+coverage:
+	cd ../.. && PYTHONPATH=lambdas/mesh-acknowledge:$$PYTHONPATH pytest lambdas/mesh-acknowledge/mesh_acknowledge/__tests__/ \
+		--cov=lambdas/mesh-acknowledge/mesh_acknowledge \
+		--cov-config=lambdas/mesh-acknowledge/pytest.ini \
+		--cov-report=html:lambdas/mesh-acknowledge/htmlcov \
+		--cov-report=term-missing \
+		--cov-report=xml:lambdas/mesh-acknowledge/coverage.xml \
+		--cov-branch
+
+lint:
+	pylint mesh_acknowledge
+
+format:
+	autopep8 -ri .
+
+package:
+	../../utils/package_python_lambda.sh meshacknowledgelambda
+
+clean:
+	rm -rf target
+
+.PHONY: install install-dev test coverage lint format package clean
diff --git a/lambdas/mesh-acknowledge/mesh_acknowledge/__init__.py b/lambdas/mesh-acknowledge/mesh_acknowledge/__init__.py
@@ -0,0 +1,9 @@
+"""
+MESH Acknowledge Lambda
+
+This lambda handles acknowledging received MESH files, by sending a message to the MESH inbox of
+their sender.
+"""
+
+__version__ = '0.1.0'
+from .handler import *
diff --git a/lambdas/mesh-acknowledge/mesh_acknowledge/__tests__/__init__.py b/lambdas/mesh-acknowledge/mesh_acknowledge/__tests__/__init__.py
@@ -0,0 +1 @@
+# Test package init
diff --git a/lambdas/mesh-acknowledge/mesh_acknowledge/__tests__/test_handler.py b/lambdas/mesh-acknowledge/mesh_acknowledge/__tests__/test_handler.py
@@ -0,0 +1,34 @@
+"""
+Tests for Lambda handler
+"""
+from unittest.mock import Mock
+from mesh_acknowledge.handler import handler
+
+
+def setup_mocks():
+    """
+    Create all mock objects needed for handler testing
+    """
+    mock_context = Mock()
+
+    return mock_context
+
+
+class TestHandler:
+    """Test suite for Lambda handler"""
+
+    def test_handler_success(self):
+        """Test successful handler execution"""
+        (mock_context) = setup_mocks()
+
+        # Execute handler
+        handler(None, mock_context)
+
+    def test_handler_error(self):
+        """Test handler execution when an exception is raised"""
+        (mock_context) = setup_mocks()
+
+        # This test should raise an exception
+
+        # Execute handler
+        handler(None, mock_context)
diff --git a/lambdas/mesh-acknowledge/mesh_acknowledge/handler.py b/lambdas/mesh-acknowledge/mesh_acknowledge/handler.py
@@ -0,0 +1,6 @@
+"""lambda handler for Mesh Acknowledge application"""
+
+
+def handler(_, _context):
+    """lambda handler for Mesh Acknowledge application"""
+    print("Started MESH Acknowledge handler")
diff --git a/lambdas/mesh-acknowledge/package_python_lambda.sh b/lambdas/mesh-acknowledge/package_python_lambda.sh
@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+set -e
+
+component_name="$1"
+
+rootdir=$(realpath "$(dirname "$0")/../..")
+source ${rootdir}/utils/get_version.sh
+
+dist_dir="${PWD}/target/dist"
+rm -rf "${dist_dir}"
+mkdir -p "${dist_dir}"
+
+# Extract internal (file://) and external dependencies from requirements.txt
+grep -E '^-e ' requirements.txt | sed 's|^-e ||' > target/internal_requirements.txt || true
+grep -vE '^-e ' requirements.txt > target/external_requirements.txt || true
+
+# Install external dependencies (from PyPI)
+pip install --platform manylinux2014_x86_64 --only-binary=:all: -r target/external_requirements.txt --target ${dist_dir} --python-version 3.14 --implementation cp
+
+# Install internal dependencies (local packages)
+pip install -r target/internal_requirements.txt --target ${dist_dir}
+
+# Bundle application code
+pip install . --no-deps --target ${dist_dir}
diff --git a/lambdas/mesh-acknowledge/pytest.ini b/lambdas/mesh-acknowledge/pytest.ini
@@ -0,0 +1,16 @@
+[pytest]
+testpaths = mesh_acknowledge/__tests__
+python_files = test_*.py
+python_classes = Test*
+python_functions = test_*
+addopts = -v --tb=short
+
+[coverage:run]
+relative_files = True
+omit =
+    */mesh_acknowledge/__tests__/*
+    */test_*.py
+    */__pycache__/*
+    */venv/*
+    */.venv/*
+    */env/*
diff --git a/lambdas/mesh-acknowledge/requirements-dev.txt b/lambdas/mesh-acknowledge/requirements-dev.txt
@@ -0,0 +1,6 @@
+-r requirements.txt
+autopep8>=2.0.2
+pylint>=2.17.4
+pytest>=7.0.1
+pytest-cov>=4.0.0
+jake>=3.0.1
diff --git a/lambdas/mesh-acknowledge/requirements.txt b/lambdas/mesh-acknowledge/requirements.txt
@@ -0,0 +1,3 @@
+mesh-client>=3.2.3
+boto3>=1.28.62
+pydantic>=2.0.0
diff --git a/lambdas/mesh-acknowledge/setup.py b/lambdas/mesh-acknowledge/setup.py
@@ -0,0 +1,7 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="mesh-acknowledge",
+    version="0.1.0",
+    packages=find_packages(),
+)
diff --git a/scripts/config/sonar-scanner.properties b/scripts/config/sonar-scanner.properties
@@ -3,13 +3,32 @@
 sonar.host.url=https://sonarcloud.io
 sonar.qualitygate.wait=true
 sonar.sourceEncoding=UTF-8
-sonar.sources=.
-sonar.tests=tests/, src/asyncapigenerator/tests, src/cloudeventjekylldocs/tests, src/eventcatalogasyncapiimporter/tests, src/python-schema-generator/tests, src/cloudevents/tools/builder/__tests__, src/cloudevents/tools/cache/__tests__, src/cloudevents/tools/generator/__tests__, lambdas/mesh-poll/src/__tests__, lambdas/ttl-create-lambda/src/__tests__, lambdas/ttl-poll-lambda/src/__tests__, utils/utils/src/__tests__, utils/sender-management/src/__tests__
-sonar.test.inclusions=tests/**, src/**/tests/**, src/**/__tests__/**, lambdas/**/src/__tests__/**, utils/utils/src/__tests__/**, utils/sender-management/src/__tests__/**
+sonar.sources=src,lambdas,utils,tests
+sonar.tests=tests
+sonar.test.inclusions=tests/**, lambdas/*/src/__tests__/**, utils/utils/src/__tests__/**, src/**/tests/**, src/**/__tests__/**, src/cloudevents/tools/**/__tests__/**, utils/sender-management/src/__tests__/**
 sonar.terraform.provider.aws.version=5.54.1
 sonar.cpd.exclusions=**.test.*
-sonar.coverage.exclusions=tests/**, src/**/tests/**, src/**/__tests__/**, **/*.dev.*, lambdas/**/src/__tests__/**, **/jest.config.ts, **/jest.config.cjs, scripts/**/*.*, docs/**/*.*, utils/utils/src/__tests__/**, src/asyncapigenerator/example_usage.py, src/asyncapigenerator/test_generator.py, src/eventcatalogasyncapiimporter/examples.py, src/digital-letters-events/**
 
-sonar.python.coverage.reportPaths=src/asyncapigenerator/coverage.xml,src/cloudeventjekylldocs/coverage.xml,src/eventcatalogasyncapiimporter/coverage.xml,src/python-schema-generator/coverage.xml
+# Coverage exclusions
+sonar.coverage.exclusions=\
+  tests/**, \
+  **/*.dev.*, \
+  **/__tests__/**, \
+  **/test_*.py, \
+  **/jest.config.ts, \
+  **/jest.config.cjs, \
+  **/setup.py, \
+  scripts/**/*.*, \
+  docs/**/*.*, \
+  utils/py-mock-mesh/**, \
+  utils/event-publisher-py/event_publisher/mesh_config.py,
+  lambdas/mesh-acknowledge/src/config.py, \
+  lambdas/mesh-acknowledge/src/errors.py, \
+  src/asyncapigenerator/example_usage.py, \
+  src/asyncapigenerator/test_generator.py, \
+  src/eventcatalogasyncapiimporter/examples.py
+
+# Coverage reports
+sonar.python.coverage.reportPaths=.coverage/coverage.xml,src/asyncapigenerator/coverage.xml,src/cloudeventjekylldocs/coverage.xml,src/eventcatalogasyncapiimporter/coverage.xml,utils/event-publisher-py/coverage.xml,utils/metric-publishers/coverage.xml,lambdas/mesh-acknowledge/coverage.xml,src/python-schema-generator/coverage.xml
 sonar.javascript.lcov.reportPaths=lcov.info,src/cloudevents/coverage/lcov.info
 sonar.typescript.lcov.reportPaths=lcov.info,src/cloudevents/coverage/lcov.info
diff --git a/scripts/tests/unit.sh b/scripts/tests/unit.sh
@@ -34,6 +34,11 @@ echo "Setting up and running eventcatalogasyncapiimporter tests..."
 make -C ./src/eventcatalogasyncapiimporter install-dev
 make -C ./src/eventcatalogasyncapiimporter coverage  # Run with coverage to generate coverage.xml for SonarCloud
 
+# Python Lambda - mesh-acknowledge
+echo "Setting up and running mesh-acknowledge tests..."
+make -C ./lambdas/mesh-acknowledge install-dev
+make -C ./lambdas/mesh-acknowledge coverage  # Run with coverage to generate coverage.xml for SonarCloud
+
 # Python projects - python-schema-generator
 echo "Setting up and running python-schema-generator tests..."
 make -C ./src/python-schema-generator install-dev
diff --git a/utils/get_version.sh b/utils/get_version.sh
@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+if [[ "${BASH_SOURCE[0]}" -ef "$0" ]]; then
+    echo "get_version.sh should be sourced, not executed!"
+    exit 1
+fi
+
+root_package_json="$(dirname ${BASH_SOURCE[0]})/../package.json"
+version="$(jq -r ".version" "${root_package_json}")"
+POINT_VERSION="${version}"."${CI_PIPELINE_IID:-0}"
+BRANCH_AND_VERSION="${CI_COMMIT_REF_NAME:-$(git branch --show-current)}"_"${POINT_VERSION}";
+
+export POINT_VERSION
+export BRANCH_AND_VERSION
diff --git a/utils/package_python_lambda.sh b/utils/package_python_lambda.sh
@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+set -e
+
+component_name="$1"
+
+utilsdir=$(realpath "$(dirname "$0")")
+source ${utilsdir}/get_version.sh
+
+dist_dir="${PWD}/target/dist"
+rm -rf "${dist_dir}"
+mkdir -p "${dist_dir}"
+
+# Extract internal (file://) and external dependencies from requirements.txt
+grep -E '^-e ' requirements.txt | sed 's|^-e ||' > target/internal_requirements.txt || true
+grep -vE '^-e ' requirements.txt > target/external_requirements.txt || true
+
+# Install external dependencies (from PyPI)
+pip install --platform manylinux2014_x86_64 --only-binary=:all: -r target/external_requirements.txt --target ${dist_dir} --python-version 3.14 --implementation cp
+
+# Install internal dependencies (local packages)
+pip install -r target/internal_requirements.txt --target ${dist_dir}
+
+# Bundle application code
+pip install . --no-deps --target ${dist_dir}
