Skip to content

Commit c18e9a4

Browse files
filipesperandiofilipesperandio
authored
Find correct paths to process (#21)
- Sonar's `src` and `exclusion` patterns are replaced by CLI's `include_paths` - `test` patterns are only use to differentiate files, as Sonar applies different rules to them. Test files are always a subset of the `included_paths`
1 parent 7df4d09 commit c18e9a4

File tree

17 files changed

+380
-14
lines changed

17 files changed

+380
-14
lines changed

‎bin/codeclimate-sonar

+1
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,6 @@ java \
1212
-Djava.awt.headless=true \
1313
-Dsonarlint.home="${BUILD_DIR}" \
1414
-Dproject.home="${CODE_DIR}" \
15+
-Dconfig="/config.json" \
1516
-Dorg.freemarker.loggerLibrary=none \
1617
cc.App --src "**/*.java" $@

‎fixtures/multiple_paths/Main.java

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
import pkg1;
2+
3+
public class Main {
4+
public void main(String[] args) {
5+
for (int k = 0; k < 20; i++) { // cause issue
6+
System.out.println(new Class1());
7+
}
8+
}
9+
}

‎fixtures/multiple_paths/config.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"enabled": true,
33
"include_paths": [
4-
"src/main/java/",
4+
"src/included/",
55
"Main.java"
66
]
77
}

‎fixtures/multiple_paths/src/excluded/java/pkg1/HasIssue.java

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
package pkg1;
2+
3+
public class HasIssue {
4+
public void method() {
5+
for (int i = 0; i < 10; i++) {
6+
for (int k = 0; k < 20; i++) {
7+
System.out.println("Hello");
8+
}
9+
}
10+
}
11+
}

‎fixtures/multiple_paths/src/included/java/pkg1/HasIssue.java

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
package pkg1;
2+
3+
class HasIssue {
4+
public void method() {
5+
for (int i = 0; i < 10; i++) {
6+
for (int k = 0; k < 20; i++) {
7+
System.out.println("Hello");
8+
}
9+
}
10+
}
11+
}

‎fixtures/multiple_paths/src/included/java/pkg1/HasNoIssue.java

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
package pkg1;
2+
3+
public class HasNoIssue {
4+
}

‎fixtures/multiple_paths/src/test/java/Test.java

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
public class Test {
2+
}

‎src/main/java/cc/App.java

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
package cc;
22

33
import org.sonarlint.cli.CustomMain;
4+
import org.sonarlint.cli.util.System2;
45

56
public class App {
67
public static void main(String[] args) {
7-
CustomMain.main(args);
8+
execute(args, System2.INSTANCE);
9+
}
10+
11+
public static void execute(String[] args, System2 system) {
12+
CustomMain.execute(args, system);
813
}
914
}

‎src/main/java/cc/Config.java

+10-3
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,22 @@
55
import com.google.gson.GsonBuilder;
66
import com.google.gson.stream.JsonReader;
77

8+
import java.io.File;
89
import java.io.FileNotFoundException;
910
import java.io.FileReader;
11+
import java.util.ArrayList;
12+
import java.util.Arrays;
1013
import java.util.List;
1114

