CCM-13278: Add Python sender lookup utility

Author: gareth-allan

Makefile

@@ -15,6 +15,7 @@ dependencies:: # Install dependencies needed to build and test the project @Pipe
 	$(MAKE) -C lambdas/mesh-acknowledge install
 	$(MAKE) -C utils/metric-publishers install
 	$(MAKE) -C utils/event-publisher-py install
+	$(MAKE) -C utils/sender-management install
 	$(MAKE) -C utils/py-mock-mesh install
 	npm install --workspaces
 	$(MAKE) generate
@@ -46,6 +47,7 @@ clean:: # Clean-up project resources (main) @Operations
 	$(MAKE) -C utils/metric-publishers clean && \
 	$(MAKE) -C utils/event-publisher-py clean && \
 	$(MAKE) -C utils/py-mock-mesh clean && \
+	$(MAKE) -C utils/sender-management clean && \
 	$(MAKE) -C src/python-schema-generator clean && \
 	rm -f .version
 	npm run clean

scripts/config/sonar-scanner.properties

@@ -28,6 +28,6 @@ sonar.coverage.exclusions=\
   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.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,utils/sender-management/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

scripts/tests/unit.sh

@@ -44,6 +44,11 @@ echo "Setting up and running metric-publishers tests..."
 make -C ./utils/metric-publishers install-dev
 make -C ./utils/metric-publishers coverage  # Run with coverage to generate coverage.xml for SonarCloud
 
+# Python utility packages - sender-management
+echo "Setting up and running Python sender-management tests..."
+make -C ./utils/sender-management install-dev
+make -C ./utils/sender-management 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

utils/sender-management/Makefile

@@ -0,0 +1,30 @@
+.PHONY: install install-dev test coverage clean
+
+install:
+	pip install -r requirements.txt
+
+install-dev: install
+	pip install -r requirements-dev.txt
+
+test:
+	cd ../.. && PYTHONPATH=utils/sender-management:$$PYTHONPATH pytest utils/sender-management/sender_management/__tests__/ -v
+
+coverage:
+	cd ../.. && PYTHONPATH=utils/sender-management:$$PYTHONPATH pytest utils/sender-management/sender_management/__tests__/ \
+		--cov=utils/sender-management/sender_management \
+		--cov-config=utils/sender-management/pytest.ini \
+		--cov-report=html:utils/sender-management/htmlcov \
+		--cov-report=term-missing \
+		--cov-report=xml:utils/sender-management/coverage.xml \
+		--cov-branch
+
+lint:
+	pylint sender_management
+
+format:
+	autopep8 -ri .
+
+clean:
+	rm -rf .coverage htmlcov/ .pytest_cache/ coverage.xml
+	find . -type d -name __pycache__ -exec rm -rf {} +
+	find . -type f -name '*.pyc' -delete

utils/sender-management/package.json

@@ -20,8 +20,8 @@
   "private": true,
   "scripts": {
     "cli": "tsx ./src/entrypoint/cli/index.ts",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
     "test:unit": "jest",
     "typecheck": "tsc --noEmit"
   },

utils/sender-management/pytest.ini

@@ -0,0 +1,16 @@
+[pytest]
+python_files = test_*.py
+python_classes = Test*
+python_functions = test_*
+testpaths = sender_management/__tests__
+addopts = -v --tb=short
+
+[coverage:run]
+relative_files = True
+omit =
+    */sender_management/__tests__/*
+    */test_*.py
+    */__pycache__/*
+    */venv/*
+    */.venv/*
+    */env/*

utils/sender-management/requirements-dev.txt

@@ -0,0 +1,5 @@
+-r requirements.txt
+autopep8>=2.0.2
+pylint>=2.17.4
+pytest>=8.0.0
+pytest-cov>=6.0.0

utils/sender-management/requirements.txt

@@ -0,0 +1,8 @@
+"""Sender Management package.
+
+This package provides utilities for managing and looking up MESH sender information
+"""
+
+from .sender_lookup import *
+
+__all__ = ["sender_lookup"]