PYSCAN-36: Migrate from Hatch to Poetry (#27)

Author: joke1196

.github/workflows/build-pr.yml

@@ -4,19 +4,40 @@ on:
   push:
     branches: [ "master" ]
   pull_request:
-    branches: [ "master" ]
+    branches: 
+      - master
+      - 'feature/**'
 
 jobs:
-  build:
-
+  test:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read      # required by actions/checkout
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        pipx install poetry
+        poetry install 
+    - name: Check tests 
+      run: |
+        poetry run pytest tests/
+  analysis:
     runs-on: ubuntu-latest
     permissions:
       id-token: write     # required by SonarSource/vault-action-wrapper
       contents: read      # required by actions/checkout
       pull-requests: read # required by SonarSource/sonarcloud-github-action
     strategy:
       fail-fast: false
-
     steps:
     - name: Get vault secrets
       id: secrets
@@ -31,26 +52,24 @@ jobs:
       uses: actions/setup-python@v4
       with:
         python-version: |
-          3.8
-          3.9
-          3.10
-          3.11
           3.12
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        python -m pip install hatch
-    - name: Check tests and generate coverage
-      run: |
-        hatch run test:cov_xml
-      env:
-        ARTIFACTORY_ACCESS_TOKEN: ${{ fromJSON(steps.secrets.outputs.vault).ARTIFACTORY_PASSWORD }}
+        pipx install poetry
+        poetry install
     - name: Check formatting
       run: |
-        hatch run tool:format
+        poetry run black src/ tests/ --check
     - name: Check licensing
       run: |
-        hatch run tool:license_check
+        poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2023 -n "Sonar Scanner Python" -E .py -d src/
+        poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2023 -n "Sonar Scanner Python" -E .py -d tests/
+        git diff --name-only --exit-code ./src ./tests
+    - name: Check tests and generate coverage
+      run: |
+        poetry run pytest --cov-report=xml:coverage.xml --cov-config=pyproject.toml --cov=src --cov-branch tests
+      env:
+        ARTIFACTORY_ACCESS_TOKEN: ${{ fromJSON(steps.secrets.outputs.vault).ARTIFACTORY_PASSWORD }}
     - name: SonarCloud Scan
       uses: SonarSource/sonarcloud-github-action@master
       env:

README.md

@@ -116,27 +116,35 @@ See the __SonarScanner__ [documentation](https://docs.sonarsource.com/sonarqube/
 ## Prerequisites
 
  - Python 3.12
- - [Hatch](https://hatch.pypa.io/latest/install/)
+ - [pipx](https://github.com/pypa/pipx)
 
-## Install virtual env and create a new environment
+## Install poetry
 
-Run `python3 -m pip install --user virtualenv`
-
-Then create a new env with `python3 -m venv <name of your venv>`
-
-Activate the venv with `source <name of your venv>/bin/activate`
+Install poetry with `pipx install poetry`
 
 # Run the main script
 
-Run `python3 main.py <args>`
+Run `python src/py_sonar_scanner`
 
 # Run the tests
 
-Run `hatch run test:test`
+Run `poetry install` to install the dependencies
+
+## Run the tests only
+
+Run `poetry run pytest test/`
+
+## Run the tests with coverage and results displayed in the terminal
+
+Run `poetry run pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=src --cov-branch tests`
+
+## Run the tests with coverage and store the result in an xml file
+
+Run `poetry run pytest --cov-report=xml:coverage.xml --cov-config=pyproject.toml --cov=src --cov-branch tests`
 
 # Build the package
 
-Run `hatch build` to create the package. 
+Run `poetry build` to create the package. 
 The binaries will be located in the `dist` directory at the root level of the project.
 
 # Publish the script
@@ -153,25 +161,28 @@ Also `dist/*` can be a bit more precise to upload a specific version of the bina
 To update the version use the hatch command:
 
 ```
-hatch version "X.Y.Z"
+poetry version "X.Y.Z"
 ```
 For more options on the version update see [the hatch documentation](https://hatch.pypa.io/latest/version/)
 
 # Tooling 
 ## Formatting 
 
-Run `hatch run tool:format` to run the check the formatting on all files.
-To automatically apply formatting, run `hatch run tool:apply_format`.
+Run `poetry run black src/ tests/ --check` to run the check the formatting on all files.
+To automatically apply formatting, run `poetry run black src/ tests/`.
 
 ## Type checking
 
-Run `hatch run tool:type_check` to execute the type checking on all files.
+Run `poetry run mypy src/ tests/ --ignore-missing-imports` to execute the type checking on all files.
 
 ## License header
 
 Before pushing, please check if all files have a license header.
-If not all files have a license header please execute: `hatch run tool:license`.
-
+If not all files have a license header please execute: 
+```
+poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2023 -n "Sonar Scanner Python" -E .py -d src/
+poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2023 -n "Sonar Scanner Python" -E .py -d tests/
+```
 
 # License