summaryrefslogtreecommitdiff
path: root/test/plugins/filesystem/FileLocatorTest.cpp
blob: 75d9f33d0d019556e4a5851208a164d16b874e30 (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
/*
    Ousía
    Copyright (C) 2014, 2015  Benjamin Paaßen, Andreas Stöckel

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#include <gtest/gtest.h>

#include <plugins/filesystem/FileLocator.hpp>
#include <plugins/filesystem/SpecialPaths.hpp>

#include <boost/filesystem.hpp>

namespace fs = boost::filesystem;

namespace ousia {
TEST(FileLocator, addSearchPath)
{
	FileLocator instance;
	ASSERT_EQ(0U, instance.getSearchPaths().size());

	// Read the canonical path of "."
	std::string canonicalPath = fs::canonical(".").generic_string();

	// Add one path for three types.
	instance.addSearchPath(".",
	                       {ResourceType::DOMAIN_DESC, ResourceType::SCRIPT,
	                        ResourceType::TYPESYSTEM});

	ASSERT_EQ(3U, instance.getSearchPaths().size());

	auto it = instance.getSearchPaths().find(ResourceType::DOMAIN_DESC);

	ASSERT_EQ(1U, it->second.size());
	ASSERT_EQ(canonicalPath, it->second[0]);

	it = instance.getSearchPaths().find(ResourceType::SCRIPT);

	ASSERT_EQ(1U, it->second.size());
	ASSERT_EQ(canonicalPath, it->second[0]);

	it = instance.getSearchPaths().find(ResourceType::TYPESYSTEM);

	ASSERT_EQ(1U, it->second.size());
	ASSERT_EQ(canonicalPath, it->second[0]);

	it = instance.getSearchPaths().find(ResourceType::ATTRIBUTES);
	ASSERT_EQ(it, instance.getSearchPaths().end());

	// Adding the path another time should not increase the number of found
	// paths, except for new resource types
	instance.addSearchPath(
	    canonicalPath, {ResourceType::DOMAIN_DESC, ResourceType::SCRIPT,
	                    ResourceType::TYPESYSTEM, ResourceType::ATTRIBUTES});

	ASSERT_EQ(4U, instance.getSearchPaths().size());

	it = instance.getSearchPaths().find(ResourceType::DOMAIN_DESC);

	ASSERT_EQ(1U, it->second.size());
	ASSERT_EQ(canonicalPath, it->second[0]);

	it = instance.getSearchPaths().find(ResourceType::SCRIPT);

	ASSERT_EQ(1U, it->second.size());
	ASSERT_EQ(canonicalPath, it->second[0]);

	it = instance.getSearchPaths().find(ResourceType::TYPESYSTEM);

	ASSERT_EQ(1U, it->second.size());
	ASSERT_EQ(canonicalPath, it->second[0]);

	it = instance.getSearchPaths().find(ResourceType::ATTRIBUTES);

	ASSERT_EQ(1U, it->second.size());
	ASSERT_EQ(canonicalPath, it->second[0]);

	// Add another path for only one of those types.

	std::string canonicalPath2 = fs::canonical("..").generic_string();

	instance.addSearchPath("..", {ResourceType::DOMAIN_DESC});

	ASSERT_EQ(4U, instance.getSearchPaths().size());

	it = instance.getSearchPaths().find(ResourceType::DOMAIN_DESC);

	ASSERT_EQ(2U, it->second.size());
	ASSERT_EQ(canonicalPath, it->second[0]);
	ASSERT_EQ(canonicalPath2, it->second[1]);
}

void assert_located(const FileLocator &instance, const std::string &path,
                    const std::string &relativeTo,
                    ResourceType type = ResourceType::DOMAIN_DESC)
{
	Resource res;
	ASSERT_TRUE(instance.locate(res, path, type, relativeTo));
	ASSERT_TRUE(res.isValid());
	fs::path p(res.getLocation());
	ASSERT_TRUE(fs::exists(p));
}

void assert_not_located(const FileLocator &instance, const std::string &path,
                        const std::string &relativeTo,
                        ResourceType type = ResourceType::DOMAIN_DESC)
{
	Resource res;
	ASSERT_FALSE(instance.locate(res, path, type, relativeTo));
	ASSERT_FALSE(res.isValid());
}

TEST(FileLocator, locate)
{
	FileLocator locator;
	locator.addUnittestSearchPath("filesystem");

	// We should be able to find a.txt, but not c.txt
	assert_located(locator, "a.txt", "");
	assert_not_located(locator, "c.txt", "");

	// Add the respective search path
	locator.addUnittestSearchPath("filesystem/b", ResourceType::DOMAIN_DESC);

	// Now we should be able to find both.
	assert_located(locator, "a.txt", "");
	assert_located(locator, "c.txt", "");

	// But only with the correct type.
	assert_not_located(locator, "c.txt", "", ResourceType::SCRIPT);
}

TEST(FileLocator, locateRelative)
{
	FileLocator locator;
	locator.addUnittestSearchPath("filesystem");

	// Add the respective search path
	locator.addUnittestSearchPath("filesystem/b");

	Resource resA, resC;
	ASSERT_TRUE(locator.locate(resA, "a.txt"));
	ASSERT_TRUE(locator.locate(resC, "c.txt"));

	Resource resD;
	ASSERT_TRUE(locator.locate(resD, "d.txt"));
	ASSERT_TRUE(locator.locate(resD, "d.txt", ResourceType::UNKNOWN, resA));
	ASSERT_TRUE(locator.locate(resD, "d.txt", ResourceType::UNKNOWN, resC));
	ASSERT_FALSE(locator.locate(resD, "./d.txt", ResourceType::UNKNOWN, resA));
	ASSERT_TRUE(locator.locate(resD, "./d.txt", ResourceType::UNKNOWN, resC));

	/*
	 * There are two e.txt, one in filesystem, one in b. If we simply look for
	 * e.txt, filesystem/b/e.txt will be returned, because search paths added
	 * last take precedence. This will be the case even if we search relative
	 * to a.txt, which is in filesystem. Only if we look for ./e.txt relative to
	 * a.txt will e.txt be returned.
	 */
	Resource resE;
	ASSERT_TRUE(locator.locate(resE, "e.txt", ResourceType::UNKNOWN));
	fs::path ePath{resE.getLocation()};
	ASSERT_EQ("b", ePath.parent_path().filename());
	ASSERT_TRUE(locator.locate(resE, "e.txt", ResourceType::UNKNOWN, resA));
	ePath = resE.getLocation();
	ASSERT_EQ("b", ePath.parent_path().filename());
	ASSERT_TRUE(locator.locate(resE, "./e.txt", ResourceType::UNKNOWN, resA));
	ePath = resE.getLocation();
	ASSERT_EQ("filesystem", ePath.parent_path().filename());
	ASSERT_FALSE(locator.locate(resE, "../e.txt", ResourceType::UNKNOWN, resA));
}

TEST(FileLocator, testStream)
{
	FileLocator locator;
	locator.addUnittestSearchPath("filesystem");

	// Locate the CMakeLists.txt
	Resource res;
	locator.locate(res, "a.txt");

	// Fetch the input stream and read the first line
	auto is_ptr = res.stream();
	std::string line;
	std::getline(*is_ptr, line);
	ASSERT_EQ("file a", line);
}

TEST(FileLocator, testDefaultSearchPaths)
{
	FileLocator locator;
	locator.addDefaultSearchPaths();

	assert_not_located(locator, "book.oxm", "", ResourceType::UNKNOWN);
	assert_located(locator, "domain/book.oxm", "", ResourceType::UNKNOWN);
	assert_located(locator, "book.oxm", "", ResourceType::DOMAIN_DESC);
	assert_not_located(locator, "color.oxm", "", ResourceType::UNKNOWN);
	assert_located(locator, "typesystem/color.oxm", "", ResourceType::UNKNOWN);
	assert_located(locator, "color.oxm", "", ResourceType::TYPESYSTEM);
}
}