CWineTest.cpp

Go to the documentation of this file.

/*
 * PROJECT:     ReactOS Automatic Testing Utility
 * LICENSE:     GPL-2.0+ (https://spdx.org/licenses/GPL-2.0+)
 * PURPOSE:     Class implementing functions for handling Wine tests
 * COPYRIGHT:   Copyright 2009-2019 Colin Finck (colin@reactos.org)
 */
 
#include "precomp.h"
 
static const DWORD ListTimeout = 10000;
 
// This value needs to be lower than the <timeout> configured in sysreg.xml! (usually 180000)
// Otherwise, sysreg2 kills the VM before we can kill the process.
static const DWORD ProcessActivityTimeout = 170000;
 
 
CWineTest::CWineTest()
    : m_hFind(NULL), m_ListBuffer(NULL)
{
    WCHAR wszDirectory[MAX_PATH];
 
    /* Set up m_TestPath */
    if (GetEnvironmentVariableW(L"ROSAUTOTEST_DIR", wszDirectory, MAX_PATH))
    {
        m_TestPath = wszDirectory;
        if (*m_TestPath.rbegin() != L'\\')
            m_TestPath += L'\\';
    }
    else
    {
        if (!GetWindowsDirectoryW(wszDirectory, MAX_PATH))
            FATAL("GetWindowsDirectoryW failed\n");
 
        m_TestPath = wszDirectory;
        m_TestPath += L"\\bin\\";
    }
}
 
CWineTest::~CWineTest()
{
    if(m_hFind)
        FindClose(m_hFind);
}
 
bool
CWineTest::GetNextFile()
{
    bool FoundFile = false;
    WIN32_FIND_DATAW fd;
 
    /* Reset the test list */
    m_ListBuffer = NULL;
    m_ListString.clear();
 
    /* Did we already begin searching for files? */
    if (m_hFind)
    {
        /* Then get the next file (if any) */
        if (FindNextFileW(m_hFind, &fd))
        {
            // printf("cFileName is '%S'.\n", fd.cFileName);
            /* If it was NOT rosautotest.exe then proceed as normal */
            if (_wcsicmp(fd.cFileName, TestName) != 0)
            {
                FoundFile = true;
            }
            else
            {
                /* It was rosautotest.exe so get the next file (if any) */
                if (FindNextFileW(m_hFind, &fd))
                {
                    FoundFile = true;
                }
                // printf("cFileName is '%S'.\n", fd.cFileName);
            }
        }
    }
    else
    {
        /* Start searching for test files */
        wstring FindPath = m_TestPath;
        wstring Module = Configuration.GetModule();
 
        /* Did the user specify a module? */
        if(Module.empty())
        {
            /* No module, so search for all "*test.exe" files in that directory */
            FindPath += L"*test.exe";
        }
        else
        {
            /* Check for 'special' tests (e.g. "kmtest") or full test name ("ntdll_winetest") */
            if (Module.substr(Module.length() - 4, 4) == L"test")
            {
                /* Search for files with the pattern "modulename.exe" */
                FindPath += Configuration.GetModule();
                FindPath += L".exe";
            }
            else
            {
                /* Search for files with the pattern "modulename_*test.exe" */
                FindPath += Configuration.GetModule();
                FindPath += L"_*test.exe";
            }
        }
 
        /* Search for the first file and check whether we got one */
        m_hFind = FindFirstFileW(FindPath.c_str(), &fd);
 
        /* If we returned a good handle */
        if (m_hFind != INVALID_HANDLE_VALUE)
        {
            // printf("cFileName is '%S'.\n", fd.cFileName);
            /* If it was NOT rosautotest.exe then proceed as normal */
            if (_wcsicmp(fd.cFileName, TestName) != 0)
            {
                FoundFile = true;
            }
            else
            {
                /* It was rosautotest.exe so get the next file (if any) */
                if (FindNextFileW(m_hFind, &fd))
                {
                    FoundFile = true;
                }
                // printf("cFileName is '%S'.\n", fd.cFileName);
            }
        }
    }
 
    if(FoundFile)
        m_CurrentFile = fd.cFileName;
 
    return FoundFile;
}
 
