1 #ifndef _TCUTESTCONTEXT_HPP
2 #define _TCUTESTCONTEXT_HPP
3 /*-------------------------------------------------------------------------
4  * drawElements Quality Program Tester Core
5  * ----------------------------------------
6  *
7  * Copyright 2014 The Android Open Source Project
8  *
9  * Licensed under the Apache License, Version 2.0 (the "License");
10  * you may not use this file except in compliance with the License.
11  * You may obtain a copy of the License at
12  *
13  *      http://www.apache.org/licenses/LICENSE-2.0
14  *
15  * Unless required by applicable law or agreed to in writing, software
16  * distributed under the License is distributed on an "AS IS" BASIS,
17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18  * See the License for the specific language governing permissions and
19  * limitations under the License.
20  *
21  *//*!
22  * \file
23  * \brief Context shared between test cases.
24  *//*--------------------------------------------------------------------*/
25 
26 #include "tcuDefs.hpp"
27 #include "qpWatchDog.h"
28 #include "qpTestLog.h"
29 
30 #include <string>
31 
32 namespace tcu
33 {
34 
35 class Archive;
36 class Platform;
37 class CommandLine;
38 class TestLog;
39 
40 /*--------------------------------------------------------------------*//*!
41  * \brief Test context
42  *
43  * Test context holds common resources that are available to test cases.
44  * This includes test log and resource archive.
45  *
46  * Test case can write to test log and must set test result to test context.
47  *//*--------------------------------------------------------------------*/
48 class TestContext
49 {
50 public:
51 							TestContext			(Platform& platform, Archive& rootArchive, TestLog& log, const CommandLine& cmdLine, qpWatchDog* watchDog);
~TestContext(void)52 							~TestContext		(void) {}
53 
54 	// API for test cases
getLog(void)55 	TestLog&				getLog				(void)			{ return m_log;			}
getArchive(void)56 	Archive&				getArchive			(void)			{ return *m_curArchive;	} //!< \note Do not access in TestNode constructors.
getPlatform(void)57 	Platform&				getPlatform			(void)			{ return m_platform;	}
58 	void					setTestResult		(qpTestResult result, const char* description);
59 	void					touchWatchdog		(void);
getCommandLine(void) const60 	const CommandLine&		getCommandLine		(void) const	{ return m_cmdLine;		}
61 
62 	// API for test framework
getTestResult(void) const63 	qpTestResult			getTestResult		(void) const	{ return m_testResult;				}
getTestResultDesc(void) const64 	const char*				getTestResultDesc	(void) const	{ return m_testResultDesc.c_str();	}
getWatchDog(void)65 	qpWatchDog*				getWatchDog			(void)			{ return m_watchDog;				}
66 
getRootArchive(void) const67 	Archive&				getRootArchive		(void) const		{ return m_rootArchive;		}
setCurrentArchive(Archive & archive)68 	void					setCurrentArchive	(Archive& archive)	{ m_curArchive = &archive;	}
69 
setTerminateAfter(bool terminate)70 	void					setTerminateAfter	(bool terminate)	{ m_terminateAfter = terminate;	}
getTerminateAfter(void) const71 	bool					getTerminateAfter	(void) const		{ return m_terminateAfter; 		}
72 
73 protected:
74 							TestContext			(const TestContext&);
75 	TestContext&			operator=			(const TestContext&);
76 
77 	Platform&				m_platform;			//!< Platform port implementation.
78 	Archive&				m_rootArchive;		//!< Root archive.
79 	TestLog&				m_log;				//!< Test log.
80 	const CommandLine&		m_cmdLine;			//!< Command line.
81 	qpWatchDog*				m_watchDog;			//!< Watchdog (can be null).
82 
83 	Archive*				m_curArchive;		//!< Current archive for test cases.
84 	qpTestResult			m_testResult;		//!< Latest test result.
85 	std::string				m_testResultDesc;	//!< Latest test result description.
86 	bool					m_terminateAfter;	//!< Should tester terminate after execution of the current test
87 };
88 
89 } // tcu
90 
91 #endif // _TCUTESTCONTEXT_HPP
92