xref: /aosp_15_r20/external/deqp/framework/common/tcuTestContext.hpp (revision 35238bce31c2a825756842865a792f8cf7f89930)

#ifndef _TCUTESTCONTEXT_HPP
#define _TCUTESTCONTEXT_HPP
/*-------------------------------------------------------------------------
 * drawElements Quality Program Tester Core
 * ----------------------------------------
 *
 * Copyright 2014 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 *//*!
 * \file
 * \brief Context shared between test cases.
 *//*--------------------------------------------------------------------*/

#include "tcuDefs.hpp"
#include "qpWatchDog.h"
#include "qpTestLog.h"

#include <string>

namespace tcu
{

class Archive;
class Platform;
class CommandLine;
class TestLog;

/*--------------------------------------------------------------------*//*!
 * \brief Test context
 *
 * Test context holds common resources that are available to test cases.
 * This includes test log and resource archive.
 *
 * Test case can write to test log and must set test result to test context.
 *//*--------------------------------------------------------------------*/
class TestContext
{
public:
    TestContext(Platform &platform, Archive &rootArchive, TestLog &log, const CommandLine &cmdLine,
                qpWatchDog *watchDog);
    ~TestContext(void)
    {
    }

    void writeSessionInfo(void);

    // API for test cases
    TestLog &getLog(void)
    {
        return m_log;
    }
    Archive &getArchive(void)
    {
        return *m_curArchive;
    } //!< \note Do not access in TestNode constructors.
    Platform &getPlatform(void)
    {
        return m_platform;
    }
    void setTestResult(qpTestResult result, const char *description);
    void touchWatchdog(void);
    void touchWatchdogAndDisableIntervalTimeLimit(void);
    void touchWatchdogAndEnableIntervalTimeLimit(void);
    const CommandLine &getCommandLine(void) const
    {
        return m_cmdLine;
    }

    // API for test framework
    qpTestResult getTestResult(void) const
    {
        return m_testResult;
    }
    const char *getTestResultDesc(void) const
    {
        return m_testResultDesc.c_str();
    }
    qpWatchDog *getWatchDog(void)
    {
        return m_watchDog;
    }

    Archive &getRootArchive(void) const
    {
        return m_rootArchive;
    }
    void setCurrentArchive(Archive &archive)
    {
        m_curArchive = &archive;
    }

    void setTerminateAfter(bool terminate)
    {
        m_terminateAfter = terminate;
    }
    bool getTerminateAfter(void) const
    {
        return m_terminateAfter;
    }

protected:
    TestContext(const TestContext &);
    TestContext &operator=(const TestContext &);

    Platform &m_platform;         //!< Platform port implementation.
    Archive &m_rootArchive;       //!< Root archive.
    TestLog &m_log;               //!< Test log.
    const CommandLine &m_cmdLine; //!< Command line.
    qpWatchDog *m_watchDog;       //!< Watchdog (can be null).

    Archive *m_curArchive;        //!< Current archive for test cases.
    qpTestResult m_testResult;    //!< Latest test result.
    std::string m_testResultDesc; //!< Latest test result description.
    bool m_terminateAfter;        //!< Should tester terminate after execution of the current test
};

} // namespace tcu

#endif // _TCUTESTCONTEXT_HPP