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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include <thread>
#include "SpecialSystemDirectory.h"
#include "gtest/gtest.h"
#include "mozilla/ErrorResult.h"
#include "mozilla/SpinEventLoopUntil.h"
#include "mozilla/dom/BlobImpl.h"
#include "mozilla/dom/Directory.h"
#include "mozilla/dom/File.h"
#include "mozilla/dom/GetFilesHelper.h"
#include "mozilla/dom/UnionTypes.h"
#include "mozilla/gtest/MozAssertions.h"
#include "mozilla/media/MediaUtils.h"
#include "nsIFile.h"
using namespace mozilla;
using namespace mozilla::dom;
nsCOMPtr<nsIFile> MakeFileFromPathSegments(
const nsTArray<const char*>& aPathSegments) {
nsCOMPtr<nsIFile> file;
MOZ_ALWAYS_SUCCEEDS(GetSpecialSystemDirectory(OS_CurrentWorkingDirectory,
getter_AddRefs(file)));
for (const auto* pathSegment : aPathSegments) {
MOZ_ALWAYS_SUCCEEDS(
file->AppendRelativePath(NS_ConvertASCIItoUTF16(pathSegment)));
}
return file;
}
nsresult AppendFileOrDirectory(nsTArray<OwningFileOrDirectory>& aDirectories,
const nsTArray<const char*>& aPathSegments) {
bool exists = false;
int retryCount = 5;
nsCOMPtr<nsIFile> file = MakeFileFromPathSegments(aPathSegments);
while (retryCount--) {
if (NS_SUCCEEDED(file->Exists(&exists))) {
break;
}
// May require retrying (bug 1963029)
std::this_thread::sleep_for(std::chrono::milliseconds(100));
}
NS_ENSURE_TRUE(exists, NS_ERROR_FILE_NOT_FOUND);
bool isDir;
MOZ_ALWAYS_SUCCEEDS(file->IsDirectory(&isDir));
if (isDir) {
// We just need to iterate over the directory, so use the junk scope
RefPtr<Directory> directory =
Directory::Create(xpc::NativeGlobal(xpc::PrivilegedJunkScope()), file);
NS_ENSURE_TRUE(directory, NS_ERROR_FAILURE);
OwningFileOrDirectory* owningDirectory = aDirectories.EmplaceBack();
owningDirectory->SetAsDirectory() = directory;
} else {
OwningFileOrDirectory* owningDirectory = aDirectories.EmplaceBack();
RefPtr<File> fileObject = File::CreateFromFile(
xpc::NativeGlobal(xpc::PrivilegedJunkScope()), file);
owningDirectory->SetAsFile() = fileObject;
}
return NS_OK;
}
struct BoolStruct {
bool mValue = false;
};
class FilesCallback : public GetFilesCallback {
public:
FilesCallback(std::atomic<bool>& aGotResponse,
const nsTArray<nsString>& aExpectedPaths)
: mGotResponse(aGotResponse), mExpectedPaths(aExpectedPaths.Clone()) {}
// -------------------
// GetFilesCallback
// -------------------
void Callback(nsresult aStatus,
const FallibleTArray<RefPtr<BlobImpl>>& aBlobImpls) override {
EXPECT_EQ(aBlobImpls.Length(), mExpectedPaths.Length());
for (const auto& blob : aBlobImpls) {
nsString path;
ErrorResult error;
blob->GetMozFullPathInternal(path, error);
ASSERT_EQ(error.StealNSResult(), NS_OK);
ASSERT_TRUE(mExpectedPaths.Contains(path));
}
mGotResponse = true;
}
private:
std::atomic<bool>& mGotResponse;
nsTArray<nsString> mExpectedPaths;
};
nsTArray<nsString> GetExpectedPaths(
const nsTArray<nsTArray<const char*>>& aPathSegmentsArray) {
nsTArray<nsString> expectedPaths(aPathSegmentsArray.Length());
for (const auto& pathSegments : aPathSegmentsArray) {
auto file = MakeFileFromPathSegments(pathSegments);
nsString expectedPath;
MOZ_ALWAYS_SUCCEEDS(file->GetPath(expectedPath));
expectedPaths.AppendElement(expectedPath);
}
return expectedPaths;
}
void ExpectGetFilesHelperResponse(
RefPtr<GetFilesHelper> aHelper,
const nsTArray<nsTArray<const char*>>& aPathSegmentsArray) {
nsTArray<nsString> expectedPaths = GetExpectedPaths(aPathSegmentsArray);
std::atomic<bool> gotCallbackResponse = false;
std::atomic<bool> gotMozPromiseResponse = false;
RefPtr<FilesCallback> callback =
MakeRefPtr<FilesCallback>(gotCallbackResponse, expectedPaths);
aHelper->AddCallback(callback);
auto mozPromise = MakeRefPtr<GetFilesHelper::MozPromiseType>(__func__);
aHelper->AddMozPromise(mozPromise,
xpc::NativeGlobal(xpc::PrivilegedJunkScope()));
mozPromise->Then(
GetMainThreadSerialEventTarget(), __func__,
[&gotMozPromiseResponse,
&expectedPaths](const nsTArray<RefPtr<mozilla::dom::File>>& aFiles) {
EXPECT_EQ(aFiles.Length(), expectedPaths.Length());
for (const auto& file : aFiles) {
nsString path;
ErrorResult error;
file->GetMozFullPathInternal(path, error);
ASSERT_EQ(error.StealNSResult(), NS_OK);
ASSERT_TRUE(expectedPaths.Contains(path));
}
gotMozPromiseResponse = true;
},
[]() { FAIL() << "MozPromise got rejected!"; });
// Make timedOut a RefPtr so if we get a response after this function
// has finished we can safely check that (and don't start accessing stack
// values that don't exist anymore)
RefPtr timedOut = MakeRefPtr<media::Refcountable<BoolStruct>>();
RefPtr<CancelableRunnable> timer =
NS_NewCancelableRunnableFunction("GetFilesHelper timeout", [&] {
if (!gotCallbackResponse.load() || !gotMozPromiseResponse.load()) {
timedOut->mValue = true;
}
});
constexpr uint32_t kTimeout = 10000;
NS_DelayedDispatchToCurrentThread(do_AddRef(timer), kTimeout);
mozilla::SpinEventLoopUntil(
"Waiting for GetFilesHelper result"_ns, [&, timedOut]() {
return (gotCallbackResponse.load() && gotMozPromiseResponse.load()) ||
timedOut->mValue;
});
timer->Cancel();
EXPECT_TRUE(gotCallbackResponse);
EXPECT_TRUE(gotMozPromiseResponse);
EXPECT_FALSE(timedOut->mValue);
}
TEST(GetFilesHelper, TestSingleDirectory)
{
nsTArray<OwningFileOrDirectory> directories;
ASSERT_NS_SUCCEEDED(
AppendFileOrDirectory(directories, {"getfiles", "inner2"}));
ErrorResult error;
RefPtr<GetFilesHelper> helper =
GetFilesHelper::Create(directories, true, error);
ASSERT_EQ(error.StealNSResult(), NS_OK);
nsTArray<nsTArray<const char*>> pathSegmentsArray;
pathSegmentsArray.AppendElement(
nsTArray{"getfiles", "inner2", "fileinner2.txt"});
ExpectGetFilesHelperResponse(helper, pathSegmentsArray);
}
TEST(GetFilesHelper, TestSingleNestedDirectory)
{
nsTArray<OwningFileOrDirectory> directories;
ASSERT_NS_SUCCEEDED(
AppendFileOrDirectory(directories, {"getfiles", "inner1"}));
ErrorResult error;
RefPtr<GetFilesHelper> helper =
GetFilesHelper::Create(directories, true, error);
ASSERT_EQ(error.StealNSResult(), NS_OK);
nsTArray<nsTArray<const char*>> pathSegmentsArray;
pathSegmentsArray.AppendElement(
nsTArray{"getfiles", "inner1", "fileinner1.txt"});
pathSegmentsArray.AppendElement(
nsTArray{"getfiles", "inner1", "inner", "fileinnerinner1.txt"});
ExpectGetFilesHelperResponse(helper, pathSegmentsArray);
}
TEST(GetFilesHelper, TestSingleNestedDirectoryNoRecursion)
{
nsTArray<OwningFileOrDirectory> directories;
ASSERT_NS_SUCCEEDED(
AppendFileOrDirectory(directories, {"getfiles", "inner1"}));
ErrorResult error;
RefPtr<GetFilesHelper> helper =
GetFilesHelper::Create(directories, false, error);
ASSERT_EQ(error.StealNSResult(), NS_OK);
nsTArray<nsTArray<const char*>> pathSegmentsArray;
pathSegmentsArray.AppendElement(
nsTArray{"getfiles", "inner1", "fileinner1.txt"});
ExpectGetFilesHelperResponse(helper, pathSegmentsArray);
}
TEST(GetFilesHelper, TestSingleDirectoryWithMultipleNestedChildren)
{
nsTArray<OwningFileOrDirectory> directories;
ASSERT_NS_SUCCEEDED(AppendFileOrDirectory(directories, {"getfiles"}));
ErrorResult error;
RefPtr<GetFilesHelper> helper =
GetFilesHelper::Create(directories, true, error);
ASSERT_EQ(error.StealNSResult(), NS_OK);
nsTArray<nsTArray<const char*>> pathSegmentsArray;
pathSegmentsArray.AppendElement(nsTArray{"getfiles", "file1.txt"});
pathSegmentsArray.AppendElement(nsTArray{"getfiles", "file2.txt"});
pathSegmentsArray.AppendElement(
nsTArray{"getfiles", "inner1", "fileinner1.txt"});
pathSegmentsArray.AppendElement(
nsTArray{"getfiles", "inner1", "inner", "fileinnerinner1.txt"});
pathSegmentsArray.AppendElement(
nsTArray{"getfiles", "inner2", "fileinner2.txt"});
ExpectGetFilesHelperResponse(helper, pathSegmentsArray);
}
TEST(GetFilesHelper, TestSingleFile)
{
nsTArray<OwningFileOrDirectory> directories;
ASSERT_NS_SUCCEEDED(AppendFileOrDirectory(
directories, {"getfiles", "inner1", "fileinner1.txt"}));
ErrorResult error;
RefPtr<GetFilesHelper> helper =
GetFilesHelper::Create(directories, true, error);
ASSERT_EQ(error.StealNSResult(), NS_OK);
nsTArray<nsTArray<const char*>> pathSegmentsArray;
pathSegmentsArray.AppendElement(
nsTArray{"getfiles", "inner1", "fileinner1.txt"});
ExpectGetFilesHelperResponse(helper, pathSegmentsArray);
}
TEST(GetFilesHelper, TestMultipleFiles)
{
nsTArray<OwningFileOrDirectory> directories;
ASSERT_NS_SUCCEEDED(AppendFileOrDirectory(
directories, {"getfiles", "inner1", "fileinner1.txt"}));
ASSERT_NS_SUCCEEDED(AppendFileOrDirectory(
directories, {"getfiles", "inner2", "fileinner2.txt"}));
ErrorResult error;
RefPtr<GetFilesHelper> helper =
GetFilesHelper::Create(directories, true, error);
ASSERT_EQ(error.StealNSResult(), NS_OK);
nsTArray<nsTArray<const char*>> pathSegmentsArray;
pathSegmentsArray.AppendElement(
nsTArray{"getfiles", "inner1", "fileinner1.txt"});
pathSegmentsArray.AppendElement(
nsTArray{"getfiles", "inner2", "fileinner2.txt"});
ExpectGetFilesHelperResponse(helper, pathSegmentsArray);
}
// Content Analysis can use GetFilesHelper with multiple directories,
// so make sure that works.
TEST(GetFilesHelper, TestMultipleDirectories)
{
nsTArray<OwningFileOrDirectory> directories;
ASSERT_NS_SUCCEEDED(
AppendFileOrDirectory(directories, {"getfiles", "inner1"}));
ASSERT_NS_SUCCEEDED(
AppendFileOrDirectory(directories, {"getfiles", "inner2"}));
ErrorResult error;
RefPtr<GetFilesHelper> helper =
GetFilesHelper::Create(directories, true, error);
ASSERT_EQ(error.StealNSResult(), NS_OK);
nsTArray<nsTArray<const char*>> pathSegmentsArray;
pathSegmentsArray.AppendElement(
nsTArray{"getfiles", "inner1", "fileinner1.txt"});
pathSegmentsArray.AppendElement(
nsTArray{"getfiles", "inner1", "inner", "fileinnerinner1.txt"});
pathSegmentsArray.AppendElement(
nsTArray{"getfiles", "inner2", "fileinner2.txt"});
ExpectGetFilesHelperResponse(helper, pathSegmentsArray);
}
|
