SONAR-7783 Ensure Sensors don't save same data twice

diff --git a/it/it-plugins/batch-plugin/src/main/java/com/sonarsource/BatchPlugin.java b/it/it-plugins/batch-plugin/src/main/java/com/sonarsource/BatchPlugin.java
index 5bc5ee622af1589d80d43e76a45b748a090aaaf6..aebd9e9b10bfd1598aad7db8b77f87c66904f057 100644 (file)
--- a/it/it-plugins/batch-plugin/src/main/java/com/sonarsource/BatchPlugin.java
+++ b/it/it-plugins/batch-plugin/src/main/java/com/sonarsource/BatchPlugin.java
@@ -41,7 +41,8 @@ public class BatchPlugin implements Plugin {
       DumpSettingsInitializer.class,
       RaiseMessageException.class,
       TempFolderExtension.class,
-      WaitingSensor.class
+      WaitingSensor.class,
+      SaveDataTwiceSensor.class
       ));
   }
 }

diff --git a/it/it-plugins/batch-plugin/src/main/java/com/sonarsource/SaveDataTwiceSensor.java b/it/it-plugins/batch-plugin/src/main/java/com/sonarsource/SaveDataTwiceSensor.java
new file mode 100644 (file)
index 0000000..b75961e
--- /dev/null
+++ b/it/it-plugins/batch-plugin/src/main/java/com/sonarsource/SaveDataTwiceSensor.java
@@ -0,0 +1,62 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2016 SonarSource SA
+ * mailto:contact 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.sonarsource;
+
+import java.util.Iterator;
+
+import org.sonar.api.batch.fs.InputFile;
+import org.sonar.api.batch.sensor.Sensor;
+import org.sonar.api.batch.sensor.SensorContext;
+import org.sonar.api.batch.sensor.SensorDescriptor;
+import org.sonar.api.batch.sensor.highlighting.TypeOfText;
+
+/**
+ * This sensor will create and save highlighting twice on the first file that it finds in the index.
+ * It requires the property sonar.it.savedatatwice
+ */
+public class SaveDataTwiceSensor implements Sensor {
+
+  @Override
+  public void describe(SensorDescriptor descriptor) {
+    descriptor.name("SaveDataTwice IT Sensor ")
+      .requireProperty("sonar.it.savedatatwice");
+  }
+
+  @Override
+  public void execute(SensorContext context) {
+    Iterator<InputFile> inputFiles = context.fileSystem().inputFiles(context.fileSystem().predicates().all()).iterator();
+
+    if (!inputFiles.hasNext()) {
+      throw new IllegalStateException("No files indexed");
+    }
+
+    InputFile file = inputFiles.next();
+    context.newHighlighting()
+      .onFile(file)
+      .highlight(file.selectLine(1), TypeOfText.CONSTANT)
+      .save();
+
+    context.newHighlighting()
+      .onFile(file)
+      .highlight(file.selectLine(file.lines()), TypeOfText.COMMENT)
+      .save();
+  }
+
+}

diff --git a/it/it-tests/src/test/java/it/Category3Suite.java b/it/it-tests/src/test/java/it/Category3Suite.java
index 9a4d76d0ed38578839e6005a6a9a92096ddb51ed..c8037bb5d773c272b8ca33b8b640d953be9591d9 100644 (file)
--- a/it/it-tests/src/test/java/it/Category3Suite.java
+++ b/it/it-tests/src/test/java/it/Category3Suite.java
@@ -71,7 +71,7 @@ public class Category3Suite {
     // Used by IssuesModeTest
     .addPlugin(pluginArtifact("access-secured-props-plugin"))
 
-    // used by TempFolderTest and DecimalScaleMetricTest
+    // used by TempFolderTest, DecimalScaleMetricTest and SaveDataTwiceTest
     .addPlugin(pluginArtifact("batch-plugin"))
 
     // used by ExtensionLifecycleTest

diff --git a/it/it-tests/src/test/java/it/analysis/SaveDataTwiceTest.java b/it/it-tests/src/test/java/it/analysis/SaveDataTwiceTest.java
new file mode 100644 (file)
index 0000000..1284df1
--- /dev/null
+++ b/it/it-tests/src/test/java/it/analysis/SaveDataTwiceTest.java
@@ -0,0 +1,66 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2016 SonarSource SA
+ * mailto:contact 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 it.analysis;
+
+import java.io.IOException;
+
+import org.junit.ClassRule;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+import org.junit.rules.TemporaryFolder;
+
+import com.sonar.orchestrator.Orchestrator;
+import com.sonar.orchestrator.build.BuildResult;
+import com.sonar.orchestrator.build.SonarScanner;
+
+import static org.assertj.core.api.Assertions.*;
+
+import it.Category3Suite;
+import util.ItUtils;
+
+public class SaveDataTwiceTest {
+  @ClassRule
+  public static Orchestrator orchestrator = Category3Suite.ORCHESTRATOR;
+
+  @Rule
+  public ExpectedException thrown = ExpectedException.none();
+
+  @Rule
+  public TemporaryFolder temp = new TemporaryFolder();
+
+  // SONAR-7783
+  @Test
+  public void should_create_in_temp_folder() throws IOException {
+    BuildResult scan = scan("sonar.it.savedatatwice", "true");
+    assertThat(scan.isSuccess()).isFalse();
+    assertThat(scan.getLogs()).contains("Trying to save highlighting twice for the same file is not supported");
+  }
+
+  private BuildResult scan(String... props) {
+    SonarScanner runner = configureScanner(props);
+    return orchestrator.executeBuildQuietly(runner);
+  }
+
+  private SonarScanner configureScanner(String... props) {
+    return SonarScanner.create(ItUtils.projectDir("shared/xoo-sample"))
+      .setProperties(props);
+  }
+}