1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
/*
* SonarQube
* Copyright (C) 2009-2025 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.scan.filesystem;
import java.util.Locale;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.sonar.api.batch.fs.InputFile;
import org.sonar.api.batch.fs.internal.TestInputFileBuilder;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;
public class MutableFileSystemTest {
private static final String LANGUAGE = "php";
@Rule
public TemporaryFolder temp = new TemporaryFolder();
private MutableFileSystem underTest;
@Before
public void prepare() throws Exception {
underTest = new MutableFileSystem(temp.newFolder().toPath());
}
@Test
public void restriction_and_hidden_file_should_be_disabled_on_default() {
assertThat(underTest.restrictToChangedFiles).isFalse();
assertThat(underTest.allowHiddenFileAnalysis).isFalse();
}
@Test
public void return_all_non_hidden_files_when_not_restricted_and_disabled() {
assertThat(underTest.inputFiles(underTest.predicates().all())).isEmpty();
addFilesWithAllStatus();
underTest.setRestrictToChangedFiles(false);
assertThat(underTest.inputFiles(underTest.predicates().all())).hasSize(3);
assertThat(underTest.inputFile(underTest.predicates().hasFilename(generateFilename(InputFile.Status.ADDED)))).isNotNull();
assertThat(underTest.inputFile(underTest.predicates().hasFilename(generateFilename(InputFile.Status.SAME)))).isNotNull();
assertThat(underTest.inputFile(underTest.predicates().hasFilename(generateFilename(InputFile.Status.CHANGED)))).isNotNull();
}
@Test
public void return_only_changed_files_when_restricted() {
assertThat(underTest.inputFiles(underTest.predicates().all())).isEmpty();
addFilesWithAllStatus();
underTest.setRestrictToChangedFiles(true);
assertThat(underTest.inputFiles(underTest.predicates().all())).hasSize(2);
assertThat(underTest.inputFile(underTest.predicates().hasFilename(generateFilename(InputFile.Status.ADDED)))).isNotNull();
assertThat(underTest.inputFile(underTest.predicates().hasFilename(generateFilename(InputFile.Status.SAME)))).isNull();
assertThat(underTest.inputFile(underTest.predicates().hasFilename(generateFilename(InputFile.Status.CHANGED)))).isNotNull();
}
@Test
public void return_all_files_when_allowing_hidden_files_analysis() {
assertThat(underTest.inputFiles(underTest.predicates().all())).isEmpty();
addFilesWithVisibility();
underTest.setAllowHiddenFileAnalysis(true);
assertThat(underTest.inputFiles(underTest.predicates().all())).hasSize(2);
assertThat(underTest.inputFile(underTest.predicates().hasFilename(generateFilename(true)))).isNotNull();
assertThat(underTest.inputFile(underTest.predicates().hasFilename(generateFilename(false)))).isNotNull();
}
@Test
public void return_only_non_hidden_files_when_not_allowing_hidden_files_analysis() {
assertThat(underTest.inputFiles(underTest.predicates().all())).isEmpty();
addFilesWithVisibility();
underTest.setAllowHiddenFileAnalysis(false);
assertThat(underTest.inputFiles(underTest.predicates().all())).hasSize(1);
assertThat(underTest.inputFile(underTest.predicates().hasFilename(generateFilename(true)))).isNull();
assertThat(underTest.inputFile(underTest.predicates().hasFilename(generateFilename(false)))).isNotNull();
}
@Test
public void hidden_file_predicate_should_preserve_predicate_optimization() {
addFilesWithVisibility();
var anotherHiddenFile = spy(new TestInputFileBuilder("foo", String.format("src/%s", ".myHiddenFile.txt"))
.setLanguage(LANGUAGE).setStatus(InputFile.Status.ADDED).setHidden(true).build());
underTest.add(anotherHiddenFile);
underTest.setAllowHiddenFileAnalysis(false);
assertThat(underTest.inputFile(underTest.predicates().hasFilename(generateFilename(true)))).isNull();
assertThat(underTest.inputFile(underTest.predicates().hasFilename(generateFilename(false)))).isNotNull();
// Verify that predicate optimization is still effective
verify(anotherHiddenFile, never()).isHidden();
// This predicate can't be optimized
assertThat(underTest.inputFiles(underTest.predicates().all())).hasSize(1);
verify(anotherHiddenFile).isHidden();
}
@Test
public void hidden_file_predicate_should_be_applied_first_for_non_optimized_predicates() {
// Checking the file type is not very costly, but it is not optimized. In real life, something more costly would be reading the file
// content, for example.
addFilesWithVisibility();
var anotherHiddenFile = spy(new TestInputFileBuilder("foo", String.format("src/%s", ".myHiddenFile." + LANGUAGE))
.setLanguage(LANGUAGE).setType(InputFile.Type.MAIN).setStatus(InputFile.Status.ADDED).setHidden(true).build());
underTest.add(anotherHiddenFile);
underTest.setAllowHiddenFileAnalysis(false);
assertThat(underTest.inputFiles(underTest.predicates().hasType(InputFile.Type.MAIN))).hasSize(1);
// Verify that the file type has not been evaluated
verify(anotherHiddenFile, never()).type();
}
private void addFilesWithVisibility() {
addFile(true);
addFile(false);
}
private void addFilesWithAllStatus() {
addFile(InputFile.Status.ADDED);
addFile(InputFile.Status.CHANGED);
addFile(InputFile.Status.SAME);
}
private void addFile(InputFile.Status status) {
addFile(status, false);
}
private void addFile(boolean hidden) {
addFile(InputFile.Status.SAME, hidden);
}
private void addFile(InputFile.Status status, boolean hidden) {
underTest.add(new TestInputFileBuilder("foo", String.format("src/%s", generateFilename(status, hidden)))
.setLanguage(LANGUAGE).setType(InputFile.Type.MAIN).setStatus(status).setHidden(hidden).build());
}
private String generateFilename(boolean hidden) {
return generateFilename(InputFile.Status.SAME, hidden);
}
private String generateFilename(InputFile.Status status) {
return generateFilename(status, false);
}
private String generateFilename(InputFile.Status status, boolean hidden) {
return String.format("%s.%s.%s", status.name().toLowerCase(Locale.ROOT), hidden, LANGUAGE);
}
}
|