DWORD
CWineTest::DoListCommand()
{
    DWORD BytesRead;
    wstring CommandLine;
    CPipe Pipe;
    CHAR TempBuffer[1024];
    DWORD ret;
 
    m_ListString.clear();
 
    /* Build the command line */
    CommandLine = m_TestPath;
    CommandLine += m_CurrentFile;
    CommandLine += L" --list";
 
    /* Start the process for getting all available tests */
    CPipedProcess Process(CommandLine, Pipe);
 
    for (;;)
    {
        /* Try to read from the pipe */
        ret = Pipe.Read(TempBuffer, ARRAYSIZE(TempBuffer), &BytesRead, ListTimeout);
 
        /* If the pipe is broken, the process terminated */
        if (ret == ERROR_BROKEN_PIPE)
            break;
 
        /* Timeout, the process might not be responding */
        if (ret == WAIT_TIMEOUT)
            break;
 
        if (ret != ERROR_SUCCESS)
            TESTEXCEPTION("Unexpected error\n");
 
        m_ListString.append(TempBuffer, BytesRead);
    }
 
    if (WaitForSingleObject(Process.GetProcessHandle(), ListTimeout) != ERROR_SUCCESS)
        TESTEXCEPTION("WaitForSingleObject failed for the test list\n");
 
    m_ListBuffer = (PCHAR)m_ListString.c_str();
    return (DWORD)m_ListString.size();
}
 
bool
CWineTest::GetNextTest()
{
    PCHAR pEnd;
    static DWORD BufferSize;
    static PCHAR pStart;
 
    if(!m_ListBuffer)
    {
        /* Perform the --list command */
        BufferSize = DoListCommand();
 
        if ((BufferSize == 0) || (m_ListBuffer == NULL))
        {
            stringstream ss;
            ss << "The --list command did not return any data for " << UnicodeToAscii(m_CurrentFile) << endl;
            TESTEXCEPTION(ss.str());
        }
 
        /* Move the pointer to the first test */
        pStart = strchr(m_ListBuffer, '\n');
        pStart += 5;
    }
 
    /* If we reach the buffer size, we finished analyzing the output of this test */
    if(pStart >= (m_ListBuffer + BufferSize))
    {
        /* Clear m_CurrentFile to indicate that */
        m_CurrentFile.clear();
 
        /* Also free the memory for the list buffer */
        m_ListBuffer = NULL;
        m_ListString.clear();
 
        return false;
    }
 
    /* Get start and end of this test name */
    pEnd = pStart;
 
    while (*pEnd != '\r')
    {
        if (*pEnd == '\0')
            TESTEXCEPTION("Unexpected test list format\n");
        ++pEnd;
    }
 
    /* Store the test name */
    m_CurrentTest = string(pStart, pEnd);
 
    /* Move the pointer to the next test */
    pStart = pEnd + 6;
 
    return true;
}
 
CTestInfo*
CWineTest::GetNextTestInfo()
{
    while(!m_CurrentFile.empty() || GetNextFile())
    {
        /* The user asked for a list of all modules */
        if (Configuration.ListModulesOnly())
        {
            std::stringstream ss;
            ss << "Module: " << UnicodeToAscii(m_CurrentFile) << endl;
            m_CurrentFile.clear();
            StringOut(ss.str());
            continue;
        }
 
        try
        {
            while(GetNextTest())
            {
                /* If the user specified a test through the command line, check this here */
                if(!Configuration.GetTest().empty() && Configuration.GetTest() != m_CurrentTest)
                    continue;
 
                {
                    auto_ptr<CTestInfo> TestInfo(new CTestInfo());
                    size_t UnderscorePosition;
 
                    /* Build the command line */
                    TestInfo->CommandLine = m_TestPath;
                    TestInfo->CommandLine += m_CurrentFile;
                    TestInfo->CommandLine += ' ';
                    TestInfo->CommandLine += AsciiToUnicode(m_CurrentTest);
 
                    /* Store the Module name */
                    UnderscorePosition = m_CurrentFile.find_last_of('_');
 
                    if(UnderscorePosition == m_CurrentFile.npos)
                    {
                        /* Use the entire name (without .exe extendion) */
                        UnderscorePosition = m_CurrentFile.find_first_of('.');
                        if(UnderscorePosition == m_CurrentFile.npos)
                            UnderscorePosition = m_CurrentFile.length();
                    }
 
                    TestInfo->Module = UnicodeToAscii(m_CurrentFile.substr(0, UnderscorePosition));
 
                    /* Store the test */
                    TestInfo->Test = m_CurrentTest;
 
                    return TestInfo.release();
                }
            }
        }
        catch(CTestException& e)
        {
            stringstream ss;
 
            ss << "An exception occurred trying to list tests for: " << UnicodeToAscii(m_CurrentFile) << endl;
            StringOut(ss.str());
            StringOut(e.GetMessage());
            StringOut("\n");
            m_CurrentFile.clear();
            m_ListString.clear();
        }
    }
 
    return NULL;
}
 
