SONAR-11950 add scm revision scanner parameter

9 files changed, 36 insertions, 9 deletions

diff --git a/server/sonar-ce-task-projectanalysis/src/main/java/org/sonar/ce/task/projectanalysis/component/ProjectAttributes.java b/server/sonar-ce-task-projectanalysis/src/main/java/org/sonar/ce/task/projectanalysis/component/ProjectAttributes.java
index 051c7f0cec3..9d0cefd5e2e 100644
--- a/server/sonar-ce-task-projectanalysis/src/main/java/org/sonar/ce/task/projectanalysis/component/ProjectAttributes.java
+++ b/server/sonar-ce-task-projectanalysis/src/main/java/org/sonar/ce/task/projectanalysis/component/ProjectAttributes.java
@@ -30,14 +30,19 @@ public class ProjectAttributes {
   @Nullable
   private final String buildString;
 
-  public ProjectAttributes(String projectVersion, @Nullable String buildString) {
+  @Nullable
+  private final String scmRevisionId;
+
+  public ProjectAttributes(String projectVersion, @Nullable String buildString, @Nullable String scmRevisionId) {
     this.projectVersion = requireNonNull(projectVersion, "project version can't be null");
     this.buildString = buildString;
+    this.scmRevisionId = scmRevisionId;
   }
 
   public ProjectAttributes(ProjectAttributes projectAttributes) {
     this.projectVersion = projectAttributes.projectVersion;
     this.buildString = projectAttributes.buildString;
+    this.scmRevisionId = projectAttributes.scmRevisionId;
   }
 
   public String getProjectVersion() {
@@ -48,11 +53,16 @@ public class ProjectAttributes {
     return Optional.ofNullable(buildString);
   }
 
+  public Optional<String> getScmRevisionId() {
+    return Optional.ofNullable(scmRevisionId);
+  }
+
   @Override
   public String toString() {
     return "ProjectAttributes{" +
       "projectVersion='" + projectVersion + '\'' +
       "buildString='" + buildString + '\'' +
+      "scmRevisionId='" + scmRevisionId + '\'' +
       '}';
   }
 }
diff --git a/server/sonar-ce-task-projectanalysis/src/main/java/org/sonar/ce/task/projectanalysis/step/BuildComponentTreeStep.java b/server/sonar-ce-task-projectanalysis/src/main/java/org/sonar/ce/task/projectanalysis/step/BuildComponentTreeStep.java
index b4788259f40..96abdd05c0e 100644
--- a/server/sonar-ce-task-projectanalysis/src/main/java/org/sonar/ce/task/projectanalysis/step/BuildComponentTreeStep.java
+++ b/server/sonar-ce-task-projectanalysis/src/main/java/org/sonar/ce/task/projectanalysis/step/BuildComponentTreeStep.java
@@ -113,7 +113,8 @@ public class BuildComponentTreeStep implements ComputationStep {
   private static ProjectAttributes createProjectAttributes(ScannerReport.Metadata metadata, @Nullable SnapshotDto baseAnalysis) {
     String projectVersion = computeProjectVersion(trimToNull(metadata.getProjectVersion()), baseAnalysis);
     String buildString = trimToNull(metadata.getBuildString());
-    return new ProjectAttributes(projectVersion, buildString);
+    String scmRevisionId = trimToNull(metadata.getScmRevisionId());
+    return new ProjectAttributes(projectVersion, buildString, scmRevisionId);
   }
 
   private static String computeProjectVersion(@Nullable String projectVersion, @Nullable SnapshotDto baseAnalysis) {
diff --git a/server/sonar-ce-task-projectanalysis/src/main/java/org/sonar/ce/task/projectanalysis/step/PersistAnalysisStep.java b/server/sonar-ce-task-projectanalysis/src/main/java/org/sonar/ce/task/projectanalysis/step/PersistAnalysisStep.java
index c6bc3bdc068..134e0a0867b 100644
--- a/server/sonar-ce-task-projectanalysis/src/main/java/org/sonar/ce/task/projectanalysis/step/PersistAnalysisStep.java
+++ b/server/sonar-ce-task-projectanalysis/src/main/java/org/sonar/ce/task/projectanalysis/step/PersistAnalysisStep.java
@@ -104,7 +104,7 @@ public class PersistAnalysisStep implements ComputationStep {
       String componentUuid = component.getUuid();
       String projectVersion = component.getType() == PROJECT ? component.getProjectAttributes().getProjectVersion() : null;
       String buildString = component.getType() == PROJECT ? component.getProjectAttributes().getBuildString().orElse(null) : null;
-      return new SnapshotDto()
+      SnapshotDto dto = new SnapshotDto()
         .setUuid(snapshotUuid)
         .setProjectVersion(projectVersion)
         .setBuildString(buildString)
@@ -113,6 +113,12 @@ public class PersistAnalysisStep implements ComputationStep {
         .setStatus(SnapshotDto.STATUS_UNPROCESSED)
         .setCreatedAt(analysisDate)
         .setBuildDate(system2.now());
+
+      if (component.getType() == PROJECT) {
+        component.getProjectAttributes().getScmRevisionId().ifPresent(dto::setRevision);
+      }
+
+      return dto;
     }
 
     private void persist(SnapshotDto snapshotDto, DbSession dbSession) {
diff --git a/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/component/ComponentImplTest.java b/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/component/ComponentImplTest.java
index e1e7d216e73..d0f4c51e5b0 100644
--- a/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/component/ComponentImplTest.java
+++ b/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/component/ComponentImplTest.java
@@ -249,7 +249,7 @@ public class ComponentImplTest {
       .setReportAttributes(ReportAttributes.newBuilder(dbKey.hashCode()).build());
     if (type == PROJECT) {
       String buildString = randomAlphabetic(15);
-      builder.setProjectAttributes(new ProjectAttributes("version_1", buildString));
+      builder.setProjectAttributes(new ProjectAttributes("version_1", buildString, "453def"));
     }
     return builder;
   }
diff --git a/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/component/ComponentTreeBuilderTest.java b/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/component/ComponentTreeBuilderTest.java
index c62af5f23b0..8ce64c942dd 100644
--- a/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/component/ComponentTreeBuilderTest.java
+++ b/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/component/ComponentTreeBuilderTest.java
@@ -64,7 +64,7 @@ public class ComponentTreeBuilderTest {
   private static final String NO_SCM_BASE_PATH = "";
   // both no project as "" or null should be supported
   private static final ProjectAttributes SOME_PROJECT_ATTRIBUTES = new ProjectAttributes(
-    randomAlphabetic(20), new Random().nextBoolean() ? null : randomAlphabetic(12));
+    randomAlphabetic(20), new Random().nextBoolean() ? null : randomAlphabetic(12), "1def5123");
 
   @Rule
   public ExpectedException expectedException = ExpectedException.none();
@@ -131,7 +131,7 @@ public class ComponentTreeBuilderTest {
       .setRef(42)
       .setName(nameInReport)
       .setDescription(descriptionInReport)
-      .build(), NO_SCM_BASE_PATH, new ProjectAttributes("6.5", buildString));
+      .build(), NO_SCM_BASE_PATH, new ProjectAttributes("6.5", buildString, "4124af4"));
 
     assertThat(root.getUuid()).isEqualTo("generated_K1_uuid");
     assertThat(root.getDbKey()).isEqualTo("generated_K1");
diff --git a/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/component/ReportComponent.java b/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/component/ReportComponent.java
index 68b64396525..0b10c06c7bb 100644
--- a/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/component/ReportComponent.java
+++ b/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/component/ReportComponent.java
@@ -70,7 +70,7 @@ public class ReportComponent implements Component {
     this.description = builder.description;
     this.uuid = builder.uuid;
     this.projectAttributes = Optional.ofNullable(builder.projectVersion)
-      .map(v -> new ProjectAttributes(v, builder.buildString))
+      .map(v -> new ProjectAttributes(v, builder.buildString, builder.scmRevisionId))
       .orElse(null);
     this.reportAttributes = ReportAttributes.newBuilder(builder.ref)
       .build();
@@ -207,6 +207,7 @@ public class ReportComponent implements Component {
     private String shortName;
     private String projectVersion;
     private String buildString;
+    private String scmRevisionId;
     private String description;
     private FileAttributes fileAttributes;
     private final List<Component> children = new ArrayList<>();
@@ -262,6 +263,11 @@ public class ReportComponent implements Component {
       return this;
     }
 
+    public Builder setScmRevisionId(@Nullable String scmRevisionId) {
+      this.scmRevisionId = scmRevisionId;
+      return this;
+    }
+
     public Builder setFileAttributes(FileAttributes fileAttributes) {
       checkState(type == Type.FILE, "Only Component of type File can have File attributes");
       this.fileAttributes = fileAttributes;
diff --git a/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/step/QualityGateEventsStepTest.java b/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/step/QualityGateEventsStepTest.java
index 23e7c2d4d5b..23ffaa83399 100644
--- a/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/step/QualityGateEventsStepTest.java
+++ b/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/step/QualityGateEventsStepTest.java
@@ -67,6 +67,7 @@ public class QualityGateEventsStepTest {
     .setKey("key 1")
     .setProjectVersion(PROJECT_VERSION)
     .setBuildString("V1.9")
+    .setScmRevisionId("456def")
     .addChildren(ReportComponent.builder(Component.Type.DIRECTORY, 2).build())
     .build();
   private static final String INVALID_ALERT_STATUS = "trololo";
diff --git a/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/step/ReportPersistAnalysisStepTest.java b/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/step/ReportPersistAnalysisStepTest.java
index 932c4597165..68bca2c288f 100644
--- a/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/step/ReportPersistAnalysisStepTest.java
+++ b/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/step/ReportPersistAnalysisStepTest.java
@@ -55,6 +55,7 @@ public class ReportPersistAnalysisStepTest extends BaseStepTest {
 
   private static final String PROJECT_KEY = "PROJECT_KEY";
   private static final String ANALYSIS_UUID = "U1";
+  private static final String REVISION_ID = "5f6432a1";
 
   @Rule
   public DbTester dbTester = DbTester.create(System2.INSTANCE);
@@ -77,6 +78,7 @@ public class ReportPersistAnalysisStepTest extends BaseStepTest {
     analysisDate = DateUtils.parseDateQuietly("2015-06-01").getTime();
     analysisMetadataHolder.setUuid(ANALYSIS_UUID);
     analysisMetadataHolder.setAnalysisDate(analysisDate);
+    analysisMetadataHolder.setScmRevisionId(REVISION_ID);
     dbIdsRepository = new DbIdsRepositoryImpl();
 
     now = DateUtils.parseDateQuietly("2015-06-02").getTime();
@@ -116,6 +118,7 @@ public class ReportPersistAnalysisStepTest extends BaseStepTest {
       .setKey(PROJECT_KEY)
       .setProjectVersion(projectVersion)
       .setBuildString(buildString)
+      .setScmRevisionId(REVISION_ID)
       .addChildren(directory)
       .build();
     treeRootHolder.setRoot(project);
@@ -137,6 +140,7 @@ public class ReportPersistAnalysisStepTest extends BaseStepTest {
     assertThat(projectSnapshot.getStatus()).isEqualTo("U");
     assertThat(projectSnapshot.getCreatedAt()).isEqualTo(analysisDate);
     assertThat(projectSnapshot.getBuildDate()).isEqualTo(now);
+    assertThat(projectSnapshot.getRevision()).isEqualTo(REVISION_ID);
 
     assertThat(dbIdsRepository.getComponentId(directory)).isEqualTo(directoryDto.getId());
     assertThat(dbIdsRepository.getComponentId(file)).isEqualTo(fileDto.getId());
diff --git a/server/sonar-docs/src/pages/project-administration/webhooks.md b/server/sonar-docs/src/pages/project-administration/webhooks.md
index c921146c595..f547adc7a8b 100644
--- a/server/sonar-docs/src/pages/project-administration/webhooks.md
+++ b/server/sonar-docs/src/pages/project-administration/webhooks.md
@@ -133,14 +133,13 @@ If you provide additional properties to your SonarScanner using the pattern `son
 For example these additional parameters:
 
 ```
-sonar-scanner -Dsonar.analysis.scmRevision=628f5175ada0d685fd7164baa7c6382c1f25cab4 -Dsonar.analysis.buildNumber=12345
+sonar-scanner -Dsonar.analysis.buildNumber=12345
 ```
 
 Would add this to the payload:
 
 ```
 "properties": {
-  "sonar.analysis.scmRevision": "628f5175ada0d685fd7164baa7c6382c1f25cab4",
   "sonar.analysis.buildNumber": "12345"
 }
 ```