Merge pull request #115 from sergioteula/fix-sonar-errors

Fix sonar errors

Author: sergioteula

.coveragerc

@@ -0,0 +1,14 @@
+[run]
+branch = True
+source = amazon_paapi
+relative_files = True
+omit = **/sdk/**
+
+[report]
+fail_under = 80
+skip_covered = true
+skip_empty = true
+
+[html]
+directory = coverage_html_report
+skip_covered = false

.githooks/pre-push

@@ -7,5 +7,6 @@ source "${ROOT_DIR}/scripts/helpers"
 ./scripts/check_black
 ./scripts/check_flake8
 ./scripts/check_pylint
+./scripts/run_tests
 
 header "Proceeding with push"

.github/workflows/lint-and-test.yml

@@ -3,6 +3,9 @@ name: Lint and test
 on:
   push:
 
+permissions:
+  pull-requests: read
+
 jobs:
 
   isort:
@@ -13,7 +16,7 @@ jobs:
         - ${{github.workspace}}:/code
     steps:
     - name: Check out code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Check imports order
       run: ./scripts/check_isort
 
@@ -25,7 +28,7 @@ jobs:
         - ${{github.workspace}}:/code
     steps:
     - name: Check out code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Check code format
       run: ./scripts/check_black
 
@@ -37,7 +40,7 @@ jobs:
         - ${{github.workspace}}:/code
     steps:
     - name: Check out code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Check code errors
       run: ./scripts/check_flake8
 
@@ -49,6 +52,41 @@ jobs:
         - ${{github.workspace}}:/code
     steps:
     - name: Check out code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Check code errors
       run: ./scripts/check_pylint
+
+  test:
+    runs-on: ubuntu-latest
+    container:
+      image: sergioteula/pytools
+      volumes:
+        - ${{github.workspace}}:/code
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v3
+    - name: Run tests
+      run: ./scripts/run_tests
+    - name: Save code coverage file
+      uses: actions/upload-artifact@v3
+      with:
+        name: coverage
+        path: coverage.xml
+
+  sonar:
+    runs-on: ubuntu-latest
+    needs: [test]
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Download a single artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: coverage
+      - name: Check code errors
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitignore

@@ -3,6 +3,7 @@
 .DS_Store
 secrets.py
 test.py
+coverage_html_report
 
 
 # Byte-compiled / optimized / DLL files

amazon_paapi/api.py

@@ -114,7 +114,7 @@ def get_items(
         return sort_items(results, items_ids, include_unavailable)
 
     def search_items(
-        self,
+        self,  # NOSONAR
         item_count: int = None,
         item_page: int = None,
         actor: str = None,

scripts/helpers

@@ -5,7 +5,7 @@ GREEN="\033[0;32m"
 RED="\033[0;31m"
 YELLOW="\033[0;33m"
 NC="\033[0m"
-LINE="--------------------------------------------------------------------"
+LINE="----------------------------------------------------------------------"
 
 check_if_installed() {
     if [ -x "$(command -v "${1}")" ]; then

scripts/run_tests

@@ -0,0 +1,24 @@
+#! /bin/bash
+
+ROOT_DIR="$(git rev-parse --show-toplevel)"
+source "${ROOT_DIR}/scripts/helpers"
+
+header "Running tests"
+
+if [ -n "$(check_if_installed docker)" ]; then
+    docker run -v "${PWD}:/code" sergioteula/pytools bash -c \
+        "coverage run -m unittest && coverage xml && coverage html && echo && coverage report"
+elif [ -n "$(check_if_installed coverage)" ]; then
+    coverage run -m unittest && coverage xml && coverage html && echo && coverage report
+else
+    error "coverage is not installed"
+    exit 1
+fi
+
+EXIT_CODE="$?"
+if [ "$EXIT_CODE" = "0" ]; then
+    success "Tests passed"
+else
+    error "Tests failed"
+    exit 1
+fi

sonar-project.properties

@@ -0,0 +1,8 @@
+sonar.organization=sergioteula
+sonar.projectKey=sergioteula_python-amazon-paapi
+sonar.sources=amazon_paapi
+sonar.exclusions=**/sdk/**
+sonar.qualitygate.wait=true
+sonar.python.version=3.6,3.7,3.8,3.9,3.10
+sonar.tests=tests
+sonar.python.coverage.reportPaths=coverage.xml