1215
public class Config {
13-
List<String> includePaths;
16+
public List<String> includePaths = Arrays.asList("");
1417

15-
public static Config from(String file) throws FileNotFoundException {
16-
return gson().fromJson(new JsonReader(new FileReader(file)), Config.class);
18+
public static Config from(String file) {
19+
try {
20+
return gson().fromJson(new JsonReader(new FileReader(file)), Config.class);
21+
} catch (Exception e) {
22+
return new Config();
23+
}
1724
}
1825

1926
private static Gson gson() {

‎src/main/java/cc/files/Collector.java

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
package cc.files;
2+
3+
import java.io.IOException;
4+
import java.nio.file.FileVisitResult;
5+
import java.nio.file.Files;
6+
import java.nio.file.Path;
7+
import java.nio.file.SimpleFileVisitor;
8+
import java.nio.file.attribute.BasicFileAttributes;
9+
import java.util.ArrayList;
10+
import java.util.List;
11+
12+
public class Collector extends SimpleFileVisitor<Path> {
13+
final List<Path> files;
14+
final Path baseDir;
15+
16+
public Collector(Path baseDir) {
17+
this.baseDir = baseDir;
18+
this.files = new ArrayList<>();
19+
}
20+
21+
public List<Path> getFiles() {
22+
return files;
23+
}
24+
25+
@Override
26+
public FileVisitResult visitFile(final Path file, BasicFileAttributes attrs) throws IOException {
27+
files.add(file);
28+
return super.visitFile(file, attrs);
29+
}
30+
31+
@Override
32+
public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
33+
if (Files.isHidden(dir)) {
34+
return FileVisitResult.SKIP_SUBTREE;
35+
}
36+
37+
return super.preVisitDirectory(dir, attrs);
38+
}
39+
}

‎src/main/java/cc/files/Finder.java

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
package cc.files;
2+
3+
import org.sonarlint.cli.InputFileFinder;
4+
import org.sonarsource.sonarlint.core.client.api.common.analysis.ClientInputFile;
5+
6+
import java.io.IOException;
7+
import java.nio.charset.Charset;
8+
import java.nio.file.Files;
9+
import java.nio.file.Path;
10+
import java.util.ArrayList;
11+
import java.util.List;
12+
import java.util.Objects;
13+
import java.util.stream.Collectors;
14+
15+
import static java.nio.file.Files.isDirectory;
16+
17+
public class Finder extends InputFileFinder {
18+
final List<String> includedPaths;
19+
final Charset charset;
20+
final Matcher matcher;
21+
22+
public Finder(List<String> includedPaths, String testsGlobPattern, Charset charset) {
23+
super(null, testsGlobPattern, null, charset);
24+
this.includedPaths = includedPaths;
25+
this.charset = charset;
26+
this.matcher = new Matcher(testsGlobPattern, charset);
27+
}
28+
29+
@Override
30+
public List<ClientInputFile> collect(Path baseDir) throws IOException {
31+
return findPaths(baseDir).stream()
32+
.map(path -> toClientInputFile(baseDir, path))
33+
.filter(Objects::nonNull)
34+
.collect(Collectors.toList());
35+
}
36+
37+
List<Path> findPaths(Path baseDir) throws IOException {
38+
List<Path> paths = new ArrayList<>();
39+
for (String path : includedPaths) {
40+
Path resolvedPath = baseDir.resolve(path);
41+
if (isDirectory(resolvedPath)) {
42+
paths.addAll(collectDir(baseDir, resolvedPath));
43+
} else {
44+
paths.add(resolvedPath);
45+
}
46+
}
47+
return paths;
48+
}
49+
50+
ClientInputFile toClientInputFile(Path baseDir, Path path) {
51+
return createInputFile(path, isTest(baseDir, path));
52+
}
53+
54+
boolean isTest(Path baseDir, Path path) {
55+
return matcher.isTest(baseDir, path);
56+
}
57+
58+
ClientInputFile createInputFile(Path resolvedPath, boolean test) {
59+
return new DefaultClientInputFile(resolvedPath, test, charset);
60+
}
61+
62+
List<Path> collectDir(Path baseDir, Path dir) throws IOException {
63+
Collector collector = new Collector(baseDir);
64+
Files.walkFileTree(dir, collector);
65+
return collector.getFiles();
66+
}
67+
}

‎src/main/java/cc/files/Matcher.java

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
package cc.files;
2+
3+
import java.nio.charset.Charset;
4+
import java.nio.file.FileSystems;
5+
import java.nio.file.Path;
6+
import java.nio.file.PathMatcher;
7+
8+
public class Matcher {
9+
static final String GLOB_PREFIX = "glob:";
10+
static PathMatcher REFUSE_ALL = p -> false;
11+
12+
final PathMatcher testsMatcher;
13+
final Charset charset;
14+
15+
public Matcher(PathMatcher testsMatcher, Charset charset) {
16+
this.testsMatcher = testsMatcher;
17+
this.charset = charset;
18+
}
19+
20+
public Matcher(String testsGlobPattern, Charset charset) {
21+
this(createPathMatcher(testsGlobPattern, REFUSE_ALL), charset);
22+
}
23+
24+
public boolean isTest(Path baseDir, Path absoluteFilePath) {
25+
Path relativeFilePath = baseDir.relativize(absoluteFilePath);
26+
return testsMatcher.matches(absoluteFilePath) || testsMatcher.matches(relativeFilePath);
27+
}
28+
29+
static PathMatcher createPathMatcher(String pattern, PathMatcher defaultMatcher) {
30+
try {
31+
if (pattern != null) {
32+
return FileSystems.getDefault().getPathMatcher(GLOB_PREFIX + pattern);
33+
} else {
34+
return defaultMatcher;
35+
}
36+
} catch (Exception e) {
37+
throw new RuntimeException("Error creating matcher with pattern: " + pattern, e);
38+
}
39+
}
40+
}

‎src/main/java/org/sonarlint/cli/CustomMain.java

+6-7
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
*/
2020
package org.sonarlint.cli;
2121

22+
import cc.Config;
23+
import cc.files.Finder;
2224
import cc.JsonReport;
2325
import org.sonarlint.cli.analysis.SonarLintFactory;
2426
import org.sonarlint.cli.config.ConfigurationReader;
@@ -46,11 +48,7 @@ public CustomMain(Options opts, SonarLintFactory sonarLintFactory, ReportFactory
4648
super(opts, sonarLintFactory, reportFactory, fileFinder, projectHome);
4749
}
4850

49-
public static void main(String[] args) {
50-
execute(args, System2.INSTANCE);
51-
}
52-
53-
static void execute(String[] args, System2 system) {
51+
public static void execute(String[] args, System2 system) {
5452
Options parsedOpts;
5553
try {
5654
parsedOpts = Options.parse(args);
@@ -74,7 +72,8 @@ static void execute(String[] args, System2 system) {
7472
return;
7573
}
7674

77-
InputFileFinder fileFinder = new InputFileFinder(parsedOpts.src(), parsedOpts.tests(), parsedOpts.exclusions(), charset);
75+
Config config = Config.from(system.getProperty("config"));
76+
InputFileFinder fileFinder = new Finder(config.includePaths, parsedOpts.tests(), charset);
7877
ReportFactory reportFactory = new CustomReportFactory(charset);
7978
ConfigurationReader reader = new ConfigurationReader();
8079
SonarLintFactory sonarLintFactory = new SonarLintFactory(reader);
@@ -102,4 +101,4 @@ public List<Reporter> createReporters(Path basePath) {
102101
return Arrays.asList(new JsonReport());
103102
}
104103
}
105-
}
104+
}

‎src/test/java/cc/ConfigTest.java

+8-2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ public class ConfigTest {
99
@Test
1010
public void include_paths() throws Exception {
1111
Config config = Config.from("fixtures/multiple_paths/config.json");
12-
assertThat(config.includePaths).containsOnly("Main.java", "src/main/java/");
12+
assertThat(config.includePaths).containsOnly("Main.java", "src/included/");
1313
}
14-
}
14+
15+
@Test
16+
public void default_config_path_include_base_dir() throws Exception {
17+
Config config = new Config();
18+
assertThat(config.includePaths).containsOnly("");
19+
}
20+
}

‎src/test/java/cc/files/FinderTest.java

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
package cc.files;
2+
3+
import org.junit.Test;
4+
import org.sonarsource.sonarlint.core.client.api.common.analysis.ClientInputFile;
5+
6+
import java.nio.charset.Charset;
7+
import java.nio.file.Paths;
8+
import java.util.Arrays;
9+
import java.util.List;
10+
import java.util.stream.Collectors;
11+
12+
import static org.assertj.core.api.Assertions.assertThat;
13+
14+
15+
public class FinderTest {
16+
17+
@Test
18+
public void find_files_in_directory() throws Exception {
19+
Finder finder = new Finder(Arrays.asList("src/included/"), null, Charset.defaultCharset());
20+
21+
List<ClientInputFile> files = finder.collect(Paths.get("fixtures/multiple_paths"));
22+
List<String> paths = files.stream().map(ClientInputFile::getPath).collect(Collectors.toList());
23+
24+
assertThat(paths).containsOnly(
25+
"fixtures/multiple_paths/src/included/java/pkg1/HasIssue.java",
26+
"fixtures/multiple_paths/src/included/java/pkg1/HasNoIssue.java"
27+
);
28+
}
29+
30+
@Test
31+
public void find_specified_files() throws Exception {
32+
Finder finder = new Finder(Arrays.asList("config.json", "Main.java"), null, Charset.defaultCharset());
33+
34+
List<ClientInputFile> files = finder.collect(Paths.get("fixtures/multiple_paths"));
35+
List<String> paths = files.stream().map(ClientInputFile::getPath).collect(Collectors.toList());
36+
37+
assertThat(paths).containsOnly(
38+
"fixtures/multiple_paths/Main.java",
39+
"fixtures/multiple_paths/config.json"
40+
);
41+
}
42+
43+
@Test
44+
public void find_from_multiple_locations() throws Exception {
45+
Finder finder = new Finder(Arrays.asList("config.json", "src/included/java/"), null, Charset.defaultCharset());
46+
47+
List<ClientInputFile> files = finder.collect(Paths.get("fixtures/multiple_paths"));
48+
List<String> paths = files.stream().map(ClientInputFile::getPath).collect(Collectors.toList());
49+
50+
assertThat(paths).containsOnly(
51+
"fixtures/multiple_paths/config.json",
52+
"fixtures/multiple_paths/src/included/java/pkg1/HasIssue.java",
53+
"fixtures/multiple_paths/src/included/java/pkg1/HasNoIssue.java"
54+
);
55+
}
56+
57+
@Test
58+
public void differentiate_src_and_test() throws Exception {
59+
Finder finder = new Finder(Arrays.asList("src/included/", "src/test/"), "{**/test/**}", Charset.defaultCharset());
60+
61+
List<ClientInputFile> files = finder.collect(Paths.get("fixtures/multiple_paths"));
62+
63+
assertThat(files.stream().filter(f -> !f.isTest()).map(ClientInputFile::getPath).collect(Collectors.toList())).containsOnly(
64+
"fixtures/multiple_paths/src/included/java/pkg1/HasIssue.java",
65+
"fixtures/multiple_paths/src/included/java/pkg1/HasNoIssue.java"
66+
);
67+
assertThat(files.stream().filter(f -> f.isTest()).map(ClientInputFile::getPath).collect(Collectors.toList())).containsOnly(
68+
"fixtures/multiple_paths/src/test/java/Test.java"
69+
);
70+
}
71+
}

0 commit comments

Comments
 (0)