Own UA for each sonar-tool

Author: okorach

cli/audit.py

@@ -27,12 +27,12 @@
 import json
 import csv
 from typing import TextIO
-from threading import Thread, Lock
+from threading import Thread
 from queue import Queue
 
 from cli import options
 
-from sonar import errcodes, exceptions
+from sonar import errcodes, exceptions, version
 from sonar.util import types
 import sonar.logging as log
 from sonar import platform, users, groups, qualityprofiles, qualitygates, sif, portfolios, applications, projects
@@ -50,7 +50,7 @@
     options.WHAT_PORTFOLIOS,
 ]
 
-_WRITE_LOCK = Lock()
+TOOL_NAME = "sonar-audit"
 
 
 def _audit_sif(sysinfo, audit_settings):
@@ -170,7 +170,7 @@ def __parser_args(desc):
         action="store_true",
         help="Creates the $HOME/.sonar-audit.properties configuration file, if not already present or outputs to stdout if it already exist",
     )
-    args = options.parse_and_check(parser=parser, logger_name="sonar-audit", verify_token=False)
+    args = options.parse_and_check(parser=parser, logger_name=TOOL_NAME, verify_token=False)
     if args.sif is None and args.config is None:
         util.check_token(args.token)
     return args
@@ -183,7 +183,7 @@ def main():
     except options.ArgumentsError as e:
         util.exit_fatal(e.message, e.errcode)
 
-    settings = config.load("sonar-audit")
+    settings = config.load(TOOL_NAME)
     settings["threads"] = kwargs[options.NBR_THREADS]
     if kwargs.get("config", False):
         config.configure()
@@ -211,6 +211,7 @@ def main():
         try:
             sq = platform.Platform(**kwargs)
             sq.verify_connection()
+            sq.set_user_agent(f"{TOOL_NAME} {version.PACKAGE_VERSION}")
         except exceptions.ConnectionError as e:
             util.exit_fatal(e.message, e.errcode)
         server_id = sq.server_id()

cli/config.py

