source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2023 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.scanner.scan.filesystem;
  21
  22 import java.io.File;
  23 import java.io.IOException;
  24 import java.nio.file.Path;
  25 import java.nio.file.Paths;
  26 import org.junit.Before;
  27 import org.junit.Rule;
  28 import org.junit.Test;
  29 import org.junit.rules.TemporaryFolder;
  30 import org.sonar.api.CoreProperties;
  31 import org.sonar.api.batch.fs.IndexedFile;
  32 import org.sonar.api.batch.fs.InputFile;
  33 import org.sonar.api.batch.fs.internal.DefaultIndexedFile;
  34 import org.sonar.api.config.internal.MapSettings;
  35
  36 import static org.assertj.core.api.Assertions.assertThat;
  37
  38 public class ProjectExclusionFiltersTest {
  39
  40   @Rule
  41   public TemporaryFolder temp = new TemporaryFolder();
  42   private Path moduleBaseDir;
  43   private MapSettings settings;
  44
  45   @Before
  46   public void setUp() throws IOException {
  47     settings = new MapSettings();
  48     moduleBaseDir = temp.newFolder().toPath();
  49   }
  50
  51   @Test
  52   public void no_inclusions_nor_exclusions() {
  53     ProjectExclusionFilters filter = new ProjectExclusionFilters(settings.asConfig());
  54
  55     IndexedFile indexedFile = new DefaultIndexedFile("foo", moduleBaseDir, "src/main/java/com/mycompany/FooDao.java", null);
  56     assertThat(filter.isExcluded(indexedFile.path(), Paths.get(indexedFile.relativePath()), InputFile.Type.MAIN)).isFalse();
  57     assertThat(filter.isExcluded(indexedFile.path(), Paths.get(indexedFile.relativePath()), InputFile.Type.TEST)).isFalse();
  58     assertThat(filter.isIncluded(indexedFile.path(), Paths.get(indexedFile.relativePath()), InputFile.Type.MAIN)).isTrue();
  59     assertThat(filter.isIncluded(indexedFile.path(), Paths.get(indexedFile.relativePath()), InputFile.Type.TEST)).isTrue();
  60   }
  61
  62   @Test
  63   public void match_inclusion() {
  64     settings.setProperty(CoreProperties.PROJECT_INCLUSIONS_PROPERTY, "**/*Dao.java");
  65     ProjectExclusionFilters filter = new ProjectExclusionFilters(settings.asConfig());
  66
  67     IndexedFile indexedFile = new DefaultIndexedFile("foo", moduleBaseDir, "src/main/java/com/mycompany/FooDao.java", null);
  68     assertThat(filter.isIncluded(indexedFile.path(), Paths.get(indexedFile.relativePath()), InputFile.Type.MAIN)).isTrue();
  69
  70     indexedFile = new DefaultIndexedFile("foo", moduleBaseDir, "src/main/java/com/mycompany/Foo.java", null);
  71     assertThat(filter.isIncluded(indexedFile.path(), Paths.get(indexedFile.relativePath()), InputFile.Type.MAIN)).isFalse();
  72   }
  73
  74   @Test
  75   public void match_at_least_one_inclusion() {
  76     settings.setProperty(CoreProperties.PROJECT_INCLUSIONS_PROPERTY, "**/*Dao.java,**/*Dto.java");
  77     ProjectExclusionFilters filter = new ProjectExclusionFilters(settings.asConfig());
  78
  79     IndexedFile indexedFile = new DefaultIndexedFile("foo", moduleBaseDir, "src/main/java/com/mycompany/Foo.java", null);
  80     assertThat(filter.isIncluded(indexedFile.path(), Paths.get(indexedFile.relativePath()), InputFile.Type.MAIN)).isFalse();
  81
  82     indexedFile = new DefaultIndexedFile("foo", moduleBaseDir, "src/main/java/com/mycompany/FooDto.java", null);
  83     assertThat(filter.isIncluded(indexedFile.path(), Paths.get(indexedFile.relativePath()), InputFile.Type.MAIN)).isTrue();
  84   }
  85
  86   @Test
  87   public void match_exclusions() {
  88     settings.setProperty(CoreProperties.PROJECT_INCLUSIONS_PROPERTY, "src/main/java/**/*");
  89     settings.setProperty(CoreProperties.PROJECT_TEST_INCLUSIONS_PROPERTY, "src/test/java/**/*");
  90     settings.setProperty(CoreProperties.PROJECT_EXCLUSIONS_PROPERTY, "**/*Dao.java");
  91     ProjectExclusionFilters filter = new ProjectExclusionFilters(settings.asConfig());
  92
  93     IndexedFile indexedFile = new DefaultIndexedFile("foo", moduleBaseDir, "src/main/java/com/mycompany/FooDao.java", null);
  94     assertThat(filter.isExcluded(indexedFile.path(), Paths.get(indexedFile.relativePath()), InputFile.Type.MAIN)).isTrue();
  95
  96     indexedFile = new DefaultIndexedFile("foo", moduleBaseDir, "src/main/java/com/mycompany/Foo.java", null);
  97     assertThat(filter.isExcluded(indexedFile.path(), Paths.get(indexedFile.relativePath()), InputFile.Type.MAIN)).isFalse();
  98
  99     // source exclusions do not apply to tests
 100     indexedFile = new DefaultIndexedFile("foo", moduleBaseDir, "src/test/java/com/mycompany/FooDao.java", null);
 101     assertThat(filter.isExcluded(indexedFile.path(), Paths.get(indexedFile.relativePath()), InputFile.Type.TEST)).isFalse();
 102   }
 103
 104   @Test
 105   public void match_exclusion_by_absolute_path() {
 106     File excludedFile = new File(moduleBaseDir.toString(), "src/main/java/org/bar/Bar.java");
 107
 108     settings.setProperty(CoreProperties.PROJECT_INCLUSIONS_PROPERTY, "src/main/java/**/*");
 109     settings.setProperty(CoreProperties.PROJECT_EXCLUSIONS_PROPERTY, "file:" + excludedFile.getAbsolutePath());
 110     ProjectExclusionFilters filter = new ProjectExclusionFilters(settings.asConfig());
 111
 112     IndexedFile indexedFile = new DefaultIndexedFile("foo", moduleBaseDir, "src/main/java/org/bar/Foo.java", null);
 113     assertThat(filter.isExcluded(indexedFile.path(), Paths.get(indexedFile.relativePath()), InputFile.Type.MAIN)).isFalse();
 114
 115     indexedFile = new DefaultIndexedFile("foo", moduleBaseDir, "src/main/java/org/bar/Bar.java", null);
 116     assertThat(filter.isExcluded(indexedFile.path(), Paths.get(indexedFile.relativePath()), InputFile.Type.MAIN)).isTrue();
 117   }
 118
 119   @Test
 120   public void trim_pattern() {
 121     assertThat(ProjectExclusionFilters.prepareMainExclusions(new String[] {"   **/*Dao.java   "}, new String[0])[0]).hasToString("**/*Dao.java");
 122   }
 123
 124 }