Toml-config (#1983)

* Move sonar-tools in subdir

* Define toml file

* Build with poetry

* Remove old backup toml file

* Create poetry lock file

* Update dependecies with versions

* Remove obsolete requirements.txt

* Us epoetry to run tests

* Update files in image with poetry

* Add test for sonar-tools-help

* Bump dependencies

* Downgrade dependency for compatibility python 3.9

* formatting

* Remove ruff python upgrade issues

* Adjust to new ruff format

* Remove deprecated sonar.login for new versions of SonarQube

* Fix bug due to typo

* Build on Windows

* Tune ruff config

* Add ruff formatting

* Remove black

Author: okorach

sonar-tools renamed to cli/sonar_tools.py

@@ -23,7 +23,11 @@
 
 from sonar import version
 
-print(f'''
+
+def main() -> None:
+    """Main entry point for sonar-tools"""
+    print(
+        f"""
 sonar-tools version {version.PACKAGE_VERSION}
 (c) Olivier Korach 2019-2025
 Collections of utilities for SonarQube Server and Cloud:
@@ -38,8 +42,13 @@
 - sonar-findings-sync: Synchronizes issues between 2 branches of a same project, a whole project
   branches of 2 different projects (potentially on different platforms).
   (also available as sonar-issues-sync for backward compatibility, but deprecated)
-- sonar-projects: Exports / Imports projects to/from zip file (Import works for EE and higher)
-- sonar-config: Exports and imports an entire (or subsets of a) SonarQube Server or Cloud platform configuration as code (JSON)
+- sonar-projects: Exports or imports projects to/from zip file (Import works for SonarQube Server EE and higher)
+- sonar-config: Exports or imports an entire (or subsets of a) SonarQube Server or Cloud platform configuration as code (JSON)
 - sonar-rules: Exports Sonar rules
 See tools built-in -h help and https://github.com/okorach/sonar-tools for more documentation
-''')
+"""
+    )
+
+
+if __name__ == "__main__":
+    main()

conf/build.sh

@@ -38,10 +38,11 @@ while [ $# -ne 0 ]; do
 done
 
 echo "======= FORMATTING CODE ========="
-black --line-length=150 .
+ruff format
 echo "======= BUILDING PACKAGE ========="
 rm -rf "$ROOTDIR/build/lib/sonar" "$ROOTDIR/build/lib/cli" "$ROOTDIR"/build/scripts*/sonar-tools "$ROOTDIR"/dist/sonar_tools*
-python -m build
+# python -m build
+poetry build
 
 if [ "$build_docs" == "1" ]; then
     echo "======= BUILDING DOCS ========="

conf/deploy.bat

@@ -21,10 +21,13 @@
 :: build_docs=1
 :: release=0
 
-black --line-length=150 .
+ruff format
+if %errorlevel% neq 0 exit /b %errorlevel%
+
 rmdir /S /Q build
 rmdir /S /Q dist
-python setup.py bdist_wheel
+poetry build
+if %errorlevel% neq 0 exit /b %errorlevel%
 
 :: Deploy locally for tests
 pip install pip install --no-deps --force-reinstall dist\*-py3-*.whl

conf/release.Dockerfile

@@ -22,10 +22,7 @@ ENV PATH="${VIRTUAL_ENV}/bin:${PATH}"
 WORKDIR /opt/sonar-tools
 
 COPY ./sonar sonar
-COPY ./requirements.txt .
 COPY ./cli cli
-COPY ./setup.py .
-COPY ./sonar-tools .
 COPY ./README.md .
 COPY ./LICENSE .
 COPY ./sonar/audit sonar/audit
@@ -36,6 +33,6 @@ RUN pip install --upgrade pip \
 USER ${USERNAME}
 WORKDIR /home/${USERNAME}
 
-HEALTHCHECK --interval=180s --timeout=5s CMD [ "sonar-tools" ]
+HEALTHCHECK --interval=180s --timeout=5s CMD [ "sonar-tools-help" ]
 
-CMD [ "sonar-tools" ]
+CMD [ "sonar-tools-help" ]

conf/ruff2sonar.py

@@ -43,26 +43,22 @@ def main() -> None:
     while i < nblines:
         line = lines[i]
         i += 1
-        # Search for pattern like "F401 [*] `sys` imported but unused"
-        if not (m := re.match(r"^([A-Za-z0-9]+) (\[\*\]) (.+)$", line)):
-            continue
-        rule_id = m.group(1)
-        message = m.group(3)
-        line = lines[i]
-        i += 1
-        # Search for pattern like "   --> cli/cust_measures.py:28:8"
-        if not (m := re.match(r"^\s*--> ([^:]+):(\d+):(\d+)$", line)):
+        # Search for pattern like "sonar/projects.py:196:13: B904 Within an `except` clause, raise exceptions"
+        if not (m := re.match(r"^([^:]+):(\d+):(\d+): ([A-Z0-9]+)( \[\*\])? (.+)$", line)):
             continue
         file_path = m.group(1)
         line_no = int(m.group(2))
+        start_col = int(m.group(3)) - 1
+        end_col = start_col + 1
+        rule_id = m.group(4)
+        message = m.group(6)
+        i += 1
 
         # Search for "   |        ^^^" pattern"
-        while i < nblines and not (m := re.match(r"^\s*\|\s(\s*)(\^+)", lines[i])):
+        while i < nblines and not re.match(r"^$", lines[i]):
+            if m := re.match(r"\s*\|\s(\s*)(\^+)", lines[i]):
+                end_col = start_col + len(m.group(2))
             i += 1
-        if not m:
-            continue
-        start_col = len(m.group(1))
-        end_col = start_col + len(m.group(2))
 
         sonar_issue = {
             "ruleId": f"{TOOLNAME}:{rule_id}",

conf/run_tests.sh

@@ -40,10 +40,7 @@ do
         sonar start -i $target && sleep 30
     fi
     if [ -d "$ROOTDIR/$GEN_LOC/$target/" ]; then
-        coverage run --branch --source="$ROOTDIR" -m pytest "$ROOTDIR/$GEN_LOC/$target/" --junit-xml="$buildDir/xunit-results-$target.xml"
-        coverage xml -o "$buildDir/coverage-$target.xml"
-    fi
-    if [ "$target" != "latest" ] && [ "$target" != "common" ]; then
-        sonar stop -i $target
+        poetry run coverage run --branch --source="$ROOTDIR" -m pytest "$ROOTDIR/$GEN_LOC/$target/" --junit-xml="$buildDir/xunit-results-$target.xml"
+        poetry run coverage xml -o "$buildDir/coverage-$target.xml"
     fi
 done

conf/scan.sh

@@ -70,13 +70,17 @@ fi
 
 version=$(grep PACKAGE_VERSION "$ROOTDIR/sonar/version.py" | cut -d "=" -f 2 | sed -e "s/[\'\" ]//g" -e "s/^ +//" -e "s/ +$//")
 
+
 cmd="sonar-scanner -Dsonar.projectVersion=$version \
   -Dsonar.python.flake8.reportPaths=$flake8Report \
   -Dsonar.python.pylint.reportPaths=$pylintReport \
-  -Dsonar.login=$SONAR_TOKEN \
   -Dsonar.token=$SONAR_TOKEN \
   "${scanOpts[*]}""
 
+if [ "$SONAR_HOST_URL" == "$SONAR_HOST_URL_9" ]; then
+  cmd="$cmd -Dsonar.login=$SONAR_TOKEN"
+fi
+
 if ls $buildDir/coverage*.xml >/dev/null 2>&1; then
   cmd="$cmd -Dsonar.python.coverage.reportPaths=$buildDir/coverage*.xml"
 else

conf/snapshot.Dockerfile

@@ -22,23 +22,21 @@ ENV PATH="${VIRTUAL_ENV}/bin:${PATH}"
 WORKDIR /opt/sonar-tools
 
 COPY ./sonar sonar
-COPY ./requirements.txt .
+COPY ./pyproject.toml .
 COPY ./cli cli
-COPY ./setup.py .
-COPY ./sonar-tools .
 COPY ./README.md .
 COPY ./LICENSE .
 COPY ./sonar/audit sonar/audit
 
 RUN pip install --upgrade pip \
-&& pip install --no-cache-dir -r requirements.txt \
-&& pip install --no-cache-dir --upgrade pip setuptools wheel \
-&& python setup.py bdist_wheel \
+&& pip install --no-cache-dir poetry \
+&& poetry install \
+&& poetry build \
 && pip install dist/sonar_tools-*-py3-*.whl --force-reinstall
 
 USER ${USERNAME}
 WORKDIR /home/${USERNAME}
 
-HEALTHCHECK --interval=180s --timeout=5s CMD [ "sonar-tools" ]
+HEALTHCHECK --interval=180s --timeout=5s CMD [ "sonar-tools-help" ]
 
-CMD [ "sonar-tools" ]
+CMD [ "sonar-tools-help" ]

migration/deploy.sh

@@ -43,7 +43,7 @@ while [ $# -ne 0 ]; do
     shift
 done
 
-black --line-length=150 .
+ruff format
 rm -rf "$ROOTDIR/build/lib/migration" "$ROOTDIR/build/lib/cli" "$ROOTDIR/build/lib/sonar" "$ROOTDIR"/build/scripts*/sonar_migration "$ROOTDIR"/dist/sonar_migration*
 python3 "$ROOTDIR/setup_migration.py" bdist_wheel