treat sonar-login as deprecated

fastlane · Dec 17, 2023 · c06fe62 · c06fe62
1 parent ba3f208
commit c06fe62
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/fastlane/lib/fastlane/actions/sonar.rb b/fastlane/lib/fastlane/actions/sonar.rb
@@ -10,6 +10,8 @@ def self.run(params)
           '&&'
         ].join(' ')
 
+        sonar_token_arg = params[:sonar_token] ? params[:sonar_token] : params[:sonar_login]
+
         sonar_scanner_args = []
         sonar_scanner_args << "-Dproject.settings=\"#{params[:project_configuration_path]}\"" if params[:project_configuration_path]
         sonar_scanner_args << "-Dsonar.projectKey=\"#{params[:project_key]}\"" if params[:project_key]
@@ -19,7 +21,7 @@ def self.run(params)
         sonar_scanner_args << "-Dsonar.exclusions=\"#{params[:exclusions]}\"" if params[:exclusions]
         sonar_scanner_args << "-Dsonar.language=\"#{params[:project_language]}\"" if params[:project_language]
         sonar_scanner_args << "-Dsonar.sourceEncoding=\"#{params[:source_encoding]}\"" if params[:source_encoding]
-        sonar_scanner_args << "-Dsonar.token=\"#{params[:sonar_token]}\"" if params[:sonar_token]
+        sonar_scanner_args << "-Dsonar.token=\"#{sonar_token_arg}\"" if sonar_token_arg
         sonar_scanner_args << "-Dsonar.host.url=\"#{params[:sonar_url]}\"" if params[:sonar_url]
         sonar_scanner_args << "-Dsonar.organization=\"#{params[:sonar_organization]}\"" if params[:sonar_organization]
         sonar_scanner_args << "-Dsonar.branch.name=\"#{params[:branch_name]}\"" if params[:branch_name]
@@ -98,6 +100,12 @@ def self.available_options
                                        env_name: "FL_SONAR_RUNNER_ARGS",
                                        description: "Pass additional arguments to sonar-scanner. Be sure to provide the arguments with a leading `-D` e.g. FL_SONAR_RUNNER_ARGS=\"-Dsonar.verbose=true\"",
                                        optional: true),
+          FastlaneCore::ConfigItem.new(key: :sonar_login,
+                                       env_name: "FL_SONAR_LOGIN",
+                                       description: "Pass the Sonar Login Token (e.g: xxxxxxprivate_token_XXXXbXX7e)",
+                                       deprecated: "Deprecated in sonar-scanner >= 5.0.x",
+                                       optional: true,
+                                       sensitive: true),
           FastlaneCore::ConfigItem.new(key: :sonar_token,
                                        env_name: "FL_SONAR_TOKEN",
                                        description: "Pass the Sonar Token (e.g: xxxxxxprivate_token_XXXXbXX7e)",

diff --git a/fastlane/swift/Fastlane.swift b/fastlane/swift/Fastlane.swift
@@ -10624,7 +10624,8 @@ public func snapshot(workspace: OptionalConfigValue<String?> = .fastlaneDefault(
    - projectLanguage: Language key, e.g. objc
    - sourceEncoding: Used encoding of source files, e.g., UTF-8
    - sonarRunnerArgs: Pass additional arguments to sonar-scanner. Be sure to provide the arguments with a leading `-D` e.g. FL_SONAR_RUNNER_ARGS="-Dsonar.verbose=true"
-   - sonarToken: Pass the Sonar Login token (e.g: xxxxxxprivate_token_XXXXbXX7e)
+   - sonarToken: Pass the Sonar Login token (e.g: xxxxxxprivate_token_XXXXbXX7e), sonarLogin is deprecated in sonar-scanner 5.0.x
+   - sonarLogin: sonarLogin is deprecated in sonar-scanner 5.0.x, use sonarToken instead
    - sonarUrl: Pass the url of the Sonar server
    - sonarOrganization: Key of the organization on SonarCloud
    - branchName: Pass the branch name which is getting scanned
@@ -10647,6 +10648,7 @@ public func sonar(projectConfigurationPath: OptionalConfigValue<String?> = .fast
                   sourceEncoding: OptionalConfigValue<String?> = .fastlaneDefault(nil),
                   sonarRunnerArgs: OptionalConfigValue<String?> = .fastlaneDefault(nil),
                   sonarToken: OptionalConfigValue<String?> = .fastlaneDefault(nil),
+                  sonarLogin: OptionalConfigValue<String?> = .fastlaneDefault(nil),
                   sonarUrl: OptionalConfigValue<String?> = .fastlaneDefault(nil),
                   sonarOrganization: OptionalConfigValue<String?> = .fastlaneDefault(nil),
                   branchName: OptionalConfigValue<String?> = .fastlaneDefault(nil),
@@ -10664,6 +10666,7 @@ public func sonar(projectConfigurationPath: OptionalConfigValue<String?> = .fast
     let sourceEncodingArg = sourceEncoding.asRubyArgument(name: "source_encoding", type: nil)
     let sonarRunnerArgsArg = sonarRunnerArgs.asRubyArgument(name: "sonar_runner_args", type: nil)
     let sonarTokenArg = sonarToken.asRubyArgument(name: "sonar_token", type: nil)
+    let sonarLoginArg = sonarLogin.asRubyArgument(name: "sonar_login", type: nil)
     let sonarUrlArg = sonarUrl.asRubyArgument(name: "sonar_url", type: nil)
     let sonarOrganizationArg = sonarOrganization.asRubyArgument(name: "sonar_organization", type: nil)
     let branchNameArg = branchName.asRubyArgument(name: "branch_name", type: nil)
@@ -10679,7 +10682,7 @@ public func sonar(projectConfigurationPath: OptionalConfigValue<String?> = .fast
                                           projectLanguageArg,
                                           sourceEncodingArg,
                                           sonarRunnerArgsArg,
-                                          sonarTokenArg,
+                                          sonarToken != .fastlaneDefault(nil) ? sonarTokenArg : sonarLoginArg,
                                           sonarUrlArg,
                                           sonarOrganizationArg,
                                           branchNameArg,