SCAN4NET-342 Prepare AnalysisContext (#2404)

Author: pavel-mikula-sonarsource

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

@@ -19,6 +19,7 @@
  */
 package com.sonar.it.scanner.msbuild.sonarqube;
 
+import com.sonar.it.scanner.msbuild.utils.AnalysisContext;
 import com.sonar.it.scanner.msbuild.utils.ScannerClassifier;
 import com.sonar.it.scanner.msbuild.utils.ScannerCommand;
 import com.sonar.it.scanner.msbuild.utils.TestUtils;
@@ -51,28 +52,23 @@ class ScannerTest {
   public Path basePath;
 
   @Test
-  void testSample() throws Exception {
-    String projectKey = "testSample";
+  void testSample() {
+    var context = AnalysisContext.forServer("testSample", basePath, "ProjectUnderTest");
     ORCHESTRATOR.getServer().restoreProfile(FileLocation.of("projects/ProjectUnderTest/TestQualityProfile.xml"));
-    ORCHESTRATOR.getServer().provisionProject(projectKey, projectKey);
-    ORCHESTRATOR.getServer().associateProjectToQualityProfile(projectKey, "cs", "ProfileForTest");
-
-    String token = TestUtils.getNewToken(ORCHESTRATOR);
-
-    Path projectDir = TestUtils.projectDir(basePath, "ProjectUnderTest");
-    TestUtils.newScannerBegin(ORCHESTRATOR, projectKey, projectDir, token).execute(ORCHESTRATOR);
-    TestUtils.buildMSBuild(ORCHESTRATOR, projectDir);
-    BuildResult result = TestUtils.executeEndStepAndDumpResults(ORCHESTRATOR, projectDir, projectKey, token);
+    ORCHESTRATOR.getServer().provisionProject(context.projectKey, context.projectKey);
+    ORCHESTRATOR.getServer().associateProjectToQualityProfile(context.projectKey, "cs", "ProfileForTest");
+    var result = context.runAnalysis();
 
     assertTrue(result.isSuccess());
-    List<Issue> issues = TestUtils.projectIssues(ORCHESTRATOR, projectKey);
+    List<Issue> issues = TestUtils.projectIssues(ORCHESTRATOR, context.projectKey);
     // 1 * csharpsquid:S1134 (line 34)
     assertThat(issues).hasSize(1);
-    assertThat(TestUtils.getMeasureAsInteger(projectKey, "ncloc", ORCHESTRATOR)).isEqualTo(25);
-    assertThat(TestUtils.getMeasureAsInteger(projectKey + ":ProjectUnderTest/Foo.cs", "ncloc", ORCHESTRATOR)).isEqualTo(25);
-    assertThat(TestUtils.getMeasureAsInteger(projectKey + ":ProjectUnderTest/Foo.cs", "lines", ORCHESTRATOR)).isEqualTo(52);
+    assertThat(TestUtils.getMeasureAsInteger(context.projectKey, "ncloc", ORCHESTRATOR)).isEqualTo(25);
+    assertThat(TestUtils.getMeasureAsInteger(context.projectKey + ":ProjectUnderTest/Foo.cs", "ncloc", ORCHESTRATOR)).isEqualTo(25);
+    assertThat(TestUtils.getMeasureAsInteger(context.projectKey + ":ProjectUnderTest/Foo.cs", "lines", ORCHESTRATOR)).isEqualTo(52);
   }
 
+
   @Test
   void testNoActiveRule() throws IOException {
     String projectKey = "testNoActiveRule";

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

@@ -19,6 +19,7 @@
  */
 package com.sonar.it.scanner.msbuild.sonarqube;
 
+import com.sonar.it.scanner.msbuild.utils.AnalysisContext;
 import com.sonar.it.scanner.msbuild.utils.ScannerClassifier;
 import com.sonar.it.scanner.msbuild.utils.TestUtils;
 import com.sonar.orchestrator.build.BuildResult;

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

@@ -0,0 +1,71 @@
+/*
+ * SonarScanner for .NET
+ * Copyright (C) 2016-2025 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package com.sonar.it.scanner.msbuild.utils;
+
+import com.sonar.it.scanner.msbuild.sonarcloud.CloudConstants;
+import com.sonar.it.scanner.msbuild.sonarqube.ServerTests;
+import com.sonar.orchestrator.Orchestrator;
+import java.nio.file.Path;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class AnalysisContext {
+  final static Logger LOG = LoggerFactory.getLogger(AnalysisContext.class);
+
+  public final Orchestrator orchestrator;
+  public final String projectKey;
+  public final Path projectDir;
+  public final String token;
+  public final ScannerCommand begin;
+  public final ScannerCommand end;
+
+  public AnalysisContext(Orchestrator orchestrator, ScannerClassifier classifier, String projectKey, Path projectDir, String token) {
+    this.orchestrator = orchestrator;
+    this.projectKey = projectKey;
+    this.projectDir = projectDir;
+    this.token = token;
+    begin = ScannerCommand.createBeginStep(classifier, token, projectDir, projectKey);
+    end = ScannerCommand.createEndStep(classifier, token, projectDir);
+  }
+
+  public static AnalysisContext forServer(String projectKey, Path temp, String directoryName) {
+    return forServer(projectKey, temp, directoryName, ScannerClassifier.NET_FRAMEWORK);
+  }
+
+  public static AnalysisContext forServer(String projectKey, Path temp, String directoryName, ScannerClassifier classifier) {
+    return new AnalysisContext(ServerTests.ORCHESTRATOR, classifier, projectKey, TestUtils.projectDir(temp, directoryName), ServerTests.token());
+  }
+
+
+  public AnalysisResult runAnalysis() {
+    var beginResult = begin.execute(orchestrator);
+    // ToDo: NuGet vs Restore
+    // ToDo: SCAN4NET-10 Use BuildCommand
+    var buildResult = TestUtils.buildMSBuild(orchestrator, this.projectDir);
+    var endResult = end.execute(orchestrator);
+    if (endResult.isSuccess()) {
+      TestUtils.dumpComponentList(orchestrator, projectKey);
+      TestUtils.dumpProjectIssues(orchestrator, projectKey);
+    } else {
+      LOG.warn("End step was not successful - skipping dumping issues data");
+    }
+    return new AnalysisResult(beginResult, buildResult, endResult);
+  }
+}

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

@@ -0,0 +1,28 @@
+/*
+ * SonarScanner for .NET
+ * Copyright (C) 2016-2025 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package com.sonar.it.scanner.msbuild.utils;
+
+import com.sonar.orchestrator.build.BuildResult;
+
+public record AnalysisResult(BuildResult begin, BuildResult build, BuildResult end) {
+  public boolean isSuccess() {
+    return begin.isSuccess() && build.isSuccess() && end.isSuccess();
+  }
+}

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

@@ -97,23 +97,23 @@ public static String developmentScannerVersion() {
     return "99";
   }
 
-  // ToDo: SCAN4NET-201: Remove Orchestrator
+  // ToDo: SCAN4NET-201: Remove this, after SCAN4NET-320 or SCAN4NET199 will stop using it
   public static ScannerCommand newScannerBegin(Orchestrator orchestrator, String projectKey, Path projectDir, String token) {
     // ToDo: Cleanup inconsistent "end" logic. For now, this defaults to "end" step and caller must override it
     return ScannerCommand.createBeginStep(ScannerClassifier.NET_FRAMEWORK, token, projectDir, projectKey);
   }
 
-  // ToDo: SCAN4NET-201: Remove Orchestrator
+  // ToDo: SCAN4NET-201: Remove this, after SCAN4NET-320 or SCAN4NET199 will stop using it
   public static ScannerCommand newScannerBegin(Orchestrator orchestrator, String projectKey, Path projectDir, String token, ScannerClassifier classifier) {
     return ScannerCommand.createBeginStep(classifier, token, projectDir, projectKey);
   }
 
-  // ToDo: SCAN4NET-201: Remove Orchestrator
+  // ToDo: SCAN4NET-201: Remove this, after SCAN4NET-320 or SCAN4NET199 will stop using it
   public static ScannerCommand newScannerEnd(Orchestrator orchestrator, Path projectDir, String token) {
     return ScannerCommand.createEndStep(ScannerClassifier.NET_FRAMEWORK, token, projectDir);
   }
 
-  // ToDo: SCAN4NET-201: Remove Orchestrator
+  // ToDo: SCAN4NET-201: Remove this, after SCAN4NET-320 or SCAN4NET199 will stop using it
   public static ScannerCommand newScannerEnd(Orchestrator orchestrator, Path projectDir, ScannerClassifier classifier, String token) {
     return ScannerCommand.createEndStep(classifier, token, projectDir);
   }
@@ -165,14 +165,18 @@ public static void deleteVirtualDrive(String drive) {
     assertThat(cleanupStatus).isZero();
   }
 
-  public static Path projectDir(Path temp, String projectName) throws IOException {
-    File projectToCopy = Paths.get("projects").resolve(projectName).toFile();
-    File destination = new File(temp.toFile(), projectName).getCanonicalFile();
-    FileUtils.deleteDirectory(destination);
-    Path newFolder = Files.createDirectories(destination.toPath());
-    FileUtils.copyDirectory(projectToCopy, newFolder.toFile());
-    Files.copy(Paths.get("..", "NuGet.Config"), newFolder.resolve("NuGet.Config"));
-    return newFolder;
+  public static Path projectDir(Path temp, String projectName) {
+    try {
+      File projectToCopy = Paths.get("projects").resolve(projectName).toFile();
+      File destination = new File(temp.toFile(), projectName).getCanonicalFile();
+      FileUtils.deleteDirectory(destination);
+      Path newFolder = Files.createDirectories(destination.toPath());
+      FileUtils.copyDirectory(projectToCopy, newFolder.toFile());
+      Files.copy(Paths.get("..", "NuGet.Config"), newFolder.resolve("NuGet.Config"));
+      return newFolder;
+    } catch (IOException ex) {
+      throw new RuntimeException(ex.getMessage(), ex);
+    }
   }
 
   public static void runMSBuildWithBuildWrapper(Orchestrator orch, Path projectDir, File buildWrapperPath, File outDir,
@@ -193,20 +197,24 @@ public static void updateSetting(Orchestrator orchestrator, String projectKey, S
     newWsClient(orchestrator).settings().set(new SetRequest().setComponent(projectKey).setKey(propertyKey).setValues(values));
   }
 
+  // ToDo: SCAN4NET-10 will move/deprecate/remove this in favor of BuildCommand
   public static void runMSBuild(Orchestrator orch, Path projectDir, String... arguments) {
     runMSBuild(orch, projectDir, Collections.emptyList(), TIMEOUT_LIMIT, arguments);
   }
 
-  public static void buildMSBuild(Orchestrator orchestrator, Path projectDir) {
-    runMSBuild(orchestrator, projectDir, Collections.emptyList(), TIMEOUT_LIMIT, "/t:Restore,Rebuild");
+  // ToDo: SCAN4NET-10 will move/deprecate/remove this in favor of BuildCommand
+  public static BuildResult buildMSBuild(Orchestrator orchestrator, Path projectDir) {
+    return runMSBuild(orchestrator, projectDir, Collections.emptyList(), TIMEOUT_LIMIT, "/t:Restore,Rebuild");
   }
 
+  // ToDo: SCAN4NET-10 will move/deprecate/remove this in favor of BuildCommand
   public static BuildResult runMSBuild(Orchestrator orch, Path projectDir, List<EnvironmentVariable> environmentVariables, long timeoutLimit, String... arguments) {
     BuildResult r = runMSBuildQuietly(orch, projectDir, environmentVariables, timeoutLimit, arguments);
     assertThat(r.isSuccess()).isTrue();
     return r;
   }
 
+  // ToDo: Move to AnalysisContext
   public static void runNuGet(Orchestrator orch, Path projectDir, Boolean useDefaultVSCodeMSBuild, String... arguments) {
     Path nugetPath = getNuGetPath(orch);
     var nugetRestore = Command.create(nugetPath.toString())
@@ -221,10 +229,12 @@ public static void runNuGet(Orchestrator orch, Path projectDir, Boolean useDefau
     assertThat(r).isZero();
   }
 
+  // ToDo: SCAN4NET-10 will move/deprecate/remove this in favor of BuildCommand
   public static BuildResult runDotnetCommand(Path workingDir, String dotnetCommand, String... arguments) {
     return runDotnetCommand(workingDir, Collections.emptyList(), dotnetCommand, arguments);
   }
 
+  // ToDo: SCAN4NET-10 will move/deprecate/remove this in favor of BuildCommand
   public static BuildResult runDotnetCommand(Path workingDir, List<EnvironmentVariable> environmentVariables, String dotnetCommand, String... arguments) {
     var argumentList = new ArrayList<>(Arrays.asList(arguments));
     argumentList.add(0, dotnetCommand);
@@ -255,6 +265,7 @@ private static Path getNuGetPath(Orchestrator orch) {
     return nugetPath;
   }
 
+  // ToDo: SCAN4NET-10 will move/deprecate/remove this in favor of BuildCommand
   private static BuildResult runMSBuildQuietly(Orchestrator orch, Path projectDir, List<EnvironmentVariable> environmentVariables, long timeoutLimit, String... arguments) {
     Path msBuildPath = getMsBuildPath(orch);
 
@@ -316,6 +327,7 @@ public static void dumpProjectIssues(Orchestrator orchestrator, String projectKe
     }
   }
 
+  @Deprecated // Use AnalysisContext instead
   public static BuildResult runAnalysis(Path projectDir, String projectKey, Boolean useNuGet) {
     String token = TestUtils.getNewToken(ORCHESTRATOR);
     String folderName = projectDir.getFileName().toString();
@@ -327,15 +339,18 @@ public static BuildResult runAnalysis(Path projectDir, String projectKey, Boolea
     return TestUtils.executeEndStepAndDumpResults(ORCHESTRATOR, projectDir, projectKey, token);
   }
 
+  @Deprecated // Use AnalysisContext instead
   public static BuildResult executeEndStepAndDumpResults(Orchestrator orchestrator, Path projectDir, String projectKey, String token) {
     return executeEndStepAndDumpResults(orchestrator, projectDir, projectKey, token, ScannerClassifier.NET_FRAMEWORK, Collections.emptyList(), Collections.emptyList());
   }
 
+  @Deprecated // Use AnalysisContext instead
   public static BuildResult executeEndStepAndDumpResults(Orchestrator orchestrator, Path projectDir, String projectKey, String token,
     List<EnvironmentVariable> environmentVariables) {
     return executeEndStepAndDumpResults(orchestrator, projectDir, projectKey, token, ScannerClassifier.NET_FRAMEWORK, environmentVariables, Collections.emptyList());
   }
 
+  @Deprecated // Use AnalysisContext instead
   public static BuildResult executeEndStepAndDumpResults(
     Orchestrator orchestrator,
     Path projectDir,
@@ -346,6 +361,7 @@ public static BuildResult executeEndStepAndDumpResults(
     return executeEndStepAndDumpResults(orchestrator, projectDir, projectKey, token, ScannerClassifier.NET_FRAMEWORK, environmentVariables, additionalProperties);
   }
 
+  @Deprecated // Use AnalysisContext instead
   public static BuildResult executeEndStepAndDumpResults(Orchestrator orchestrator,
     Path projectDir,
     String projectKey,
@@ -408,6 +424,7 @@ public static String getNewToken(Orchestrator orchestrator) {
     return ServerTests.token();
   }
 
+  // ToDo: Remove this in SCAN4NET-290
   public static boolean hasModules(Orchestrator orch) {
     return !orch.getServer().version().isGreaterThanOrEquals(7, 6);
   }
@@ -468,6 +485,7 @@ private static List<String> extractCeTaskIds(BuildResult buildResult) {
       .collect(Collectors.toList());
   }
 
+  // ToDo: SCAN4NET-10 will deprecate/remove this. By using AnalysisContext and its environment variable handling, this will not be needed anymore
   private static Command initCommandEnvironment(Command command, List<EnvironmentVariable> environmentVariables) {
     var buildDirectory = environmentVariables.stream().filter(x -> x.name() == AzureDevOps.AGENT_BUILDDIRECTORY).findFirst();
     if (buildDirectory.isPresent()) {