Add Sonar (#14)

* Add Sonar

* Fix code smells

.github/workflows/merge-to-main.yml

@@ -18,14 +18,16 @@ jobs:
         run: pip install -r requirements.txt && pip install -r requirements-dev.txt
       - name: Run test suite
         run: |
-          coverage run -m py.test -v
+          coverage run -m py.test -v --junitxml=testresults.xml
           coverage xml
-      - name: Report results to DeepSource
+      - uses: sonarsource/sonarqube-scan-action@master
-        run: |
-          curl https://deepsource.io/cli | sh
-          ./bin/deepsource report --analyzer test-coverage --key python --value-file ./coverage.xml
         env:
-          DEEPSOURCE_DSN: ${{ secrets.DEEPSOURCE_DSN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
+      - uses: sonarsource/sonarqube-quality-gate-action@master
+        timeout-minutes: 5
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
 
   build:
     needs: coverage

.github/workflows/pull-request.yml

@@ -23,14 +23,16 @@ jobs:
       - name: Install dependencies
         run: pip install -r requirements.txt && pip install -r requirements-dev.txt
       - name: Lint
-        run: pylint --recursive=yes .
+        run: pylint --recursive=yes --output-format=parseable --output=lintreport.txt .
       - name: Run test suite
         run: |
-          coverage run -m py.test -v
+          coverage run -m py.test -v --junitxml=testresults.xml
           coverage xml
-      - name: Report results to DeepSource
+      - uses: sonarsource/sonarqube-scan-action@master
-        run: |
-          curl https://deepsource.io/cli | sh
-          ./bin/deepsource report --analyzer test-coverage --key python --value-file ./coverage.xml
         env:
-          DEEPSOURCE_DSN: ${{ secrets.DEEPSOURCE_DSN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
+      - uses: sonarsource/sonarqube-quality-gate-action@master
+        timeout-minutes: 5
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitignore

@@ -38,6 +38,8 @@ pip-log.txt
 pip-delete-this-directory.txt
 
 # Unit test / coverage reports
+lintreport.txt
+testresults.xml
 htmlcov/
 .tox/
 .nox/

README.md

@@ -1,4 +1,4 @@
-# iPilot [![CI](https://github.com/luketainton/pypilot/actions/workflows/ci-branch-main.yml/badge.svg)](https://github.com/luketainton/pypilot/actions/workflows/ci-branch-main.yml) [![DeepSource](https://deepsource.io/gh/luketainton/pypilot.svg/?label=active+issues&show_trend=true&token=8utkyLrh7RPelvS-BNX1O8hZ)](https://deepsource.io/gh/luketainton/pypilot/?ref=repository-badge)
+# iPilot [![CI](https://github.com/luketainton/pypilot/actions/workflows/ci-branch-main.yml/badge.svg)](https://github.com/luketainton/pypilot/actions/workflows/ci-branch-main.yml) [![Quality Gate Status](https://sonarqube.tainton.uk/api/project_badges/measure?project=luketainton_pypilot_AYHo1eOKSbMjdyWLhHhP&metric=alert_status&token=squ_7c59ea8a624979cf8d8305ca4bbf18048df8145b)](https://sonarqube.tainton.uk/dashboard?id=luketainton_pypilot_AYHo1eOKSbMjdyWLhHhP)
 
 ## Description
 IP Information Lookup Tool

app/_version.py

@@ -2,4 +2,4 @@
 
 """MODULE: Specifies app version."""
 
-VERSION = "1.2"
+VERSION = "1.2"  # pragma: no cover

app/args.py

@@ -7,7 +7,7 @@ import argparse
 from app.query_normalisation import get_public_ip
 
 
-def parse_args() -> argparse.Namespace:
+def parse_args() -> argparse.Namespace:  # pragma: no cover
     """Get arguments from user via the command line."""
     parser = argparse.ArgumentParser(
         description="Query information about an IP address or domain name."

app/ip_info.py

@@ -2,6 +2,8 @@
 
 """MODULE: Provides functions to call various APIs to retrieve IP/prefix information."""
 
+from typing import Union
+
 import ipaddress
 import requests
 
@@ -24,7 +26,7 @@ def get_autonomous_system_number(as_info: str) -> str:
     return as_number
 
 
-def get_prefix_information(autonomous_system: int) -> list:
+def get_prefix_information(autonomous_system: int) -> Union[list, None]:
     """Retrieves prefix information about a given autonomous system."""
     api_endpoint = f"https://api.hackertarget.com/aslookup/?q={str(autonomous_system)}"
     try:

app/print_table.py

@@ -2,10 +2,11 @@
 
 """MODULE: Provides functions for preparing, then printing, retrieved data."""
 
+from typing import Union
 from tabulate import tabulate
 
 
-def generate_prefix_string(prefixes: list) -> str:
+def generate_prefix_string(prefixes: list) -> Union[str, None]:
     """Generate a string that spilts prefixes into rows of 4."""
     num_per_row = 4
     try:

sonar-project.properties

@@ -0,0 +1,8 @@
+sonar.projectKey=luketainton_pypilot_AYHo1eOKSbMjdyWLhHhP
+sonar.python.version=3.10
+sonar.python.coverage.reportPaths=coverage.xml
+sonar.python.pylint.reportPaths=lintreport.txt
+sonar.python.xunit.reportPath=testresults.xml
+sonar.sources=app
+sonar.tests=tests
+sonar.exclusions=,.github/**,.gitignore,CODEOWNERS,CHANGELOG.md,LICENSE.md,README.md,renovate.json,requirements-dev.txt,requirements.txt