Misc minor improvements and fixes

* Fix bug

* Fix bug

* Fix TD

* Fix bug due to refactoring

* Disable rule R0913 covered by ruff

* Fix type hint

* Tune ruff analysis to not report type hints in python 3.10+ format

* Fix

* Quality pass

* Fix issue changelog count

* Remove unused import

* Add release date test

* Formatting

* fix exit code of sonar-tools-help

* Fix minimum version

* Fix migration build with toml file

* Add migration in package

* Fix pack (migration vs cli)

* Adjust issue counts after intro of ruff

* Fix sync export test

* Fix tests

* Fix tests

* Fix test now that no warning on sonar-tools

Author: okorach

README.md

@@ -39,7 +39,7 @@ deletes tokens created since more than a certain number of days
 - [Release notes](https://github.com/okorach/sonar-tools/releases)
 
 # Requirements and Installation
-- `sonar-tools` requires python 3.8 or higher
+- `sonar-tools` requires python 3.9 or higher
 - Installation is based on [pip](https://pypi.org/project/pip/).
 - Online installation.
   - Run: `python3 -m pip install sonar-tools` (or `python3 -m pip upgrade sonar-tools`)

cli/sonar_tools.py

@@ -21,7 +21,7 @@
 
 """Main entry point for sonar-tools"""
 
-from sonar import version
+from sonar import version, utilities, errcodes
 
 
 def main() -> None:
@@ -48,6 +48,7 @@ def main() -> None:
 See tools built-in -h help and https://github.com/okorach/sonar-tools for more documentation
 """
     )
+    utilities.final_exit(errcodes.OK)
 
 
 if __name__ == "__main__":

conf/prep_all_tests.sh

@@ -45,7 +45,7 @@ create_fresh_project "${SYNC_PROJECT_KEY}" "${SONAR_HOST_URL_TEST:?}" "${SONAR_T
 create_fresh_project "${SYNC_PROJECT_KEY}" "${SONAR_HOST_URL_LATEST:?}" "${SONAR_TOKEN_LATEST_ADMIN_USER}" "${SONAR_TOKEN_LATEST_ADMIN_ANALYSIS}"
 create_fresh_project "${SYNC_PROJECT_KEY}" "${SONAR_HOST_URL_CB:?}" "${SONAR_TOKEN_CB_ADMIN_USER}" "${SONAR_TOKEN_CB_ADMIN_ANALYSIS}"
 create_fresh_project "${SYNC_PROJECT_KEY}" "${SONAR_HOST_URL_9:?}" "${SONAR_TOKEN_9_ADMIN_USER}" "${SONAR_TOKEN_9_ADMIN_ANALYSIS}"
-create_fresh_project "${SYNC_PROJECT_KEY}" "https://sonarcloud.io" "${SONAR_TOKEN_SONARCLOUD" "${SONAR_TOKEN_SONARCLOUD"
+create_fresh_project "${SYNC_PROJECT_KEY}" "https://sonarcloud.io" "${SONAR_TOKEN_SONARCLOUD}" "${SONAR_TOKEN_SONARCLOUD}"
 create_fresh_project "${SYNC_PROJECT_KEY}" "${SONAR_HOST_URL_CB:?}" "${SONAR_TOKEN_CB_ADMIN_USER}" "${SONAR_TOKEN_CB_ADMIN_ANALYSIS}"
 
 for pr in 5 7; do

conf/pylintrc

@@ -91,7 +91,9 @@ disable=raw-checker-failed,
         R0205,
         W0107,
         R1721,
-        R1711
+        R1711,
+        R0913
+
 
 
 # Enable the message, report, category or checker with the given id(s). You can

migration/README.md

@@ -18,7 +18,7 @@ Command line tool to collect SonarQube data to prepare eventual migration to Son
 
 
 # Requirements and Installation
-- `sonar-migration` requires python 3.8 or higher
+- `sonar-migration` requires python 3.9 or higher
 - Installation is based on [pip](https://pypi.org/project/pip/).
 - Online installation.
   - Run: `python3 -m pip install sonar-migration` (or `python3 -m pip upgrade sonar-migration`)

migration/deploy.sh

@@ -25,6 +25,7 @@ CONFDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
 build_image=1
 release=0
+release_docker=0
 
 while [[ $# -ne 0 ]]; do
     case "${1}" in
@@ -43,9 +44,12 @@ while [[ $# -ne 0 ]]; do
     shift
 done
 
-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
+mv "${ROOTDIR}/pyproject.toml" "${ROOTDIR}/pyproject.toml.sonar-tools"
+cp "${ROOTDIR}/migration/pyproject.toml" "${ROOTDIR}"
+poetry build
+mv "${ROOTDIR}/pyproject.toml.sonar-tools" "${ROOTDIR}/pyproject.toml"
+
 
 # Deploy locally for tests
 pip install --upgrade --force-reinstall "${ROOTDIR}"/dist/sonar_migration-*-py3-*.whl
@@ -63,7 +67,7 @@ if [[ "${release}" = "1" ]]; then
     fi
 fi
 
-if [[ "${release}_docker" = "1" ]]; then
+if [[ "${release_docker}" = "1" ]]; then
     docker buildx build --push --platform linux/amd64,linux/arm64 -t olivierkorach/sonar-migration:0.4  -t olivierkorach/sonar-migration:latest -f migration/release.Dockerfile "${ROOTDIR}"
     cd "${CONFDIR}" && docker pushrm olivierkorach/sonar-migration
 fi

migration/pyproject.toml

@@ -0,0 +1,183 @@
+[project]
+name = "sonar-migration"
+version = "0.6"
+description = "A tool for SonarQube Server to Cloud migration assistance"
+authors = [
+  {name = "Olivier Korach", email = "[email protected]"},
+]
+maintainers = [
+  {name = "Olivier Korach", email = "[email protected]"},
+]
+
+license = "LGPL-3.0-only"
+
+license-files = ["LICEN[CS]E*"]
+
+keywords = ["sonarqube", "sonar", "migration", "administration", "automation"]
+
+readme = "README.md"
+requires-python = ">= 3.9"
+dependencies = [
+    "argparse",
+    "datetime",
+    "python-dateutil (>=2.9.0)",
+    "requests (>=2.32)",
+    "jprops (>=2.0.2)",
+    "levenshtein (>=0.27.1)",
+    "PyYAML (>=6.0.2)",
+]
+
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  # Indicate who your project is intended for
+  "Intended Audience :: Developers",
+  "Topic :: Code Quality :: Utility Tools",
+  # Specify the Python versions you support here.
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+]
+
+[project.urls]
+Homepage = "https://pypi.org/sonar-migration"
+Documentation = "https://github.com/okorach/migration/README.md"
+Repository = "https://github.com/okorach/sonar-tools.git"
+Issues = "https://github.com/okorach/sonar-tools/issues"
+Changelog = "https://github.com/okorach/sonar-tools/blob/master/doc/what-is-new.md"
+
+[project.scripts]
+sonar-migration = "migration.migration:main"
+
+[build-system]
+build-backend = "poetry.core.masonry.api"
+requires = [
+    "poetry-core>=2.0.0,<3.0.0",
+    "wheel",
+    "sphinx>=7.4.7",
+    "sphinx_rtd_theme>=3.0.2",
+    "sphinx-autodoc-typehints>=2.2.3",
+    "twine",
+    "get_pypi_latest_version",
+]
+
+[tool.poetry]
+packages = [{include = "sonar"}, {include = "migration"}]
+
+[dependency-groups]
+test = [
+    "pytest (>=8.1.1)",
+    "coverage (>=7.4.4)",
+]
+lint = [
+    "ruff (>=0.5.2)",
+    "pylint (>=3.1.0)",
+    "flake8 (>=7.0.0)",
+]
+docs = [
+    "sphinx (>=7.3.7)",
+    "sphinx-autodoc-typehints (>=2.1.0)",
+    "sphinx-rtd-theme (>=2.0.0)",
+]
+dev = [
+    { include-group = "test" },
+    { include-group = "lint" },
+    { include-group = "docs" },
+]
+
+[tool.ruff]
+
+# Set the maximum line length to 150.
+line-length = 150
+target-version = "py39"
+indent-width = 4
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = true
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"
+
+
+[tool.ruff.lint]
+# Add the `line-too-long` rule to the enforced rule set. By default, Ruff omits rules that
+# overlap with the use of a formatter, like Black, but we can override this behavior by
+# explicitly adding the rule.
+# extend-select = ["E501"]
+# select = [
+#    # pycodestyle
+#    "E",
+#    # Pyflakes
+#    "F",
+#    # pyupgrade
+#    # "UP",
+#    # flake8-bugbear
+#    "B",
+#    # flake8-simplify
+#    "SIM",
+#    # isort
+#    "I",
+#]
+select = [ "ALL" ]
+extend-ignore = [
+    "D403",
+    "D415",
+    "D400",
+    "FBT002",
+    "FBT001",
+    "PTH123", # `open()` should be replaced by `Path.open()`
+    "ISC001",
+    "COM812", # Missing trailing comma in a dictionary or set literal
+    "D211",
+    "D213",
+    "D203",
+    "D401",
+    "ERA001",
+    "S101",
+    "I001",
+    "TRY003",
+    "EM102",
+]
+
+exclude = [
+    ".eggs",
+    ".git",
+    ".mypy_cache",
+    ".pyenv",
+    ".pytest_cache",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages"
+]
+
+[tool.ruff.lint.pyupgrade]
+# Preserve types, even if a file imports `from __future__ import annotations`.
+keep-runtime-typing = true

pyproject.toml

@@ -80,7 +80,7 @@ requires = [
 ]
 
 [tool.poetry]
-packages = [{include = "sonar"}, {include = "cli"}]
+packages = [{include = "sonar"}, {include = "migration"}, {include = "cli"}]
 
 [dependency-groups]
 test = [
@@ -193,3 +193,6 @@ exclude = [
     "site-packages"
 ]
 
+[tool.ruff.lint.pyupgrade]
+# Preserve types, even if a file imports `from __future__ import annotations`.
+keep-runtime-typing = true

sonar/components.py

@@ -250,7 +250,7 @@ def set_visibility(self, visibility: str) -> None:
     def get_analyses(self, filter_in: Optional[list[str]] = None, filter_out: Optional[list[str]] = None) -> types.ApiPayload:
         """Returns a component analyses"""
         params = utilities.dict_remap(self.api_params(c.READ), {"component": "project"})
-        data = self.endpoint.get_paginated("project_analyses/search", return_field="analyses", params=params)["analyses"]
+        data = self.endpoint.get_paginated("project_analyses/search", return_field="analyses", **params)["analyses"]
         if filter_in and len(filter_in) > 0:
             data = [d for d in data if any(e["category"] in filter_in for e in d["events"])]
         if filter_out and len(filter_out) > 0:

sonar/groups.py

@@ -203,7 +203,7 @@ def members(self, use_cache: bool = True) -> list[users.User]:
                 data = json.loads(self.get(MEMBERSHIP_API, params={"groupId": self.id}).text)
                 self.__members = [users.User.get_object_by_id(self.endpoint, d["userId"]) for d in data["groupMemberships"]]
             else:
-                data = self.endpoint.get_paginated("api/user_groups/users", return_field="users", params={"name": self.name})
+                data = self.endpoint.get_paginated("api/user_groups/users", return_field="users", name=self.name)
                 self.__members = [users.User.get_object(self.endpoint, d["login"]) for d in data["users"]]
         return self.__members