source: trunk/include/Arm4DbTest.h @ 704

/**********************************************************************
 * Copyright (c) 2005-2008 David Carter <dcarter@arm4.org> and others.
 * All rights reserved.   This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors: 
 * David Carter - Initial API and implementation
 **********************************************************************/

#ifndef LIBARM4DBTEST_H /* Prevent multiple inclusion */
#define LIBARM4DBTEST_H 1

#include "Arm4db.h"
#include "Arm4DbTestDaemon.h"

#if LONG_MAX == 2147483647l
#define UNINITIALIZED_HANDLE 0x1234567890123456ll
#else
#define UNINITIALIZED_HANDLE 0x1234567890123456l
#endif

class Arm4DbTest {
public:
        /* Constructors */
        Arm4DbTest (const std::string &testProgramName);
        Arm4DbTest (const std::string &config_name, const std::string &testProgramName);
        Arm4DbTest ();

        /* Destructors */
        virtual ~Arm4DbTest ();

        /* Accessors */
        const std::string &getTest (void) const { return m_testName; }
        const std::string &getTestGroup (void) const { return m_testGroupName; }
        int getPassCount (void) const { return m_passCount; }
        int getFailCount (void) const { return m_failCount; }

        /* Mutators */
        void setTest (const std::string &name) { m_testName = name; }
        void clearTest (void) { m_testName = ""; }
        void setTestGroup (const std::string &name) { m_testGroupName = name; }
        void clearTestGroup (void) { m_testGroupName = ""; }
        void clearCounters (void) { m_passCount = m_failCount = 0; }

        /* Operations */
        void setInstance (void);
        void assertFailed (const std::string &description);
        void assertPassed (const std::string &description);
        bool assertPass (const std::string &description, int result) { return assertPass (description, (bool) result); }
        bool assertPass (const std::string &description, bool result);
        bool assertFail (const std::string &description, int result) { return assertFail (description, (bool) result); }
        bool assertFail (const std::string &description, bool result);
        bool assertEqual (const std::string &description, int result1, int result2);
        bool assertEqual (const std::string &description, const std::string &result1, const std::string &result2);
        bool assertEqual (const std::string &description, const arm_id_t &id1, const arm_id_t &id2);
        bool assertNotEqual (const std::string &description, int result1, int result2);
        bool assertNotEqual (const std::string &description, const std::string &result1, const std::string &result2);
        bool assertNotEqual (const std::string &description, const arm_id_t &id1, const arm_id_t &id2);
        bool assertEmpty (const std::string &description, const arm_id_t &id);
        bool assertEmpty (const std::string &description, const arm_int64_t handle);
        bool assertNotEmpty (const std::string &description, const arm_id_t &id);
        bool assertNotEmpty (const std::string &description, const arm_int64_t handle);
        bool assertValid (const std::string &description, const arm_id_t &id);
        bool assertValid (const std::string &description, const arm_int64_t handle);
        bool assertNotValid (const std::string &description, const arm_id_t &id);
        bool assertNotValid (const std::string &description, const arm_int64_t handle);
        bool assertNull (const std::string &description, const void *data_ptr);
        bool assertNotNull (const std::string &description, const void *data_ptr);

        void validateExports (Arm4DbTestDaemon &daemon);

        void showResults (void) const;

        static bool equal (const arm_id_t &id1, const arm_id_t &id2);
        static bool empty (const arm_id_t &id);
        static bool empty (const arm_int64_t handle);
        static bool valid (const arm_id_t &id);
        static bool valid (const arm_int64_t handle);
        static void print (const arm_id_t &id);
        static void initializeId (arm_id_t &id);
        static void initializeHandle (arm_int64_t &handle);

        static std::string testString (const char *string_ptr, int max_length);

        /* Operators */

protected:

private:
        /* Mark these as private to prevent their use */
        Arm4DbTest (const Arm4DbTest &);
        Arm4DbTest &operator= (const Arm4DbTest &);

        const Arm4dbConfig &getConfig (void) { return Arm4dbConfig::getConfig (); }

        void importTest (const std::string &testName, const std::string &reference_xml, Arm4DbTestDaemon &daemon);
        void importDefinitionsTest (const std::string &testName, const std::string &reference_xml, Arm4DbTestDaemon &daemon);

        std::string m_testName;
        std::string m_testGroupName;
        std::string m_testProgramName;
        int m_passCount;
        int m_failCount;

        static arm_id_t m_fill;
};

#endif /* LIBARM4DBTEST_H */