@@ -23,14 +23,14 @@
 """
 import sys
 from typing import TextIO
-from threading import Thread, Lock
+from threading import Thread
 from queue import Queue
 
 import json
 import yaml
 
 from cli import options
-from sonar import exceptions, errcodes, utilities
+from sonar import exceptions, errcodes, utilities, version
 from sonar.util import types
 import sonar.logging as log
 from sonar import platform, rules, qualityprofiles, qualitygates, users, groups
@@ -50,8 +50,9 @@
     options.WHAT_PORTFOLIOS,
 ]
 
-__JSON_KEY_PLATFORM = "platform"
+TOOL_NAME = "sonar-config"
 
+__JSON_KEY_PLATFORM = "platform"
 __JSON_KEY_SETTINGS = "globalSettings"
 __JSON_KEY_USERS = "users"
 __JSON_KEY_GROUPS = "groups"
@@ -74,8 +75,6 @@
     options.WHAT_PORTFOLIOS: __JSON_KEY_PORTFOLIOS,
 }
 
-_WRITE_LOCK = Lock()
-
 
 _EXPORT_CALLS = {
     "platform": [__JSON_KEY_PLATFORM, platform.basics],
@@ -123,8 +122,7 @@ def __parse_args(desc):
         help="By default, sonar-config exports multi-valued settings as comma separated strings instead of arrays (if there is not comma in values). "
         "Set this flag if you want to force export multi valued settings as arrays",
     )
-    args = options.parse_and_check(parser=parser, logger_name="sonar-config")
-    return args
+    return options.parse_and_check(parser=parser, logger_name=TOOL_NAME)
 
 
 def __write_export(config: dict[str, str], file: str, format: str) -> None:
@@ -320,6 +318,7 @@ def main() -> None:
         kwargs = utilities.convert_args(__parse_args("Extract SonarQube platform configuration"))
         endpoint = platform.Platform(**kwargs)
         endpoint.verify_connection()
+        endpoint.set_user_agent(f"{TOOL_NAME} {version.PACKAGE_VERSION}")
     except (options.ArgumentsError, exceptions.ObjectNotFound) as e:
         utilities.exit_fatal(e.message, e.errcode)
     if not kwargs[options.EXPORT] and not kwargs[options.IMPORT]:

cli/cust_measures.py

@@ -29,7 +29,9 @@
 
 from cli import options
 import sonar.logging as log
-from sonar import custom_measures, platform, utilities, errcodes, exceptions
+from sonar import custom_measures, platform, utilities, errcodes, exceptions, version
+
+TOOL_NAME = "sonar-custom-measures"
 
 
 def parse_args(desc):
@@ -38,7 +40,7 @@ def parse_args(desc):
     parser.add_argument("-m", "--metricKey", required=True, help="What custom metric to work on")
     parser.add_argument("--value", required=False, help="Updates the value of the metric")
     parser.add_argument("--description", required=False, help="Updates the description of the metric")
-    return options.parse_and_check(parser, logger_name="sonar-custom-measures")
+    return options.parse_and_check(parser, logger_name=TOOL_NAME)
 
 
 def main():
@@ -47,6 +49,7 @@ def main():
         kwargs = utilities.convert_args(parse_args("Manipulate custom metrics"))
         sqenv = platform.Platform(**kwargs)
         sqenv.verify_connection()
+        sqenv.set_user_agent(f"{TOOL_NAME} {version.PACKAGE_VERSION}")
     except (options.ArgumentsError, exceptions.ObjectNotFound) as e:
         utilities.exit_fatal(e.message, e.errcode)
     if sqenv.version() >= (9, 0, 0):

cli/findings_export.py

@@ -32,16 +32,17 @@
 from queue import Queue
 import threading
 from threading import Thread
-from requests import HTTPError, RequestException
+from requests import RequestException
 
 from cli import options
 from sonar.util.types import ConfigSettings
 import sonar.logging as log
-from sonar import platform, exceptions, errcodes
+from sonar import platform, exceptions, errcodes, version
 from sonar import issues, hotspots, findings
 from sonar import projects, applications, portfolios
 import sonar.utilities as util
 
+TOOL_NAME = "sonar-findings"
 WRITE_END = object()
 TOTAL_FINDINGS = 0
 IS_FIRST = True
@@ -140,8 +141,7 @@ def parse_args(desc):
     options.add_url_arg(parser)
     options.add_dateformat_arg(parser)
     options.add_language_arg(parser, "findings")
-    args = options.parse_and_check(parser=parser, logger_name="sonar-findings-export")
-    return args
+    return options.parse_and_check(parser=parser, logger_name=TOOL_NAME)
 
 
 def __write_header(**kwargs) -> None:
@@ -402,6 +402,7 @@ def main():
         kwargs = util.convert_args(parse_args("Sonar findings export"))
         sqenv = platform.Platform(**kwargs)
         sqenv.verify_connection()
+        sqenv.set_user_agent(f"{TOOL_NAME} {version.PACKAGE_VERSION}")
     except (options.ArgumentsError, exceptions.ObjectNotFound) as e:
         util.exit_fatal(e.message, e.errcode)
     del kwargs[options.TOKEN]

cli/findings_sync.py

@@ -33,10 +33,10 @@
 
 from cli import options
 import sonar.logging as log
-from sonar import platform, syncer, exceptions, projects, branches, errcodes
+from sonar import platform, syncer, exceptions, projects, branches, errcodes, version
 import sonar.utilities as util
 
-_WITH_COMMENTS = {"additionalFields": "comments"}
+TOOL_NAME = "sonar-findings-sync"
 
 
 def __parse_args(desc):
@@ -88,8 +88,7 @@ def __parse_args(desc):
         help="If specified, will not add a link to source issue in the target issue comments",
     )
 
-    args = options.parse_and_check(parser=parser, logger_name="sonar-findings-sync")
-    return args
+    return options.parse_and_check(parser=parser, logger_name=TOOL_NAME)
 
 
 def __dump_report(report, file):
@@ -114,6 +113,7 @@ def main() -> int:
         params = util.convert_args(args)
         source_env = platform.Platform(**params)
         source_env.verify_connection()
+        source_env.set_user_agent(f"{TOOL_NAME} {version.PACKAGE_VERSION}")
     except (options.ArgumentsError, exceptions.ObjectNotFound) as e:
         util.exit_fatal(e.message, e.errcode)
 
@@ -135,6 +135,7 @@ def main() -> int:
             target_params = util.convert_args(args, second_platform=True)
             target_env = platform.Platform(**target_params)
             target_env.verify_connection()
+            target_env.set_user_agent(f"{TOOL_NAME} {version.PACKAGE_VERSION}")
         except (options.ArgumentsError, exceptions.ObjectNotFound) as e:
             util.exit_fatal(e.message, e.errcode)
 
@@ -159,6 +160,7 @@ def main() -> int:
     }
 
     report = []
+    counters = {}
     try:
         if not projects.exists(source_key, endpoint=source_env):
             raise exceptions.ObjectNotFound(source_key, f"Project key '{source_key}' does not exist")

cli/housekeeper.py

@@ -31,11 +31,13 @@
 
 from cli import options
 import sonar.logging as log
-from sonar import platform, tokens, users, projects, branches, pull_requests
+from sonar import platform, tokens, users, projects, branches, pull_requests, version
 import sonar.utilities as util
 import sonar.exceptions as ex
 from sonar.audit import config, problem
 
+TOOL_NAME = "sonar-housekeeper"
+
 
 def get_project_problems(max_days_proj, max_days_branch, max_days_pr, nb_threads, endpoint):
     problems = []
@@ -153,8 +155,7 @@ def _parse_arguments():
         default=_DEFAULT_TOKEN_OBSOLESCENCE,
         help=f"Deletes user tokens older than a certain number of days, by default {_DEFAULT_TOKEN_OBSOLESCENCE} days",
     )
-    args = options.parse_and_check(parser=parser, logger_name="sonar-housekeeper")
-    return args
+    return options.parse_and_check(parser=parser, logger_name=TOOL_NAME)
 
 
 def _delete_objects(problems, mode):
@@ -207,6 +208,7 @@ def main():
         kwargs = util.convert_args(_parse_arguments())
         sq = platform.Platform(**kwargs)
         sq.verify_connection()
+        sq.set_user_agent(f"{TOOL_NAME} {version.PACKAGE_VERSION}")
     except (options.ArgumentsError, ex.ObjectNotFound) as e:
         util.exit_fatal(e.message, e.errcode)
 

cli/loc.py

@@ -28,9 +28,11 @@
 
 from cli import options
 import sonar.logging as log
-from sonar import platform, portfolios, applications, projects, errcodes, exceptions
+from sonar import platform, portfolios, applications, projects, errcodes, exceptions, version
 import sonar.utilities as util
 
+TOOL_NAME = "sonar-loc"
+
 
 def __get_csv_header_list(**kwargs) -> list[str]:
     """Returns CSV header"""
@@ -194,7 +196,7 @@ def __parse_args(desc):
         action="store_true",
         help="Extracts only toplevel portfolios LoCs, not sub-portfolios",
     )
-    args = options.parse_and_check(parser=parser, logger_name="sonar-loc")
+    args = options.parse_and_check(parser=parser, logger_name=TOOL_NAME)
     return args
 
 
@@ -220,6 +222,7 @@ def main() -> None:
         )
         endpoint = platform.Platform(**kwargs)
         endpoint.verify_connection()
+        endpoint.set_user_agent(f"{TOOL_NAME} {version.PACKAGE_VERSION}")
     except (options.ArgumentsError, exceptions.ConnectionError) as e:
         util.exit_fatal(e.message, e.errcode)
 

cli/measures_export.py

@@ -33,10 +33,11 @@
 from sonar.util import types
 from cli import options
 import sonar.logging as log
-from sonar import metrics, platform, exceptions, errcodes
+from sonar import metrics, platform, exceptions, errcodes, version
 from sonar import projects, applications, portfolios
 import sonar.utilities as util
 
+TOOL_NAME = "sonar-measures"
 RATINGS = "letters"
 PERCENTS = "float"
 DATEFMT = "datetime"
@@ -140,7 +141,7 @@ def __parse_args(desc):
     )
     options.add_dateformat_arg(parser)
     options.add_url_arg(parser)
-    args = options.parse_and_check(parser=parser, logger_name="sonar-measures-export")
+    args = options.parse_and_check(parser=parser, logger_name=TOOL_NAME)
     if args.ratingsAsNumbers:
         CONVERT_OPTIONS["ratings"] = "numbers"
     if args.percentsAsString:
@@ -295,6 +296,7 @@ def main() -> None:
         kwargs = util.convert_args(__parse_args("Extract measures of projects"))
         endpoint = platform.Platform(**kwargs)
         endpoint.verify_connection()
+        endpoint.set_user_agent(f"{TOOL_NAME} {version.PACKAGE_VERSION}")
     except (options.ArgumentsError, exceptions.ObjectNotFound) as e:
         util.exit_fatal(e.message, e.errcode)
 

cli/projects_cli.py

@@ -29,9 +29,11 @@
 
 from cli import options
 import sonar.logging as log
-from sonar import errcodes, exceptions, utilities
+from sonar import errcodes, exceptions, utilities, version
 from sonar import platform, projects
 
+TOOL_NAME = "sonar-projects"
+
 
 def __export_projects(endpoint: platform.Platform, **kwargs) -> None:
     """Exports a list (or all) of projects into zip files"""
@@ -126,9 +128,10 @@ def main() -> None:
         help="Maximum wait time for export of 1 project",
     )
     try:
-        kwargs = utilities.convert_args(options.parse_and_check(parser=parser, logger_name="sonar-projects"))
+        kwargs = utilities.convert_args(options.parse_and_check(parser=parser, logger_name=TOOL_NAME))
         sq = platform.Platform(**kwargs)
         sq.verify_connection()
+        sq.set_user_agent(f"{TOOL_NAME} {version.PACKAGE_VERSION}")
     except (options.ArgumentsError, exceptions.ObjectNotFound) as e:
         utilities.exit_fatal(e.message, e.errcode)
 

cli/rules_cli.py

@@ -26,17 +26,19 @@
 
 from cli import options
 import sonar.logging as log
-from sonar import rules, platform, exceptions, errcodes
+from sonar import rules, platform, exceptions, errcodes, version
 import sonar.utilities as util
 
+TOOL_NAME = "sonar-rules"
+
 
 def __parse_args(desc: str) -> object:
     """Sets and parses CLI arguments"""
     parser = options.set_common_args(desc)
     parser = options.set_output_file_args(parser, allowed_formats=("json", "csv"))
     parser = options.add_language_arg(parser, "rules")
     parser = options.add_import_export_arg(parser, "rules", import_opt=False)
-    args = options.parse_and_check(parser=parser, logger_name="sonar-rules")
+    args = options.parse_and_check(parser=parser, logger_name=TOOL_NAME)
     return args
 
 
@@ -68,6 +70,7 @@ def main() -> int:
         kwargs = util.convert_args(__parse_args("Extract rules"))
         endpoint = platform.Platform(**kwargs)
         endpoint.verify_connection()
+        endpoint.set_user_agent(f"{TOOL_NAME} {version.PACKAGE_VERSION}")
     except (options.ArgumentsError, exceptions.ObjectNotFound) as e:
         util.exit_fatal(e.message, e.errcode)
     file = kwargs[options.REPORT_FILE]