]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-7783 Ensure Sensors don't save same data twice
authorDuarte Meneses <duarte.meneses@sonarsource.com>
Thu, 7 Jul 2016 13:28:47 +0000 (15:28 +0200)
committerDuarte Meneses <duarte.meneses@sonarsource.com>
Fri, 8 Jul 2016 09:13:27 +0000 (11:13 +0200)
it/it-plugins/batch-plugin/src/main/java/com/sonarsource/BatchPlugin.java
it/it-plugins/batch-plugin/src/main/java/com/sonarsource/SaveDataTwiceSensor.java [deleted file]
it/it-tests/src/test/java/it/Category3Suite.java
it/it-tests/src/test/java/it/analysis/SaveDataTwiceTest.java [deleted file]
plugins/sonar-xoo-plugin/src/main/java/org/sonar/xoo/XooPlugin.java
plugins/sonar-xoo-plugin/src/main/java/org/sonar/xoo/rule/SaveDataTwiceSensor.java [new file with mode: 0644]
plugins/sonar-xoo-plugin/src/test/java/org/sonar/xoo/XooPluginTest.java
sonar-scanner-engine/src/test/java/org/sonar/scanner/mediumtest/highlighting/HighlightingMediumTest.java

index aebd9e9b10bfd1598aad7db8b77f87c66904f057..5bc5ee622af1589d80d43e76a45b748a090aaaf6 100644 (file)
@@ -41,8 +41,7 @@ public class BatchPlugin implements Plugin {
       DumpSettingsInitializer.class,
       RaiseMessageException.class,
       TempFolderExtension.class,
-      WaitingSensor.class,
-      SaveDataTwiceSensor.class
+      WaitingSensor.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
deleted file mode 100644 (file)
index b75961e..0000000
+++ /dev/null
@@ -1,62 +0,0 @@
-/*
- * 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();
-  }
-
-}
index c8037bb5d773c272b8ca33b8b640d953be9591d9..9a4d76d0ed38578839e6005a6a9a92096ddb51ed 100644 (file)
@@ -71,7 +71,7 @@ public class Category3Suite {
     // Used by IssuesModeTest
     .addPlugin(pluginArtifact("access-secured-props-plugin"))
 
-    // used by TempFolderTest, DecimalScaleMetricTest and SaveDataTwiceTest
+    // used by TempFolderTest and DecimalScaleMetricTest
     .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
deleted file mode 100644 (file)
index 1284df1..0000000
+++ /dev/null
@@ -1,66 +0,0 @@
-/*
- * 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);
-  }
-}
index 38127ef52a3245c6c1665a3d5d8d74d82ab6efa1..870992596e7ccd3ccc14adc05259066d943607d8 100644 (file)
@@ -47,6 +47,7 @@ import org.sonar.xoo.rule.OneIssuePerLineSensor;
 import org.sonar.xoo.rule.OneIssuePerModuleSensor;
 import org.sonar.xoo.rule.OneVulnerabilityIssuePerModuleSensor;
 import org.sonar.xoo.rule.RandomAccessSensor;
+import org.sonar.xoo.rule.SaveDataTwiceSensor;
 import org.sonar.xoo.rule.Xoo2BasicProfile;
 import org.sonar.xoo.rule.XooBasicProfile;
 import org.sonar.xoo.rule.XooEmptyProfile;
@@ -97,6 +98,7 @@ public class XooPlugin implements Plugin {
       ChecksSensor.class,
       RandomAccessSensor.class,
       DeprecatedResourceApiSensor.class,
+      SaveDataTwiceSensor.class,
 
       OneBlockerIssuePerFileSensor.class,
       OneIssuePerLineSensor.class,
diff --git a/plugins/sonar-xoo-plugin/src/main/java/org/sonar/xoo/rule/SaveDataTwiceSensor.java b/plugins/sonar-xoo-plugin/src/main/java/org/sonar/xoo/rule/SaveDataTwiceSensor.java
new file mode 100644 (file)
index 0000000..4233bb7
--- /dev/null
@@ -0,0 +1,61 @@
+/*
+ * 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 org.sonar.xoo.rule;
+
+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();
+  }
+}
index 6257dea6f9293b3f7e788424a87507917dc31cf1..b9255f056d80fc26efaf71216d7fe67ccd0ba505 100644 (file)
@@ -35,10 +35,10 @@ public class XooPluginTest {
   public void provide_extensions_for_5_5() {
     Plugin.Context context = new Plugin.Context(new SonarRuntime(Version.parse("5.5"), SonarProduct.SONARQUBE, SonarQubeSide.SCANNER));
     new XooPlugin().define(context);
-    assertThat(context.getExtensions()).hasSize(40).contains(CpdTokenizerSensor.class);
+    assertThat(context.getExtensions()).hasSize(41).contains(CpdTokenizerSensor.class);
 
     context = new Plugin.Context(new SonarRuntime(Version.parse("5.4"), SonarProduct.SONARLINT, null));
     new XooPlugin().define(context);
-    assertThat(context.getExtensions()).hasSize(39).doesNotContain(CpdTokenizerSensor.class);
+    assertThat(context.getExtensions()).hasSize(40).doesNotContain(CpdTokenizerSensor.class);
   }
 }
index aa07798bfaa53ff396941d68e6032844cb6e577e..e44b7085951810ca4f9c036fb77778ad0824191e 100644 (file)
@@ -92,6 +92,31 @@ public class HighlightingMediumTest {
     assertThat(result.highlightingTypeFor(file, 2, 8)).isEmpty();
   }
 
+  @Test
+  public void saveTwice() throws IOException {
+    File baseDir = temp.newFolder();
+    File srcDir = new File(baseDir, "src");
+    srcDir.mkdir();
+
+    File xooFile = new File(srcDir, "sample.xoo");
+    FileUtils.write(xooFile, "Sample xoo\ncontent plop");
+
+    exception.expect(UnsupportedOperationException.class);
+    exception.expectMessage("Trying to save highlighting twice for the same file is not supported");
+    tester.newTask()
+      .properties(ImmutableMap.<String, String>builder()
+        .put("sonar.projectBaseDir", baseDir.getAbsolutePath())
+        .put("sonar.projectKey", "com.foo.project")
+        .put("sonar.projectName", "Foo Project")
+        .put("sonar.projectVersion", "1.0-SNAPSHOT")
+        .put("sonar.projectDescription", "Description of Foo Project")
+        .put("sonar.sources", "src")
+        .put("sonar.it.savedatatwice", "true")
+        .build())
+      .start();
+
+  }
+
   @Test
   public void computeInvalidOffsets() throws IOException {
 
@@ -118,7 +143,7 @@ public class HighlightingMediumTest {
       }
     });
 
-    TaskResult result = tester.newTask()
+    tester.newTask()
       .properties(ImmutableMap.<String, String>builder()
         .put("sonar.projectBaseDir", baseDir.getAbsolutePath())
         .put("sonar.projectKey", "com.foo.project")