test_env.h

Go to the documentation of this file.

// ================================================================= //
//                                                                   //
//   File      : test_env.h                                          //
//   Purpose   : parsimony unittest toolkit                          //
//                                                                   //
//   Coded by Ralf Westram (coder@reallysoft.de) in September 2014   //
//   http://www.arb-home.de/                                         //
//                                                                   //
// ================================================================= //

#ifndef TEST_ENV_H
#define TEST_ENV_H

void fake_AW_init_color_groups();

template<typename SEQTYPE>
struct fake_agt FINAL_TYPE : public AWT_graphic_parsimony, virtual Noncopyable {
    SEQTYPE *templ;
    LocallyModify<int> permit_flag_updates; // w/o need for AWT_auto_refresh instances in unit tests

    fake_agt(ArbParsimony& parsimony_)
        : AWT_graphic_parsimony(parsimony_, ap_main->get_gb_main(), NULp),
          templ(NULp),
          permit_flag_updates(exports.get_modifying_flag_ref(), -1)
    {}
    ~fake_agt() OVERRIDE {
        delete templ;
    }
    void init(AliView *aliview) {
        fake_AW_init_color_groups(); // acts like color_groups were active
        delete templ;
        templ = aliview->has_data() ? new SEQTYPE(aliview) : NULp;
        AWT_graphic_parsimony::init(aliview, templ, true, false);
    }

    void read_tree_settings() OVERRIDE {
        // only needs to set members needed to compute_tree()
        groupScale.pow    = .33;
        groupScale.linear = 1.0;
    }
};


template<typename SEQTYPE>
class PARSIMONY_testenv : virtual Noncopyable {
    GB_shell           shell;
    AP_main            apMain;
    fake_agt<SEQTYPE> *agt;
    ArbParsimony       parsimony;
    long               prev_combine_count;
    KL_Settings       *klSettings;

    void common_init(const char *dbname) {
        apMain.open(dbname);

        TEST_EXPECT_NULL(ap_main);
        ap_main = &apMain;

        agt = new fake_agt<SEQTYPE>(parsimony);
        parsimony.set_tree(agt);

        prev_combine_count = AP_combinableSeq::combine_count();
    }

public:
    PARSIMONY_testenv(const char *dbname)
        : parsimony(),
          klSettings(NULp)
    {
        common_init(dbname);
        agt->init(new AliView(ap_main->get_gb_main()));
    }
    PARSIMONY_testenv(const char *dbname, const char *aliName);
    ~PARSIMONY_testenv() {
        if (root_node()) {
            AP_tree_edge::destroy(root_node());
        }

        TEST_EXPECT_EQUAL(ap_main, &apMain);
        ap_main = NULp;

        delete agt;
        delete klSettings;

        ap_assert(prev_combine_count == AP_combinableSeq::combine_count()); // please add tests documenting combines_performed()
    }

    AP_tree_nlen *root_node() {
        AP_tree_nlen *root = apMain.get_root_node();
        ap_assert(root == graphic_tree()->get_root_node());
        return root;
    }
    AP_pars_root *tree_root() { return agt->get_tree_root(); }

    GB_ERROR load_tree(const char *tree_name) {
        GBDATA         *gb_main = ap_main->get_gb_main();
        GB_transaction  ta(gb_main);     // @@@ do inside AWT_graphic_tree::load?
        GB_ERROR        error   = agt->load_from_DB(gb_main, tree_name);
        if (!error) {
            AP_tree_edge::initialize(rootNode());   // builds edges

            ap_assert(root_node());
            ap_assert(root_node() == rootNode()); // need tree-access via global 'ap_main' (too much code is based on that)
            ap_assert(rootEdge());

            ASSERT_VALID_TREE(root_node());
        }
        return error;
    }

    void push() { apMain.remember(); }
    void push_whole_tree() { apMain.remember_whole_tree(); }
    void pop() { apMain.revert(); }
    void accept() { apMain.accept(); }
    void accept_if(bool cond) { apMain.accept_if(cond); }

#if defined(ASSERTION_USED) || defined(UNIT_TESTS)
    Validity pop_will_produce_valid_tree() { return apMain.revert_will_produce_valid_tree(); }
    Validity all_available_pops_will_produce_valid_trees() { return apMain.all_available_reverts_will_produce_valid_trees(); }
#endif

    Level get_frame_level() { return apMain.get_frameLevel(); }
    Level get_user_push_counter() { return apMain.get_user_push_counter(); }

    AWT_graphic_parsimony *graphic_tree() { return agt; }

    GBDATA *gbmain() const { return apMain.get_gb_main(); }

    long combines_performed() {
        long performed     = AP_combinableSeq::combine_count()-prev_combine_count;
        prev_combine_count = AP_combinableSeq::combine_count();
        return performed;
    }

    void compute_tree() { root_node()->compute_tree(); }

    KL_Settings& get_KL_settings() {
        ap_assert(klSettings);
        return *klSettings;
    }

#if defined(PROVIDE_PRINT)
    void dump2file(const char *name) { apMain.dump2file(name); }
#endif
};

// ---------------------------
//      expected combines

# define TEST_EXPECT_COMBINES_PERFORMED(env,expComb) TEST_EXPECT_EQUAL((env).combines_performed(), expComb)


#else
#error test_env.h included twice
#endif // TEST_ENV_H