SCANPY-122 Create IT which scans a project (#161)

Author: Seppli11

.cirrus.yml

@@ -10,6 +10,7 @@ env:
   DEPLOY_PULL_REQUEST: 'true'
   POETRY_VIRTUALENVS_PATH: "~/.cache/poetry/venvs"
   POETRY_CACHE_DIR: "~/.cache/poetry/pypoetry"
+  SONARQUBE_VERSION: 25.3.0.104237
 
 only_if: $CIRRUS_USER_COLLABORATOR == 'true' && $CIRRUS_TAG == "" && ($CIRRUS_PR != "" || $CIRRUS_BRANCH == 'master' || $CIRRUS_BRANCH =~ "branch-.*")
 container_definition: &CONTAINER_DEFINITION
@@ -29,7 +30,7 @@ container_definition: &CONTAINER_DEFINITION
 poetry_cache_template: &POETRY_CACHE
   poetry_cache:
     folder: ~/.cache/poetry/
-    fingerprint_script: cat poetry.lock its/poetry.lock
+    fingerprint_script: cat poetry.lock 
 
 .poetry_template: &POETRY_TEMPLATE
   eks_container:
@@ -73,8 +74,7 @@ formatting_task:
     - poetry run black src/ tests/ --check
     - poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2024 -n "Sonar Scanner Python" -E .py -d src/
     - poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2024 -n "Sonar Scanner Python" -E .py -d tests/
-    - poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2024 -n "Sonar Scanner Python" -E .py -d its/ -x its/sources/**.py
-    - git diff --name-only --exit-code ./src ./tests ./its
+    - git diff --name-only --exit-code ./src ./tests
 
 analysis_task:
   <<: *POETRY_TEMPLATE
@@ -130,20 +130,19 @@ its_task:
   alias: its
   sonarqube_cache:
     folder: sonarqube_cache/
-    populate_script: mkdir -p sonarqube_cache && wget -q https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-10.5.1.90531.zip -O sonarqube_cache/sonarqube.zip
-    fingerprint_key: sonarqube-10.5.1.90531
+    populate_script: mkdir -p sonarqube_cache && wget -q https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-$SONARQUBE_VERSION.zip -O sonarqube_cache/sonarqube.zip
+    fingerprint_script: echo "sonarqube-$SONARQUBE_VERSION"
   <<: *POETRY_TEMPLATE
   its_script:
     - unzip -q sonarqube_cache/sonarqube.zip -d sonarqube
     - cd $(ls -d sonarqube/*/)
     - ./bin/linux-x86-64/sonar.sh start
     - cd -
-    - cd its/
     - jfrog poetry-config --server-id-resolve repox --repo-resolve sonarsource-pypi
     - jfrog poetry install
     - unset SONAR_TOKEN
     - unset SONAR_HOST_URL
-    - poetry run pytest
+    - poetry run pytest --its tests/its 
 
 promote_task:
   depends_on:

CONTRIBUTING.md

@@ -32,7 +32,7 @@ url = 'https://repox.jfrog.io/artifactory/api/pypi/sonarsource-pypi/simple'
 
 ## Run the tests only
 
-Run `poetry run pytest test/`
+Run `poetry run pytest tests/`
 
 ## Run the tests with coverage and results displayed in the terminal
 
@@ -42,6 +42,39 @@ Run `poetry run pytest --cov-report=term-missing --cov-config=pyproject.toml --c
 
 Run `poetry run pytest --cov-report=xml:coverage.xml --cov-config=pyproject.toml --cov=src --cov-branch tests`
 
+## Run the ITs
+
+Run `poetry run pytest tests/its --its` to run the its.
+
+To see the ITs in the VSCode test explorer, add the `--its` argument to the `python.testing.pytestArgs` setting in `.vscode/settings.json`.
+
+The the following keys should be present:
+```json
+  "python.testing.unittestArgs": ["-v", "-s", "tests", "-p", "test_*.py"],
+  "python.testing.pytestEnabled": true,
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestArgs": ["--its", "tests"],
+```
+
+### Debugging the ITs
+
+To debug the sonar-scanner being run in the its, the ITs have to be run with `poetry run pytest tests/its --its --debug-its`
+
+The `pysonar-scanner` process will wait until VSCode or any other debug adapter protocol client connects on the port `5678`.
+
+For VSCode, add the following launch configuration in the `configurations` array:
+```json
+{
+    "name": "Python Debugger: Remote Attach",
+    "type": "debugpy",
+    "request": "attach",
+    "connect": {
+        "host": "localhost",
+        "port": 5678
+    },
+}
+```
+
 # Build the package
 
 Run `poetry build` to create the package.