SONARWEB-52 Declare the plugin as compliant with SonarLint

SonarSource · Sep 28, 2016 · 5cca919 · 5cca919
1 parent 1015bfb
commit 5cca919
Show file tree

Hide file tree

Showing 4 changed files with 135 additions and 1 deletion.
diff --git a/its/plugin/pom.xml b/its/plugin/pom.xml
@@ -22,9 +22,15 @@
  <license.owner>SonarSource SA and Matthijs Galesloot</license.owner>
  <license.mailto>[email protected]</license.mailto>
  <gitRepositoryName>sonar-web</gitRepositoryName>
+ <sonarlint.version>2.3.2</sonarlint.version>
  </properties>
 
  <dependencies>
+ <dependency>
+ <groupId>org.sonarsource.sonarlint.core</groupId>
+ <artifactId>sonarlint-core</artifactId>
+ <version>${sonarlint.version}</version>
+ </dependency>
  <dependency>
  <groupId>org.sonarsource.orchestrator</groupId>
  <artifactId>sonar-orchestrator</artifactId>

diff --git a/its/plugin/src/test/java/com/sonar/it/web/SonarLintTest.java b/its/plugin/src/test/java/com/sonar/it/web/SonarLintTest.java
@@ -0,0 +1,126 @@
+/*
+ * SonarSource :: Web :: ITs :: Plugin
+ * Copyright (c) 2011-2016 SonarSource SA and Matthijs Galesloot
+ * [email protected]
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.sonar.it.web;
+
+import com.sonar.orchestrator.locator.FileLocation;
+import org.apache.commons.io.FileUtils;
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.ClassRule;
+import org.junit.Test;
+import org.junit.rules.TemporaryFolder;
+import org.sonarsource.sonarlint.core.StandaloneSonarLintEngineImpl;
+import org.sonarsource.sonarlint.core.client.api.common.analysis.ClientInputFile;
+import org.sonarsource.sonarlint.core.client.api.common.analysis.Issue;
+import org.sonarsource.sonarlint.core.client.api.standalone.StandaloneAnalysisConfiguration;
+import org.sonarsource.sonarlint.core.client.api.standalone.StandaloneGlobalConfiguration;
+import org.sonarsource.sonarlint.core.client.api.standalone.StandaloneSonarLintEngine;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.tuple;
+
+public class SonarLintTest {
+
+ @ClassRule
+ public static TemporaryFolder temp = new TemporaryFolder();
+
+ private static StandaloneSonarLintEngine sonarlintEngine;
+
+ private static File baseDir;
+
+ @BeforeClass
+ public static void prepare() throws Exception {
+ StandaloneGlobalConfiguration sonarLintConfig = StandaloneGlobalConfiguration.builder()
+ .addPlugin(FileLocation.byWildcardMavenFilename(new File("../../sonar-web-plugin/target"), "sonar-web-plugin-*.jar").getFile().toURI().toURL())
+ .setSonarLintUserHome(temp.newFolder().toPath())
+ .setLogOutput((formattedMessage, level) -> {
+ /* Don't pollute logs */ })
+ .build();
+ sonarlintEngine = new StandaloneSonarLintEngineImpl(sonarLintConfig);
+ baseDir = temp.newFolder();
+ }
+
+ @AfterClass
+ public static void stop() {
+ sonarlintEngine.stop();
+ }
+
+ @Test
+ public void should_raise_three_issues() throws IOException {
+ ClientInputFile inputFile = prepareInputFile("foo.html",
+ "<html>\n" +
+ "<body>\n" +
+ "<a href=\"foo.png\">a</a>\n" +
+ "</body>\n" +
+ "</html>\n",
+ false);
+
+ List<Issue> issues = new ArrayList<>();
+ sonarlintEngine.analyze(
+ new StandaloneAnalysisConfiguration(baseDir.toPath(), temp.newFolder().toPath(), Collections.singletonList(inputFile), new HashMap<>()),
+ issues::add);
+
+ assertThat(issues).extracting("ruleKey", "startLine", "inputFile.path", "severity").containsOnly(
+ tuple("Web:DoctypePresenceCheck", 1, inputFile.getPath(), "MAJOR"),
+ tuple("Web:LinkToImageCheck", 3, inputFile.getPath(), "MAJOR"),
+ tuple("Web:PageWithoutTitleCheck", 1, inputFile.getPath(), "MAJOR"));
+ }
+
+ private ClientInputFile prepareInputFile(String relativePath, String content, final boolean isTest) throws IOException {
+ File file = new File(baseDir, relativePath);
+ FileUtils.write(file, content, StandardCharsets.UTF_8);
+ return createInputFile(file.toPath(), isTest);
+ }
+
+ private ClientInputFile createInputFile(final Path path, final boolean isTest) {
+ return new ClientInputFile() {
+
+ @Override
+ public Path getPath() {
+ return path;
+ }
+
+ @Override
+ public boolean isTest() {
+ return isTest;
+ }
+
+ @Override
+ public Charset getCharset() {
+ return StandardCharsets.UTF_8;
+ }
+
+ @Override
+ public <G> G getClientObject() {
+ return null;
+ }
+
+ };
+ }
+
+}
diff --git a/its/plugin/src/test/java/com/sonar/it/web/WebTestSuite.java b/its/plugin/src/test/java/com/sonar/it/web/WebTestSuite.java
@@ -31,7 +31,8 @@
 @SuiteClasses({
  FileSuffixesTest.class,
  StandardMeasuresTest.class,
- VariousTest.class
+ VariousTest.class,
+ SonarLintTest.class
 })
 public class WebTestSuite {
 

diff --git a/sonar-web-plugin/pom.xml b/sonar-web-plugin/pom.xml
@@ -20,6 +20,7 @@
  <sonar.pluginName>Web</sonar.pluginName>
  <sonar.pluginClass>org.sonar.plugins.web.WebPlugin</sonar.pluginClass>
  <sonar.skipDependenciesPackaging>true</sonar.skipDependenciesPackaging>
+ <sonar.sonarLintSupported>true</sonar.sonarLintSupported>
  </properties>
 
  <licenses>