testDatahash1.cpp

Go to the documentation of this file.

/*
 * testDathash1.cpp
 *
 * Copyright (C) 2008  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Test for the datahash routines.
 */

// includes --------------------------------------------------------------------
#include "datahash/datahash.h"  // always include our own header file first!

#include <fstream>

#include "common/wave_ex.h"
#include "datahash/datahash_text.h"
#include "datahash/datahash_util.h"
#include "perf/perf.h"



static const char * s_filename          = "testhash-1.txt";

struct key_value_t {
        const char *    key;
        const char *    value;
};


static const key_value_t s_funkyLines[] = {
    { "funky",          "This is a funky line! [] @/^\\$() _~`<>,. { } | += --- \t yup!" },
    { "greek",          "Μπορῶ νὰ φάω σπασμένα γυαλιὰ χωρὶς νὰ πάθω τίποτα." },
    { "frenchProvencal","Pòdi manjar de veire, me nafrariá pas." },
    { "georgian",       "მინას ვჭამ და არა მტკივა." },
    { "macedonian",     "Можам да јадам стакло, а не ме штета." },
    { "japanese",       "私はガラスを食べられます。それは私を傷つけません。" },
    { "chinese",        "我能吞下玻璃而不伤身体。" },

    // keep this last
    { NULL, NULL }
};


////////////////////////////////////////////////////////////////////////////////
//
//      static helper methods
//
////////////////////////////////////////////////////////////////////////////////

static void
addSubhash
(
IN Datahash * h,
IN const char * key
)
{
        ASSERT(h, "null");
        ASSERT(key, "null");

        smart_ptr<Datahash> subhash = Datahash::create();
        ASSERT(subhash, "out of memory");

        h->insert(key, subhash);
}



static void
addToSubhash
(
IN Datahash * h,
IN const char * hashname,
IN const char * key,
IN const char * value
)
{
        ASSERT(h, "null");
        ASSERT(hashname, "null");
        ASSERT(key, "null");
        ASSERT(value, "null");

        smart_ptr<Datahash> sub = getSubhash(h, hashname);
        ASSERT(sub, "null");

        sub->insert(key, value);
}



static void
verifyBadAdd
(
IN Datahash * h,
IN const char * key,
IN const char * value
)
{
        ASSERT(h, "null");
        ASSERT(key, "null");
        ASSERT(value, "null");

        bool caughtException = false;
        try {
                h->insert(key, value);
        } catch (std::exception& e) {
                caughtException = true;
        }

        if (!caughtException) {
                WAVE_EX(wex);
                wex << "Illegal add-to-hash of key='" << key << "' and value='";
                wex << value << "' should have thrown exception but did not!";
        }
}



static void
writeHash
(
IN const Datahash * hash
)
{
        ASSERT(hash, "null");

        std::ofstream outfile(s_filename);
        if (!outfile.good()) {
                WAVE_EX(wex);
                wex << "Failed to open file for writing: " << s_filename;
        }

        writeHashToStream(hash, outfile);
}



static void
verifySubhash
(
IN const Datahash * h,
IN const char * name
)
{
        ASSERT(h, "null");
        ASSERT(name, "null");

        smart_ptr<Datahash> sub = getSubhash(h, name);
        ASSERT(sub, "null");
}



static void
verifySubhashValue
(
IN const Datahash * h,
IN const char * name,
IN const char * key,
IN const char * value
)
{
        ASSERT(h, "null");
        ASSERT(name, "null");
        ASSERT(key, "null");
        ASSERT(value, "null");

        smart_ptr<Datahash> sub = getSubhash(h, name);
        ASSERT(sub, "null");

        Datahash::iterator_t i;
        sub->getIterator(key, i);
        std::string k;
        hash_value_t hv;
        while (sub->getNextElement(i, k, hv)) {
                if (eHashDataType_String != hv.type) {
                        continue;       // skip this non-string entry
                }
                const char * val = hv.text.c_str();
                if (!strcmp(val, value))
                        return;
        }

        WAVE_EX(wex);
        wex << "Failed to find value '" << value << "' for key '" << key;
        wex << "' in subhash '" << name << "'";
}



static void
verifyMissing
(
IN const Datahash * h,
IN const char * key
)
{
        ASSERT(h, "null");
        ASSERT(key, "null");

        bool caughtException = false;
        try {
                getString(h, key);
        } catch (std::exception& e) {
                caughtException = true;
        }

        if (!caughtException) {
                WAVE_EX(wex);
                wex << "Should have failed to find key '" << key << "' ";
                wex << "in hash, but no exception was thrown!";
        }
}



static void
doTest
(
void
)
{
        // create a new, nested hash
        smart_ptr<Datahash> hash = Datahash::create();
        ASSERT(hash, "out of memory");

        addSubhash(hash, "foo");
        addSubhash(hash, "bar");

        addToSubhash(hash, "bar", "text", "This is long, long text!  Yessir.");

        addToSubhash(hash, "foo", "key1", "value1");
        addToSubhash(hash, "foo", "key1", "value2");
        addToSubhash(hash, "foo", "key1", "value3");

        // verify failure
        verifyBadAdd(hash, "key-1", "value-1");
        verifyBadAdd(hash, "0key", "value-1");
        verifyBadAdd(hash, "유리를", "value-2");     // korean
        verifyBadAdd(hash, "Можам", "value-3");            // macedonian
        // add a funky line to a deeper subhash
        smart_ptr<Datahash> subhash = getSubhash(hash, "foo");
        addSubhash(subhash, "xyz");
        for (const key_value_t * p = s_funkyLines; p->key; ++p) {
                addToSubhash(subhash, "xyz", p->key, p->value);
        }

        // write to file
        writeHash(hash);

        // resurrect from file in new hash
        smart_ptr<Datahash> hash2 = readHashFromTextFile(s_filename);
        ASSERT(hash2, "failed to read hash?");

        // verify everything is there
        verifySubhash(hash2, "bar");
        verifySubhashValue(hash2, "bar", "text",
                "This is long, long text!  Yessir.");

        verifySubhash(hash2, "foo");
        verifySubhashValue(hash2, "foo", "key1", "value1");
        verifySubhashValue(hash2, "foo", "key1", "value2");
        verifySubhashValue(hash2, "foo", "key1", "value3");

        smart_ptr<Datahash> subhash2 = getSubhash(hash2, "foo");
        verifySubhash(subhash2, "xyz");
        for (const key_value_t * p = s_funkyLines; p->key; ++p) {
                verifySubhashValue(subhash2, "xyz", p->key, p->value);
        }

        // verify stuff is NOT there!
        verifyMissing(hash2, "key");
        verifyMissing(subhash2, "key1");
}



////////////////////////////////////////////////////////////////////////////////
//
//      entry point
//
////////////////////////////////////////////////////////////////////////////////

int
main
(
IN int argc,
IN const char * argv[]
)
{
        int retval = 0;
        try {
                perf::Timer timer("overall timer");
                doTest();

        } catch (std::exception& e) {
                DPRINTF("Exception: %s", e.what());
                retval = 1;
        } catch (...) {
                DPRINTF("Unknown exception!");
                retval = 2;
        }
        perf::dumpTimingSummary(std::cerr);

        return retval;
}