aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firestore/core/test/firebase/firestore/util/path_test.cc
blob: a60e839e86bff64ce6fbc0bf54d3430f7ebc2e52 (plain)
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
/*
 * Copyright 2018 Google
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "Firestore/core/src/firebase/firestore/util/path.h"

#include "gtest/gtest.h"

namespace firebase {
namespace firestore {
namespace util {

// There are several potential sources of inspiration for what is correct
// behavior for these functions.
//
// Python: test with
//
//   python -c 'import os.path; print(os.path.basename("a/b/c//"))'
//
// POSIX shell: test with
//
//   dirname "a/b/c//"
//
// libc++: std::filesystem does not yet ship with Xcode (as of 9.4). Test with a
// new (non-default installed) llvm, e.g. llvm-6.0:
//
//   brew install llvm
//   llvm=$(brew --prefix)/opt/llvm
//   $llvm/bin/clang++ -I$llvm/include -I$llvm/include/c++/v1 -L$llvm/lib
//       -Wl,-rpath,$llvm/lib test.cc -lc++experimental && ./a.out
//
//   test.cc contains something like:
//     #include <experimental/filesystem>
//     #include <iostream>
//     namespace fs = std::experimental::filesystem;
//     int main() {
//       std::cout << fs::path("/a/b/c//").parent_path() << std::endl;
//     }
//
// cppreference: look up example output in functions declared here:
//   https://en.cppreference.com/w/cpp/filesystem/path
//
// This implementation mostly follows python's example:
//
//   * It's pretty simple to implement
//   * POSIX is more complicated than we need
//   * std::filesystem is still too experimental (as of 2018-06-05)

#define EXPECT_BASENAME_EQ(expected, source)                  \
  do {                                                        \
    EXPECT_EQ(std::string{expected}, Path::Basename(source)); \
  } while (0)

TEST(Path, Basename_NoSeparator) {
  // POSIX would require all of these to be ".".
  // python and libc++ agree this is "".
  EXPECT_BASENAME_EQ("", "");
  EXPECT_BASENAME_EQ("a", "a");
  EXPECT_BASENAME_EQ("foo", "foo");
  EXPECT_BASENAME_EQ(".", ".");
  EXPECT_BASENAME_EQ("..", "..");
}

TEST(Path, Basename_LeadingSlash) {
  EXPECT_BASENAME_EQ("", "/");
  EXPECT_BASENAME_EQ("", "///");
  EXPECT_BASENAME_EQ("a", "/a");
  EXPECT_BASENAME_EQ("a", "//a");

  EXPECT_BASENAME_EQ(".", "/.");
  EXPECT_BASENAME_EQ("..", "/..");
  EXPECT_BASENAME_EQ("..", "//..");
}

TEST(Path, Basename_IntermediateSlash) {
  EXPECT_BASENAME_EQ("b", "/a/b");
  EXPECT_BASENAME_EQ("b", "/a//b");
  EXPECT_BASENAME_EQ("b", "//a/b");
  EXPECT_BASENAME_EQ("b", "//a//b");

  EXPECT_BASENAME_EQ("b", "//..//b");
  EXPECT_BASENAME_EQ("b", "//a/./b");
  EXPECT_BASENAME_EQ("b", "//a/.//b");
}

TEST(Path, Basename_TrailingSlash) {
  // python: "a/b//" => ""
  // POSIX: "a/b//" => "b"
  // libc++ path::filename(): "a/b//" => "." (cppreference suggests "")
  EXPECT_BASENAME_EQ("", "/a/");
  EXPECT_BASENAME_EQ("", "/a///");

  EXPECT_BASENAME_EQ("", "/a/b/");
  EXPECT_BASENAME_EQ("", "/a/b//");
  EXPECT_BASENAME_EQ("", "/a//b//");
  EXPECT_BASENAME_EQ("", "//a//b//");
}

TEST(Path, Basename_RelativePath) {
  EXPECT_BASENAME_EQ("b", "a/b");
  EXPECT_BASENAME_EQ("b", "a//b");

  EXPECT_BASENAME_EQ("b", "..//b");
  EXPECT_BASENAME_EQ("b", "a/./b");
  EXPECT_BASENAME_EQ("b", "a/.//b");
  EXPECT_BASENAME_EQ("b", "a//.//b");
}

#define EXPECT_DIRNAME_EQ(expected, source)                  \
  do {                                                       \
    EXPECT_EQ(std::string{expected}, Path::Dirname(source)); \
  } while (0)

TEST(Path, Dirname_NoSeparator) {
  // POSIX would require all of these to be ".".
  // python and libc++ agree this is "".
  EXPECT_DIRNAME_EQ("", "");
  EXPECT_DIRNAME_EQ("", "a");
  EXPECT_DIRNAME_EQ("", "foo");
  EXPECT_DIRNAME_EQ("", ".");
  EXPECT_DIRNAME_EQ("", "..");
}

TEST(Path, Dirname_LeadingSlash) {
  // POSIX says all "/".
  // python starts with "/" but does not strip trailing slashes.
  // libc++ path::parent_path() considers all of these be "", though
  // cppreference.com indicates this should be "/" in example output so this is
  // likely a bug.
  EXPECT_DIRNAME_EQ("/", "/");
  EXPECT_DIRNAME_EQ("/", "///");
  EXPECT_DIRNAME_EQ("/", "/a");
  EXPECT_DIRNAME_EQ("/", "//a");

  EXPECT_DIRNAME_EQ("/", "/.");
  EXPECT_DIRNAME_EQ("/", "/..");
  EXPECT_DIRNAME_EQ("/", "//..");
}

TEST(Path, Dirname_IntermediateSlash) {
  EXPECT_DIRNAME_EQ("/a", "/a/b");
  EXPECT_DIRNAME_EQ("/a", "/a//b");
  EXPECT_DIRNAME_EQ("//a", "//a/b");
  EXPECT_DIRNAME_EQ("//a", "//a//b");

  EXPECT_DIRNAME_EQ("//..", "//..//b");
  EXPECT_DIRNAME_EQ("//a/.", "//a/./b");
  EXPECT_DIRNAME_EQ("//a/.", "//a/.//b");
}

TEST(Path, Dirname_TrailingSlash) {
  // POSIX demands stripping trailing slashes before computing dirname, while
  // python and libc++ effectively seem to consider the path to contain an empty
  // path segment there.
  EXPECT_DIRNAME_EQ("/a", "/a/");
  EXPECT_DIRNAME_EQ("/a", "/a///");

  EXPECT_DIRNAME_EQ("/a/b", "/a/b/");
  EXPECT_DIRNAME_EQ("/a/b", "/a/b//");
  EXPECT_DIRNAME_EQ("/a//b", "/a//b//");
  EXPECT_DIRNAME_EQ("//a//b", "//a//b//");
}

TEST(Path, Dirname_RelativePath) {
  EXPECT_DIRNAME_EQ("a", "a/b");
  EXPECT_DIRNAME_EQ("a", "a//b");

  EXPECT_DIRNAME_EQ("..", "..//b");
  EXPECT_DIRNAME_EQ("a/.", "a/./b");
  EXPECT_DIRNAME_EQ("a/.", "a/.//b");
  EXPECT_DIRNAME_EQ("a//.", "a//.//b");
}

TEST(Path, IsAbsolute) {
  EXPECT_FALSE(Path::IsAbsolute(""));
  EXPECT_TRUE(Path::IsAbsolute("/"));
  EXPECT_TRUE(Path::IsAbsolute("//"));
  EXPECT_TRUE(Path::IsAbsolute("/foo"));
  EXPECT_FALSE(Path::IsAbsolute("foo"));
  EXPECT_FALSE(Path::IsAbsolute("foo/bar"));
}

TEST(Path, Join_Absolute) {
  EXPECT_EQ("/", Path::Join("/"));

  EXPECT_EQ("/", Path::Join("", "/"));
  EXPECT_EQ("/", Path::Join("a", "/"));
  EXPECT_EQ("/b", Path::Join("a", "/b"));

  // Alternate root names should be preserved.
  EXPECT_EQ("//", Path::Join("a", "//"));
  EXPECT_EQ("//b", Path::Join("a", "//b"));
  EXPECT_EQ("///b///", Path::Join("a", "///b///"));

  EXPECT_EQ("/", Path::Join("/", "/"));
  EXPECT_EQ("/b", Path::Join("/", "/b"));
  EXPECT_EQ("//b", Path::Join("//host/a", "//b"));
  EXPECT_EQ("//b", Path::Join("//host/a/", "//b"));

  EXPECT_EQ("/", Path::Join("/", ""));
  EXPECT_EQ("/a", Path::Join("/", "a"));
  EXPECT_EQ("/a/b/c", Path::Join("/", "a", "b", "c"));
  EXPECT_EQ("/a/", Path::Join("/", "a/"));
  EXPECT_EQ("/.", Path::Join("/", "."));
  EXPECT_EQ("/..", Path::Join("/", ".."));
}

TEST(Path, Join_Relative) {
  EXPECT_EQ("", Path::Join(""));

  EXPECT_EQ("", Path::Join("", "", "", ""));
  EXPECT_EQ("a/b/c", Path::Join("a/b", "c"));
  EXPECT_EQ("/c/d", Path::Join("a/b", "/c", "d"));
  EXPECT_EQ("/c/d", Path::Join("a/b/", "/c", "d"));
}

TEST(Path, Join_Types) {
  EXPECT_EQ("a/b", Path::Join(absl::string_view{"a"}, "b"));
  EXPECT_EQ("a/b", Path::Join(std::string{"a"}, "b"));

  std::string a_string{"a"};
  EXPECT_EQ("a/b", Path::Join(a_string, "b"));
  EXPECT_EQ("a", a_string);
}

}  // namespace util
}  // namespace firestore
}  // namespace firebase