CCM-12616: fix sonarcloud issues

lapenna-bjss · lapenna-bjss · commit 331d6c40edea · 2025-11-12T11:14:59.000Z
diff --git a/.github/actions/setup-python-poetry/action.yaml b/.github/actions/setup-python-poetry/action.yaml
@@ -0,0 +1,26 @@
+name: "Setup Python and Poetry"
+description: "Sets up Python environment and installs Poetry with dependencies"
+inputs:
+  python-version:
+    description: "Python version to use"
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - name: "Set up Python"
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: "Install Poetry"
+      uses: snok/install-poetry@v1
+      with:
+        version: latest
+        virtualenvs-create: true
+        virtualenvs-in-project: true
+
+    - name: "Install Poetry dependencies"
+      shell: bash
+      run: |
+        cd lambdas/mesh-poll && poetry install
diff --git a/.github/workflows/stage-2-test.yaml b/.github/workflows/stage-2-test.yaml
@@ -62,16 +62,11 @@ jobs:
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v5
-      - name: "Set up Python"
-        uses: actions/setup-python@v4
+      - name: "Setup Python and Poetry"
+        uses: ./.github/actions/setup-python-poetry
         with:
           python-version: ${{ inputs.python_version }}
-      - name: "Install Poetry"
-        uses: snok/install-poetry@v1
-        with:
-          version: latest
-          virtualenvs-create: true
-          virtualenvs-in-project: true
+          working-directory: "lambdas/mesh-poll"
       - name: "Repo setup"
         run: |
           npm ci
@@ -100,16 +95,11 @@ jobs:
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v5
-      - name: "Set up Python"
-        uses: actions/setup-python@v4
+      - name: "Setup Python and Poetry"
+        uses: ./.github/actions/setup-python-poetry
         with:
           python-version: ${{ inputs.python_version }}
-      - name: "Install Poetry"
-        uses: snok/install-poetry@v1
-        with:
-          version: latest
-          virtualenvs-create: true
-          virtualenvs-in-project: true
+          working-directory: "lambdas/mesh-poll"
       - name: "Repo setup"
         run: |
           npm ci
diff --git a/.gitleaksignore b/.gitleaksignore
@@ -7,3 +7,4 @@ cd9c0efec38c5d63053dd865e5d4e207c0760d91:docs/guides/Perform_static_analysis.md:
 52386bca9b88c0c8c7dee52ab0ec69d04fb72c46:src/TESTING_PLAN.md:ipv4:145
 cc74128e4207833109339e96f3aaebf3cd40dd65:src/TESTING_PLAN.md:ipv4:2507
 973c8a1feb76f3cd8743ce27b14e4acc4252240c:src/TESTING_PLAN.md:ipv4:2507
+791619daf5af4806da7266fa301c0e82145b6de8:src/TESTING_PLAN.md:ipv4:2507
diff --git a/lambdas/mesh-poll/Makefile b/lambdas/mesh-poll/Makefile
@@ -14,7 +14,7 @@ test-coverage:
 	poetry run pytest --cov --cov-report xml:target/coverage/@comms/mesh-poll-lambda/cobertura-coverage.xml
 
 lint:
-	poetry run pylint mesh_poll
+	poetry run pylint src
 
 format:
 	poetry run autopep8 -ri .
diff --git a/lambdas/mesh-poll/poetry.lock b/lambdas/mesh-poll/poetry.lock
diff --git a/lambdas/mesh-poll/pyproject.toml b/lambdas/mesh-poll/pyproject.toml
@@ -3,23 +3,25 @@ name = "mesh-poll"
 version = "0.1.0"
 description = "Poll a MESH mailbox"
 authors = ["Your Name <you@example.com>"]
+package-mode = false
 
 [tool.poetry.dependencies]
 python = "^3.9"
 structlog = "^21.5.0"
 py-mock-mesh = {path = "../../utils/py-mock-mesh", develop = false}
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 autopep8 = "^2.0.2"
 pylint = "^2.17.4"
 pytest = "^7.0.1"
 pytest-cov = "^4.0.0"
