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
171
172
173
174
175
176
177
178
179
180
|
/*
* 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.sca;
import java.io.File;
import java.io.IOException;
import java.util.Optional;
import org.assertj.core.util.Files;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import org.junit.jupiter.api.io.TempDir;
import org.slf4j.event.Level;
import org.sonar.api.batch.bootstrap.ProjectDefinition;
import org.sonar.api.batch.fs.internal.DefaultInputModule;
import org.sonar.api.testfixtures.log.LogTesterJUnit5;
import org.sonar.scanner.config.DefaultConfiguration;
import org.sonar.scanner.protocol.output.ScannerReportWriter;
import org.sonar.scanner.report.ReportPublisher;
import org.sonar.scanner.repository.featureflags.FeatureFlagsRepository;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoInteractions;
import static org.mockito.Mockito.when;
class ScaExecutorTest {
private final CliService cliService = mock(CliService.class);
private final CliCacheService cliCacheService = mock(CliCacheService.class);
private final ReportPublisher reportPublisher = mock(ReportPublisher.class);
private final FeatureFlagsRepository featureFlagsRepository = mock(FeatureFlagsRepository.class);
private final DefaultConfiguration configuration = mock(DefaultConfiguration.class);
@RegisterExtension
private final LogTesterJUnit5 logTester = new LogTesterJUnit5();
private final ScaExecutor underTest = new ScaExecutor(cliCacheService, cliService, reportPublisher, featureFlagsRepository, configuration);
@TempDir
File rootModuleDir;
private DefaultInputModule root;
@BeforeEach
void before() {
when(featureFlagsRepository.isEnabled("sca")).thenReturn(true);
root = new DefaultInputModule(
ProjectDefinition.create().setBaseDir(rootModuleDir).setWorkDir(rootModuleDir.toPath().getRoot().toFile()));
}
@Test
void execute_shouldCallCliAndPublisher() throws IOException {
File mockCliFile = Files.newTemporaryFile();
File mockManifestZip = Files.newTemporaryFile();
ScannerReportWriter mockReportWriter = mock(ScannerReportWriter.class);
when(cliCacheService.cacheCli()).thenReturn(mockCliFile);
when(cliService.generateManifestsZip(root, mockCliFile, configuration)).thenReturn(mockManifestZip);
when(reportPublisher.getWriter()).thenReturn(mockReportWriter);
logTester.setLevel(Level.DEBUG);
underTest.execute(root);
verify(cliService).generateManifestsZip(root, mockCliFile, configuration);
verify(mockReportWriter).writeScaFile(mockManifestZip);
assertThat(logTester.logs(Level.DEBUG)).contains("Zip ready for report: " + mockManifestZip);
assertThat(logTester.logs(Level.DEBUG)).contains("Manifest zip written to report");
}
@Test
void execute_whenIOException_shouldHandleException() throws IOException {
File mockCliFile = Files.newTemporaryFile();
when(cliCacheService.cacheCli()).thenReturn(mockCliFile);
doThrow(IOException.class).when(cliService).generateManifestsZip(root, mockCliFile, configuration);
logTester.setLevel(Level.INFO);
underTest.execute(root);
verify(cliService).generateManifestsZip(root, mockCliFile, configuration);
assertThat(logTester.logs(Level.ERROR)).contains("Error gathering manifests");
}
@Test
void execute_whenIllegalStateException_shouldHandleException() throws IOException {
File mockCliFile = Files.newTemporaryFile();
when(cliCacheService.cacheCli()).thenReturn(mockCliFile);
doThrow(IllegalStateException.class).when(cliService).generateManifestsZip(root, mockCliFile, configuration);
logTester.setLevel(Level.INFO);
underTest.execute(root);
verify(cliService).generateManifestsZip(root, mockCliFile, configuration);
assertThat(logTester.logs(Level.ERROR)).contains("Error gathering manifests");
}
@Test
void execute_whenNoCliFound_shouldSkipAnalysis() throws IOException {
File mockCliFile = new File("");
when(cliCacheService.cacheCli()).thenReturn(mockCliFile);
underTest.execute(root);
verify(cliService, never()).generateManifestsZip(root, mockCliFile, configuration);
}
@Test
void execute_whenGlobalFeatureDisabled_skips() {
when(featureFlagsRepository.isEnabled("sca")).thenReturn(false);
logTester.setLevel(Level.DEBUG);
underTest.execute(root);
assertThat(logTester.logs()).contains("Dependency analysis skipped");
verifyNoInteractions(cliService, cliCacheService);
}
@Test
void execute_whenProjectPropertyDisabled_skips() {
when(configuration.getBoolean("sonar.sca.enabled")).thenReturn(Optional.of(false));
logTester.setLevel(Level.DEBUG);
underTest.execute(root);
assertThat(logTester.logs()).contains("Dependency analysis disabled for this project");
verifyNoInteractions(cliService, cliCacheService);
}
@Test
void execute_whenProjectPropertyExplicitlyEnabled_CallsCli() throws IOException {
when(configuration.getBoolean("sonar.sca.enabled")).thenReturn(Optional.of(true));
File mockCliFile = Files.newTemporaryFile();
File mockManifestZip = Files.newTemporaryFile();
ScannerReportWriter mockReportWriter = mock(ScannerReportWriter.class);
when(cliCacheService.cacheCli()).thenReturn(mockCliFile);
when(cliService.generateManifestsZip(root, mockCliFile, configuration)).thenReturn(mockManifestZip);
when(reportPublisher.getWriter()).thenReturn(mockReportWriter);
logTester.setLevel(Level.DEBUG);
underTest.execute(root);
verify(cliService).generateManifestsZip(root, mockCliFile, configuration);
verify(mockReportWriter).writeScaFile(mockManifestZip);
assertThat(logTester.logs(Level.DEBUG)).contains("Zip ready for report: " + mockManifestZip);
assertThat(logTester.logs(Level.DEBUG)).contains("Manifest zip written to report");
}
@Test
void execute_printsRuntime() throws IOException {
File mockCliFile = Files.newTemporaryFile();
File mockManifestZip = Files.newTemporaryFile();
ScannerReportWriter mockReportWriter = mock(ScannerReportWriter.class);
when(cliCacheService.cacheCli()).thenReturn(mockCliFile);
when(cliService.generateManifestsZip(root, mockCliFile, configuration)).thenReturn(mockManifestZip);
when(reportPublisher.getWriter()).thenReturn(mockReportWriter);
logTester.setLevel(Level.INFO);
underTest.execute(root);
assertThat(logTester.logs(Level.INFO)).anyMatch(l -> l.matches("Load SCA project dependencies \\(done\\) \\| time=\\d+ms"));
}
}
|
