Debian Codegraph @

unittests/integration/test_PackageResourceRetriever.cpp

raw
1 /*
2 * Copyright (c) 2011-2022, The DART development contributors
3 * All rights reserved.
4 *
5 * The list of contributors can be found at:
6 * https://github.com/dartsim/dart/blob/master/LICENSE
7 *
8 * This file is provided under the following "BSD-style" License:
9 * Redistribution and use in source and binary forms, with or
10 * without modification, are permitted provided that the following
11 * conditions are met:
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above
15 * copyright notice, this list of conditions and the following
16 * disclaimer in the documentation and/or other materials provided
17 * with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #include <gtest/gtest.h>
34
35 #include "dart/config.hpp"
36 #include "dart/utils/PackageResourceRetriever.hpp"
37
38 #include "TestHelpers.hpp"
39
40 using dart::common::Resource;
41 using dart::common::ResourcePtr;
42 using dart::common::ResourceRetriever;
43 using dart::common::Uri;
44 using dart::utils::PackageResourceRetriever;
45
46 TEST(PackageResourceRetriever, exists_UnableToResolve_ReturnsFalse)
47 {
48 auto mockRetriever = std::make_shared<PresentResourceRetriever>();
49 PackageResourceRetriever retriever(mockRetriever);
50
51 EXPECT_FALSE(retriever.exists(Uri::createFromString("package://test/foo")));
52 EXPECT_TRUE(mockRetriever->mExists.empty());
53 EXPECT_TRUE(mockRetriever->mGetFilePath.empty());
54 EXPECT_TRUE(mockRetriever->mRetrieve.empty());
55 }
56
57 TEST(PackageResourceRetriever, exists_DelegateFails_ReturnsFalse)
58 {
59 // Additional slash is required for Windows because Windows file system
60 // doesn't have a leading slash for an absolute path.
61 // Reference: https://en.wikipedia.org/wiki/File_URI_scheme#Windows
62 #ifdef _WIN32
63 const char* expected = "file:///" DART_DATA_LOCAL_PATH "test/foo";
64 #else
65 const char* expected = "file://" DART_DATA_LOCAL_PATH "test/foo";
66 #endif
67
68 auto mockRetriever = std::make_shared<AbsentResourceRetriever>();
69 PackageResourceRetriever retriever(mockRetriever);
70 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test");
71
72 EXPECT_FALSE(retriever.exists(Uri::createFromString("package://test/foo")));
73 ASSERT_EQ(1u, mockRetriever->mExists.size());
74 EXPECT_EQ(expected, mockRetriever->mExists.front());
75 EXPECT_TRUE(mockRetriever->mGetFilePath.empty());
76 EXPECT_TRUE(mockRetriever->mRetrieve.empty());
77 }
78
79 TEST(PackageResourceRetriever, exists_UnsupportedUri_ReturnsFalse)
80 {
81 auto mockRetriever = std::make_shared<PresentResourceRetriever>();
82 PackageResourceRetriever retriever(mockRetriever);
83 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test");
84
85 EXPECT_FALSE(retriever.exists(Uri::createFromString("foo://test/foo")));
86 EXPECT_TRUE(mockRetriever->mExists.empty());
87 EXPECT_TRUE(mockRetriever->mGetFilePath.empty());
88 EXPECT_TRUE(mockRetriever->mRetrieve.empty());
89 }
90
91 TEST(PackageResourceRetriever, exists_StripsTrailingSlash)
92 {
93 #ifdef _WIN32
94 const char* expected = "file:///" DART_DATA_LOCAL_PATH "test/foo";
95 #else
96 const char* expected = "file://" DART_DATA_LOCAL_PATH "test/foo";
97 #endif
98
99 auto mockRetriever = std::make_shared<PresentResourceRetriever>();
100 PackageResourceRetriever retriever(mockRetriever);
101 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test/");
102
103 EXPECT_TRUE(retriever.exists(Uri::createFromString("package://test/foo")));
104 ASSERT_EQ(1u, mockRetriever->mExists.size());
105 EXPECT_EQ(expected, mockRetriever->mExists.front());
106 EXPECT_TRUE(mockRetriever->mGetFilePath.empty());
107 EXPECT_TRUE(mockRetriever->mRetrieve.empty());
108 }
109
110 TEST(PackageResourceRetriever, exists_FirstUriSucceeds)
111 {
112 #ifdef _WIN32
113 const char* expected = "file:///" DART_DATA_LOCAL_PATH "test1/foo";
114 #else
115 const char* expected = "file://" DART_DATA_LOCAL_PATH "test1/foo";
116 #endif
117
118 auto mockRetriever = std::make_shared<PresentResourceRetriever>();
119 PackageResourceRetriever retriever(mockRetriever);
120 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test1");
121 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test2");
122
123 EXPECT_TRUE(retriever.exists(Uri::createFromString("package://test/foo")));
124 ASSERT_EQ(1u, mockRetriever->mExists.size());
125 EXPECT_EQ(expected, mockRetriever->mExists.front());
126 EXPECT_TRUE(mockRetriever->mGetFilePath.empty());
127 EXPECT_TRUE(mockRetriever->mRetrieve.empty());
128 }
129
130 TEST(PackageResourceRetriever, exists_FallsBackOnSecondUri)
131 {
132 #ifdef _WIN32
133 const char* expected1 = "file:///" DART_DATA_LOCAL_PATH "test1/foo";
134 const char* expected2 = "file:///" DART_DATA_LOCAL_PATH "test2/foo";
135 #else
136 const char* expected1 = "file://" DART_DATA_LOCAL_PATH "test1/foo";
137 const char* expected2 = "file://" DART_DATA_LOCAL_PATH "test2/foo";
138 #endif
139
140 auto mockRetriever = std::make_shared<AbsentResourceRetriever>();
141 PackageResourceRetriever retriever(mockRetriever);
142 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test1");
143 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test2");
144
145 EXPECT_FALSE(retriever.exists(Uri::createFromString("package://test/foo")));
146 ASSERT_EQ(2u, mockRetriever->mExists.size());
147 EXPECT_EQ(expected1, mockRetriever->mExists[0]);
148 EXPECT_EQ(expected2, mockRetriever->mExists[1]);
149 EXPECT_TRUE(mockRetriever->mGetFilePath.empty());
150 EXPECT_TRUE(mockRetriever->mRetrieve.empty());
151 }
152
153 TEST(PackageResourceRetriever, getFilePath_UnableToResolve_ReturnsEmptyString)
154 {
155 auto mockRetriever = std::make_shared<PresentResourceRetriever>();
156 PackageResourceRetriever retriever(mockRetriever);
157
158 EXPECT_EQ(
159 retriever.getFilePath(Uri::createFromString("package://test/foo")), "");
160 EXPECT_TRUE(mockRetriever->mExists.empty());
161 EXPECT_TRUE(mockRetriever->mGetFilePath.empty());
162 EXPECT_TRUE(mockRetriever->mRetrieve.empty());
163 }
164
165 TEST(PackageResourceRetriever, getFilePath_DelegateFails_ReturnsEmptyString)
166 {
167 // GTest breaks the string concatenation.
168 #ifdef _WIN32
169 const char* expected = "file:///" DART_DATA_LOCAL_PATH "test/foo";
170 #else
171 const char* expected = "file://" DART_DATA_LOCAL_PATH "test/foo";
172 #endif
173
174 auto mockRetriever = std::make_shared<AbsentResourceRetriever>();
175 PackageResourceRetriever retriever(mockRetriever);
176 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test");
177
178 EXPECT_EQ(
179 retriever.getFilePath(Uri::createFromString("package://test/foo")), "");
180 ASSERT_TRUE(mockRetriever->mExists.empty());
181 EXPECT_EQ(expected, mockRetriever->mGetFilePath.front());
182 ASSERT_EQ(1u, mockRetriever->mGetFilePath.size());
183 EXPECT_TRUE(mockRetriever->mRetrieve.empty());
184 }
185
186 TEST(PackageResourceRetriever, getFilePath_UnsupportedUri_ReturnsEmptyString)
187 {
188 auto mockRetriever = std::make_shared<PresentResourceRetriever>();
189 PackageResourceRetriever retriever(mockRetriever);
190 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test");
191
192 EXPECT_EQ(retriever.getFilePath(Uri::createFromString("foo://test/foo")), "");
193 EXPECT_TRUE(mockRetriever->mExists.empty());
194 EXPECT_TRUE(mockRetriever->mGetFilePath.empty());
195 EXPECT_TRUE(mockRetriever->mRetrieve.empty());
196 }
197
198 TEST(PackageResourceRetriever, getFilePath_StripsTrailingSlash)
199 {
200 #ifdef _WIN32
201 const char* expected = "file:///" DART_DATA_LOCAL_PATH "test/foo";
202 #else
203 const char* expected = "file://" DART_DATA_LOCAL_PATH "test/foo";
204 #endif
205
206 auto mockRetriever = std::make_shared<PresentResourceRetriever>();
207 PackageResourceRetriever retriever(mockRetriever);
208 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test/");
209
210 EXPECT_EQ(
211 retriever.getFilePath(Uri::createFromString("package://test/foo")),
212 expected);
213 ASSERT_TRUE(mockRetriever->mExists.empty());
214 EXPECT_EQ(expected, mockRetriever->mGetFilePath.front());
215 ASSERT_EQ(1u, mockRetriever->mGetFilePath.size());
216 EXPECT_TRUE(mockRetriever->mRetrieve.empty());
217 }
218
219 TEST(PackageResourceRetriever, getFilePath_FirstUriSucceeds)
220 {
221 #ifdef _WIN32
222 const char* expected = "file:///" DART_DATA_LOCAL_PATH "test1/foo";
223 #else
224 const char* expected = "file://" DART_DATA_LOCAL_PATH "test1/foo";
225 #endif
226
227 auto mockRetriever = std::make_shared<PresentResourceRetriever>();
228 PackageResourceRetriever retriever(mockRetriever);
229 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test1");
230 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test2");
231
232 EXPECT_EQ(
233 retriever.getFilePath(Uri::createFromString("package://test/foo")),
234 expected);
235 ASSERT_TRUE(mockRetriever->mExists.empty());
236 EXPECT_EQ(expected, mockRetriever->mGetFilePath.front());
237 ASSERT_EQ(1u, mockRetriever->mGetFilePath.size());
238 EXPECT_TRUE(mockRetriever->mRetrieve.empty());
239 }
240
241 TEST(PackageResourceRetriever, getFilePath_FallsBackOnSecondUri)
242 {
243 #ifdef _WIN32
244 const char* expected1 = "file:///" DART_DATA_LOCAL_PATH "test1/foo";
245 const char* expected2 = "file:///" DART_DATA_LOCAL_PATH "test2/foo";
246 #else
247 const char* expected1 = "file://" DART_DATA_LOCAL_PATH "test1/foo";
248 const char* expected2 = "file://" DART_DATA_LOCAL_PATH "test2/foo";
249 #endif
250
251 auto mockRetriever = std::make_shared<AbsentResourceRetriever>();
252 PackageResourceRetriever retriever(mockRetriever);
253 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test1");
254 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test2");
255
256 EXPECT_EQ(
257 retriever.getFilePath(Uri::createFromString("package://test/foo")), "");
258 ASSERT_TRUE(mockRetriever->mExists.empty());
259 ASSERT_EQ(2u, mockRetriever->mGetFilePath.size());
260 EXPECT_EQ(expected1, mockRetriever->mGetFilePath[0]);
261 EXPECT_EQ(expected2, mockRetriever->mGetFilePath[1]);
262 EXPECT_TRUE(mockRetriever->mRetrieve.empty());
263 }
264
265 TEST(PackageResourceRetriever, retrieve_UnableToResolve_ReturnsNull)
266 {
267 auto mockRetriever = std::make_shared<PresentResourceRetriever>();
268 PackageResourceRetriever retriever(mockRetriever);
269
270 EXPECT_EQ(
271 nullptr, retriever.retrieve(Uri::createFromString("package://test/foo")));
272 EXPECT_TRUE(mockRetriever->mExists.empty());
273 EXPECT_TRUE(mockRetriever->mRetrieve.empty());
274 }
275
276 TEST(PackageResourceRetriever, retrieve_DelegateFails_ReturnsNull)
277 {
278 // GTest breaks the string concatenation.
279 #ifdef _WIN32
280 const char* expected = "file:///" DART_DATA_LOCAL_PATH "test/foo";
281 #else
282 const char* expected = "file://" DART_DATA_LOCAL_PATH "test/foo";
283 #endif
284
285 auto mockRetriever = std::make_shared<AbsentResourceRetriever>();
286 PackageResourceRetriever retriever(mockRetriever);
287 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test");
288
289 EXPECT_EQ(
290 nullptr, retriever.retrieve(Uri::createFromString("package://test/foo")));
291 EXPECT_TRUE(mockRetriever->mExists.empty());
292 ASSERT_EQ(1u, mockRetriever->mRetrieve.size());
293 EXPECT_EQ(expected, mockRetriever->mRetrieve.front());
294 }
295
296 TEST(PackageResourceRetriever, retrieve_UnsupportedUri_ReturnsNull)
297 {
298 auto mockRetriever = std::make_shared<PresentResourceRetriever>();
299 PackageResourceRetriever retriever(mockRetriever);
300 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test");
301
302 EXPECT_EQ(
303 nullptr, retriever.retrieve(Uri::createFromString("foo://test/foo")));
304 EXPECT_TRUE(mockRetriever->mExists.empty());
305 EXPECT_TRUE(mockRetriever->mRetrieve.empty());
306 }
307
308 TEST(PackageResourceRetriever, retrieve_StripsTrailingSlash)
309 {
310 #ifdef _WIN32
311 const char* expected = "file:///" DART_DATA_LOCAL_PATH "test/foo";
312 #else
313 const char* expected = "file://" DART_DATA_LOCAL_PATH "test/foo";
314 #endif
315
316 auto mockRetriever = std::make_shared<PresentResourceRetriever>();
317 PackageResourceRetriever retriever(mockRetriever);
318 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test/");
319
320 EXPECT_TRUE(
321 retriever.retrieve(Uri::createFromString("package://test/foo"))
322 != nullptr);
323 EXPECT_TRUE(mockRetriever->mExists.empty());
324 ASSERT_EQ(1u, mockRetriever->mRetrieve.size());
325 EXPECT_EQ(expected, mockRetriever->mRetrieve.front());
326 }
327
328 TEST(PackageResourceRetriever, retrieve_FirstUriSucceeds)
329 {
330 #ifdef _WIN32
331 const char* expected = "file:///" DART_DATA_LOCAL_PATH "test1/foo";
332 #else
333 const char* expected = "file://" DART_DATA_LOCAL_PATH "test1/foo";
334 #endif
335
336 auto mockRetriever = std::make_shared<PresentResourceRetriever>();
337 PackageResourceRetriever retriever(mockRetriever);
338 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test1");
339 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test2");
340
341 EXPECT_TRUE(
342 retriever.retrieve(Uri::createFromString("package://test/foo"))
343 != nullptr);
344 EXPECT_TRUE(mockRetriever->mExists.empty());
345 ASSERT_EQ(1u, mockRetriever->mRetrieve.size());
346 EXPECT_EQ(expected, mockRetriever->mRetrieve.front());
347 }
348
349 TEST(PackageResourceRetriever, retrieve_FallsBackOnSecondUri)
350 {
351 #ifdef _WIN32
352 const char* expected1 = "file:///" DART_DATA_LOCAL_PATH "test1/foo";
353 const char* expected2 = "file:///" DART_DATA_LOCAL_PATH "test2/foo";
354 #else
355 const char* expected1 = "file://" DART_DATA_LOCAL_PATH "test1/foo";
356 const char* expected2 = "file://" DART_DATA_LOCAL_PATH "test2/foo";
357 #endif
358
359 auto mockRetriever = std::make_shared<AbsentResourceRetriever>();
360 PackageResourceRetriever retriever(mockRetriever);
361 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test1");
362 retriever.addPackageDirectory("test", DART_DATA_LOCAL_PATH "test2");
363
364 EXPECT_EQ(
365 nullptr, retriever.retrieve(Uri::createFromString("package://test/foo")));
366 EXPECT_TRUE(mockRetriever->mExists.empty());
367 ASSERT_EQ(2u, mockRetriever->mRetrieve.size());
368 EXPECT_EQ(expected1, mockRetriever->mRetrieve[0]);
369 EXPECT_EQ(expected2, mockRetriever->mRetrieve[1]);
370 }