#pragma region Copyright (c) 2014-2016 OpenRCT2 Developers /***************************************************************************** * OpenRCT2, an open source clone of Roller Coaster Tycoon 2. * * OpenRCT2 is the work of many authors, a full list can be found in contributors.md * For more information, visit https://github.com/OpenRCT2/OpenRCT2 * * OpenRCT2 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. * * A full copy of the GNU General Public License can be found in licence.txt *****************************************************************************/ #pragma endregion #include #include #include #if defined(__unix__) #include #include #endif // defined(__unix__) #include "PaintIntercept.hpp" #include "TestTrack.hpp" #include "Utils.hpp" extern "C" { #include "data.h" #include "../../src/rct2.h" #include "../../src/ride/ride.h" #include "../../src/ride/ride_data.h" #include "../../src/ride/track.h" #include "../../src/ride/track_data.h" } typedef struct { uint8 rideType; std::vector trackTypes; } TestCase; enum CLIColour { DEFAULT, RED, YELLOW, GREEN, }; bool gTestColor = true; Verbosity _verbosity = NORMAL; static bool CStringEquals(const char *lhs, const char *rhs) { if (lhs == NULL) return rhs == NULL; if (rhs == NULL) return false; return strcmp(lhs, rhs) == 0; } enum COLOUR_METHOD { COLOUR_METHOD_NONE, COLOUR_METHOD_ANSI, COLOUR_METHOD_WINDOWS, }; static COLOUR_METHOD GetColourMethod() { if (!gTestColor) { return COLOUR_METHOD_NONE; } const char* const term = getenv("TERM"); const bool term_supports_color = CStringEquals(term, "xterm") || CStringEquals(term, "xterm-color") || CStringEquals(term, "xterm-256color") || CStringEquals(term, "screen") || CStringEquals(term, "screen-256color") || CStringEquals(term, "tmux") || CStringEquals(term, "tmux-256color") || CStringEquals(term, "rxvt-unicode") || CStringEquals(term, "rxvt-unicode-256color") || CStringEquals(term, "linux") || CStringEquals(term, "cygwin"); if (term_supports_color) { return COLOUR_METHOD_ANSI; } #ifdef __WINDOWS__ return COLOUR_METHOD_WINDOWS; #else return COLOUR_METHOD_NONE; #endif } static const char* GetAnsiColorCode(CLIColour color) { switch (color) { case RED: return "1"; case GREEN: return "2"; case YELLOW: return "3"; default: return NULL; }; } #ifdef __WINDOWS__ static WORD GetCurrentWindowsConsoleAttribute(HANDLE hConsoleOutput) { CONSOLE_SCREEN_BUFFER_INFO csbi; GetConsoleScreenBufferInfo(hConsoleOutput, &csbi); return csbi.wAttributes; } static WORD GetWindowsConsoleAttribute(CLIColour color, WORD defaultAttr) { switch (color) { case RED: return FOREGROUND_RED; case GREEN: return FOREGROUND_GREEN; case YELLOW: return FOREGROUND_RED | FOREGROUND_GREEN; default: return defaultAttr; }; } #endif static void Write_VA(Verbosity verbosity, CLIColour colour, const char *fmt, va_list args) { if (_verbosity < verbosity) return; COLOUR_METHOD colourMethod = GetColourMethod(); if (colour == CLIColour::DEFAULT || colourMethod == COLOUR_METHOD_NONE) { vprintf(fmt, args); } else if (colourMethod == COLOUR_METHOD_ANSI) { printf("\033[0;3%sm", GetAnsiColorCode(colour)); vprintf(fmt, args); printf("\033[m"); } else if (colourMethod == COLOUR_METHOD_WINDOWS) { #ifdef __WINDOWS__ HANDLE hStdOut = GetStdHandle(STD_OUTPUT_HANDLE); WORD defaultAttr = GetCurrentWindowsConsoleAttribute(hStdOut); SetConsoleTextAttribute(hStdOut, GetWindowsConsoleAttribute(colour, defaultAttr)); vprintf(fmt, args); SetConsoleTextAttribute(hStdOut, defaultAttr); #endif } } static void Write(Verbosity verbosity, CLIColour colour, const char *fmt, ...) { va_list args; va_start(args, fmt); Write_VA(verbosity, colour, fmt, args); va_end(args); } static void Write(Verbosity verbosity, const char * fmt, ...) { va_list args; va_start(args, fmt); Write_VA(verbosity, DEFAULT, fmt, args); va_end(args); } static void Write(CLIColour colour, const char * fmt, ...) { va_list args; va_start(args, fmt); Write_VA(NORMAL, colour, fmt, args); va_end(args); } static void Write(const char * fmt, ...) { va_list args; va_start(args, fmt); Write_VA(NORMAL, DEFAULT, fmt, args); va_end(args); } #if defined(__WINDOWS__) #include int main(int argc, char *argv[]); #define OPENRCT2_DLL_MODULE_NAME "openrct2.dll" static HMODULE _dllModule = NULL; utf8 *utf8_write_codepoint(utf8 *dst, uint32 codepoint) { if (codepoint <= 0x7F) { dst[0] = (utf8)codepoint; return dst + 1; } else if (codepoint <= 0x7FF) { dst[0] = 0xC0 | ((codepoint >> 6) & 0x1F); dst[1] = 0x80 | (codepoint & 0x3F); return dst + 2; } else if (codepoint <= 0xFFFF) { dst[0] = 0xE0 | ((codepoint >> 12) & 0x0F); dst[1] = 0x80 | ((codepoint >> 6) & 0x3F); dst[2] = 0x80 | (codepoint & 0x3F); return dst + 3; } else { dst[0] = 0xF0 | ((codepoint >> 18) & 0x07); dst[1] = 0x80 | ((codepoint >> 12) & 0x3F); dst[2] = 0x80 | ((codepoint >> 6) & 0x3F); dst[3] = 0x80 | (codepoint & 0x3F); return dst + 4; } } utf8 *widechar_to_utf8(const wchar_t *src) { utf8 *result = (utf8 *)malloc((wcslen(src) * 4) + 1); utf8 *dst = result; for (; *src != 0; src++) { dst = utf8_write_codepoint(dst, *src); } *dst++ = 0; size_t size = (size_t)(dst - result); return (utf8 *)realloc(result, size); } utf8 **windows_get_command_line_args(int *outNumArgs) { int argc; // Get command line arguments as widechar LPWSTR commandLine = GetCommandLineW(); LPWSTR *argvW = CommandLineToArgvW(commandLine, &argc); // Convert to UTF-8 utf8 **argvUtf8 = (utf8**)malloc(argc * sizeof(utf8*)); for (int i = 0; i < argc; i++) { argvUtf8[i] = widechar_to_utf8(argvW[i]); } LocalFree(argvW); *outNumArgs = argc; return argvUtf8; } BOOL APIENTRY DllMain(HANDLE hModule, DWORD dwReason, LPVOID lpReserved) { _dllModule = (HMODULE)hModule; return TRUE; } __declspec(dllexport) int StartOpenRCT(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine, int nCmdShow) { if (_dllModule == NULL) { _dllModule = GetModuleHandleA(OPENRCT2_DLL_MODULE_NAME); } int argc; char ** argv = (char**)windows_get_command_line_args(&argc); int gExitCode = main(argc, argv); // Free argv for (int i = 0; i < argc; i++) { free(argv[i]); } free(argv); exit(gExitCode); return gExitCode; } #endif char *segments = (char *)(GOOD_PLACE_FOR_DATA_SEGMENT); static uint32 sawyercoding_calculate_checksum(const uint8* buffer, size_t length) { size_t i; uint32 checksum = 0; for (i = 0; i < length; i++) checksum += buffer[i]; return checksum; } /** * Loads RCT2's data model and remaps the addresses. * @returns true if the data integrity check succeeded, otherwise false. */ static bool openrct2_setup_rct2_segment() { // OpenRCT2 on Linux and macOS is wired to have the original Windows PE sections loaded // necessary. Windows does not need to do this as OpenRCT2 runs as a DLL loaded from the Windows PE. int len = 0x01429000 - 0x8a4000; // 0xB85000, 12079104 bytes or around 11.5MB int err = 0; // in some configurations err and len may be unused UNUSED(err); UNUSED(len); #if defined(__unix__) int pageSize = getpagesize(); int numPages = (len + pageSize - 1) / pageSize; unsigned char *dummy = (unsigned char *)malloc(numPages); err = mincore((void *)segments, len, dummy); bool pagesMissing = false; if (err != 0) { err = errno; #ifdef __LINUX__ // On Linux ENOMEM means all requested range is unmapped if (err != ENOMEM) { pagesMissing = true; perror("mincore"); } #else pagesMissing = true; perror("mincore"); #endif // __LINUX__ } else { for (int i = 0; i < numPages; i++) { if (dummy[i] != 1) { pagesMissing = true; void *start = (void *)(segments + i * pageSize); void *end = (void *)(segments + (i + 1) * pageSize - 1); log_warning("required page %p - %p is not in memory!", start, end); } } } free(dummy); if (pagesMissing) { log_error("At least one of required pages was not found in memory. This can cause segfaults later on."); } // section: text err = mprotect((void *)0x401000, 0x8a4000 - 0x401000, PROT_READ | PROT_EXEC | PROT_WRITE); if (err != 0) { perror("mprotect"); } // section: rw data err = mprotect((void *)segments, 0x01429000 - 0x8a4000, PROT_READ | PROT_WRITE); if (err != 0) { perror("mprotect"); } #endif // defined(__unix__) // Check that the expected data is at various addresses. // Start at 0x9a6000, which is start of .data, to skip the region containing addresses to DLL // calls, which can be changed by windows/wine loader. const uint32 c1 = sawyercoding_calculate_checksum((const uint8*)(segments + (uintptr_t)(0x009A6000 - 0x8a4000)), 0x009E0000 - 0x009A6000); const uint32 c2 = sawyercoding_calculate_checksum((const uint8*)(segments + (uintptr_t)(0x01428000 - 0x8a4000)), 0x014282BC - 0x01428000); const uint32 exp_c1 = 10114815; const uint32 exp_c2 = 23564; if (c1 != exp_c1 || c2 != exp_c2) { log_warning("c1 = %u, expected %u, match %d", c1, exp_c1, c1 == exp_c1); log_warning("c2 = %u, expected %u, match %d", c2, exp_c2, c2 == exp_c2); return false; } return true; } static void PrintRideTypes() { for (uint8 rideType = 0; rideType < 91; rideType++) { CLIColour colour = CLIColour::DEFAULT; bool implemented = Utils::rideIsImplemented(rideType); const char * rideName = RideNames[rideType]; const char * status = ""; if (implemented) { status = " [IMPLEMENTED]"; colour = CLIColour::GREEN; } Write(colour, "%2d: %-30s%s\n", rideType, rideName, status); } } #include "GeneralSupportHeightCall.hpp" static void TestGeneralSupportHeightCall() { SupportCall callA = {16, 0x20}; SupportCall callB = {32, 0x20}; SupportCall callC = {48, 0x20}; SupportCall callD = {48, 0x1F}; SupportCall out = {0,0}; bool success; SupportCall groupA[4] = {callA, callA, callA, callA}; success = GeneralSupportHeightCall::FindMostCommonSupportCall(groupA, &out); assert(success); assert(out == callA); SupportCall groupB[4] = {callB, callA, callA, callA}; success = GeneralSupportHeightCall::FindMostCommonSupportCall(groupB, &out); assert(success); assert(out == callA); SupportCall groupC[4] = {callB, callA, callB, callA}; success = GeneralSupportHeightCall::FindMostCommonSupportCall(groupC, &out); assert(!success); SupportCall groupD[4] = {callB, callC, callB, callA}; success = GeneralSupportHeightCall::FindMostCommonSupportCall(groupD, &out); assert(!success); SupportCall groupE[4] = {callD, callC, callB, callA}; success = GeneralSupportHeightCall::FindMostCommonSupportCall(groupE, &out); assert(!success); } int main(int argc, char *argv[]) { TestGeneralSupportHeightCall(); std::vector testCases; bool generate = false; uint8 specificRideType = 0xFF; for (int i = 0; i < argc; ++i) { char *arg = argv[i]; if (strcmp(arg, "--gtest_color=no") == 0) { gTestColor = false; } else if (strcmp(arg, "--quiet") == 0) { _verbosity = Verbosity::QUIET; } else if (strcmp(arg, "--ride-type") == 0) { if (i + 1 < argc) { i++; specificRideType = atoi(argv[i]); } else { PrintRideTypes(); return 2; } } else if (strcmp(arg, "--generate") == 0) { generate = true; } } if (generate) { if (specificRideType > 90) { fprintf(stderr, "No ride or invalid ride specified.\n"); return 1; } openrct2_setup_rct2_segment(); PaintIntercept::InitHooks(); return generatePaintCode(specificRideType); } for (uint8 rideType = 0; rideType < 91; rideType++) { if (specificRideType != 0xFF && rideType != specificRideType) { continue; } if (!Utils::rideIsImplemented(rideType)) { continue; } TestCase testCase = {0}; testCase.rideType = rideType; if (ride_type_has_flag(rideType, RIDE_TYPE_FLAG_FLAT_RIDE)) { testCase.trackTypes.push_back(RideConstructionDefaultTrackType[rideType]); } else { for (int trackType = 0; trackType < 256; trackType++) { if (Utils::rideSupportsTrackType(rideType, trackType)) { testCase.trackTypes.push_back(trackType); } } } testCases.push_back(testCase); } int testCaseCount = (int) testCases.size(); int testCount = 0; for (auto &&tc : testCases) { testCount += tc.trackTypes.size(); } Write(CLIColour::GREEN, "[==========] "); Write("Running %d tests from %d test cases.\n", testCount, testCaseCount); Write(CLIColour::GREEN, "[----------] "); Write("Global test environment set-up.\n"); openrct2_setup_rct2_segment(); PaintIntercept::InitHooks(); int successCount = 0; std::vector failures; for (auto &&tc : testCases) { const utf8string rideTypeName = RideNames[tc.rideType]; Write(CLIColour::GREEN, "[----------] "); Write("%d tests from %s\n", (int)tc.trackTypes.size(), rideTypeName); for (auto &&trackType : tc.trackTypes) { utf8string trackTypeName; if (ride_type_has_flag(tc.rideType, RIDE_TYPE_FLAG_FLAT_RIDE)) { trackTypeName = FlatTrackNames[trackType]; } else { trackTypeName = TrackNames[trackType]; } Write(CLIColour::GREEN, "[ RUN ] "); Write("%s.%s\n", rideTypeName, trackTypeName); std::string out; int retVal = TestTrack::TestPaintTrackElement(tc.rideType, trackType, &out); Write("%s", out.c_str()); switch (retVal) { case TEST_SUCCESS: Write(CLIColour::GREEN, "[ OK ] "); Write("%s.%s (0 ms)\n", rideTypeName, trackTypeName); successCount++; break; case TEST_SKIPPED: Write("Skipped\n"); // Outputting this as OK because CLion only allows FAILED or OK Write(CLIColour::YELLOW, "[ OK ] "); Write("%s.%s (0 ms)\n", rideTypeName, trackTypeName); successCount++; break; case TEST_FAILED: utf8string testCaseName = new utf8[64]; snprintf(testCaseName, 64, "%s.%s", rideTypeName, trackTypeName); Write(CLIColour::RED, "[ FAILED ] "); Write("%s (0 ms)\n", testCaseName); failures.push_back(testCaseName); break; } } Write(CLIColour::GREEN, "[----------] "); Write("%d tests from %s (0 ms total)\n", (int)tc.trackTypes.size(), rideTypeName); } Write("\n"); Write(CLIColour::GREEN, "[----------] "); Write("Global test environment tear-down\n"); Write(CLIColour::GREEN, "[==========] "); Write("%d tests from %d test cases ran. (0 ms total).\n", testCount, testCaseCount); Write(Verbosity::QUIET, CLIColour::GREEN, "[ PASSED ] "); Write(Verbosity::QUIET, "%d tests.\n", successCount); if (failures.size() > 0) { Write(Verbosity::QUIET, CLIColour::RED, "[ FAILED ] "); Write(Verbosity::QUIET, "%d tests, listed below:\n", (int)failures.size()); for (auto &&failure : failures) { Write(Verbosity::QUIET, CLIColour::RED, "[ FAILED ] "); Write(Verbosity::QUIET, "%s\n", failure); delete [] failure; } Write(Verbosity::QUIET, "\n"); Write(Verbosity::QUIET, "%d FAILED TESTS\n", (int)failures.size()); return 1; } return 0; }