GCC Code Coverage Report


Directory: ../
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 100.0% 0 / 215 / 215
Functions: -% 0 / 35 / 35
Branches: -% 0 / 1494 / 1494

test/unittest/UnitDriver.cpp
Line Branch Exec Source
1 // Copyright (c) 2021-2026 ChilliBits. All rights reserved.
2 // LCOV_EXCL_START
3
4 #include <gtest/gtest.h>
5
6 #include <driver/Driver.h>
7 #include <exception/CliError.h>
8
9 namespace spice::testing {
10
11 using namespace spice::compiler;
12
13 TEST(DriverTest, BuildSubcommandMinimal) {
14 const char *argv[] = {"spice", "build", "../../media/test-project/test.spice"};
15 static constexpr int argc = std::size(argv);
16 CliOptions cliOptions;
17 Driver driver(cliOptions, true);
18 ASSERT_EQ(EXIT_SUCCESS, driver.parse(argc, argv));
19 driver.enrich();
20
21 ASSERT_TRUE(driver.shouldCompile);
22 ASSERT_FALSE(driver.shouldInstall);
23 ASSERT_FALSE(driver.shouldUninstall);
24 ASSERT_FALSE(driver.shouldExecute);
25 ASSERT_FALSE(cliOptions.execute);
26 ASSERT_EQ("../../media/test-project/test.spice", cliOptions.mainSourceFile.relative_path().generic_string());
27 ASSERT_EQ(OptLevel::O0, cliOptions.optLevel);
28 ASSERT_EQ(BuildMode::DEBUG, cliOptions.buildMode);
29 ASSERT_FALSE(cliOptions.generateTestMain);
30 ASSERT_FALSE(cliOptions.testMode);
31 ASSERT_FALSE(cliOptions.noEntryFct);
32 }
33
34 TEST(DriverTest, BuildSubcommandComplex) {
35 const char *argv[] = {
36 "spice",
37 "b",
38 "-d",
39 "-ir",
40 "-g",
41 "-Os",
42 "-m",
43 "release",
44 "-lto",
45 "--sanitizer=address",
46 "--output-container=exec",
47 "../../media/test-project/test.spice",
48 };
49 static constexpr int argc = std::size(argv);
50 CliOptions cliOptions;
51 Driver driver(cliOptions, true);
52 ASSERT_EQ(EXIT_SUCCESS, driver.parse(argc, argv));
53 driver.enrich();
54
55 ASSERT_TRUE(driver.shouldCompile);
56 ASSERT_FALSE(driver.shouldInstall);
57 ASSERT_FALSE(driver.shouldUninstall);
58 ASSERT_FALSE(driver.shouldExecute);
59 ASSERT_FALSE(cliOptions.execute);
60 ASSERT_EQ("../../media/test-project/test.spice", cliOptions.mainSourceFile.relative_path().generic_string());
61 ASSERT_EQ(OptLevel::Os, cliOptions.optLevel); // -Os
62 ASSERT_EQ(BuildMode::RELEASE, cliOptions.buildMode); // -m release
63 ASSERT_FALSE(cliOptions.generateTestMain);
64 ASSERT_FALSE(cliOptions.testMode);
65 ASSERT_FALSE(cliOptions.noEntryFct);
66 ASSERT_TRUE(cliOptions.instrumentation.generateDebugInfo); // -g
67 ASSERT_EQ(Sanitizer::ADDRESS, cliOptions.instrumentation.sanitizer); // --sanitizer=address
68 ASSERT_EQ(OutputContainer::EXECUTABLE, cliOptions.outputContainer); // --output-container=exec
69 ASSERT_TRUE(cliOptions.useLTO); // -lto
70 ASSERT_TRUE(cliOptions.printDebugOutput); // -d
71 ASSERT_TRUE(cliOptions.dump.dumpIR); // -ir
72 ASSERT_TRUE(cliOptions.useLifetimeMarkers); // implicitly due to enabled address sanitizer
73 }
74
75 TEST(DriverTest, RunSubcommandMinimal) {
76 const char *argv[] = {"spice", "run", "../../media/test-project/test.spice"};
77 static constexpr int argc = std::size(argv);
78 CliOptions cliOptions;
79 Driver driver(cliOptions, true);
80 ASSERT_EQ(EXIT_SUCCESS, driver.parse(argc, argv));
81 driver.enrich();
82
83 ASSERT_TRUE(driver.shouldCompile);
84 ASSERT_FALSE(driver.shouldInstall);
85 ASSERT_FALSE(driver.shouldUninstall);
86 ASSERT_TRUE(driver.shouldExecute);
87 ASSERT_TRUE(cliOptions.execute);
88 ASSERT_EQ("../../media/test-project/test.spice", cliOptions.mainSourceFile.relative_path().generic_string());
89 ASSERT_EQ(OptLevel::O0, cliOptions.optLevel);
90 ASSERT_FALSE(cliOptions.generateTestMain);
91 ASSERT_FALSE(cliOptions.testMode);
92 ASSERT_FALSE(cliOptions.noEntryFct);
93 }
94
95 TEST(DriverTest, RunSubcommandComplex) {
96 const char *argv[] = {"spice", "r", "-O2", "-j", "8", "-ast", "../../media/test-project/test.spice"};
97 static constexpr int argc = std::size(argv);
98 CliOptions cliOptions;
99 Driver driver(cliOptions, true);
100 ASSERT_EQ(EXIT_SUCCESS, driver.parse(argc, argv));
101 driver.enrich();
102
103 ASSERT_TRUE(driver.shouldCompile);
104 ASSERT_FALSE(driver.shouldInstall);
105 ASSERT_FALSE(driver.shouldUninstall);
106 ASSERT_TRUE(driver.shouldExecute);
107 ASSERT_TRUE(cliOptions.execute);
108 ASSERT_EQ("../../media/test-project/test.spice", cliOptions.mainSourceFile.relative_path().generic_string());
109 ASSERT_EQ(OptLevel::O2, cliOptions.optLevel); // -O2
110 ASSERT_FALSE(cliOptions.generateTestMain);
111 ASSERT_FALSE(cliOptions.testMode);
112 ASSERT_FALSE(cliOptions.noEntryFct);
113 ASSERT_EQ(8, cliOptions.compileJobCount); // -j 8
114 ASSERT_TRUE(cliOptions.dump.dumpAST); // -ast
115 }
116
117 TEST(DriverTest, TestSubcommandMinimal) {
118 const char *argv[] = {"spice", "test", "../../media/test-project/test.spice"};
119 static constexpr int argc = std::size(argv);
120 CliOptions cliOptions;
121 Driver driver(cliOptions, true);
122 ASSERT_EQ(EXIT_SUCCESS, driver.parse(argc, argv));
123 driver.enrich();
124
125 ASSERT_TRUE(driver.shouldCompile);
126 ASSERT_FALSE(driver.shouldInstall);
127 ASSERT_FALSE(driver.shouldUninstall);
128 ASSERT_TRUE(driver.shouldExecute);
129 ASSERT_TRUE(cliOptions.execute);
130 ASSERT_EQ("../../media/test-project/test.spice", cliOptions.mainSourceFile.relative_path().generic_string());
131 ASSERT_EQ(OptLevel::O0, cliOptions.optLevel);
132 ASSERT_EQ(BuildMode::TEST, cliOptions.buildMode); // -m test
133 ASSERT_TRUE(cliOptions.generateTestMain);
134 ASSERT_FALSE(cliOptions.testMode);
135 ASSERT_TRUE(cliOptions.noEntryFct);
136 }
137
138 TEST(DriverTest, TestSubcommandComplex) {
139 const char *argv[] = {"spice", "t", "-s", "-cst", "--sanitizer=thread", "../../media/test-project/test.spice"};
140 static constexpr int argc = std::size(argv);
141 CliOptions cliOptions;
142 Driver driver(cliOptions, true);
143 ASSERT_EQ(EXIT_SUCCESS, driver.parse(argc, argv));
144 driver.enrich();
145
146 ASSERT_TRUE(driver.shouldCompile);
147 ASSERT_FALSE(driver.shouldInstall);
148 ASSERT_FALSE(driver.shouldUninstall);
149 ASSERT_TRUE(driver.shouldExecute);
150 ASSERT_TRUE(cliOptions.execute);
151 ASSERT_EQ("../../media/test-project/test.spice", cliOptions.mainSourceFile.relative_path().generic_string());
152 ASSERT_EQ(OptLevel::O0, cliOptions.optLevel);
153 ASSERT_TRUE(cliOptions.generateTestMain);
154 ASSERT_TRUE(cliOptions.noEntryFct);
155 ASSERT_TRUE(cliOptions.dump.dumpCST); // -cst
156 ASSERT_TRUE(cliOptions.dump.dumpAssembly); // -s
157 ASSERT_EQ(Sanitizer::THREAD, cliOptions.instrumentation.sanitizer); // --sanitizer=thread
158 }
159
160 TEST(DriverTest, InstallSubcommandMinimal) {
161 const char *argv[] = {"spice", "install", "../../media/test-project/test.spice"};
162 static constexpr int argc = std::size(argv);
163 CliOptions cliOptions;
164 Driver driver(cliOptions, true);
165 ASSERT_EQ(EXIT_SUCCESS, driver.parse(argc, argv));
166 driver.enrich();
167
168 ASSERT_TRUE(driver.shouldCompile);
169 ASSERT_TRUE(driver.shouldInstall);
170 ASSERT_FALSE(driver.shouldUninstall);
171 ASSERT_FALSE(driver.shouldExecute);
172 ASSERT_FALSE(cliOptions.execute);
173 ASSERT_EQ("../../media/test-project/test.spice", cliOptions.mainSourceFile.relative_path().generic_string());
174 ASSERT_EQ(OptLevel::O0, cliOptions.optLevel);
175 ASSERT_FALSE(cliOptions.generateTestMain);
176 ASSERT_FALSE(cliOptions.testMode);
177 ASSERT_FALSE(cliOptions.noEntryFct);
178 }
179
180 TEST(DriverTest, UninstallSubcommandMinimal) {
181 const char *argv[] = {"spice", "uninstall", "../../media/test-project/test.spice"};
182 static constexpr int argc = std::size(argv);
183 CliOptions cliOptions;
184 Driver driver(cliOptions, true);
185 ASSERT_EQ(EXIT_SUCCESS, driver.parse(argc, argv));
186 driver.enrich();
187
188 ASSERT_FALSE(driver.shouldCompile);
189 ASSERT_FALSE(driver.shouldInstall);
190 ASSERT_TRUE(driver.shouldUninstall);
191 ASSERT_FALSE(driver.shouldExecute);
192 ASSERT_FALSE(cliOptions.execute);
193 ASSERT_EQ("../../media/test-project/test.spice", cliOptions.mainSourceFile.relative_path().generic_string());
194 ASSERT_EQ(OptLevel::O0, cliOptions.optLevel);
195 ASSERT_FALSE(cliOptions.generateTestMain);
196 ASSERT_FALSE(cliOptions.testMode);
197 ASSERT_FALSE(cliOptions.noEntryFct);
198 }
199
200 TEST(DriverTest, MemorySanitizerOnlyLinux) {
201 const char *argv[] = {"spice", "build", "--sanitizer=memory", "../../media/test-project/test.spice"};
202 static constexpr int argc = std::size(argv);
203 CliOptions cliOptions;
204 Driver driver(cliOptions, true);
205
206 ASSERT_EQ(EXIT_SUCCESS, driver.parse(argc, argv));
207 #if OS_LINUX
208 driver.enrich();
209 ASSERT_EQ(Sanitizer::MEMORY, cliOptions.instrumentation.sanitizer);
210 ASSERT_TRUE(cliOptions.useLifetimeMarkers); // implicitly due to enabled address sanitizer
211 #else
212 try {
213 driver.enrich();
214 FAIL();
215 } catch (CliError &error) {
216 auto errorMsg = "[Error|CLI] Feature is not supported for this target: Memory sanitizer is only supported for Linux targets";
217 ASSERT_STREQ(errorMsg, error.what());
218 }
219 #endif
220 }
221
222 TEST(DriverTest, IncompatibleOptions) {
223 // --static in combination with --output-container=dylib is not allowed
224 const char *argv[] = {"spice", "build", "--static", "--output-container=dylib", "../../media/test-project/test.spice"};
225 static constexpr int argc = std::size(argv);
226 CliOptions cliOptions;
227 Driver driver(cliOptions, true);
228 ASSERT_EQ(EXIT_SUCCESS, driver.parse(argc, argv));
229
230 try {
231 driver.enrich();
232 } catch (CliError &error) {
233 const auto errorMsg = "[Error|CLI] Incompatible options: Cannot link statically if compiling shared library";
234 ASSERT_STREQ(errorMsg, error.what());
235 }
236 }
237
238 using DriverInvalidEnumTestParam = std::pair<const char *, const char *>;
239 class DriverTest : public ::testing::TestWithParam<DriverInvalidEnumTestParam> {};
240
241 TEST_P(DriverTest, InvalidEnumValue) {
242 const auto &[arg, errorMessage] = GetParam();
243 const char *argv[] = {"spice", "build", arg, "../../media/test-project/test.spice"};
244 static constexpr int argc = std::size(argv);
245 CliOptions cliOptions;
246 Driver driver(cliOptions, true);
247 try {
248 driver.parse(argc, argv);
249 FAIL();
250 } catch (CliError &error) {
251 ASSERT_STREQ(errorMessage, error.what());
252 }
253 }
254
255 const auto INVALID_ENUM_TEST_VALUES = ::testing::Values(
256 DriverInvalidEnumTestParam{
257 "--build-mode=unknown",
258 "[Error|CLI] Invalid build mode: unknown",
259 },
260 DriverInvalidEnumTestParam{
261 "--sanitizer=unknown",
262 "[Error|CLI] Invalid sanitizer: unknown",
263 },
264 DriverInvalidEnumTestParam{
265 "--output-container=unknown",
266 "[Error|CLI] Invalid output container: unknown",
267 });
268 INSTANTIATE_TEST_SUITE_P(DriverTest, DriverTest, INVALID_ENUM_TEST_VALUES);
269
270 } // namespace spice::testing
271
272 // LCOV_EXCL_STOP
273