wiesel / tests / common / modules.cpp

  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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
/**
 * Copyright (C) 2012
 * Christian Fischer
 *
 * https://bitbucket.org/baldur/wiesel/
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
 * Public License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301 USA
 */
#include "gtest/gtest.h"

#include <wiesel/modules.h>


using namespace wiesel;



class ITestModule : public Module
{
public:
	ITestModule() {
		return;
	}

	virtual ~ITestModule() {
		return;
	}

public:
	virtual int getTestValue() = 0;
};




class TestMod17 : public ITestModule
{
public:
	TestMod17() {
		return;
	}

	static TestMod17* create() {
		return new TestMod17();
	}

	virtual ~TestMod17() {
		return;
	}

	virtual int getTestValue() {
		return 17;
	}
};


class TestMod23 : public ITestModule
{
public:
	TestMod23() {
		return;
	}

	static TestMod23* create() {
		return new TestMod23();
	}

	virtual ~TestMod23() {
		return;
	}

	virtual int getTestValue() {
		return 23;
	}
};


class TestMod42 : public ITestModule
{
public:
	TestMod42() {
		return;
	}

	static TestMod42* create() {
		return new TestMod42();
	}

	virtual ~TestMod42() {
		return;
	}

	virtual int getTestValue() {
		return 42;
	}
};




class ITrackingModule : public Module
{
};


class TrackingModuleImpl : public ITrackingModule
{
public:
	static TrackingModuleImpl *create() {
		return new TrackingModuleImpl();
	}

	TrackingModuleImpl() {
		++construction_count;
	}

	virtual ~TrackingModuleImpl() {
		++destruction_count;
	}

public:
	static int construction_count;
	static int destruction_count;
};

int TrackingModuleImpl::construction_count	= 0;
int TrackingModuleImpl::destruction_count	= 0;





/**
 * Test if the module loaders work.
 */
TEST(ModuleApi, ModuleLoaders) {
	// for shorter code...
	typedef std::vector<ModuleLoader<ITestModule>*> TestModList;

	// there shouldn't be any module in the registry
	TestModList list1 = ModuleRegistry::getInstance()->findModules<ITestModule>();
	ASSERT_TRUE(list1.empty());

	// create a new scope
	{
		// register the module within this scope, so it should be gone when leaving the scope
		REGISTER_MODULE(ITestModule, TestMod17, &TestMod17::create, "TestMod", 0x01000000u, IModuleLoader::PriorityNormal);

		// now we should have exactly one module registered
		TestModList list2 = ModuleRegistry::getInstance()->findModules<ITestModule>();
		ASSERT_EQ(1u, list2.size());

		// get the module loader
		ModuleLoader<ITestModule> *test_loader = list2[0];

		// get the module
		ITestModule *testmod1 = test_loader->create();
		ASSERT_TRUE(NULL != testmod1);

		// compare the result of the module
		ASSERT_EQ(17, testmod1->getTestValue());
	}

	// after we left the scope, the registry should be empty
	TestModList list3 = ModuleRegistry::getInstance()->findModules<ITestModule>();
	ASSERT_TRUE(list3.empty());

	return;
}


TEST(ModuleApi, ModuleConstruction) {
	// for shorter code...
	typedef std::vector<ModuleLoader<ITrackingModule>*> TrackingModList;

	// reset vars
	TrackingModuleImpl::construction_count	= 0;
	TrackingModuleImpl::destruction_count	= 0;

	ITrackingModule *module1 = NULL;
	ITrackingModule *module2 = NULL;

	// create a new scope
	{
		// register the module within this scope, so it should be gone when leaving the scope
		REGISTER_MODULE(ITrackingModule, TrackingModuleImpl, &TrackingModuleImpl::create, "TrackingModule", 0x01000000u, IModuleLoader::PriorityNormal);

		// no module should be created at this moment
		ASSERT_EQ(0, TrackingModuleImpl::construction_count);
		ASSERT_EQ(0, TrackingModuleImpl::destruction_count);

		// get the module loader
		TrackingModList list = ModuleRegistry::getInstance()->findModules<ITrackingModule>();
		ASSERT_EQ(1u, list.size());

		// there should still no module instance
		ASSERT_EQ(0, TrackingModuleImpl::construction_count);
		ASSERT_EQ(0, TrackingModuleImpl::destruction_count);

		// now create the first module...
		module1 = list[0]->create();
		module1->retain();

		// one creation, but no destruction.
		ASSERT_EQ(1, TrackingModuleImpl::construction_count);
		ASSERT_EQ(0, TrackingModuleImpl::destruction_count);

		// create the second module
		module2 = list[0]->create();
		module2->retain();

		// two creations, but still no destruction
		ASSERT_EQ(2, TrackingModuleImpl::construction_count);
		ASSERT_EQ(0, TrackingModuleImpl::destruction_count);

		// release the first module
		module1->release();
		module1 = NULL;

		// the first one should be destructed, but the first one should be still alive.
		ASSERT_EQ(2, TrackingModuleImpl::construction_count);
		ASSERT_EQ(1, TrackingModuleImpl::destruction_count);
	}

	// we left scope. the module loader should be destroyed
	ASSERT_TRUE(ModuleRegistry::getInstance()->findModules<ITrackingModule>().empty());

	// ... but the second module itself should still be alive.
	ASSERT_EQ(2, TrackingModuleImpl::construction_count);
	ASSERT_EQ(1, TrackingModuleImpl::destruction_count);

	// now release the second module
	module2->release();
	module2 = NULL;

	// ... and check, if it's really gone
	ASSERT_EQ(2, TrackingModuleImpl::construction_count);
	ASSERT_EQ(2, TrackingModuleImpl::destruction_count);

	return;
}


