123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258 |
- /*
- * SonarQube
- * Copyright (C) 2009-2019 SonarSource SA
- * mailto:info 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.scanner.issue;
-
- import java.io.IOException;
- import java.util.Collections;
- import java.util.HashSet;
- import org.junit.Before;
- import org.junit.Rule;
- import org.junit.Test;
- import org.junit.rules.TemporaryFolder;
- import org.junit.runner.RunWith;
- import org.mockito.ArgumentCaptor;
- import org.mockito.Mock;
- import org.mockito.runners.MockitoJUnitRunner;
- import org.sonar.api.batch.bootstrap.ProjectDefinition;
- import org.sonar.api.batch.fs.internal.DefaultInputFile;
- import org.sonar.api.batch.fs.internal.DefaultInputModule;
- import org.sonar.api.batch.fs.internal.TestInputFileBuilder;
- import org.sonar.api.batch.rule.internal.ActiveRulesBuilder;
- import org.sonar.api.batch.rule.internal.NewActiveRule;
- import org.sonar.api.batch.rule.internal.RulesBuilder;
- import org.sonar.api.batch.sensor.issue.internal.DefaultExternalIssue;
- import org.sonar.api.batch.sensor.issue.internal.DefaultIssue;
- import org.sonar.api.batch.sensor.issue.internal.DefaultIssueLocation;
- import org.sonar.api.rule.RuleKey;
- import org.sonar.api.rule.Severity;
- import org.sonar.api.rules.RuleType;
- import org.sonar.scanner.protocol.output.ScannerReport;
- import org.sonar.scanner.report.ReportPublisher;
-
- import static org.assertj.core.api.Assertions.assertThat;
- import static org.mockito.ArgumentMatchers.any;
- import static org.mockito.ArgumentMatchers.anyString;
- import static org.mockito.ArgumentMatchers.eq;
- import static org.mockito.Mockito.RETURNS_DEEP_STUBS;
- import static org.mockito.Mockito.mock;
- import static org.mockito.Mockito.verify;
- import static org.mockito.Mockito.verifyZeroInteractions;
- import static org.mockito.Mockito.when;
-
- @RunWith(MockitoJUnitRunner.class)
- public class ModuleIssuesTest {
-
- static final RuleKey SQUID_RULE_KEY = RuleKey.of("squid", "AvoidCycle");
- static final String SQUID_RULE_NAME = "Avoid Cycle";
- private static final RuleKey NOSONAR_RULE_KEY = RuleKey.of("squid", "NoSonarCheck");
-
- private DefaultInputModule projectRoot;
-
- @Rule
- public TemporaryFolder temp = new TemporaryFolder();
-
- @Mock
- ModuleIssueFilters filters;
-
- ActiveRulesBuilder activeRulesBuilder = new ActiveRulesBuilder();
- RulesBuilder ruleBuilder = new RulesBuilder();
-
- ModuleIssues moduleIssues;
-
- DefaultInputFile file = new TestInputFileBuilder("foo", "src/Foo.php").initMetadata("Foo\nBar\nBiz\n").build();
- ReportPublisher reportPublisher = mock(ReportPublisher.class, RETURNS_DEEP_STUBS);
-
- @Before
- public void prepare() throws IOException {
- projectRoot = new DefaultInputModule(ProjectDefinition.create()
- .setKey("foo")
- .setBaseDir(temp.newFolder())
- .setWorkDir(temp.newFolder()));
- }
-
- @Test
- public void ignore_null_active_rule() {
- ruleBuilder.add(SQUID_RULE_KEY).setName(SQUID_RULE_NAME);
- initModuleIssues();
- DefaultIssue issue = new DefaultIssue(projectRoot)
- .at(new DefaultIssueLocation().on(file).at(file.selectLine(3)).message("Foo"))
- .forRule(SQUID_RULE_KEY);
- boolean added = moduleIssues.initAndAddIssue(issue);
-
- assertThat(added).isFalse();
- verifyZeroInteractions(reportPublisher);
- }
-
- @Test
- public void ignore_null_rule_of_active_rule() {
- ruleBuilder.add(SQUID_RULE_KEY).setName(SQUID_RULE_NAME);
- activeRulesBuilder.addRule(new NewActiveRule.Builder().setRuleKey(SQUID_RULE_KEY).setQProfileKey("qp-1").build());
- initModuleIssues();
-
- DefaultIssue issue = new DefaultIssue(projectRoot)
- .at(new DefaultIssueLocation().on(file).at(file.selectLine(3)).message("Foo"))
- .forRule(SQUID_RULE_KEY);
- boolean added = moduleIssues.initAndAddIssue(issue);
-
- assertThat(added).isFalse();
- verifyZeroInteractions(reportPublisher);
- }
-
- @Test
- public void add_issue_to_cache() {
- ruleBuilder.add(SQUID_RULE_KEY).setName(SQUID_RULE_NAME);
- activeRulesBuilder.addRule(new NewActiveRule.Builder()
- .setRuleKey(SQUID_RULE_KEY)
- .setSeverity(Severity.INFO)
- .setQProfileKey("qp-1")
- .build());
- initModuleIssues();
-
- DefaultIssue issue = new DefaultIssue(projectRoot)
- .at(new DefaultIssueLocation().on(file).at(file.selectLine(3)).message("Foo"))
- .forRule(SQUID_RULE_KEY)
- .overrideSeverity(org.sonar.api.batch.rule.Severity.CRITICAL);
-
- when(filters.accept(anyString(), any(ScannerReport.Issue.class))).thenReturn(true);
-
- boolean added = moduleIssues.initAndAddIssue(issue);
-
- assertThat(added).isTrue();
- ArgumentCaptor<ScannerReport.Issue> argument = ArgumentCaptor.forClass(ScannerReport.Issue.class);
- verify(reportPublisher.getWriter()).appendComponentIssue(eq(file.batchId()), argument.capture());
- assertThat(argument.getValue().getSeverity()).isEqualTo(org.sonar.scanner.protocol.Constants.Severity.CRITICAL);
- }
-
- @Test
- public void add_external_issue_to_cache() {
- ruleBuilder.add(SQUID_RULE_KEY).setName(SQUID_RULE_NAME);
- initModuleIssues();
-
- DefaultExternalIssue issue = new DefaultExternalIssue(projectRoot)
- .at(new DefaultIssueLocation().on(file).at(file.selectLine(3)).message("Foo"))
- .type(RuleType.BUG)
- .forRule(SQUID_RULE_KEY)
- .severity(org.sonar.api.batch.rule.Severity.CRITICAL);
-
- moduleIssues.initAndAddExternalIssue(issue);
-
- ArgumentCaptor<ScannerReport.ExternalIssue> argument = ArgumentCaptor.forClass(ScannerReport.ExternalIssue.class);
- verify(reportPublisher.getWriter()).appendComponentExternalIssue(eq(file.batchId()), argument.capture());
- assertThat(argument.getValue().getSeverity()).isEqualTo(org.sonar.scanner.protocol.Constants.Severity.CRITICAL);
- }
-
- @Test
- public void use_severity_from_active_rule_if_no_severity_on_issue() {
- ruleBuilder.add(SQUID_RULE_KEY).setName(SQUID_RULE_NAME);
- activeRulesBuilder.addRule(new NewActiveRule.Builder()
- .setRuleKey(SQUID_RULE_KEY)
- .setSeverity(Severity.INFO)
- .setQProfileKey("qp-1")
- .build());
- initModuleIssues();
-
- DefaultIssue issue = new DefaultIssue(projectRoot)
- .at(new DefaultIssueLocation().on(file).at(file.selectLine(3)).message("Foo"))
- .forRule(SQUID_RULE_KEY);
- when(filters.accept(anyString(), any(ScannerReport.Issue.class))).thenReturn(true);
- moduleIssues.initAndAddIssue(issue);
-
- ArgumentCaptor<ScannerReport.Issue> argument = ArgumentCaptor.forClass(ScannerReport.Issue.class);
- verify(reportPublisher.getWriter()).appendComponentIssue(eq(file.batchId()), argument.capture());
- assertThat(argument.getValue().getSeverity()).isEqualTo(org.sonar.scanner.protocol.Constants.Severity.INFO);
- }
-
- @Test
- public void filter_issue() {
- ruleBuilder.add(SQUID_RULE_KEY).setName(SQUID_RULE_NAME);
- activeRulesBuilder.addRule(new NewActiveRule.Builder()
- .setRuleKey(SQUID_RULE_KEY)
- .setSeverity(Severity.INFO)
- .setQProfileKey("qp-1")
- .build());
- initModuleIssues();
-
- DefaultIssue issue = new DefaultIssue(projectRoot)
- .at(new DefaultIssueLocation().on(file).at(file.selectLine(3)).message(""))
- .forRule(SQUID_RULE_KEY);
-
- when(filters.accept(anyString(), any(ScannerReport.Issue.class))).thenReturn(false);
-
- boolean added = moduleIssues.initAndAddIssue(issue);
-
- assertThat(added).isFalse();
- verifyZeroInteractions(reportPublisher);
- }
-
- @Test
- public void should_ignore_lines_commented_with_nosonar() {
- ruleBuilder.add(SQUID_RULE_KEY).setName(SQUID_RULE_NAME);
- activeRulesBuilder.addRule(new NewActiveRule.Builder()
- .setRuleKey(SQUID_RULE_KEY)
- .setSeverity(Severity.INFO)
- .setQProfileKey("qp-1")
- .build());
- initModuleIssues();
-
- DefaultIssue issue = new DefaultIssue(projectRoot)
- .at(new DefaultIssueLocation().on(file).at(file.selectLine(3)).message(""))
- .forRule(SQUID_RULE_KEY);
-
- file.noSonarAt(new HashSet<>(Collections.singletonList(3)));
-
- boolean added = moduleIssues.initAndAddIssue(issue);
-
- assertThat(added).isFalse();
- verifyZeroInteractions(reportPublisher);
- }
-
- @Test
- public void should_accept_issues_on_no_sonar_rules() {
- // The "No Sonar" rule logs violations on the lines that are flagged with "NOSONAR" !!
- ruleBuilder.add(NOSONAR_RULE_KEY).setName("No Sonar");
- activeRulesBuilder.addRule(new NewActiveRule.Builder()
- .setRuleKey(NOSONAR_RULE_KEY)
- .setSeverity(Severity.INFO)
- .setQProfileKey("qp-1")
- .build());
- initModuleIssues();
-
- file.noSonarAt(new HashSet<>(Collections.singletonList(3)));
-
- DefaultIssue issue = new DefaultIssue(projectRoot)
- .at(new DefaultIssueLocation().on(file).at(file.selectLine(3)).message(""))
- .forRule(NOSONAR_RULE_KEY);
-
- when(filters.accept(anyString(), any(ScannerReport.Issue.class))).thenReturn(true);
-
- boolean added = moduleIssues.initAndAddIssue(issue);
-
- assertThat(added).isTrue();
- verify(reportPublisher.getWriter()).appendComponentIssue(eq(file.batchId()), any());
- }
-
- /**
- * Every rules and active rules has to be added in builders before creating ModuleIssues
- */
- private void initModuleIssues() {
- moduleIssues = new ModuleIssues(activeRulesBuilder.build(), filters, reportPublisher);
- }
-
- }
|