/*
 *  The Mana World Server
 *  Copyright 2004 The Mana World Development Team
 *
 *  This file is part of The Mana World.
 *
 *  The Mana World  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
 *  Software Foundation; either version 2 of the License, or any later version.
 *
 *  The Mana  World is  distributed in  the hope  that it  will be  useful, but
 *  WITHOUT ANY WARRANTY; without even  the implied warranty of MERCHANTABILITY
 *  or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 *  more details.
 *
 *  You should  have received a  copy of the  GNU General Public  License along
 *  with The Mana  World; if not, write to the  Free Software Foundation, Inc.,
 *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 *  $Id$
 */


#ifndef _TMWSERV_TEST_STORAGE_H_
#define _TMWSERV_TEST_STORAGE_H_


#include <bitset>
#include <vector>

#include <cppunit/extensions/HelperMacros.h>

#include "../dal/dataproviderfactory.h"


/**
 * Requirements:
 *     - if using MySQL or PostgreSQL as backends, then make sure that a user
 *       named 'guest' with the password 'guest' has enough privileges to
 *       create tables and populate them in a database named 'tmwteststorage'
 *       prior to running the teststorage unit tests.
 */


using namespace tmwserv::dal;


/**
 * Unit test for the Storage class.
 */
class StorageTest: public CppUnit::TestFixture
{
    CPPUNIT_TEST_SUITE(StorageTest);

    // add tests to the test suite.
    CPPUNIT_TEST(testGetAccount1);
    CPPUNIT_TEST(testGetAccount2);
    CPPUNIT_TEST(testAddAccount1);
    CPPUNIT_TEST(testAddAccount2);
    CPPUNIT_TEST(testUpdAccount1);
    CPPUNIT_TEST(testUpdAccount2);
    CPPUNIT_TEST(testDelAccount1);
    CPPUNIT_TEST(testDelAccount2);
    CPPUNIT_TEST(testDelAccount3);
    CPPUNIT_TEST(testDelAccount4);
    CPPUNIT_TEST(testDelAccount5);

    CPPUNIT_TEST_SUITE_END();


    public:
        /**
         * Set up fixtures.
         */
        void
        setUp(void);


        /**
         * Tear down fixtures.
         */
        void
        tearDown(void);


        /**
         * Fetch an existing account from the database.
         */
        void
        testGetAccount1(void);


        /**
         * Fetch an unexisting account from the database.
         */
        void
        testGetAccount2(void);


        /**
         * Test passing a null pointer to addAcccount().
         */
        void
        testAddAccount1(void);


        /**
         * Test adding a new account.
         */
        void
        testAddAccount2(void);


        /**
         * Test updating an existing account with new characters.
         */
        void
        testUpdAccount1(void);


        /**
         * Test updating an existing account with a new password and new
         * character stats.
         */
        void
        testUpdAccount2(void);


        /**
         * Test deleting an account that exists in the database but not
         * loaded yet in memory.
         */
        void
        testDelAccount1(void);


        /**
         * Test deleting an account that was added to the storage but not
         * yet persisted.
         */
        void
        testDelAccount2(void);


        /**
         * Test deleting an account that exists in the database and loaded
         * in memory.
         */
        void
        testDelAccount3(void);


        /**
         * Test deleting an account that does not exist.
         */
        void
        testDelAccount4(void);


        /**
         * Test deleting twice an account that exists in the database and
         * loaded in memory.
         */
        void
        testDelAccount5(void);


    private:
        /**
         * Initialize the storage.
         */
        void
        initStorage(void);


        /**
         * Clean the storage.
         */
        void
        cleanStorage(void);


        /**
         * Drop a table.
         *
         * @param db the database.
         * @param name the table name.
         */
        void
        dropTable(std::auto_ptr<DataProvider>& db,
                  const std::string& name);


        /**
         * Insert a new account.
         *
         * @param db the database.
         * @param name the user name.
         */
        void
        insertAccount(std::auto_ptr<DataProvider>&,
                      const std::string& name);


        /**
         * Enumeration type for the bits.
         * Each bit represents a particular check.
         */
        enum CheckValues {
            CHK_DEFAULT_ACCOUNTS,
            CHK_1ST_ACCOUNT_DELETED,
            CHK_NEW_ADDED_ACCOUNT,
            CHK_CHARACTERS_1,
            CHK_CHARACTERS_4,
            CHK_CHARACTERS_UPDATE_1,
            CHK_NO_CHARACTERS_1,
            NUM_CHECKS
        };


        /**
         * Type definition for the checks.
         */
        typedef std::bitset<NUM_CHECKS> Checks;


        /**
         * Check the state of the database.
         *
         * @param what bitmask that contains information about what to check.
         */
        void
        checkDb(const Checks& what);


    private:
        static std::string mStorageName;         /**< name of the storage */
        static std::string mStorageUser;         /**< storage user */
        static std::string mStorageUserPassword; /**< user password */
};


#endif // _TMWSERV_TEST_STORAGE_H_