Fixes #1346

Author: okorach

cli/migration.py

@@ -24,7 +24,7 @@
 import sys
 
 from cli import options
-from sonar import exceptions, errcodes, utilities
+from sonar import exceptions, errcodes, utilities, version
 import sonar.logging as log
 from sonar import platform, rules, qualityprofiles, qualitygates, users, groups
 from sonar import projects, portfolios, applications
@@ -143,6 +143,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"sonar-migration {version.MIGRATION_TOOL_VERSION}")
     except (options.ArgumentsError, exceptions.ObjectNotFound) as e:
         utilities.exit_fatal(e.message, e.errcode)
 

sonar/platform.py

@@ -53,7 +53,7 @@
 _NON_EXISTING_SETTING_SKIPPED = "Setting %s does not exist, skipping..."
 _HTTP_ERROR = "%s Error: %s HTTP status code %d - %s"
 
-_SONAR_TOOLS_AGENT = {"user-agent": f"sonar-tools {version.PACKAGE_VERSION}"}
+_SONAR_TOOLS_AGENT = f"sonar-tools {version.PACKAGE_VERSION}"
 _UPDATE_CENTER = "https://raw.githubusercontent.com/SonarSource/sonar-update-center-properties/master/update-center-source.properties"
 
 LTA = None
@@ -88,6 +88,7 @@ def __init__(self, url: str, token: str, org: str = None, cert_file: Optional[st
         self.http_timeout = int(http_timeout)
         self.organization = org
         self.__is_sonarcloud = util.is_sonarcloud_url(self.url)
+        self._user_agent = _SONAR_TOOLS_AGENT
 
     def __str__(self) -> str:
         """
@@ -136,6 +137,9 @@ def user_data(self) -> types.ApiPayload:
             self.__user_data = json.loads(self.get("api/users/current").text)
         return self.__user_data
 
+    def set_user_agent(self, user_agent: str) -> None:
+        self._user_agent = user_agent
+
     def server_id(self) -> str:
         """
         Returns the SonarQube instance server id
@@ -210,7 +214,7 @@ def __run_request(
     ) -> requests.Response:
         """Makes an HTTP request to SonarQube"""
         api = _normalize_api(api)
-        headers = _SONAR_TOOLS_AGENT
+        headers = {"user-agent": self._user_agent}
         if params is None:
             params = {}
         if self.is_sonarcloud():