TEST(ModuleApi, ModuleConstructionSingleton) {
	// for shorter code...
	typedef std::vector<ModuleLoader<ITrackingModule>*> TrackingModList;

	// reset vars
	TrackingModuleImpl::construction_count	= 0;
	TrackingModuleImpl::destruction_count	= 0;

	ITrackingModule *module1 = NULL;
	ITrackingModule *module2 = NULL;

	// create a new scope
	{
		// register the module within this scope, so it should be gone when leaving the scope
		REGISTER_MODULE_SINGLETON(ITrackingModule, TrackingModuleImpl, &TrackingModuleImpl::create, "TrackingModule", 0x01000000u, IModuleLoader::PriorityNormal);

		// no module should be created at this moment
		ASSERT_EQ(0, TrackingModuleImpl::construction_count);
		ASSERT_EQ(0, TrackingModuleImpl::destruction_count);

		// get the module loader
		TrackingModList list = ModuleRegistry::getInstance()->findModules<ITrackingModule>();
		ASSERT_EQ(1u, list.size());

		// there should still no module instance
		ASSERT_EQ(0, TrackingModuleImpl::construction_count);
		ASSERT_EQ(0, TrackingModuleImpl::destruction_count);

		// now create the first module...
		module1 = list[0]->create();
		module1->retain();

		// one creation, but no destruction.
		ASSERT_EQ(1, TrackingModuleImpl::construction_count);
		ASSERT_EQ(0, TrackingModuleImpl::destruction_count);

		// the reference count of our module should be 2 (module1 + singleton reference)
		ASSERT_EQ(2, module1->getReferenceCount());

		// create the second module
		module2 = list[0]->create();
		module2->retain();

		// we should got the same object
		ASSERT_EQ(module1, module2);

		// since the module is registered as singleton, there should still be only one instance
		ASSERT_EQ(1, TrackingModuleImpl::construction_count);
		ASSERT_EQ(0, TrackingModuleImpl::destruction_count);

		// the reference count of our module should be 3 (module1, module2, singleton reference)
		ASSERT_EQ(3, module1->getReferenceCount());
		ASSERT_EQ(3, module2->getReferenceCount());

		// release the first module
		module1->release();
		module1 = NULL;

		// there should still be only one valid object, it should not be released
		ASSERT_EQ(1, TrackingModuleImpl::construction_count);
		ASSERT_EQ(0, TrackingModuleImpl::destruction_count);

		// ... but the ref count should have been decreased
		ASSERT_EQ(2, module2->getReferenceCount());
	}

	// we left scope. the module loader should be destroyed
	ASSERT_TRUE(ModuleRegistry::getInstance()->findModules<ITrackingModule>().empty());

	// ... but the module itself should still be alive.
	ASSERT_EQ(1, TrackingModuleImpl::construction_count);
	ASSERT_EQ(0, TrackingModuleImpl::destruction_count);

	// ... and only one reference left
	ASSERT_EQ(1, module2->getReferenceCount());

	// now release the second module
	module2->release();
	module2 = NULL;

	// ... and check, if it's really gone
	ASSERT_EQ(1, TrackingModuleImpl::construction_count);
	ASSERT_EQ(1, TrackingModuleImpl::destruction_count);

	return;
}


/**
 * Test if modules are sorted correctly by their API version.
 */
