SCAN4NET-294 Deduplicate help message IT (#2369)

Author: pavel-mikula-sonarsource

azure-pipelines.yml

@@ -474,11 +474,6 @@ stages:
             inputs:
               versionSpec: $(NUGET_VERSION)
 
-          - powershell: |
-              $projectVersion = Get-Content "$(Build.SourcesDirectory)\build\version.txt"
-              Write-Host "##vso[task.setvariable variable=SONAR_PROJECT_VERSION]$projectVersion"
-            displayName: "Get version from artifact file"
-
           - task: Maven@4
             displayName: 'Run Maven ITs for $(PRODUCT) $(SQ_VERSION)'
             env:
@@ -512,7 +507,6 @@ stages:
                 -Dsonar.textplugin.version=$(TEXT_VERSION)
                 -Dsonar.goplugin.version=$(GO_VERSION)
                 -Dsonar.runtimeVersion=$(SQ_VERSION)
-                -DscannerForMSBuild.version=$(SONAR_PROJECT_VERSION).$(Build.BuildId)
                 -Dmsbuild.path="$(MSBUILD_PATH)"
                 -Dmsbuild.platformtoolset=$(PLATFORMTOOLSET)
                 -Dmsbuild.windowssdk=$(WINDOWSSDKTARGET)

its/pom.xml

@@ -124,36 +124,4 @@
     </plugins>
   </build>
 
-  <profiles>
-    <profile>
-      <id>download-scanner-artifacts</id>
-      <activation>
-        <property>
-          <name>scannerForMSBuild.version</name>
-        </property>
-      </activation>
-      <build>
-        <plugins>
-          <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-dependency-plugin</artifactId>
-            <version>3.6.1</version>
-            <executions>
-              <execution>
-                <id>download-scanner</id>
-                <phase>initialize</phase>
-                <goals>
-                  <goal>get</goal>
-                </goals>
-                <configuration>
-                  <artifact>org.sonarsource.scanner.msbuild:sonar-scanner:${scannerForMSBuild.version}:zip:net-framework</artifact>
-                </configuration>
-              </execution>
-            </executions>
-          </plugin>
-        </plugins>
-      </build>
-    </profile>
-  </profiles>
-
 </project>

its/src/test/java/com/sonar/it/scanner/msbuild/sonarqube/ScannerMSBuildTest.java

@@ -27,7 +27,6 @@
 import com.sonar.it.scanner.msbuild.utils.ScannerCommand;
 import com.sonar.it.scanner.msbuild.utils.TestUtils;
 import com.sonar.orchestrator.build.BuildResult;
-import com.sonar.orchestrator.build.ScannerForMSBuild;
 import com.sonar.orchestrator.http.HttpException;
 import com.sonar.orchestrator.locator.FileLocation;
 import com.sonar.orchestrator.util.Command;
@@ -205,17 +204,6 @@ void testSampleWithProxyAuth() throws Exception {
     assertThat(seenByProxy).isNotEmpty();
   }
 
-  @Test
-  void testHelpMessage() throws IOException {
-    assumeTrue(TestUtils.getScannerVersion(ORCHESTRATOR) == null);
-
-    Path projectDir = TestUtils.projectDir(basePath, "ProjectUnderTest");
-    BuildResult result = ORCHESTRATOR.executeBuild(ScannerForMSBuild.create(projectDir.toFile()).addArgument("/?"));
-
-    assertThat(result.getLogs()).contains("Usage");
-    assertTrue(result.isSuccess());
-  }
-
   @Test
   void testNoProjectNameAndVersion() throws Exception {
     String localProjectKey = PROJECT_KEY + ".4";
@@ -486,8 +474,9 @@ void testVerbose() throws IOException {
   @Test
   void testHelp() throws IOException {
     Path projectDir = TestUtils.projectDir(basePath, "ProjectUnderTest");
-    BuildResult result = ORCHESTRATOR.executeBuild(ScannerForMSBuild.create(projectDir.toFile()).addArgument("/?"));
+    BuildResult result = ScannerCommand.createHelpStep(ScannerClassifier.NET_FRAMEWORK, projectDir).execute(ORCHESTRATOR);
 
+    assertTrue(result.isSuccess());
     assertThat(result.getLogs()).contains("Usage");
     assertThat(result.getLogs()).contains("SonarScanner.MSBuild.exe");
   }

its/src/test/java/com/sonar/it/scanner/msbuild/utils/ScannerCommand.java

@@ -37,6 +37,7 @@
 public class ScannerCommand {
 
   private enum Step {
+    help,
     begin,
     end
   }
@@ -71,6 +72,10 @@ public static ScannerCommand createEndStep(ScannerClassifier classifier, String
     return new ScannerCommand(Step.end, classifier, token, projectDir, null);
   }
 
+  public static ScannerCommand createHelpStep(ScannerClassifier classifier, Path projectDir) {
+    return new ScannerCommand(Step.help, classifier, null, projectDir, null);
+  }
+
   public ScannerCommand setProperty(String key, @Nullable String value) {
     if (value == null) {
       this.properties.remove(key);
@@ -164,10 +169,14 @@ private Command createCommand(Orchestrator orchestrator) {
     var tokenProperty = orchestrator.getServer().version().isGreaterThanOrEquals(10, 0)
       ? "/d:sonar.token=" + token   // The `sonar.token` property was introduced in SonarQube 10.0
       : "/d:sonar.login=" + token;  // sonar.login is obsolete
-    var command = classifier.createBaseCommand()
-      .setDirectory(projectDir.toFile())
-      .addArgument(step.toString())
-      .addArgument(tokenProperty);
+    var command = classifier.createBaseCommand().setDirectory(projectDir.toFile());
+    if (step == Step.help) {
+      command.addArgument("/?");
+    } else {
+      command
+        .addArgument(step.toString())
+        .addArgument(tokenProperty);
+    }
     if (step == Step.begin) {
       command.addArgument("/k:" + projectKey);
       if (!properties.containsKey("sonar.host.url")) {

its/src/test/java/com/sonar/it/scanner/msbuild/utils/TestUtils.java

@@ -21,7 +21,6 @@
 
 import com.sonar.orchestrator.Orchestrator;
 import com.sonar.orchestrator.build.BuildResult;
-import com.sonar.orchestrator.http.HttpMethod;
 import com.sonar.orchestrator.locator.Location;
 import com.sonar.orchestrator.locator.MavenLocation;
 import com.sonar.orchestrator.util.Command;
@@ -70,11 +69,6 @@ public class TestUtils {
   public static final Long TIMEOUT_LIMIT = 60 * 1000L;
   public static final String MSBUILD_DEFAULT_PATH = "C:\\Program Files\\Microsoft Visual Studio\\2022\\Professional\\MSBuild\\Current\\Bin\\MSBuild.exe";
 
-  @CheckForNull
-  public static String getScannerVersion(Orchestrator orchestrator) {
-    return orchestrator.getConfiguration().getString("scannerForMSBuild.version");
-  }
-
   @CheckForNull
   public static String getAnalyzerVersion(Orchestrator orchestrator) {
     return orchestrator.getConfiguration().getString("DOTNET_VERSION");
@@ -345,8 +339,7 @@ public static BuildResult executeEndStepAndDumpResults(Orchestrator orchestrator
       endCommand.setEnvironmentVariable(pair.getName(), pair.getValue());
     }
 
-    for (var property : additionalProperties)
-    {
+    for (var property : additionalProperties) {
       var keyValue = property.split("=");
       var value = keyValue.length > 1 ? keyValue[1] : null;
       LOG.info("Setting property: {}={}", keyValue[0], value);