This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_test_harness.c
635 lines (550 loc) · 19.1 KB
1
/*
2
Simple DirectMedia Layer
3
Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
20
21
22
23
24
25
*/
#include "SDL_config.h"
#include "SDL_test.h"
26
27
#include <stdio.h>
#include <stdlib.h>
28
#include <string.h>
29
#include <time.h>
30
31
/* Invalid test name/description message format */
32
33
34
35
36
37
38
const char *SDLTest_InvalidNameFormat = "(Invalid)";
/* Log summary message format */
const char *SDLTest_LogSummaryFormat = "%s Summary: Total=%d Passed=%d Failed=%d Skipped=%d";
/* Final result message format */
const char *SDLTest_FinalResultFormat = ">>> %s '%s': %s\n";
39
40
41
/*! \brief Timeout for single test case execution */
static Uint32 SDLTest_TestCaseTimeout = 3600;
42
43
/**
44
45
46
47
48
49
50
51
52
* Generates a random run seed string for the harness. The generated seed
* will contain alphanumeric characters (0-9A-Z).
*
* Note: The returned string needs to be deallocated by the caller.
*
* \param length The length of the seed string to generate
*
* \returns The generated seed string
*/
53
char *
54
SDLTest_GenerateRunSeed(const int length)
55
56
57
58
59
{
char *seed = NULL;
SDLTest_RandomContext randomContext;
int counter;
60
/* Sanity check input */
61
62
63
64
65
if (length <= 0) {
SDLTest_LogError("The length of the harness seed must be >0.");
return NULL;
}
66
/* Allocate output buffer */
67
68
69
70
71
72
seed = (char *)SDL_malloc((length + 1) * sizeof(char));
if (seed == NULL) {
SDLTest_LogError("SDL_malloc for run seed output buffer failed.");
return NULL;
}
73
/* Generate a random string of alphanumeric characters */
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
SDLTest_RandomInitTime(&randomContext);
for (counter = 0; counter < length - 1; ++counter) {
unsigned int number = SDLTest_Random(&randomContext);
char ch = (char) (number % (91 - 48)) + 48;
if (ch >= 58 && ch <= 64) {
ch = 65;
}
seed[counter] = ch;
}
seed[counter] = '\0';
return seed;
}
/**
89
90
91
92
93
94
95
96
97
98
* Generates an execution key for the fuzzer.
*
* \param runSeed The run seed to use
* \param suiteName The name of the test suite
* \param testName The name of the test
* \param iteration The iteration count
*
* \returns The generated execution key to initialize the fuzzer with.
*
*/
99
Uint64
100
SDLTest_GenerateExecKey(char *runSeed, char *suiteName, char *testName, int iteration)
101
102
103
104
105
106
107
108
109
110
111
{
SDLTest_Md5Context md5Context;
Uint64 *keys;
char iterationString[16];
Uint32 runSeedLength;
Uint32 suiteNameLength;
Uint32 testNameLength;
Uint32 iterationStringLength;
Uint32 entireStringLength;
char *buffer;
112
if (runSeed == NULL || SDL_strlen(runSeed)==0) {
113
114
115
116
SDLTest_LogError("Invalid runSeed string.");
return -1;
}
117
if (suiteName == NULL || SDL_strlen(suiteName)==0) {
118
119
120
121
SDLTest_LogError("Invalid suiteName string.");
return -1;
}
122
if (testName == NULL || SDL_strlen(testName)==0) {
123
124
125
126
127
128
129
130
131
SDLTest_LogError("Invalid testName string.");
return -1;
}
if (iteration <= 0) {
SDLTest_LogError("Invalid iteration count.");
return -1;
}
132
/* Convert iteration number into a string */
133
SDL_memset(iterationString, 0, sizeof(iterationString));
134
135
SDL_snprintf(iterationString, sizeof(iterationString) - 1, "%d", iteration);
136
/* Combine the parameters into single string */
137
138
139
140
runSeedLength = SDL_strlen(runSeed);
suiteNameLength = SDL_strlen(suiteName);
testNameLength = SDL_strlen(testName);
iterationStringLength = SDL_strlen(iterationString);
141
142
143
144
145
146
147
148
entireStringLength = runSeedLength + suiteNameLength + testNameLength + iterationStringLength + 1;
buffer = (char *)SDL_malloc(entireStringLength);
if (buffer == NULL) {
SDLTest_LogError("SDL_malloc failed to allocate buffer for execKey generation.");
return 0;
}
SDL_snprintf(buffer, entireStringLength, "%s%s%s%d", runSeed, suiteName, testName, iteration);
149
/* Hash string and use half of the digest as 64bit exec key */
150
151
152
153
154
155
156
157
SDLTest_Md5Init(&md5Context);
SDLTest_Md5Update(&md5Context, (unsigned char *)buffer, entireStringLength);
SDLTest_Md5Final(&md5Context);
SDL_free(buffer);
keys = (Uint64 *)md5Context.digest;
return keys[0];
}
158
159
/**
160
161
162
163
164
165
166
167
168
* \brief Set timeout handler for test.
*
* Note: SDL_Init(SDL_INIT_TIMER) will be called if it wasn't done so before.
*
* \param timeout Timeout interval in seconds.
* \param callback Function that will be called after timeout has elapsed.
*
* \return Timer id or -1 on failure.
*/
169
SDL_TimerID
170
SDLTest_SetTestTimeout(int timeout, void (*callback)())
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
{
Uint32 timeoutInMilliseconds;
SDL_TimerID timerID;
if (callback == NULL) {
SDLTest_LogError("Timeout callback can't be NULL");
return -1;
}
if (timeout < 0) {
SDLTest_LogError("Timeout value must be bigger than zero.");
return -1;
}
/* Init SDL timer if not initialized before */
if (SDL_WasInit(SDL_INIT_TIMER) == 0) {
if (SDL_InitSubSystem(SDL_INIT_TIMER)) {
SDLTest_LogError("Failed to init timer subsystem: %s", SDL_GetError());
return -1;
}
}
/* Set timer */
timeoutInMilliseconds = timeout * 1000;
timerID = SDL_AddTimer(timeoutInMilliseconds, (SDL_TimerCallback)callback, 0x0);
if (timerID == 0) {
SDLTest_LogError("Creation of SDL timer failed: %s", SDL_GetError());
return -1;
}
return timerID;
}
203
204
205
206
/**
* \brief Timeout handler. Aborts test run and exits harness process.
*/
207
void
208
SDLTest_BailOut()
209
210
{
SDLTest_LogError("TestCaseTimeout timer expired. Aborting test run.");
211
exit(TEST_ABORTED); /* bail out from the test */
212
213
214
}
/**
215
216
217
218
219
220
221
222
* \brief Execute a test using the given execution key.
*
* \param testSuite Suite containing the test case.
* \param testCase Case to execute.
* \param execKey Execution key for the fuzzer.
*
* \returns Test case result.
*/
223
int
224
SDLTest_RunTest(SDLTest_TestSuiteReference *testSuite, SDLTest_TestCaseReference *testCase, Uint64 execKey)
225
226
{
SDL_TimerID timer = 0;
227
int testCaseResult = 0;
228
int testResult = 0;
229
int fuzzerCount;
230
231
232
233
234
235
236
237
238
if (testSuite==NULL || testCase==NULL || testSuite->name==NULL || testCase->name==NULL)
{
SDLTest_LogError("Setup failure: testSuite or testCase references NULL");
return TEST_RESULT_SETUP_FAILURE;
}
if (!testCase->enabled)
{
239
SDLTest_Log((char *)SDLTest_FinalResultFormat, "Test", testCase->name, "Skipped (Disabled)");
240
241
242
return TEST_RESULT_SKIPPED;
}
243
244
/* Initialize fuzzer */
245
246
SDLTest_FuzzerInit(execKey);
247
/* Reset assert tracker */
248
249
SDLTest_ResetAssertSummary();
250
/* Set timeout timer */
251
252
timer = SDLTest_SetTestTimeout(SDLTest_TestCaseTimeout, SDLTest_BailOut);
253
/* Maybe run suite initalizer function */
254
255
if (testSuite->testSetUp) {
testSuite->testSetUp(0x0);
256
if (SDLTest_AssertSummaryToTestResult() == TEST_RESULT_FAILED) {
257
SDLTest_LogError((char *)SDLTest_FinalResultFormat, "Suite Setup", testSuite->name, "Failed");
258
259
260
261
return TEST_RESULT_SETUP_FAILURE;
}
}
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
/* Run test case function */
testCaseResult = testCase->testCase(0x0);
/* Convert test execution result into harness result */
if (testCaseResult == TEST_SKIPPED) {
/* Test was programatically skipped */
testResult = TEST_RESULT_SKIPPED;
} else if (testCaseResult == TEST_STARTED) {
/* Test did not return a TEST_COMPLETED value; assume it failed */
testResult = TEST_RESULT_FAILED;
} else if (testCaseResult == TEST_ABORTED) {
/* Test was aborted early; assume it failed */
testResult = TEST_RESULT_FAILED;
} else {
/* Perform failure analysis based on asserts */
testResult = SDLTest_AssertSummaryToTestResult();
}
279
280
/* Maybe run suite cleanup function (ignore failed asserts) */
281
282
283
284
if (testSuite->testTearDown) {
testSuite->testTearDown(0x0);
}
285
/* Cancel timeout timer */
286
287
288
289
if (timer) {
SDL_RemoveTimer(timer);
}
290
/* Report on asserts and fuzzer usage */
291
292
293
294
fuzzerCount = SDLTest_GetFuzzerInvocationCount();
if (fuzzerCount > 0) {
SDLTest_Log("Fuzzer invocations: %d", fuzzerCount);
}
295
296
297
298
299
300
301
302
303
304
305
306
307
308
/* Final log based on test execution result */
if (testCaseResult == TEST_SKIPPED) {
/* Test was programatically skipped */
SDLTest_Log((char *)SDLTest_FinalResultFormat, "Test", testCase->name, "Skipped (Programmatically)");
} else if (testCaseResult == TEST_STARTED) {
/* Test did not return a TEST_COMPLETED value; assume it failed */
SDLTest_LogError((char *)SDLTest_FinalResultFormat, "Test", testCase->name, "Failed (test started, but did not return TEST_COMPLETED)");
} else if (testCaseResult == TEST_ABORTED) {
/* Test was aborted early; assume it failed */
SDLTest_LogError((char *)SDLTest_FinalResultFormat, "Test", testCase->name, "Failed (Aborted)");
} else {
SDLTest_LogAssertSummary();
}
309
310
return testResult;
311
312
313
314
315
316
317
318
319
320
}
/* Prints summary of all suites/tests contained in the given reference */
void SDLTest_LogTestSuiteSummary(SDLTest_TestSuiteReference *testSuites)
{
int suiteCounter;
int testCounter;
SDLTest_TestSuiteReference *testSuite;
SDLTest_TestCaseReference *testCase;
321
/* Loop over all suites */
322
323
324
325
326
suiteCounter = 0;
while(&testSuites[suiteCounter]) {
testSuite=&testSuites[suiteCounter];
suiteCounter++;
SDLTest_Log("Test Suite %i - %s\n", suiteCounter,
327
(testSuite->name) ? testSuite->name : SDLTest_InvalidNameFormat);
328
329
/* Loop over all test cases */
330
331
332
333
334
335
testCounter = 0;
while(testSuite->testCases[testCounter])
{
testCase=(SDLTest_TestCaseReference *)testSuite->testCases[testCounter];
testCounter++;
SDLTest_Log(" Test Case %i - %s: %s", testCounter,
336
337
(testCase->name) ? testCase->name : SDLTest_InvalidNameFormat,
(testCase->description) ? testCase->description : SDLTest_InvalidNameFormat);
338
339
340
341
}
}
}
342
343
344
345
346
347
/* Gets a timer value in seconds */
float GetClock()
{
float currentClock = (float)clock();
return currentClock / (float)CLOCKS_PER_SEC;
}
348
349
/**
350
351
352
353
354
355
356
357
358
359
360
361
362
* \brief Execute a test suite using the given run seend and execution key.
*
* The filter string is matched to the suite name (full comparison) to select a single suite,
* or if no suite matches, it is matched to the test names (full comparison) to select a single test.
*
* \param testSuites Suites containing the test case.
* \param userRunSeed Custom run seed provided by user, or NULL to autogenerate one.
* \param userExecKey Custom execution key provided by user, or 0 to autogenerate one.
* \param filter Filter specification. NULL disables. Case sensitive.
* \param testIterations Number of iterations to run each test case.
*
* \returns Test run result; 0 when all tests passed, 1 if any tests failed.
*/
363
int SDLTest_RunSuites(SDLTest_TestSuiteReference *testSuites[], const char *userRunSeed, Uint64 userExecKey, const char *filter, int testIterations)
364
365
366
367
368
369
{
int suiteCounter;
int testCounter;
int iterationCounter;
SDLTest_TestSuiteReference *testSuite;
SDLTest_TestCaseReference *testCase;
370
const char *runSeed = NULL;
371
372
char *currentSuiteName;
char *currentTestName;
373
Uint64 execKey;
374
375
376
377
378
379
float runStartSeconds;
float suiteStartSeconds;
float testStartSeconds;
float runEndSeconds;
float suiteEndSeconds;
float testEndSeconds;
380
float runtime;
381
382
383
384
int suiteFilter = 0;
char *suiteFilterName = NULL;
int testFilter = 0;
char *testFilterName = NULL;
385
386
387
388
389
390
391
392
393
394
int testResult = 0;
int runResult = 0;
Uint32 totalTestFailedCount = 0;
Uint32 totalTestPassedCount = 0;
Uint32 totalTestSkippedCount = 0;
Uint32 testFailedCount = 0;
Uint32 testPassedCount = 0;
Uint32 testSkippedCount = 0;
Uint32 countSum = 0;
char *logFormat = (char *)SDLTest_LogSummaryFormat;
395
396
/* Sanitize test iterations */
397
398
399
400
if (testIterations < 1) {
testIterations = 1;
}
401
/* Generate run see if we don't have one already */
402
if (userRunSeed == NULL || SDL_strlen(userRunSeed) == 0) {
403
404
runSeed = SDLTest_GenerateRunSeed(16);
if (runSeed == NULL) {
405
SDLTest_LogError("Generating a random seed failed");
406
407
return 2;
}
408
409
} else {
runSeed = userRunSeed;
410
411
}
412
413
/* Reset per-run counters */
414
415
416
totalTestFailedCount = 0;
totalTestPassedCount = 0;
totalTestSkippedCount = 0;
417
418
/* Take time - run start */
419
runStartSeconds = GetClock();
420
421
/* Log run with fuzzer parameters */
422
SDLTest_Log("::::: Test Run /w seed '%s' started\n", runSeed);
423
424
/* Initialize filtering */
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
if (filter != NULL && SDL_strlen(filter) > 0) {
/* Loop over all suites to check if we have a filter match */
suiteCounter = 0;
while (testSuites[suiteCounter] && suiteFilter == 0) {
testSuite=(SDLTest_TestSuiteReference *)testSuites[suiteCounter];
suiteCounter++;
if (testSuite->name != NULL && SDL_strcmp(filter, testSuite->name) == 0) {
/* Matched a suite name */
suiteFilter = 1;
suiteFilterName = testSuite->name;
SDLTest_Log("Filtering: running only suite '%s'", suiteFilterName);
break;
}
/* Within each suite, loop over all test cases to check if we have a filter match */
testCounter = 0;
while (testSuite->testCases[testCounter] && testFilter == 0)
{
testCase=(SDLTest_TestCaseReference *)testSuite->testCases[testCounter];
testCounter++;
if (testCase->name != NULL && SDL_strcmp(filter, testCase->name) == 0) {
/* Matched a test name */
suiteFilter = 1;
suiteFilterName = testSuite->name;
testFilter = 1;
testFilterName = testCase->name;
SDLTest_Log("Filtering: running only test '%s' in suite '%s'", testFilterName, suiteFilterName);
break;
}
}
}
if (suiteFilter == 0 && testFilter == 0) {
SDLTest_LogError("Filter '%s' did not match any test suite/case.", filter);
SDLTest_Log("Exit code: 2");
return 2;
}
}
464
/* Loop over all suites */
465
suiteCounter = 0;
466
467
468
while(testSuites[suiteCounter]) {
testSuite=(SDLTest_TestSuiteReference *)testSuites[suiteCounter];
currentSuiteName = (char *)((testSuite->name) ? testSuite->name : SDLTest_InvalidNameFormat);
469
suiteCounter++;
470
471
/* Filter suite if flag set and we have a name */
472
473
if (suiteFilter == 1 && suiteFilterName != NULL && testSuite->name != NULL &&
SDL_strcmp(suiteFilterName, testSuite->name) != 0) {
474
/* Skip suite */
475
476
477
478
479
SDLTest_Log("===== Test Suite %i: '%s' skipped\n",
suiteCounter,
currentSuiteName);
} else {
480
/* Reset per-suite counters */
481
482
483
484
testFailedCount = 0;
testPassedCount = 0;
testSkippedCount = 0;
485
/* Take time - suite start */
486
487
suiteStartSeconds = GetClock();
488
/* Log suite started */
489
490
491
492
SDLTest_Log("===== Test Suite %i: '%s' started\n",
suiteCounter,
currentSuiteName);
493
/* Loop over all test cases */
494
495
testCounter = 0;
while(testSuite->testCases[testCounter])
496
{
497
498
499
500
testCase=(SDLTest_TestCaseReference *)testSuite->testCases[testCounter];
currentTestName = (char *)((testCase->name) ? testCase->name : SDLTest_InvalidNameFormat);
testCounter++;
501
/* Filter tests if flag set and we have a name */
502
503
if (testFilter == 1 && testFilterName != NULL && testCase->name != NULL &&
SDL_strcmp(testFilterName, testCase->name) != 0) {
504
/* Skip test */
505
506
507
508
SDLTest_Log("===== Test Case %i.%i: '%s' skipped\n",
suiteCounter,
testCounter,
currentTestName);
509
} else {
510
/* Override 'disabled' flag if we specified a test filter (i.e. force run for debugging) */
511
512
513
514
if (testFilter == 1 && !testCase->enabled) {
SDLTest_Log("Force run of disabled test since test filter was set");
testCase->enabled = 1;
}
515
516
/* Take time - test start */
517
518
testStartSeconds = GetClock();
519
/* Log test started */
520
521
522
523
SDLTest_Log("----- Test Case %i.%i: '%s' started",
suiteCounter,
testCounter,
currentTestName);
524
if (testCase->description != NULL && SDL_strlen(testCase->description)>0) {
525
526
527
528
SDLTest_Log("Test Description: '%s'",
(testCase->description) ? testCase->description : SDLTest_InvalidNameFormat);
}
529
/* Loop over all iterations */
530
531
532
533
534
535
536
537
iterationCounter = 0;
while(iterationCounter < testIterations)
{
iterationCounter++;
if (userExecKey != 0) {
execKey = userExecKey;
} else {
538
execKey = SDLTest_GenerateExecKey((char *)runSeed, testSuite->name, testCase->name, iterationCounter);
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
}
SDLTest_Log("Test Iteration %i: execKey %llu", iterationCounter, execKey);
testResult = SDLTest_RunTest(testSuite, testCase, execKey);
if (testResult == TEST_RESULT_PASSED) {
testPassedCount++;
totalTestPassedCount++;
} else if (testResult == TEST_RESULT_SKIPPED) {
testSkippedCount++;
totalTestSkippedCount++;
} else {
testFailedCount++;
totalTestFailedCount++;
}
}
556
/* Take time - test end */
557
558
559
560
561
testEndSeconds = GetClock();
runtime = testEndSeconds - testStartSeconds;
if (runtime < 0.0f) runtime = 0.0f;
if (testIterations > 1) {
562
/* Log test runtime */
563
564
565
SDLTest_Log("Runtime of %i iterations: %.1f sec", testIterations, runtime);
SDLTest_Log("Average Test runtime: %.5f sec", runtime / (float)testIterations);
} else {
566
/* Log test runtime */
567
568
569
SDLTest_Log("Total Test runtime: %.1f sec", runtime);
}
570
/* Log final test result */
571
572
573
574
575
576
577
578
579
580
581
switch (testResult) {
case TEST_RESULT_PASSED:
SDLTest_Log((char *)SDLTest_FinalResultFormat, "Test", currentTestName, "Passed");
break;
case TEST_RESULT_FAILED:
SDLTest_LogError((char *)SDLTest_FinalResultFormat, "Test", currentTestName, "Failed");
break;
case TEST_RESULT_NO_ASSERT:
SDLTest_LogError((char *)SDLTest_FinalResultFormat,"Test", currentTestName, "No Asserts");
break;
}
582
583
584
585
}
}
586
/* Take time - suite end */
587
588
suiteEndSeconds = GetClock();
runtime = suiteEndSeconds - suiteStartSeconds;
589
if (runtime < 0.0f) runtime = 0.0f;
590
591
/* Log suite runtime */
592
SDLTest_Log("Total Suite runtime: %.1f sec", runtime);
593
594
/* Log summary and final Suite result */
595
596
597
598
599
600
601
602
603
604
605
countSum = testPassedCount + testFailedCount + testSkippedCount;
if (testFailedCount == 0)
{
SDLTest_Log(logFormat, "Suite", countSum, testPassedCount, testFailedCount, testSkippedCount);
SDLTest_Log((char *)SDLTest_FinalResultFormat, "Suite", currentSuiteName, "Passed");
}
else
{
SDLTest_LogError(logFormat, "Suite", countSum, testPassedCount, testFailedCount, testSkippedCount);
SDLTest_LogError((char *)SDLTest_FinalResultFormat, "Suite", currentSuiteName, "Failed");
}
606
607
}
608
609
}
610
/* Take time - run end */
611
runEndSeconds = GetClock();
612
613
runtime = runEndSeconds - runStartSeconds;
if (runtime < 0.0f) runtime = 0.0f;
614
615
/* Log total runtime */
616
SDLTest_Log("Total Run runtime: %.1f sec", runtime);
617
618
/* Log summary and final run result */
619
countSum = totalTestPassedCount + totalTestFailedCount + totalTestSkippedCount;
620
if (totalTestFailedCount == 0)
621
622
623
{
runResult = 0;
SDLTest_Log(logFormat, "Run", countSum, totalTestPassedCount, totalTestFailedCount, totalTestSkippedCount);
624
SDLTest_Log((char *)SDLTest_FinalResultFormat, "Run /w seed", runSeed, "Passed");
625
626
627
628
629
}
else
{
runResult = 1;
SDLTest_LogError(logFormat, "Run", countSum, totalTestPassedCount, totalTestFailedCount, totalTestSkippedCount);
630
SDLTest_LogError((char *)SDLTest_FinalResultFormat, "Run /w seed", runSeed, "Failed");
631
}
632
633
SDLTest_Log("Exit code: %d", runResult);
634
return runResult;
635
}