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
|
#include "RadiantTest.h"
#include "ifavourites.h"
#include "iregistry.h"
#include "settings/SettingsManager.h"
namespace test
{
class FavouritesTest :
public RadiantTest
{
protected:
// A function that is invoked after modules have been shut down
std::function<void()> checkAfterShutdown;
void copyUserXmlFileToSettingsPath(const std::string& userXmlFile)
{
fs::path sourcePath = _context.getTestResourcePath();
sourcePath /= "settings/";
sourcePath /= userXmlFile;
settings::SettingsManager manager(_context);
fs::path targetPath = manager.getCurrentVersionSettingsFolder();
targetPath /= "user.xml";
fs::remove(targetPath);
fs::copy(sourcePath, targetPath);
}
void postShutdown() override
{
if (checkAfterShutdown)
{
checkAfterShutdown();
}
}
};
class FavouritesTestWithLegacyFavourites :
public FavouritesTest
{
public:
void preStartup() override
{
copyUserXmlFileToSettingsPath("old_favourites.xml");
}
};
TEST_F(FavouritesTest, AddingAndRemovingFavourites)
{
EXPECT_TRUE(GlobalFavouritesManager().getFavourites("material").empty());
// Add caulk
GlobalFavouritesManager().addFavourite("material", "textures/common/caulk");
EXPECT_EQ(GlobalFavouritesManager().getFavourites("material").size(), 1);
EXPECT_EQ(GlobalFavouritesManager().getFavourites("material").count("textures/common/caulk"), 1);
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("material", "textures/common/caulk"));
EXPECT_FALSE(GlobalFavouritesManager().isFavourite("material", "textures/common/clip"));
// Add clip
GlobalFavouritesManager().addFavourite("material", "textures/common/clip");
EXPECT_EQ(GlobalFavouritesManager().getFavourites("material").size(), 2);
EXPECT_EQ(GlobalFavouritesManager().getFavourites("material").count("textures/common/caulk"), 1);
EXPECT_EQ(GlobalFavouritesManager().getFavourites("material").count("textures/common/clip"), 1);
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("material", "textures/common/caulk"));
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("material", "textures/common/clip"));
// Remove caulk
GlobalFavouritesManager().removeFavourite("material", "textures/common/caulk");
EXPECT_EQ(GlobalFavouritesManager().getFavourites("material").size(), 1);
EXPECT_EQ(GlobalFavouritesManager().getFavourites("material").count("textures/common/clip"), 1);
EXPECT_FALSE(GlobalFavouritesManager().isFavourite("material", "textures/common/caulk"));
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("material", "textures/common/clip"));
// Remove clip
GlobalFavouritesManager().removeFavourite("material", "textures/common/clip");
EXPECT_EQ(GlobalFavouritesManager().getFavourites("material").size(), 0);
EXPECT_FALSE(GlobalFavouritesManager().isFavourite("material", "textures/common/caulk"));
EXPECT_FALSE(GlobalFavouritesManager().isFavourite("material", "textures/common/clip"));
}
TEST_F(FavouritesTest, CaseSensitivity)
{
EXPECT_TRUE(GlobalFavouritesManager().getFavourites("material").empty());
EXPECT_TRUE(GlobalFavouritesManager().getFavourites("MATErial").empty());
// Add caulk
GlobalFavouritesManager().addFavourite("material", "textures/common/caulk");
EXPECT_EQ(GlobalFavouritesManager().getFavourites("material").size(), 1);
EXPECT_EQ(GlobalFavouritesManager().getFavourites("MATErial").size(), 1);
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("material", "textures/common/caulk"));
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("MATErial", "textures/common/caulk"));
// Remove caulk
GlobalFavouritesManager().removeFavourite("MATErial", "textures/common/caulk");
EXPECT_EQ(GlobalFavouritesManager().getFavourites("material").size(), 0);
EXPECT_EQ(GlobalFavouritesManager().getFavourites("MATErial").size(), 0);
}
TEST_F(FavouritesTest, AddingNoneTypes)
{
// Should always be empty
EXPECT_TRUE(GlobalFavouritesManager().getFavourites("").empty());
// None reports always false
EXPECT_FALSE(GlobalFavouritesManager().isFavourite("", "textures/common/clip"));
// Add clip to empty category
GlobalFavouritesManager().addFavourite("", "textures/common/clip");
// Should still be empty
EXPECT_TRUE(GlobalFavouritesManager().getFavourites("").empty());
// Should still report as false
EXPECT_FALSE(GlobalFavouritesManager().isFavourite("", "textures/common/clip"));
}
TEST_F(FavouritesTest, RemovingNoneTypes)
{
// Should always be empty
EXPECT_TRUE(GlobalFavouritesManager().getFavourites("").empty());
// Remove clip to empty category - it's not there, but it shouldn't crash
GlobalFavouritesManager().removeFavourite("", "textures/common/clip");
// Should still be empty
EXPECT_TRUE(GlobalFavouritesManager().getFavourites("").empty());
}
TEST_F(FavouritesTest, RemovingNonExistent)
{
EXPECT_TRUE(GlobalFavouritesManager().getFavourites("material").empty());
// Add caulk
GlobalFavouritesManager().addFavourite("material", "textures/common/caulk");
EXPECT_EQ(GlobalFavouritesManager().getFavourites("material").size(), 1);
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("material", "textures/common/caulk"));
// Remove non-existent => shouldn't change anything
GlobalFavouritesManager().removeFavourite("material", "textures/doesntexist");
EXPECT_EQ(GlobalFavouritesManager().getFavourites("material").size(), 1);
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("material", "textures/common/caulk"));
}
TEST_F(FavouritesTest, AddingEmptyPaths)
{
EXPECT_TRUE(GlobalFavouritesManager().getFavourites("material").empty());
// Add an empty string
GlobalFavouritesManager().addFavourite("material", "");
// Should still be empty
EXPECT_TRUE(GlobalFavouritesManager().getFavourites("material").empty());
// Empty strings always evaluate to false
EXPECT_FALSE(GlobalFavouritesManager().isFavourite("material", ""));
}
TEST_F(FavouritesTest, FavouritesArePersisted)
{
EXPECT_TRUE(GlobalFavouritesManager().getFavourites("material").empty());
// Add caulk and clip
GlobalFavouritesManager().addFavourite("material", "textures/common/caulk");
GlobalFavouritesManager().addFavourite("material", "textures/common/clip");
EXPECT_EQ(GlobalFavouritesManager().getFavourites("material").size(), 2);
EXPECT_EQ(GlobalFavouritesManager().getFavourites("material").count("textures/common/caulk"), 1);
EXPECT_EQ(GlobalFavouritesManager().getFavourites("material").count("textures/common/clip"), 1);
checkAfterShutdown = [&]()
{
settings::SettingsManager manager(_context);
fs::path userXml = manager.getCurrentVersionSettingsFolder();
userXml /= "user.xml";
xml::Document doc(userXml.string());
auto savedNodes = doc.findXPath("/user/ui/favourites/material//favourite");
EXPECT_EQ(savedNodes.size(), 2);
std::set<std::string> savedFavourites;
for (const auto& node : savedNodes)
{
savedFavourites.emplace(node.getAttributeValue("value"));
}
EXPECT_EQ(savedFavourites.count("textures/common/caulk"), 1);
EXPECT_EQ(savedFavourites.count("textures/common/clip"), 1);
};
}
TEST_F(FavouritesTestWithLegacyFavourites, LegacyFavouritesAreImported)
{
// The settings in the old location in the user.xml file should have been imported
EXPECT_FALSE(GlobalFavouritesManager().getFavourites("material").empty());
// These were present in the mediabrowser legacy nodes
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("material", "textures/base_trim/gotrustcol1"));
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("material", "textures/common/caulk"));
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("material", "textures/common/clip"));
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("material", "textures/common/monster_clip"));
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("material", "textures/darkmod/stone/cobblestones/blocks_mixedsize01_dark"));
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("material", "textures/darkmod/stone/cobblestones/blocks_mixedsize03_mossy"));
// These were declared in the decl-typed nodes
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("material", "textures/common/ladder"));
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("entityDef", "atdm:ai_proguard"));
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("soundShader", "clock_tick01"));
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("soundShader", "clock_tick02"));
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("model", "bush02.lwo"));
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("model", "bush01.lwo"));
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("particle", "heavy_rain"));
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("particle", "barrelfire"));
// This one is already saved in the new location and should have been loaded too
EXPECT_TRUE(GlobalFavouritesManager().isFavourite("material", "textures/some/weird/name"));
// The old nodes should have been automatically removed
EXPECT_TRUE(GlobalRegistry().findXPath("user/ui/mediaBrowser/favourites").empty());
EXPECT_TRUE(GlobalRegistry().findXPath("user/ui/favourites/materials").empty());
EXPECT_TRUE(GlobalRegistry().findXPath("user/ui/favourites/entityDefs").empty());
EXPECT_TRUE(GlobalRegistry().findXPath("user/ui/favourites/soundShaders").empty());
EXPECT_TRUE(GlobalRegistry().findXPath("user/ui/favourites/models").empty());
EXPECT_TRUE(GlobalRegistry().findXPath("user/ui/favourites/particles").empty());
}
TEST_F(FavouritesTest, ChangedSignals)
{
EXPECT_TRUE(GlobalFavouritesManager().getFavourites("material").empty());
bool signalFired = false;
GlobalFavouritesManager().getSignalForType("material").connect([&]()
{
signalFired = true;
});
// Add caulk
GlobalFavouritesManager().addFavourite("material", "textures/common/caulk");
EXPECT_TRUE(signalFired);
signalFired = false; // reset
// Add the same again => shouldn't fire
GlobalFavouritesManager().addFavourite("material", "textures/common/caulk");
EXPECT_FALSE(signalFired);
// Remove non-existent => shouldn't fire
GlobalFavouritesManager().removeFavourite("material", "textures/doesntexist");
EXPECT_FALSE(signalFired);
// Add a different type => shouldn't fire
GlobalFavouritesManager().addFavourite("entitydef", "my_entity");
EXPECT_FALSE(signalFired);
GlobalFavouritesManager().removeFavourite("material", "textures/common/caulk");
EXPECT_TRUE(signalFired);
}
TEST_F(FavouritesTest, RequestingSignalForNoneType)
{
EXPECT_THROW(GlobalFavouritesManager().getSignalForType(""), std::invalid_argument);
}
}
|