-
-[tool.poetry.group.dev.dependencies]
 jake = "^3.0.1"
 
 [tool.coverage.run]
-omit = ["tests/*"]
+omit = ["src/__tests__/*"]
+
+[tool.pytest.ini_options]
+pythonpath = "."
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
diff --git a/lambdas/mesh-poll/src/__init__.py b/lambdas/mesh-poll/src/__init__.py
diff --git a/lambdas/mesh-poll/src/__tests__/test_mesh_poll.py b/lambdas/mesh-poll/src/__tests__/test_mesh_poll.py
@@ -1,4 +1,4 @@
-from mesh_poll import __version__
+from src import __version__
 
 
 def test_version():
diff --git a/lambdas/mesh-poll/src/config.py b/lambdas/mesh-poll/src/config.py
diff --git a/lambdas/mesh-poll/src/handler.py b/lambdas/mesh-poll/src/handler.py
diff --git a/schemas/scripts/README.md b/schemas/scripts/README.md
@@ -8,7 +8,7 @@ The documentation generation has been split into a two-stage process for better
 
 ### 1. `generate_docs_yaml.py`
 
-Generates structured YAML documentation files from JSON Schema YAML files.
+Generates structured yaml documentation files from JSON Schema yaml files.
 
 ```bash
 python generate_docs_yaml.py <src_dir> <docs_yaml_dir>
@@ -19,23 +19,23 @@ python generate_docs_yaml.py <src_dir> <docs_yaml_dir>
 - Extracts metadata, properties, constraints, examples, and inheritance information
 - Creates `.doc.yaml` files with structured documentation data
 - Generates hierarchical `index.yaml` files for navigation
-- Machine-readable format suitable for consumption by other tools (Jekyll, etc.)
+- Machine-readable format suitable for consumption by other tools (jekyll, etc.)
 
 ### 2. `generate_docs_markdown.py`
 
-Generates Markdown documentation from YAML documentation files.
+Generates Markdown documentation from yaml documentation files.
 
 ```bash
 python generate_docs_markdown.py <docs_yaml_dir> <docs_md_dir>
 ```
 
 **Features:**
 
-- Converts YAML documentation to human-readable Markdown
+- Converts yaml documentation to human-readable Markdown
 - Creates hierarchical index files with navigation
 - Preserves all schema information in readable format
-- Generates front matter for Jekyll/static site generators
-- **Embeds source YAML schema in front matter** for tool consumption
+- Generates front matter for jekyll/static site generators
+- **Embeds source yaml schema in front matter** for tool consumption
 - Supports nested properties and complex schema structures
 
 ### 3. `generate_docs_all.py`
@@ -49,7 +49,7 @@ python generate_docs_all.py <src_dir> [output_dir]
 **Features:**
 
 - Copies source schema files to `output/schemas/`
-- Generates YAML documentation in `output/docs/yaml/`
+- Generates yaml documentation in `output/docs/yaml/`
 - Generates Markdown documentation in `output/docs/md/`
 - Creates a complete, self-contained documentation package
 
@@ -63,7 +63,7 @@ Original single-stage documentation generator. Still available but recommend usi
 
 ## Other Utility Scripts
 
-- `yaml_to_json.py` - Converts YAML schema files to JSON format using PyYAML
+- `yaml_to_json.py` - Converts yaml schema files to JSON format using PyYAML
 
 ## Documentation File Structure
 
@@ -87,12 +87,12 @@ output/                        # Complete documentation package
 
 ## Benefits of Two-Stage Approach
 
-1. **Flexibility**: YAML files can be consumed by different tools (Jekyll themes, API generators, etc.)
+1. **Flexibility**: yaml files can be consumed by different tools (jekyll themes, API generators, etc.)
 2. **Separation of Concerns**: Documentation extraction separate from presentation
-3. **Caching**: YAML generation only needs to run when schemas change
-4. **Multiple Outputs**: Same YAML can generate different formats (Markdown, HTML, PDF, etc.)
-5. **Tool Integration**: Other applications can easily consume the structured YAML data
-6. **Source Preservation**: Original YAML schema embedded in Markdown front matter for tool access
+3. **Caching**: yaml generation only needs to run when schemas change
+4. **Multiple Outputs**: Same yaml can generate different formats (Markdown, HTML, PDF, etc.)
+5. **Tool Integration**: Other applications can easily consume the structured yaml data
+6. **Source Preservation**: Original yaml schema embedded in Markdown front matter for tool access
 
 ## Markdown Front Matter Structure
 
@@ -128,7 +128,7 @@ examples:
 ---
 ```
 