TEST(ModuleApi, ApiVersionOrder) {
	// for shorter code...
	typedef std::vector<ModuleLoader<ITestModule>*> TestModList;

	// there shouldn't be any module in the registry
	TestModList list1 = ModuleRegistry::getInstance()->findModules<ITestModule>();
	ASSERT_TRUE(list1.empty());

	// create a new scope
	{
		// register the module within this scope, so it should be gone when leaving the scope
		REGISTER_MODULE(ITestModule, TestMod17, &TestMod17::create, "TestMod", 0x01001700u, IModuleLoader::PriorityNormal);
		REGISTER_MODULE(ITestModule, TestMod42, &TestMod42::create, "TestMod", 0x01004200u, IModuleLoader::PriorityNormal);
		REGISTER_MODULE(ITestModule, TestMod23, &TestMod23::create, "TestMod", 0x01002300u, IModuleLoader::PriorityNormal);

		// now we should have exactly one module registered
		TestModList list2 = ModuleRegistry::getInstance()->findModules<ITestModule>();
		ASSERT_EQ(3u, list2.size());

		// get the moduiles
		ITestModule *testmod1 = list2[0]->create();
		ITestModule *testmod2 = list2[1]->create();
		ITestModule *testmod3 = list2[2]->create();

		// check if all modules were created
		ASSERT_TRUE(NULL != testmod1);
		ASSERT_TRUE(NULL != testmod2);
		ASSERT_TRUE(NULL != testmod3);

		// compare the result of the module
		EXPECT_EQ(42, testmod1->getTestValue());
		EXPECT_EQ(23, testmod2->getTestValue());
		EXPECT_EQ(17, testmod3->getTestValue());
	}

	// after we left the scope, the registry should be empty
	TestModList list3 = ModuleRegistry::getInstance()->findModules<ITestModule>();
	ASSERT_TRUE(list3.empty());

	return;
}


/**
 * Test if modules are sorted correctly by their priority.
 * The API version should be ignored, because their API names are different.
 */
TEST(ModuleApi, PriorityOrder) {
	// for shorter code...
	typedef std::vector<ModuleLoader<ITestModule>*> TestModList;

	// there shouldn't be any module in the registry
	TestModList list1 = ModuleRegistry::getInstance()->findModules<ITestModule>();
	ASSERT_TRUE(list1.empty());

	// create a new scope
	{
		// register the module within this scope, so it should be gone when leaving the scope
		REGISTER_MODULE(ITestModule, TestMod23, &TestMod23::create, "TestMod3", 0x01002300u, IModuleLoader::PriorityNormal);
		REGISTER_MODULE(ITestModule, TestMod42, &TestMod42::create, "TestMod2", 0x01004200u, IModuleLoader::PriorityLow);
		REGISTER_MODULE(ITestModule, TestMod17, &TestMod17::create, "TestMod1", 0x01001700u, IModuleLoader::PriorityHigh);

		// now we should have exactly one module registered
		TestModList list2 = ModuleRegistry::getInstance()->findModules<ITestModule>();
		ASSERT_EQ(3u, list2.size());

		// get the moduiles
		ITestModule *testmod1 = list2[0]->create();
		ITestModule *testmod2 = list2[1]->create();
		ITestModule *testmod3 = list2[2]->create();

		// check if all modules were created
		ASSERT_TRUE(NULL != testmod1);
		ASSERT_TRUE(NULL != testmod2);
		ASSERT_TRUE(NULL != testmod3);

		// compare the result of the module
		EXPECT_EQ(17, testmod1->getTestValue());
		EXPECT_EQ(23, testmod2->getTestValue());
		EXPECT_EQ(42, testmod3->getTestValue());
	}

	// after we left the scope, the registry should be empty
	TestModList list3 = ModuleRegistry::getInstance()->findModules<ITestModule>();
	ASSERT_TRUE(list3.empty());

	return;
}


/**
 * Test if modules are sorted correctly, when using both api version and priority.
 */
TEST(ModuleApi, CombinedOrder) {
	// for shorter code...
	typedef std::vector<ModuleLoader<ITestModule>*> TestModList;

	// there shouldn't be any module in the registry
	TestModList list1 = ModuleRegistry::getInstance()->findModules<ITestModule>();
	ASSERT_TRUE(list1.empty());

	// create a new scope
	{
		// register the module within this scope, so it should be gone when leaving the scope
		REGISTER_MODULE(ITestModule, TestMod23, &TestMod23::create, "TestMod", 0x01002300u, IModuleLoader::PriorityNormal);
		REGISTER_MODULE(ITestModule, TestMod42, &TestMod42::create, "TestMod", 0x01004200u, IModuleLoader::PriorityNormal);
		REGISTER_MODULE(ITestModule, TestMod17, &TestMod17::create, "TestMod", 0x01001700u, IModuleLoader::PriorityHigh);

		// now we should have exactly one module registered
		TestModList list2 = ModuleRegistry::getInstance()->findModules<ITestModule>();
		ASSERT_EQ(3u, list2.size());

		// get the moduiles
		ITestModule *testmod1 = list2[0]->create();
		ITestModule *testmod2 = list2[1]->create();
		ITestModule *testmod3 = list2[2]->create();

		// check if all modules were created
		ASSERT_TRUE(NULL != testmod1);
		ASSERT_TRUE(NULL != testmod2);
		ASSERT_TRUE(NULL != testmod3);

		// compare the result of the module
		EXPECT_EQ(17, testmod1->getTestValue());
		EXPECT_EQ(42, testmod2->getTestValue());
		EXPECT_EQ(23, testmod3->getTestValue());
	}

	// after we left the scope, the registry should be empty
	TestModList list3 = ModuleRegistry::getInstance()->findModules<ITestModule>();
	ASSERT_TRUE(list3.empty());

	return;
}
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.