From 579aa0457917229ed583c782563552ae957e121d Mon Sep 17 00:00:00 2001
From: Julien HENRY <julien.henry@sonarsource.com>
Date: Wed, 6 Sep 2017 12:32:26 +0200
Subject: [PATCH] SONAR-9701 Don't publish empty modules

---
 .../scanner/report/ComponentsPublisher.java   |  9 +--
 .../report/ComponentsPublisherTest.java       | 58 ++++++++++++++++++-
 2 files changed, 62 insertions(+), 5 deletions(-)

diff --git a/sonar-scanner-engine/src/main/java/org/sonar/scanner/report/ComponentsPublisher.java b/sonar-scanner-engine/src/main/java/org/sonar/scanner/report/ComponentsPublisher.java
index 68f0a380a4f..84275b0d0e2 100644
--- a/sonar-scanner-engine/src/main/java/org/sonar/scanner/report/ComponentsPublisher.java
+++ b/sonar-scanner-engine/src/main/java/org/sonar/scanner/report/ComponentsPublisher.java
@@ -21,9 +21,7 @@ package org.sonar.scanner.report;
 
 import java.util.Collection;
 import java.util.stream.Collectors;
-
 import javax.annotation.CheckForNull;
-
 import org.apache.commons.lang.StringUtils;
 import org.sonar.api.CoreProperties;
 import org.sonar.api.batch.bootstrap.ProjectDefinition;
@@ -177,10 +175,13 @@ public class ComponentsPublisher implements ReportPublisherStep {
   }
 
   private boolean shouldSkipComponent(DefaultInputComponent component, Collection<InputComponent> children) {
-    if (component instanceof InputDir && children.isEmpty()) {
+    if (component instanceof InputModule && children.isEmpty() && isShortLivingBranch()) {
+      // no children on a module in short branch analysis -> skip it (except root)
+      return !moduleHierarchy.isRoot((InputModule) component);
+    } else if (component instanceof InputDir && children.isEmpty()) {
       try (CloseableIterator<Issue> componentIssuesIt = reader.readComponentIssues(component.batchId())) {
         if (!componentIssuesIt.hasNext()) {
-          // no file to publish on a directory without issues -> skip it
+          // no files to publish on a directory without issues -> skip it
           return true;
         }
       }
diff --git a/sonar-scanner-engine/src/test/java/org/sonar/scanner/report/ComponentsPublisherTest.java b/sonar-scanner-engine/src/test/java/org/sonar/scanner/report/ComponentsPublisherTest.java
index 5d45fca8155..5b0406bdfc1 100644
--- a/sonar-scanner-engine/src/test/java/org/sonar/scanner/report/ComponentsPublisherTest.java
+++ b/sonar-scanner-engine/src/test/java/org/sonar/scanner/report/ComponentsPublisherTest.java
@@ -21,6 +21,7 @@ package org.sonar.scanner.report;
 
 import java.io.File;
 import java.io.IOException;
+import java.util.Arrays;
 import java.util.Collections;
 import org.junit.Before;
 import org.junit.Rule;
@@ -206,6 +207,62 @@ public class ComponentsPublisherTest {
     assertThat(writer.hasComponentData(FileStructure.Domain.COMPONENT, 7)).isFalse();
   }
 
+  @Test
+  public void should_skip_empty_modules_for_short_living_branches() throws IOException {
+    ProjectAnalysisInfo projectAnalysisInfo = mock(ProjectAnalysisInfo.class);
+    when(projectAnalysisInfo.analysisDate()).thenReturn(DateUtils.parseDate("2012-12-12"));
+
+    ProjectDefinition rootDef = ProjectDefinition.create()
+      .setKey("foo")
+      .setProperty(CoreProperties.PROJECT_VERSION_PROPERTY, "1.0")
+      .setName("Root project")
+      .setDescription("Root description")
+      .setBaseDir(temp.newFolder())
+      .setWorkDir(temp.newFolder());
+    DefaultInputModule root = new DefaultInputModule(rootDef, 1);
+
+    ProjectDefinition emptyModuleDef = ProjectDefinition.create()
+      .setKey("modEmpty")
+      .setProperty(CoreProperties.PROJECT_VERSION_PROPERTY, "1.0")
+      .setName("Empty module")
+      .setDescription("Empty module")
+      .setBaseDir(temp.newFolder())
+      .setWorkDir(temp.newFolder());
+    DefaultInputModule emptyModule = new DefaultInputModule(emptyModuleDef, 2);
+
+    ProjectDefinition notEmptyModuleDef = ProjectDefinition.create()
+      .setKey("modNotEmpty")
+      .setProperty(CoreProperties.PROJECT_VERSION_PROPERTY, "1.0")
+      .setName("Module")
+      .setDescription("Module")
+      .setBaseDir(temp.newFolder())
+      .setWorkDir(temp.newFolder());
+    DefaultInputModule notEmptyModule = new DefaultInputModule(notEmptyModuleDef, 3);
+
+    moduleHierarchy = mock(InputModuleHierarchy.class);
+    when(moduleHierarchy.root()).thenReturn(root);
+    when(moduleHierarchy.isRoot(root)).thenReturn(true);
+    when(moduleHierarchy.children(root)).thenReturn(Arrays.asList(emptyModule, notEmptyModule));
+    when(moduleHierarchy.children(emptyModule)).thenReturn(Collections.emptyList());
+    when(moduleHierarchy.children(notEmptyModule)).thenReturn(Collections.emptyList());
+    when(branchConfiguration.branchType()).thenReturn(BranchType.SHORT);
+
+    // dir with files
+    DefaultInputDir dir = new DefaultInputDir("modNotEmpty", "src", 4);
+    tree.index(dir, notEmptyModule);
+
+    // Only an unchanged file, so module should also be skipped
+    DefaultInputFile file = new TestInputFileBuilder("modNotEmpty", "src/Foo.java", 5).setLines(2).setStatus(InputFile.Status.SAME).build();
+    tree.index(file, dir);
+
+    ComponentsPublisher publisher = new ComponentsPublisher(moduleHierarchy, tree, branchConfiguration);
+    publisher.publish(writer);
+
+    assertThat(writer.hasComponentData(FileStructure.Domain.COMPONENT, 1)).isTrue();
+    assertThat(writer.hasComponentData(FileStructure.Domain.COMPONENT, 2)).isFalse();
+    assertThat(writer.hasComponentData(FileStructure.Domain.COMPONENT, 3)).isFalse();
+  }
+
   @Test
   public void should_set_directory_status() throws IOException {
     ProjectAnalysisInfo projectAnalysisInfo = mock(ProjectAnalysisInfo.class);
@@ -320,7 +377,6 @@ public class ComponentsPublisherTest {
     assertThat(writer.hasComponentData(FileStructure.Domain.COMPONENT, 7)).isFalse();
   }
 
-
   @Test
   public void add_components_without_version_and_name() throws IOException {
     ProjectAnalysisInfo projectAnalysisInfo = mock(ProjectAnalysisInfo.class);
-- 
2.39.5