first

1 files changed, 348 insertions, 0 deletions

diff --git a/test/MrsWatsonTestMain.c b/test/MrsWatsonTestMain.c
new file mode 100644
index 0000000..980cbfd
--- /dev/null
+++ b/test/MrsWatsonTestMain.c
@@ -0,0 +1,348 @@
+//
+//  MrsWatsonTestMain.c
+//  MrsWatson
+//
+//  Created by Nik Reiman on 8/9/12.
+//  Copyright (c) 2012 Teragon Audio. All rights reserved.
+//
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <time.h>
+
+#include "app/ProgramOption.h"
+#include "base/File.h"
+#include "base/PlatformInfo.h"
+#include "unit/ApplicationRunner.h"
+
+#include "MrsWatsonTestMain.h"
+
+extern LinkedList getTestSuites(void);
+extern TestSuite findTestSuite(LinkedList testSuites, const CharString testSuiteName);
+extern TestCase findTestCase(TestSuite testSuite, char *testName);
+extern void printUnitTestSuites(void);
+extern TestSuite runUnitTests(LinkedList testSuites, boolByte onlyPrintFailing);
+extern TestSuite runIntegrationTests(TestEnvironment testEnvironment);
+
+static const char *DEFAULT_TEST_SUITE_NAME = "all";
+
+#if UNIX
+static const char *MRSWATSON_EXE_NAME = "mrswatson";
+#elif WINDOWS
+static const char *MRSWATSON_EXE_NAME = "mrswatson.exe";
+#else
+static const char *MRSWATSON_EXE_NAME = "mrswatson";
+#endif
+
+static ProgramOptions _newTestProgramOptions(void)
+{
+    ProgramOptions programOptions = newProgramOptions(NUM_TEST_OPTIONS);
+    srand((unsigned int)time(NULL));
+
+    programOptionsAdd(programOptions, newProgramOptionWithName(OPTION_TEST_SUITE, "suite",
+                      "Choose a test suite to run. Current suites include:\n\
+\t- Integration: run audio quality tests against actual executable\n\
+\t- Unit: run all internal unit tests\n\
+\t- All: run all tests (default)\n\
+\t- A suite name (use '--list' to see all suite names)",
+                      true, kProgramOptionTypeString, kProgramOptionArgumentTypeRequired));
+    programOptionsSetCString(programOptions, OPTION_TEST_SUITE, DEFAULT_TEST_SUITE_NAME);
+
+    programOptionsAdd(programOptions, newProgramOptionWithName(OPTION_TEST_NAME, "test",
+                      "Run a single test. Tests are named 'Suite:Name', for example:\n\
+\t-t 'LinkedList:AppendItem'",
+                      true, kProgramOptionTypeString, kProgramOptionArgumentTypeRequired));
+
+    programOptionsAdd(programOptions, newProgramOptionWithName(OPTION_TEST_PRINT_TESTS, "list-tests",
+                      "List all unit tests in the same format required by --test",
+                      true, kProgramOptionTypeEmpty, kProgramOptionArgumentTypeNone));
+
+    programOptionsAdd(programOptions, newProgramOptionWithName(OPTION_TEST_MRSWATSON_PATH, "mrswatson-path",
+                      "Path to mrswatson executable. By default, mrswatson is assumed to be in the same \
+directory as mrswatsontest. Only required for running integration tests.",
+                      true, kProgramOptionTypeString, kProgramOptionArgumentTypeRequired));
+
+    programOptionsAdd(programOptions, newProgramOptionWithName(OPTION_TEST_RESOURCES_PATH, "resources",
+                      "Path to resources directory. Only required for running integration tests.",
+                      true, kProgramOptionTypeString, kProgramOptionArgumentTypeRequired));
+
+    programOptionsAdd(programOptions, newProgramOptionWithName(OPTION_TEST_PRINT_ONLY_FAILING, "quiet",
+                      "Print only failing tests. Note that if a test causes the suite to crash, the \
+bad test's name will not be printed. In this case, re-run without this option, as \
+the test names will be printed before the tests are executed.",
+                      true, kProgramOptionTypeEmpty, kProgramOptionArgumentTypeNone));
+
+    programOptionsAdd(programOptions, newProgramOptionWithName(OPTION_TEST_KEEP_FILES, "keep-files",
+                      "Keep files generated by integration tests (such as log files, audio output, \
+etc.). Normally these files are automatically removed if a test succeeds.",
+                      true, kProgramOptionTypeEmpty, kProgramOptionArgumentTypeNone));
+
+    programOptionsAdd(programOptions, newProgramOptionWithName(OPTION_TEST_HELP, "help",
+                      "Print full program help (this screen), or just the help for a single argument.",
+                      true, kProgramOptionTypeString, kProgramOptionArgumentTypeOptional));
+
+    programOptionsAdd(programOptions, newProgramOptionWithName(OPTION_TEST_VERBOSE, "verbose",
+                      "Show logging output from tests",
+                      true, kProgramOptionTypeEmpty, kProgramOptionArgumentTypeNone));
+
+    return programOptions;
+}
+
+void _printTestSummary(int testsRun, int testsPassed, int testsFailed, int testsSkipped)
+{
+    CharString numberBuffer = newCharStringWithCapacity(kCharStringLengthShort);
+
+    printToLog(getLogColor(kTestLogEventReset), NULL, "Ran ");
+    sprintf(numberBuffer->data, "%d", testsRun);
+    printToLog(getLogColor(kTestLogEventSection), NULL, numberBuffer->data);
+    printToLog(getLogColor(kTestLogEventReset), NULL, " tests: ");
+    sprintf(numberBuffer->data, "%d", testsPassed);
+    printToLog(getLogColor(kTestLogEventPass), NULL, numberBuffer->data);
+    printToLog(getLogColor(kTestLogEventReset), NULL, " passed, ");
+
+    sprintf(numberBuffer->data, "%d", testsFailed);
+
+    if (testsFailed > 0) {
+        printToLog(getLogColor(kTestLogEventFail), NULL, numberBuffer->data);
+    } else {
+        printToLog(getLogColor(kTestLogEventReset), NULL, numberBuffer->data);
+    }
+
+    printToLog(getLogColor(kTestLogEventReset), NULL, " failed, ");
+
+    sprintf(numberBuffer->data, "%d", testsSkipped);
+
+    if (testsSkipped > 0) {
+        printToLog(getLogColor(kTestLogEventSkip), NULL, numberBuffer->data);
+    } else {
+        printToLog(getLogColor(kTestLogEventReset), NULL, numberBuffer->data);
+    }
+
+    printToLog(getLogColor(kTestLogEventReset), NULL, " skipped");
+    flushLog(NULL);
+
+    freeCharString(numberBuffer);
+}
+
+File _findMrsWatsonExe(CharString mrsWatsonExeArg)
+{
+    CharString currentExecutableFilename = NULL;
+    CharString mrsWatsonExeName = NULL;
+    File currentExecutablePath = NULL;
+    File currentExecutableDir = NULL;
+    File mrsWatsonExe = NULL;
+
+    if (mrsWatsonExeArg != NULL && !charStringIsEmpty(mrsWatsonExeArg)) {
+        mrsWatsonExe = newFileWithPath(mrsWatsonExeArg);
+    } else {
+        currentExecutableFilename = fileGetExecutablePath();
+        currentExecutablePath = newFileWithPath(currentExecutableFilename);
+
+        if (currentExecutablePath != NULL) {
+            currentExecutableDir = fileGetParent(currentExecutablePath);
+
+            if (currentExecutableDir != NULL) {
+                mrsWatsonExeName = newCharStringWithCString(MRSWATSON_EXE_NAME);
+
+                if (platformInfoIsRuntime64Bit()) {
+                    charStringAppendCString(mrsWatsonExeName, "64");
+                }
+
+                mrsWatsonExe = newFileWithParent(currentExecutableDir, mrsWatsonExeName);
+            }
+        }
+    }
+
+    freeCharString(currentExecutableFilename);
+    freeCharString(mrsWatsonExeName);
+    freeFile(currentExecutablePath);
+    freeFile(currentExecutableDir);
+    return mrsWatsonExe;
+}
+
+int main(int argc, char *argv[])
+{
+    ProgramOptions programOptions;
+    int totalTestsRun = 0;
+    int totalTestsPassed = 0;
+    int totalTestsFailed = 0;
+    int totalTestsSkipped = 0;
+    CharString testSuiteToRun = NULL;
+    CharString testSuiteName = NULL;
+    CharString mrsWatsonExeName = NULL;
+    CharString totalTimeString = NULL;
+    CharString executablePath = NULL;
+    File mrsWatsonExe = NULL;
+    File resourcesPath = NULL;
+    boolByte shouldRunUnitTests = false;
+    boolByte shouldRunIntegrationTests = false;
+    TestCase testCase = NULL;
+    TestSuite testSuite = NULL;
+    LinkedList testSuites = NULL;
+    TestSuite unitTestResults = NULL;
+    TestEnvironment testEnvironment = NULL;
+    TaskTimer timer;
+    char *testArgument;
+    char *colon;
+    char *testCaseName;
+
+    timer = newTaskTimer(NULL, NULL);
+    taskTimerStart(timer);
+
+    programOptions = _newTestProgramOptions();
+
+    if (!programOptionsParseArgs(programOptions, argc, argv)) {
+        printf("Or run with --help (option) to see help for a single option\n");
+        return -1;
+    }
+
+    if (programOptions->options[OPTION_TEST_HELP]->enabled) {
+        printf("Run with '--help full' to see extended help for all options.\n");
+
+        if (charStringIsEmpty(programOptionsGetString(programOptions, OPTION_TEST_HELP))) {
+            printf("All options, where <argument> is required and [argument] is optional\n");
+            programOptionsPrintHelp(programOptions, false, DEFAULT_INDENT_SIZE);
+        } else {
+            programOptionsPrintHelp(programOptions, true, DEFAULT_INDENT_SIZE);
+        }
+
+        return -1;
+    } else if (programOptions->options[OPTION_TEST_PRINT_TESTS]->enabled) {
+        printUnitTestSuites();
+        return -1;
+    }
+
+    if (programOptions->options[OPTION_TEST_VERBOSE]->enabled) {
+        initEventLogger();
+        setLogLevel(LOG_DEBUG);
+    }
+
+    testSuiteToRun = programOptionsGetString(programOptions, OPTION_TEST_SUITE);
+
+    if (programOptions->options[OPTION_TEST_NAME]->enabled) {
+        shouldRunUnitTests = false;
+        shouldRunIntegrationTests = false;
+
+        testArgument = programOptionsGetString(programOptions, OPTION_TEST_NAME)->data;
+        colon = strchr(testArgument, ':');
+
+        if (colon == NULL) {
+            printf("ERROR: Invalid test name");
+            programOptionPrintHelp(programOptions->options[OPTION_TEST_NAME], true, DEFAULT_INDENT_SIZE, 0);
+            return -1;
+        }
+
+        testCaseName = strdup(colon + 1);
+        *colon = '\0';
+
+        testSuiteName = programOptionsGetString(programOptions, OPTION_TEST_NAME);
+        testSuites = getTestSuites();
+        testSuite = findTestSuite(testSuites, testSuiteName);
+
+        if (testSuite == NULL) {
+            printf("ERROR: Could not find test suite '%s'\n", testSuiteName->data);
+            freeLinkedListAndItems(testSuites, (LinkedListFreeItemFunc)freeTestSuite);
+            return -1;
+        }
+
+        testCase = findTestCase(testSuite, testCaseName);
+
+        if (testCase == NULL) {
+            printf("ERROR: Could not find test case '%s'\n", testCaseName);
+            freeLinkedListAndItems(testSuites, (LinkedListFreeItemFunc)freeTestSuite);
+            return -1;
+        } else {
+            printf("Running test in %s:\n", testSuite->name);
+            runTestCase(testCase, testSuite);
+            freeLinkedListAndItems(testSuites, (LinkedListFreeItemFunc)freeTestSuite);
+        }
+    } else if (charStringIsEqualToCString(testSuiteToRun, "all", true)) {
+        shouldRunUnitTests = true;
+        shouldRunIntegrationTests = true;
+    } else if (charStringIsEqualToCString(testSuiteToRun, "unit", true)) {
+        shouldRunUnitTests = true;
+    } else if (charStringIsEqualToCString(testSuiteToRun, "integration", true)) {
+        shouldRunIntegrationTests = true;
+    } else {
+        testSuites = getTestSuites();
+        testSuite = findTestSuite(testSuites, testSuiteToRun);
+
+        if (testSuite == NULL) {
+            printf("ERROR: Invalid test suite '%s'\n", testSuiteToRun->data);
+            printf("Run with '--list' suite to show possible test suites\n");
+            freeLinkedListAndItems(testSuites, (LinkedListFreeItemFunc)freeTestSuite);
+            return -1;
+        } else {
+            testSuite->onlyPrintFailing = programOptions->options[OPTION_TEST_PRINT_ONLY_FAILING]->enabled;
+            runTestSuite(testSuite, NULL);
+            totalTestsRun = testSuite->numSuccess + testSuite->numFail;
+            totalTestsPassed = testSuite->numSuccess;
+            totalTestsFailed = testSuite->numFail;
+            totalTestsSkipped = testSuite->numSkips;
+            freeLinkedListAndItems(testSuites, (LinkedListFreeItemFunc)freeTestSuite);
+        }
+    }
+
+    if (shouldRunUnitTests) {
+        printf("=== Unit tests ===\n");
+        testSuites = getTestSuites();
+        unitTestResults = runUnitTests(testSuites,
+                                       programOptions->options[OPTION_TEST_PRINT_ONLY_FAILING]->enabled);
+
+        totalTestsRun += unitTestResults->numSuccess + unitTestResults->numFail;
+        totalTestsPassed += unitTestResults->numSuccess;
+        totalTestsFailed += unitTestResults->numFail;
+        totalTestsSkipped += unitTestResults->numSkips;
+
+        freeLinkedListAndItems(testSuites, (LinkedListFreeItemFunc)freeTestSuite);
+        freeTestSuite(unitTestResults);
+    }
+
+    mrsWatsonExe = _findMrsWatsonExe(programOptionsGetString(programOptions, OPTION_TEST_MRSWATSON_PATH));
+
+    if (shouldRunIntegrationTests && mrsWatsonExe == NULL) {
+        printf("Could not find mrswatson, skipping integration tests\n");
+        shouldRunIntegrationTests = false;
+    }
+
+    if (programOptions->options[OPTION_TEST_RESOURCES_PATH]->enabled) {
+        resourcesPath = newFileWithPath(programOptionsGetString(programOptions, OPTION_TEST_RESOURCES_PATH));
+    }
+
+    if (shouldRunIntegrationTests && !fileExists(resourcesPath)) {
+        printf("Could not find test resources, skipping integration tests\n");
+        shouldRunIntegrationTests = false;
+    }
+
+    if (shouldRunIntegrationTests) {
+        printf("\n=== Integration tests ===\n");
+        testEnvironment = newTestEnvironment(mrsWatsonExe->absolutePath->data, resourcesPath->absolutePath->data);
+        testEnvironment->results->onlyPrintFailing = programOptions->options[OPTION_TEST_PRINT_ONLY_FAILING]->enabled;
+        testEnvironment->results->keepFiles = programOptions->options[OPTION_TEST_KEEP_FILES]->enabled;
+        runIntegrationTests(testEnvironment);
+        totalTestsRun += testEnvironment->results->numSuccess + testEnvironment->results->numFail;
+        totalTestsPassed += testEnvironment->results->numSuccess;
+        totalTestsFailed += testEnvironment->results->numFail;
+        totalTestsSkipped += testEnvironment->results->numSkips;
+    }
+
+    taskTimerStop(timer);
+
+    if (totalTestsRun > 0) {
+        printf("\n=== Finished ===\n");
+        _printTestSummary(totalTestsRun, totalTestsPassed, totalTestsFailed, totalTestsSkipped);
+        totalTimeString = taskTimerHumanReadbleString(timer);
+        printf("Total time: %s\n", totalTimeString->data);
+    }
+
+    freeTestEnvironment(testEnvironment);
+    freeProgramOptions(programOptions);
+    freeCharString(executablePath);
+    freeCharString(mrsWatsonExeName);
+    freeCharString(totalTimeString);
+    freeFile(mrsWatsonExe);
+    freeFile(resourcesPath);
+    freeTaskTimer(timer);
+    return totalTestsFailed;
+}