-This allows tools like Jekyll to:
+This allows tools like jekyll to:
 
 - Access all metadata for listing and organization
 - Process properties directly for form generation or validation
@@ -149,13 +149,13 @@ python generate_docs_all.py src
 python generate_docs_all.py src my_output
 ```
 
-### Generate only YAML (for tool consumption)
+### Generate only yaml (for tool consumption)
 
 ```bash
 python generate_docs_yaml.py src docs_yaml
 ```
 
-### Generate only Markdown (from existing YAML)
+### Generate only Markdown (from existing yaml)
 
 ```bash
 python generate_docs_markdown.py docs_yaml docs_md
@@ -167,7 +167,7 @@ python generate_docs_markdown.py docs_yaml docs_md
 python generate_docs.py src docs
 ```
 
-### Convert YAML to JSON
+### Convert yaml to JSON
 
 ```bash
 python yaml_to_json.py input.schema.yaml output.schema.json
diff --git a/scripts/config/sonar-scanner.properties b/scripts/config/sonar-scanner.properties
@@ -3,12 +3,13 @@
 sonar.host.url=https://sonarcloud.io
 sonar.qualitygate.wait=true
 sonar.sourceEncoding=UTF-8
+sonar.language=js,python
 sonar.sources=.
 sonar.tests=tests/, lambdas/mesh-poll/src/__tests__, lambdas/ttl-create-lambda/src/__tests__, lambdas/ttl-poll-lambda/src/__tests__, utils/utils/src/__tests__
 sonar.test.inclusions=tests/**, lambdas/**/src/__tests__/**, utils/utils/src/__tests__/**
 sonar.terraform.provider.aws.version=5.54.1
 sonar.cpd.exclusions=**.test.*
 sonar.coverage.exclusions=tests/, **/*.dev.*, lambdas/**/src/__tests__, **/jest.config.ts, scripts/**/*, docs/**/*, utils/utils/src/__tests__
 
-#sonar.python.coverage.reportPaths=.coverage/coverage.xml
+sonar.python.coverage.reportPaths=lambdas/**/target/coverage/**/*cobertura-coverage.xml
 sonar.javascript.lcov.reportPaths=lcov.info
diff --git a/utils/get_version.sh b/utils/get_version.sh
@@ -1,15 +1,14 @@
 #!/usr/bin/env bash
 
-if [ "${BASH_SOURCE[0]}" -ef "$0" ]
-then
-    echo "get_version.sh should be sourced not executed!"
+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}";
+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
+export POINT_VERSION
+export BRANCH_AND_VERSION
diff --git a/utils/py-mock-mesh/py_mock_mesh/mesh_message.py b/utils/py-mock-mesh/py_mock_mesh/mesh_message.py
@@ -18,7 +18,7 @@
 ]
 
 
-class InvalidHeaderException(BaseException):
+class InvalidHeaderException(Exception):
     """
     Indicates an invalid header on a MESH message
     """

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-from mesh_poll import __version__`
	`1`	`+from src import __version__`
`2`	`2`
`3`	`3`
`4`	`4`	`def test_version():`