void
CWineTest::RunTest(CTestInfo* TestInfo)
{
    DWORD BytesAvailable;
    stringstream ss, ssFinish;
    DWORD StartTime;
    float TotalTime;
    string tailString;
    CPipe Pipe;
    char Buffer[1024];
 
    ss << "Running Wine Test, Module: " << TestInfo->Module << ", Test: " << TestInfo->Test << endl;
    StringOut(ss.str());
 
    SetCurrentDirectoryW(m_TestPath.c_str());
 
    StartTime = GetTickCount();
 
    try
    {
        /* Execute the test */
        CPipedProcess Process(TestInfo->CommandLine, Pipe);
 
        /* Receive all the data from the pipe */
        for (;;)
        {
            DWORD dwReadResult = Pipe.Read(Buffer, sizeof(Buffer) - 1, &BytesAvailable, ProcessActivityTimeout);
            if (dwReadResult == ERROR_SUCCESS)
            {
                /* Output text through StringOut, even while the test is still running */
                Buffer[BytesAvailable] = 0;
                tailString = StringOut(tailString.append(string(Buffer)), false);
 
                if (Configuration.DoSubmit())
                    TestInfo->Log += Buffer;
            }
            else if (dwReadResult == ERROR_BROKEN_PIPE)
            {
                // The process finished and has been terminated.
                break;
            }
            else if (dwReadResult == WAIT_TIMEOUT)
            {
                // The process activity timeout above has elapsed without any new data.
                TESTEXCEPTION("Timeout while waiting for the test process\n");
            }
            else
            {
                // An unexpected error.
                TESTEXCEPTION("CPipe::Read failed for the test run\n");
            }
        }
    }
    catch(CTestException& e)
    {
        if(!tailString.empty())
            StringOut(tailString);
        tailString.clear();
        StringOut(e.GetMessage());
        TestInfo->Log += e.GetMessage();
    }
 
    /* Print what's left */
    if(!tailString.empty())
        StringOut(tailString);
 
    TotalTime = ((float)GetTickCount() - StartTime)/1000;
    ssFinish << "Test " << TestInfo->Test << " completed in ";
    ssFinish << setprecision(2) << fixed << TotalTime << " seconds." << endl;
    StringOut(ssFinish.str());
    TestInfo->Log += ssFinish.str();
}
 
void
CWineTest::Run()
{
    auto_ptr<CTestList> TestList;
    auto_ptr<CWebService> WebService;
    CTestInfo* TestInfo;
    DWORD ErrorMode = 0;
 
    /* The virtual test list is of course faster, so it should be preferred over
       the journaled one.
       Enable the journaled one only in case ...
          - we're running under ReactOS (as the journal is only useful in conjunction with sysreg2)
          - we shall keep information for Crash Recovery
          - and the user didn't specify a module (then doing Crash Recovery doesn't really make sense) */
    if(Configuration.IsReactOS() && Configuration.DoCrashRecovery() && Configuration.GetModule().empty())
    {
        /* Use a test list with a permanent journal */
        TestList.reset(new CJournaledTestList(this));
    }
    else
    {
        /* Use the fast virtual test list with no additional overhead */
        TestList.reset(new CVirtualTestList(this));
    }
 
    /* Initialize the Web Service interface if required */
    if (Configuration.DoSubmit())
    {
        if (CWebServiceLibCurl::CanUseLibCurl())
        {
            StringOut("[ROSAUTOTEST] Using libcurl\n");
            WebService.reset(new CWebServiceLibCurl());
        }
        else
        {
            StringOut("[ROSAUTOTEST] Using wininet\n");
            WebService.reset(new CWebServiceWinInet());
        }
    }
 
    /* Disable error dialogs if we're running in non-interactive mode */
    if(!Configuration.IsInteractive())
        ErrorMode = SetErrorMode(SEM_FAILCRITICALERRORS | SEM_NOGPFAULTERRORBOX);
 
    /* Get information for each test to run */
    while((TestInfo = TestList->GetNextTestInfo()) != 0)
    {
        auto_ptr<CTestInfo> TestInfoPtr(TestInfo);
 
        RunTest(TestInfo);
 
        if(Configuration.DoSubmit() && !TestInfo->Log.empty())
            WebService->Submit("wine", TestInfo);
 
        StringOut("\n\n");
    }
 
    /* We're done with all tests. Finish this run */
    if(Configuration.DoSubmit())
        WebService->Finish("wine");
 
    /* Restore the original error mode */
    if(!Configuration.IsInteractive())
        SetErrorMode(ErrorMode);
}