#ifndef CYGONCE_INFRA_TESTCASE_H
|
#ifndef CYGONCE_INFRA_TESTCASE_H
|
#define CYGONCE_INFRA_TESTCASE_H
|
#define CYGONCE_INFRA_TESTCASE_H
|
//==========================================================================
|
//==========================================================================
|
//
|
//
|
// testcase.h
|
// testcase.h
|
//
|
//
|
// Target side interface for tests
|
// Target side interface for tests
|
//
|
//
|
//==========================================================================
|
//==========================================================================
|
//####COPYRIGHTBEGIN####
|
//####COPYRIGHTBEGIN####
|
//
|
//
|
// ----------------------------------------------------------------------------
|
// ----------------------------------------------------------------------------
|
// Copyright (C) 1998, 1999, 2000 Red Hat, Inc.
|
// Copyright (C) 1998, 1999, 2000 Red Hat, Inc.
|
//
|
//
|
// This file is part of the eCos host tools.
|
// This file is part of the eCos host tools.
|
//
|
//
|
// This program is free software; you can redistribute it and/or modify it
|
// This program 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
|
// under the terms of the GNU General Public License as published by the Free
|
// Software Foundation; either version 2 of the License, or (at your option)
|
// Software Foundation; either version 2 of the License, or (at your option)
|
// any later version.
|
// any later version.
|
//
|
//
|
// This program is distributed in the hope that it will be useful, but WITHOUT
|
// This program is distributed in the hope that it will be useful, but WITHOUT
|
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
// more details.
|
// more details.
|
//
|
//
|
// You should have received a copy of the GNU General Public License along with
|
// You should have received a copy of the GNU General Public License along with
|
// this program; if not, write to the Free Software Foundation, Inc.,
|
// this program; if not, write to the Free Software Foundation, Inc.,
|
// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
//
|
//
|
// ----------------------------------------------------------------------------
|
// ----------------------------------------------------------------------------
|
//
|
//
|
//####COPYRIGHTEND####
|
//####COPYRIGHTEND####
|
//==========================================================================
|
//==========================================================================
|
//#####DESCRIPTIONBEGIN####
|
//#####DESCRIPTIONBEGIN####
|
//
|
//
|
// Author(s): ctarpy
|
// Author(s): ctarpy
|
// Contributors: ctarpy, jlarmour
|
// Contributors: ctarpy, jlarmour
|
// Date: 1999-02-16
|
// Date: 1999-02-16
|
//
|
//
|
//
|
//
|
//####DESCRIPTIONEND####
|
//####DESCRIPTIONEND####
|
|
|
#include <cyg/infra/cyg_type.h> // Common type definitions and support
|
#include <cyg/infra/cyg_type.h> // Common type definitions and support
|
|
|
|
|
// CONSTANTS
|
// CONSTANTS
|
|
|
// Status codes
|
// Status codes
|
|
|
typedef enum {
|
typedef enum {
|
CYGNUM_TEST_FAIL,
|
CYGNUM_TEST_FAIL,
|
CYGNUM_TEST_PASS,
|
CYGNUM_TEST_PASS,
|
CYGNUM_TEST_EXIT,
|
CYGNUM_TEST_EXIT,
|
CYGNUM_TEST_INFO,
|
CYGNUM_TEST_INFO,
|
CYGNUM_TEST_GDBCMD,
|
CYGNUM_TEST_GDBCMD,
|
CYGNUM_TEST_NA
|
CYGNUM_TEST_NA
|
} Cyg_test_code;
|
} Cyg_test_code;
|
|
|
// FUNCTION PROTOTYPES
|
// FUNCTION PROTOTYPES
|
|
|
externC void
|
externC void
|
cyg_test_output(Cyg_test_code _status_, const char* _msg_, int _line_number_,
|
cyg_test_output(Cyg_test_code _status_, const char* _msg_, int _line_number_,
|
const char* _file_);
|
const char* _file_);
|
|
|
// This should be called at the start of each test file
|
// This should be called at the start of each test file
|
externC void
|
externC void
|
cyg_test_init(void);
|
cyg_test_init(void);
|
|
|
// This causes the test to exit
|
// This causes the test to exit
|
externC void
|
externC void
|
cyg_test_exit(void) CYGBLD_ATTRIB_NORET;
|
cyg_test_exit(void) CYGBLD_ATTRIB_NORET;
|
|
|
// GLOBALS
|
// GLOBALS
|
|
|
externC int cyg_test_is_simulator; // infrastructure changes as necessary
|
externC int cyg_test_is_simulator; // infrastructure changes as necessary
|
|
|
// MACROS
|
// MACROS
|
|
|
// ----------- Info -----------
|
// ----------- Info -----------
|
//
|
//
|
// Any macro with EXIT in it should only be used in a panic situation. It
|
// Any macro with EXIT in it should only be used in a panic situation. It
|
// is synonymous with assert. If the test behaves as expected, it
|
// is synonymous with assert. If the test behaves as expected, it
|
// should call one of the FINISH macros.
|
// should call one of the FINISH macros.
|
//
|
//
|
// - Compound testcases
|
// - Compound testcases
|
// If a testcase is capable of being part of a compound, then the following
|
// If a testcase is capable of being part of a compound, then the following
|
// rules apply:
|
// rules apply:
|
// - The testcase must only ever call one of the EXIT macros if it decides
|
// - The testcase must only ever call one of the EXIT macros if it decides
|
// the state of the system is such that further testing is meaningless;
|
// the state of the system is such that further testing is meaningless;
|
// such a call would prevent subsequent tests in the compound from being
|
// such a call would prevent subsequent tests in the compound from being
|
// run.
|
// run.
|
// - In order to terminate the test, the testcase should call one of the
|
// - In order to terminate the test, the testcase should call one of the
|
// FINISH macros. This must be done from within main().
|
// FINISH macros. This must be done from within main().
|
|
|
|
|
|
|
|
|
// The following is the testcase API to be used by testcases.
|
// The following is the testcase API to be used by testcases.
|
|
|
#define CYG_TEST_INIT() cyg_test_init()
|
#define CYG_TEST_INIT() cyg_test_init()
|
|
|
#define CYG_TEST_INFO( _msg_ ) \
|
#define CYG_TEST_INFO( _msg_ ) \
|
cyg_test_output(CYGNUM_TEST_INFO, _msg_, __LINE__, __FILE__)
|
cyg_test_output(CYGNUM_TEST_INFO, _msg_, __LINE__, __FILE__)
|
|
|
#define CYG_TEST_PASS( _msg_ ) \
|
#define CYG_TEST_PASS( _msg_ ) \
|
cyg_test_output(CYGNUM_TEST_PASS, _msg_, __LINE__, __FILE__)
|
cyg_test_output(CYGNUM_TEST_PASS, _msg_, __LINE__, __FILE__)
|
|
|
#define CYG_TEST_FAIL( _msg_ ) \
|
#define CYG_TEST_FAIL( _msg_ ) \
|
cyg_test_output(CYGNUM_TEST_FAIL, _msg_, __LINE__, __FILE__)
|
cyg_test_output(CYGNUM_TEST_FAIL, _msg_, __LINE__, __FILE__)
|
|
|
#define CYG_TEST_EXIT( _msg_ ) \
|
#define CYG_TEST_EXIT( _msg_ ) \
|
(cyg_test_output(CYGNUM_TEST_EXIT, _msg_, __LINE__, __FILE__), \
|
(cyg_test_output(CYGNUM_TEST_EXIT, _msg_, __LINE__, __FILE__), \
|
cyg_test_exit())
|
cyg_test_exit())
|
|
|
// Use the following macro to instruct GDB to run a command when using
|
// Use the following macro to instruct GDB to run a command when using
|
// the automatic testing infrastructure. This must be used *before*
|
// the automatic testing infrastructure. This must be used *before*
|
// CYG_TEST_INIT() is called
|
// CYG_TEST_INIT() is called
|
|
|
#define CYG_TEST_GDBCMD( _command_ ) \
|
#define CYG_TEST_GDBCMD( _command_ ) \
|
CYG_MACRO_START \
|
CYG_MACRO_START \
|
cyg_test_output(CYGNUM_TEST_GDBCMD, _command_, __LINE__, __FILE__); \
|
cyg_test_output(CYGNUM_TEST_GDBCMD, _command_, __LINE__, __FILE__); \
|
CYG_MACRO_END
|
CYG_MACRO_END
|
|
|
// Use the following macro to declare that a test is not applicable for
|
// Use the following macro to declare that a test is not applicable for
|
// some reason - perhaps not appropriate due to chosen hardware,
|
// some reason - perhaps not appropriate due to chosen hardware,
|
// configuration options governing the presence of a tested feature, or
|
// configuration options governing the presence of a tested feature, or
|
// even configuration options governing the presence of a feature the
|
// even configuration options governing the presence of a feature the
|
// test relies on _in_order_ to test the feature (despite being
|
// test relies on _in_order_ to test the feature (despite being
|
// unrelated!)
|
// unrelated!)
|
|
|
#define CYG_TEST_NA( _msg_ ) \
|
#define CYG_TEST_NA( _msg_ ) \
|
CYG_MACRO_START \
|
CYG_MACRO_START \
|
cyg_test_output(CYGNUM_TEST_NA, _msg_, __LINE__, __FILE__); \
|
cyg_test_output(CYGNUM_TEST_NA, _msg_, __LINE__, __FILE__); \
|
cyg_test_exit(); \
|
cyg_test_exit(); \
|
CYG_MACRO_END
|
CYG_MACRO_END
|
|
|
#ifdef CYG_COMPOUND_TEST
|
#ifdef CYG_COMPOUND_TEST
|
# define CYG_TEST_FINISH( _msg_ ) \
|
# define CYG_TEST_FINISH( _msg_ ) \
|
CYG_MACRO_START \
|
CYG_MACRO_START \
|
cyg_test_output(CYGNUM_TEST_EXIT, _msg_, __LINE__, __FILE__); \
|
cyg_test_output(CYGNUM_TEST_EXIT, _msg_, __LINE__, __FILE__); \
|
return 0; \
|
return 0; \
|
CYG_MACRO_END
|
CYG_MACRO_END
|
#else
|
#else
|
# define CYG_TEST_FINISH( _msg_ ) CYG_TEST_EXIT( _msg_ )
|
# define CYG_TEST_FINISH( _msg_ ) CYG_TEST_EXIT( _msg_ )
|
#endif
|
#endif
|
|
|
#define CYG_TEST_STILL_ALIVE( _ctr_ , _msg_ ) CYG_TEST_INFO( _msg_ )
|
#define CYG_TEST_STILL_ALIVE( _ctr_ , _msg_ ) CYG_TEST_INFO( _msg_ )
|
|
|
|
|
// ----- The following are convenience functions
|
// ----- The following are convenience functions
|
|
|
#define CYG_TEST_PASS_FINISH( _msg_ ) \
|
#define CYG_TEST_PASS_FINISH( _msg_ ) \
|
CYG_MACRO_START \
|
CYG_MACRO_START \
|
CYG_TEST_PASS( _msg_ ); \
|
CYG_TEST_PASS( _msg_ ); \
|
CYG_TEST_FINISH("done"); \
|
CYG_TEST_FINISH("done"); \
|
CYG_MACRO_END
|
CYG_MACRO_END
|
|
|
#define CYG_TEST_FAIL_FINISH( _msg_ ) \
|
#define CYG_TEST_FAIL_FINISH( _msg_ ) \
|
CYG_MACRO_START \
|
CYG_MACRO_START \
|
CYG_TEST_FAIL( _msg_ ); \
|
CYG_TEST_FAIL( _msg_ ); \
|
CYG_TEST_FINISH("done"); \
|
CYG_TEST_FINISH("done"); \
|
CYG_MACRO_END
|
CYG_MACRO_END
|
|
|
|
|
#define CYG_TEST_CHECK( _chk_ , _msg_) \
|
#define CYG_TEST_CHECK( _chk_ , _msg_) \
|
CYG_MACRO_START \
|
CYG_MACRO_START \
|
(void)(( _chk_ ) || ( CYG_TEST_FAIL( _msg_ ) , cyg_test_exit(), 1)); \
|
(void)(( _chk_ ) || ( CYG_TEST_FAIL( _msg_ ) , cyg_test_exit(), 1)); \
|
CYG_MACRO_END
|
CYG_MACRO_END
|
|
|
#define CYG_TEST_PASS_FAIL( _cdn_, _msg_ ) \
|
#define CYG_TEST_PASS_FAIL( _cdn_, _msg_ ) \
|
CYG_MACRO_START \
|
CYG_MACRO_START \
|
if ( _cdn_ ) CYG_TEST_PASS( _msg_ ); else CYG_TEST_FAIL( _msg_ ); \
|
if ( _cdn_ ) CYG_TEST_PASS( _msg_ ); else CYG_TEST_FAIL( _msg_ ); \
|
CYG_MACRO_END
|
CYG_MACRO_END
|
|
|
|
|
// CYG_TEST_PASS_EXIT and CYG_TEST_FAIL_EXIT are now obscelete,
|
// CYG_TEST_PASS_EXIT and CYG_TEST_FAIL_EXIT are now obscelete,
|
// but are here for now
|
// but are here for now
|
// to avoid breaking testcases which still use them. They will
|
// to avoid breaking testcases which still use them. They will
|
// soon go away.
|
// soon go away.
|
#define CYG_TEST_PASS_EXIT( _msg_ ) \
|
#define CYG_TEST_PASS_EXIT( _msg_ ) \
|
(cyg_test_output(CYGNUM_TEST_PASS, _msg_, __LINE__, __FILE__), \
|
(cyg_test_output(CYGNUM_TEST_PASS, _msg_, __LINE__, __FILE__), \
|
CYG_TEST_EXIT("done"))
|
CYG_TEST_EXIT("done"))
|
|
|
#define CYG_TEST_FAIL_EXIT( _msg_ ) \
|
#define CYG_TEST_FAIL_EXIT( _msg_ ) \
|
(cyg_test_output(CYGNUM_TEST_FAIL, _msg_, __LINE__, __FILE__), \
|
(cyg_test_output(CYGNUM_TEST_FAIL, _msg_, __LINE__, __FILE__), \
|
CYG_TEST_EXIT("done"))
|
CYG_TEST_EXIT("done"))
|
|
|
|
|
#endif // CYGONCE_INFRA_TESTCASE_H
|
#endif // CYGONCE_INFRA_TESTCASE_H
|
// EOF testcase.h
|
// EOF testcase.h
|
|
|