db/tests.h

#include <dballe/core/data.h>
#include <dballe/db/db.h>
#include <dballe/db/fwd.h>
#include <dballe/db/summary.h>
#include <dballe/db/v7/fwd.h>
#include <dballe/msg/tests.h>
#include <dballe/sql/fwd.h>
#include <dballe/values.h>
#include <functional>
#include <utility>

namespace dballe {
namespace tests {

impl::Messages messages_from_db(std::shared_ptr<db::Transaction> tr,
                                const dballe::Query& query);
impl::Messages messages_from_db(std::shared_ptr<db::Transaction> tr,
                                const char* query);

struct TestDataSet
{
    std::map<std::string, core::Data> stations;
    std::map<std::string, core::Data> data;

    TestDataSet() {}
    virtual ~TestDataSet() {}

    void populate_db(dballe::DB& db);
    virtual void populate_transaction(Transaction& tr);
};

struct EmptyTestDataset
{
    void populate_db();
};

struct OldDballeTestDataSet : public TestDataSet
{
    OldDballeTestDataSet();
};

bool has_driver(const std::string& backend);

struct V7DB
{
    typedef db::v7::DB DB;
    typedef db::v7::Transaction TR;
    static const auto format = db::Format::V7;
    static std::shared_ptr<DB> create_db(const std::string& backend, bool wipe);
};

template <typename DB> struct BaseDBFixture : public Fixture
{
    std::string backend;
    std::shared_ptr<typename DB::DB> db;
    bool destroys_db = false;

    BaseDBFixture(const char* backend);
    virtual ~BaseDBFixture();

    void test_setup();
    void test_teardown();
    virtual void create_db();
    bool has_driver();
};

template <typename DB> struct EmptyTransactionFixture : public BaseDBFixture<DB>
{
    using BaseDBFixture<DB>::BaseDBFixture;
    std::shared_ptr<typename DB::TR> tr;

    void test_setup();
    void test_teardown();
    void populate(TestDataSet& data_set);
};

template <typename DB, typename TestData>
struct TransactionFixture : public EmptyTransactionFixture<DB>
{
    using EmptyTransactionFixture<DB>::EmptyTransactionFixture;

    TestData test_data;

    void create_db() override
    {
        EmptyTransactionFixture<DB>::create_db();
        wassert(test_data.populate_db(*this->db));
    }
};

template <typename DB> struct DBFixture : public BaseDBFixture<DB>
{
    using BaseDBFixture<DB>::BaseDBFixture;

    void test_setup();
    void populate_database(TestDataSet& data_set);
};

struct ActualCursor : public Actual<std::shared_ptr<dballe::Cursor>>
{
    using Actual::Actual;

    void station_keys_match(const DBStation& expected);

    void data_context_matches(const Data& expected);

    void data_var_matches(const Data& expected, wreport::Varcode code)
    {
        data_var_matches(core::Data::downcast(expected).values.var(code));
    }
    void data_var_matches(const DBValues& expected)
    {
        if (auto c =
                std::dynamic_pointer_cast<dballe::db::CursorStation>(_actual))
        {
            DBValues actual_values = c->get_values();
            if (!actual_values.vars_equal(expected))
                // Quick hack to get proper formatting of mismatch
                wassert(actual(c->get_values()) == expected);
        }
        else if (auto c = std::dynamic_pointer_cast<dballe::CursorStationData>(
                     _actual))
            data_var_matches(expected.var(c->get_varcode()));
        else if (auto c =
                     std::dynamic_pointer_cast<dballe::CursorData>(_actual))
            data_var_matches(expected.var(c->get_varcode()));
        else
            throw wreport::error_consistency(
                "cannot call data_var_matches on this kind of cursor");
    }
    void data_var_matches(const Values& expected, wreport::Varcode code)
    {
        data_var_matches(expected.var(code));
    }
    void data_var_matches(const wreport::Var& expected);

    void data_matches(const Data& ds)
    {
        if (auto c =
                std::dynamic_pointer_cast<dballe::CursorStationData>(_actual))
            data_matches(ds, c->get_varcode());
        else if (auto c =
                     std::dynamic_pointer_cast<dballe::CursorData>(_actual))
            data_matches(ds, c->get_varcode());
        else
            throw wreport::error_consistency(
                "cannot call data_matches on this kind of cursor");
    }
    void data_matches(const Data& ds, wreport::Varcode code);
};

typedef std::function<void(const db::DBSummary&)> result_checker;

template <typename DB> struct ActualDB : public Actual<std::shared_ptr<DB>>
{
    using Actual<std::shared_ptr<DB>>::Actual;

    void try_data_query(const std::string& query, unsigned expected);

    void try_data_query(const Query& query, unsigned expected);

    void try_station_query(const std::string& query, unsigned expected);

    void try_summary_query(const std::string& query, unsigned expected,
                           result_checker checker = nullptr);
};

inline ActualCursor actual(std::shared_ptr<dballe::Cursor>& actual)
{
    return ActualCursor(actual);
}
inline ActualCursor actual(std::shared_ptr<dballe::CursorStation>& actual)
{
    return ActualCursor(actual);
}
inline ActualCursor actual(std::shared_ptr<dballe::CursorStationData>& actual)
{
    return ActualCursor(actual);
}
inline ActualCursor actual(std::shared_ptr<dballe::CursorData>& actual)
{
    return ActualCursor(actual);
}
inline ActualCursor actual(std::shared_ptr<dballe::CursorSummary>& actual)
{
    return ActualCursor(actual);
}
inline ActualDB<dballe::DB> actual(std::shared_ptr<dballe::DB> actual)
{
    return ActualDB<dballe::DB>(actual);
}
ActualDB<dballe::DB> actual(std::shared_ptr<dballe::db::v7::DB> actual);
inline ActualDB<dballe::db::Transaction>
actual(std::shared_ptr<dballe::db::Transaction> actual)
{
    return ActualDB<dballe::db::Transaction>(actual);
}
ActualDB<dballe::db::Transaction>
actual(std::shared_ptr<dballe::db::v7::Transaction> actual);

extern template class BaseDBFixture<V7DB>;
extern template class DBFixture<V7DB>;
extern template class EmptyTransactionFixture<V7DB>;
extern template class ActualDB<dballe::DB>;
extern template class ActualDB<dballe::db::Transaction>;

} // namespace tests
} // namespace dballe