server/src/study.test.c

#include <platform.h>

#include "study.h"

#include <kernel/config.h>
#include <kernel/building.h>
#include <kernel/faction.h>
#include <kernel/item.h>
#include <kernel/order.h>
#include <kernel/race.h>
#include <kernel/region.h>
#include <kernel/unit.h>
#include <util/rand.h>
#include <util/message.h>
#include <util/language.h>
#include <util/base36.h>
#include <tests.h>

#include <assert.h>

#include <CuTest.h>

#define MAXLOG 4
typedef struct log_entry {
    unit *u;
    skill_t sk;
    int days;
} log_entry;

static log_entry log_learners[MAXLOG];
static int log_size;

static void log_learn(unit *u, skill_t sk, int days) {
    if (log_size < MAXLOG) {
        log_entry * entry = &log_learners[log_size++];
        entry->u = u;
        entry->sk = sk;
        entry->days = days;
    }
}

void learn_inject(void) {
    log_size = 0;
    inject_learn(log_learn);
}

void learn_reset(void) {
    inject_learn(0);
}

typedef struct {
    unit *u;
    unit *teachers[2];
} study_fixture;

static void setup_locale(struct locale *lang) {
    int i;
    for (i = 0; i < MAXSKILLS; ++i) {
        if (!locale_getstring(lang, mkname("skill", skillnames[i])))
            locale_setstring(lang, mkname("skill", skillnames[i]), skillnames[i]);
    }
    locale_setstring(lang, parameters[P_ANY], "ALLE");
    init_parameters(lang);
    init_skills(lang);
}

static void setup_study(study_fixture *fix, skill_t sk) {
    struct region * r;
    struct faction *f;
    struct locale *lang;

    assert(fix);
    test_setup();
    config_set("study.random_progress", "0");
    test_create_world();
    r = findregion(0, 0);
    f = test_create_faction(0);
    lang = get_or_create_locale(locale_name(f->locale));
    setup_locale(lang);
    fix->u = test_create_unit(f, r);
    assert(fix->u);
    fix->u->thisorder = create_order(K_STUDY, f->locale, "%s", skillnames[sk]);

    fix->teachers[0] = test_create_unit(f, r);
    assert(fix->teachers[0]);
    fix->teachers[0]->thisorder = create_order(K_TEACH, f->locale, "%s", itoa36(fix->u->no));

    fix->teachers[1] = test_create_unit(f, r);
    assert(fix->teachers[1]);
    fix->teachers[1]->thisorder = create_order(K_TEACH, f->locale, "%s", itoa36(fix->u->no));
    test_clear_messages(f);
}

static void test_study_no_teacher(CuTest *tc) {
    study_fixture fix;
    skill *sv;

    setup_study(&fix, SK_CROSSBOW);
    study_cmd(fix.u, fix.u->thisorder);
    CuAssertPtrNotNull(tc, sv = unit_skill(fix.u, SK_CROSSBOW));
    CuAssertIntEquals(tc, 1, sv->level);
    CuAssertIntEquals(tc, 2, sv->weeks);
    CuAssertPtrEquals(tc, 0, test_get_last_message(fix.u->faction->msgs));
    test_cleanup();
}

static void test_study_with_teacher(CuTest *tc) {
    study_fixture fix;
    skill *sv;

    setup_study(&fix, SK_CROSSBOW);
    set_level(fix.teachers[0], SK_CROSSBOW, TEACHDIFFERENCE);
    teach_cmd(fix.teachers[0], fix.teachers[0]->thisorder);
    CuAssertPtrEquals(tc, 0, test_get_last_message(fix.u->faction->msgs));
    study_cmd(fix.u, fix.u->thisorder);
    CuAssertPtrNotNull(tc, sv = unit_skill(fix.u, SK_CROSSBOW));
    CuAssertIntEquals(tc, 1, sv->level);
    CuAssertIntEquals(tc, 1, sv->weeks);
    test_cleanup();
}

static void test_study_with_bad_teacher(CuTest *tc) {
    study_fixture fix;
    skill *sv;

    setup_study(&fix, SK_CROSSBOW);
    teach_cmd(fix.teachers[0], fix.teachers[0]->thisorder);
    CuAssertPtrNotNull(tc, test_find_messagetype(fix.u->faction->msgs, "teach_asgood"));
    study_cmd(fix.u, fix.u->thisorder);
    CuAssertPtrNotNull(tc, sv = unit_skill(fix.u, SK_CROSSBOW));
    CuAssertIntEquals(tc, 1, sv->level);
    CuAssertIntEquals(tc, 2, sv->weeks);
    test_cleanup();
}

static void test_study_bug_2194(CuTest *tc) {
    unit *u, *u1, *u2;
    struct locale * loc;
    building * b;

    test_setup();
    random_source_inject_constant(0.0);
    init_resources();
    loc = get_or_create_locale("de");
    setup_locale(loc);
    u = test_create_unit(test_create_faction(0), test_create_region(0, 0, 0));
    scale_number(u, 2);
    set_level(u, SK_CROSSBOW, TEACHDIFFERENCE);
    u->faction->locale = loc;
    u1 = test_create_unit(u->faction, u->region);
    scale_number(u1, 17);
    u1->thisorder = create_order(K_STUDY, loc, skillnames[SK_CROSSBOW]);
    u2 = test_create_unit(u->faction, u->region);
    scale_number(u2, 3);
    u2->thisorder = create_order(K_STUDY, loc, skillnames[SK_MAGIC]);
    u->thisorder = create_order(K_TEACH, loc, "%s %s", itoa36(u1->no), itoa36(u2->no));
    b = test_create_building(u->region, test_create_buildingtype("academy"));
    b->size = 22;
    u_set_building(u, b);
    u_set_building(u1, b);
    u_set_building(u2, b);
    i_change(&u1->items, get_resourcetype(R_SILVER)->itype, 50);
    i_change(&u2->items, get_resourcetype(R_SILVER)->itype, 50);
    b->flags = BLD_MAINTAINED;
    learn_inject();
    teach_cmd(u, u->thisorder);
    learn_reset();
    CuAssertPtrEquals(tc, u, log_learners[0].u);
    CuAssertIntEquals(tc, SK_CROSSBOW, log_learners[0].sk);
    CuAssertIntEquals(tc, 1, log_size);
    CuAssertPtrNotNull(tc, test_find_messagetype(u->faction->msgs, "teach_asgood"));

    free_order(u->thisorder);
    u->thisorder = create_order(K_TEACH, loc, itoa36(u2->no));
    learn_inject();
    teach_cmd(u, u->thisorder);
    learn_reset();
    CuAssertIntEquals(tc, 0, log_size);
    test_cleanup();
}

static CuTest *g_tc;

static void cb_learn_one(unit *u, skill_t sk, int days) {
    CuAssertIntEquals(g_tc, SK_ALCHEMY, sk);
    CuAssertIntEquals(g_tc, 10, days);
}

static void cb_learn_two(unit *u, skill_t sk, int days) {
    CuAssertIntEquals(g_tc, SK_ALCHEMY, sk);
    CuAssertIntEquals(g_tc, 20, days);
}

static void test_produceexp(CuTest *tc) {
    unit *u;

    g_tc = tc;
    test_setup();
    u = test_create_unit(test_create_faction(0), test_create_region(0, 0, 0));
    scale_number(u, 2);
    config_set("study.produceexp", "20");
    produceexp_ex(u, SK_ALCHEMY, 1, cb_learn_one);
    produceexp_ex(u, SK_ALCHEMY, 2, cb_learn_two);
    test_cleanup();
}

static void test_academy_building(CuTest *tc) {
    unit *u, *u1, *u2;
    struct locale * loc;
    building * b;
    message * msg;

    test_setup();
    mt_register(mt_new_va("teach_asgood", "unit:unit", "region:region", "command:order", "student:unit", 0));

    random_source_inject_constant(0.0);
    init_resources();
    loc = get_or_create_locale("de");
    setup_locale(loc);
    u = test_create_unit(test_create_faction(0), test_create_region(0, 0, 0));
    scale_number(u, 2);
    set_level(u, SK_CROSSBOW, TEACHDIFFERENCE);
    u->faction->locale = loc;
    u1 = test_create_unit(u->faction, u->region);
    scale_number(u1, 15);
    u1->thisorder = create_order(K_STUDY, loc, skillnames[SK_CROSSBOW]);
    u2 = test_create_unit(u->faction, u->region);
    scale_number(u2, 5);
    u2->thisorder = create_order(K_STUDY, loc, skillnames[SK_CROSSBOW]);
    set_level(u2, SK_CROSSBOW, 1);
    u->thisorder = create_order(K_TEACH, loc, "%s %s", itoa36(u1->no), itoa36(u2->no));
    b = test_create_building(u->region, test_create_buildingtype("academy"));
    b->size = 22;
    u_set_building(u, b);
    u_set_building(u1, b);
    u_set_building(u2, b);
    i_change(&u1->items, get_resourcetype(R_SILVER)->itype, 50);
    i_change(&u2->items, get_resourcetype(R_SILVER)->itype, 50);
    b->flags = BLD_MAINTAINED;
    learn_inject();
    teach_cmd(u, u->thisorder);
    learn_reset();
    CuAssertPtrNotNull(tc, msg = test_find_messagetype(u->faction->msgs, "teach_asgood"));
    CuAssertPtrEquals(tc, u, (unit *)(msg)->parameters[0].v);
    CuAssertPtrEquals(tc, u2, (unit *)(msg)->parameters[3].v);

    CuAssertPtrEquals(tc, u, log_learners[0].u);
    CuAssertIntEquals(tc, SK_CROSSBOW, log_learners[0].sk);
    CuAssertIntEquals(tc, 15, log_learners[0].days);
    test_cleanup();
}

void test_learn_skill_single(CuTest *tc) {
    unit *u;
    skill *sv;
    test_setup();
    config_set("study.random_progress", "0");
    u = test_create_unit(test_create_faction(0), test_create_region(0, 0, 0));
    learn_skill(u, SK_ALCHEMY, STUDYDAYS);
    CuAssertPtrNotNull(tc, sv = u->skills);
    CuAssertIntEquals(tc, SK_ALCHEMY, sv->id);
    CuAssertIntEquals(tc, 1, sv->level);
    CuAssertIntEquals(tc, 2, sv->weeks);
    learn_skill(u, SK_ALCHEMY, STUDYDAYS);
    CuAssertIntEquals(tc, 1, sv->weeks);
    learn_skill(u, SK_ALCHEMY, STUDYDAYS * 2);
    CuAssertIntEquals(tc, 2, sv->level);
    CuAssertIntEquals(tc, 2, sv->weeks);
    test_cleanup();
}

void test_learn_skill_multi(CuTest *tc) {
    unit *u;
    skill *sv;
    test_setup();
    config_set("study.random_progress", "0");
    u = test_create_unit(test_create_faction(0), test_create_region(0, 0, 0));
    scale_number(u, 10);
    learn_skill(u, SK_ALCHEMY, STUDYDAYS * u->number);
    CuAssertPtrNotNull(tc, sv = u->skills);
    CuAssertIntEquals(tc, SK_ALCHEMY, sv->id);
    CuAssertIntEquals(tc, 1, sv->level);
    CuAssertIntEquals(tc, 2, sv->weeks);
    learn_skill(u, SK_ALCHEMY, STUDYDAYS * u->number);
    CuAssertIntEquals(tc, 1, sv->weeks);
    learn_skill(u, SK_ALCHEMY, STUDYDAYS  * u->number * 2);
    CuAssertIntEquals(tc, 2, sv->level);
    CuAssertIntEquals(tc, 2, sv->weeks);
    test_cleanup();
}

static void test_demon_skillchanges(CuTest *tc) {
    unit * u;
    const race * rc;
    test_setup();
    rc = test_create_race("demon");
    CuAssertPtrEquals(tc, (void *)rc, (void *)get_race(RC_DAEMON));
    u = test_create_unit(test_create_faction(rc), test_create_region(0, 0, 0));
    CuAssertPtrNotNull(tc, u);
    set_level(u, SK_CROSSBOW, 1);
    demon_skillchange(u);
    // TODO: sensing here
    test_cleanup();
}

static void test_study_cmd(CuTest *tc) {
    unit *u;
    test_setup();
    init_resources();
    u = test_create_unit(test_create_faction(0), test_create_region(0, 0, 0));
    u->thisorder = create_order(K_STUDY, u->faction->locale, "CROSSBOW");
    learn_inject();
    study_cmd(u, u->thisorder);
    learn_reset();
    CuAssertPtrEquals(tc, u, log_learners[0].u);
    CuAssertIntEquals(tc, SK_CROSSBOW, log_learners[0].sk);
    CuAssertIntEquals(tc, STUDYDAYS, log_learners[0].days);
    test_cleanup();
}

static void test_study_magic(CuTest *tc) {
    unit *u;
    faction *f;
    const struct locale *lang;
    const struct resource_type *rtype;

    test_setup();
    init_resources();
    f = test_create_faction(0);
    u = test_create_unit(f, test_create_region(0, 0, 0));
    lang = f->locale;
    CuAssertPtrNotNull(tc, rtype = get_resourcetype(R_SILVER));
    u->thisorder = create_order(K_STUDY, lang, "%s", skillnames[SK_MAGIC]);
    study_cmd(u, u->thisorder);
    CuAssertPtrNotNull(tc, test_find_messagetype(f->msgs, "error178"));
    free_order(u->thisorder);

    test_clear_messages(f);
    u->thisorder = create_order(K_STUDY, lang, "%s %s", skillnames[SK_MAGIC], magic_school[M_GWYRRD]);
    study_cmd(u, u->thisorder);
    CuAssertPtrNotNull(tc, test_find_messagetype(f->msgs, "error65"));

    test_clear_messages(f);
    i_change(&u->items, rtype->itype, 100);
    study_cmd(u, u->thisorder);
    CuAssertIntEquals(tc, M_GWYRRD, f->magiegebiet);
    CuAssertIntEquals(tc, 0, i_get(u->items, rtype->itype));
    CuAssertPtrNotNull(tc, get_mage(u));
    CuAssertPtrEquals(tc, 0, test_find_messagetype(f->msgs, "error65"));
    CuAssertIntEquals(tc, M_GWYRRD, get_mage(u)->magietyp);

    /* the static cost array in study_cost prevents this test:
    test_clear_messages(f);
    config_set("skills.cost.magic", "50");
    i_change(&u->items, rtype->itype, 50);
    study_cmd(u, u->thisorder);
    CuAssertPtrEquals(tc, 0, test_find_messagetype(f->msgs, "error65"));
    */

    test_cleanup();
}

static void test_study_cost(CuTest *tc) {
    unit *u;
    const struct item_type *itype;

    test_setup();
    init_resources();
    itype = get_resourcetype(R_SILVER)->itype;
    u = test_create_unit(test_create_faction(0), test_create_region(0, 0, 0));
    scale_number(u, 2);
    u->thisorder = create_order(K_STUDY, u->faction->locale, skillnames[SK_ALCHEMY]);
    i_change(&u->items, itype, u->number * study_cost(u, SK_ALCHEMY));
    learn_inject();
    study_cmd(u, u->thisorder);
    learn_reset();
    CuAssertPtrEquals(tc, u, log_learners[0].u);
    CuAssertIntEquals(tc, SK_ALCHEMY, log_learners[0].sk);
    CuAssertIntEquals(tc, STUDYDAYS*u->number, log_learners[0].days);
    CuAssertIntEquals(tc, 0, i_get(u->items, itype));
    test_cleanup();
}

static void test_teach_cmd(CuTest *tc) {
    unit *u, *ut;
    test_setup();
    init_resources();
    u = test_create_unit(test_create_faction(0), test_create_region(0, 0, 0));
    scale_number(u, 10);
    u->thisorder = create_order(K_STUDY, u->faction->locale, "CROSSBOW");
    ut = test_create_unit(u->faction, u->region);
    set_level(ut, SK_CROSSBOW, TEACHDIFFERENCE);
    ut->thisorder = create_order(K_TEACH, u->faction->locale, itoa36(u->no));
    learn_inject();
    teach_cmd(ut, ut->thisorder);
    study_cmd(u, u->thisorder);
    learn_reset();
    CuAssertPtrEquals(tc, u, log_learners[0].u);
    CuAssertIntEquals(tc, SK_CROSSBOW, log_learners[0].sk);
    CuAssertIntEquals(tc, STUDYDAYS*2*u->number, log_learners[0].days);
    test_cleanup();
}

static void test_teach_two(CuTest *tc) {
    unit *u1, *u2, *ut;
    test_setup();
    init_resources();
    u1 = test_create_unit(test_create_faction(0), test_create_region(0, 0, 0));
    scale_number(u1, 5);
    u1->thisorder = create_order(K_STUDY, u1->faction->locale, "CROSSBOW");
    u2 = test_create_unit(u1->faction, u1->region);
    scale_number(u2, 5);
    u2->thisorder = create_order(K_STUDY, u2->faction->locale, "CROSSBOW");
    ut = test_create_unit(u1->faction, u1->region);
    set_level(ut, SK_CROSSBOW, TEACHDIFFERENCE);
    ut->thisorder = create_order(K_TEACH, ut->faction->locale, "%s %s", itoa36(u1->no), itoa36(u2->no));
    learn_inject();
    teach_cmd(ut, ut->thisorder);
    study_cmd(u1, u1->thisorder);
    study_cmd(u2, u2->thisorder);
    learn_reset();
    CuAssertPtrEquals(tc, u1, log_learners[0].u);
    CuAssertIntEquals(tc, SK_CROSSBOW, log_learners[0].sk);
    CuAssertIntEquals(tc, STUDYDAYS * 2 * u1->number, log_learners[0].days);
    CuAssertPtrEquals(tc, u2, log_learners[1].u);
    CuAssertIntEquals(tc, SK_CROSSBOW, log_learners[1].sk);
    CuAssertIntEquals(tc, STUDYDAYS * 2 * u2->number, log_learners[1].days);
    test_cleanup();
}

static void test_teach_two_skills(CuTest *tc) {
    unit *u1, *u2, *ut;
    faction *f;
    region *r;

    test_setup();
    init_resources();
    f = test_create_faction(0);
    r = test_create_region(0, 0, 0);
    u1 = test_create_unit(f, r);
    scale_number(u1, 5);
    u1->thisorder = create_order(K_STUDY, f->locale, "CROSSBOW");
    u2 = test_create_unit(f, r);
    scale_number(u2, 5);
    u2->thisorder = create_order(K_STUDY, f->locale, "ENTERTAINMENT");
    ut = test_create_unit(f, r);
    set_level(ut, SK_ENTERTAINMENT, TEACHDIFFERENCE);
    set_level(ut, SK_CROSSBOW, TEACHDIFFERENCE);
    ut->thisorder = create_order(K_TEACH, f->locale, "%s %s", itoa36(u1->no), itoa36(u2->no));
    learn_inject();
    teach_cmd(ut, ut->thisorder);
    study_cmd(u1, u1->thisorder);
    study_cmd(u2, u2->thisorder);
    learn_reset();
    CuAssertPtrEquals(tc, u1, log_learners[0].u);
    CuAssertIntEquals(tc, SK_CROSSBOW, log_learners[0].sk);
    CuAssertIntEquals(tc, STUDYDAYS * 2 * u1->number, log_learners[0].days);
    CuAssertPtrEquals(tc, u2, log_learners[1].u);
    CuAssertIntEquals(tc, SK_ENTERTAINMENT, log_learners[1].sk);
    CuAssertIntEquals(tc, STUDYDAYS * 2 * u2->number, log_learners[1].days);
    test_cleanup();
}

static void test_teach_one_to_many(CuTest *tc) {
    unit *u, *ut;
    test_setup();
    init_resources();
    u = test_create_unit(test_create_faction(0), test_create_region(0, 0, 0));
    scale_number(u, 20);
    u->thisorder = create_order(K_STUDY, u->faction->locale, "CROSSBOW");
    ut = test_create_unit(u->faction, u->region);
    set_level(ut, SK_CROSSBOW, TEACHDIFFERENCE);
    ut->thisorder = create_order(K_TEACH, u->faction->locale, itoa36(u->no));
    learn_inject();
    teach_cmd(ut, ut->thisorder);
    study_cmd(u, u->thisorder);
    learn_reset();
    CuAssertPtrEquals(tc, u, log_learners[0].u);
    CuAssertIntEquals(tc, SK_CROSSBOW, log_learners[0].sk);
    CuAssertIntEquals(tc, STUDYDAYS * 10 + STUDYDAYS * u->number, log_learners[0].days);
    test_cleanup();
}

static void test_teach_many_to_one(CuTest *tc) {
    unit *u, *u1, *u2;
    test_setup();
    init_resources();
    u = test_create_unit(test_create_faction(0), test_create_region(0, 0, 0));
    scale_number(u, 20);
    u->thisorder = create_order(K_STUDY, u->faction->locale, "CROSSBOW");
    u1 = test_create_unit(u->faction, u->region);
    set_level(u1, SK_CROSSBOW, TEACHDIFFERENCE);
    u1->thisorder = create_order(K_TEACH, u->faction->locale, itoa36(u->no));
    u2 = test_create_unit(u->faction, u->region);
    set_level(u2, SK_CROSSBOW, TEACHDIFFERENCE);
    u2->thisorder = create_order(K_TEACH, u->faction->locale, itoa36(u->no));
    learn_inject();
    teach_cmd(u1, u1->thisorder);
    teach_cmd(u2, u2->thisorder);
    study_cmd(u, u->thisorder);
    learn_reset();
    CuAssertPtrEquals(tc, u, log_learners[0].u);
    CuAssertIntEquals(tc, SK_CROSSBOW, log_learners[0].sk);
    CuAssertIntEquals(tc, 2 * STUDYDAYS * u->number, log_learners[0].days);
    test_cleanup();
}

static void test_teach_many_to_many(CuTest *tc) {
    unit *s1, *s2, *t1, *t2;
    region *r;
    faction *f;

    test_setup();
    init_resources();
    f = test_create_faction(0);
    r = test_create_region(0, 0, 0);
    s1 = test_create_unit(f, r);
    scale_number(s1, 20);
    s1->thisorder = create_order(K_STUDY, f->locale, "CROSSBOW");
    s2 = test_create_unit(f, r);
    scale_number(s2, 10);
    s2->thisorder = create_order(K_STUDY, f->locale, "CROSSBOW");

    t1 = test_create_unit(f, r);
    set_level(t1, SK_CROSSBOW, TEACHDIFFERENCE);
    t1->thisorder = create_order(K_TEACH, f->locale, "%s %s", itoa36(s1->no), itoa36(s2->no));
    t2 = test_create_unit(f, r);
    scale_number(t2, 2);
    set_level(t2, SK_CROSSBOW, TEACHDIFFERENCE);
    t2->thisorder = create_order(K_TEACH, f->locale, "%s %s", itoa36(s1->no), itoa36(s2->no));
    learn_inject();
    teach_cmd(t1, t1->thisorder);
    teach_cmd(t2, t2->thisorder);
    study_cmd(s1, s1->thisorder);
    study_cmd(s2, s2->thisorder);
    learn_reset();
    CuAssertPtrEquals(tc, s1, log_learners[0].u);
    CuAssertIntEquals(tc, SK_CROSSBOW, log_learners[0].sk);
    CuAssertIntEquals(tc, 2 * STUDYDAYS * s1->number, log_learners[0].days);
    CuAssertPtrEquals(tc, s2, log_learners[1].u);
    CuAssertIntEquals(tc, SK_CROSSBOW, log_learners[1].sk);
    CuAssertIntEquals(tc, 2 * STUDYDAYS * s2->number, log_learners[1].days);
    test_cleanup();
}

CuSuite *get_study_suite(void)
{
    CuSuite *suite = CuSuiteNew();
    SUITE_ADD_TEST(suite, test_study_cmd);
    SUITE_ADD_TEST(suite, test_study_cost);
    SUITE_ADD_TEST(suite, test_study_magic);
    SUITE_ADD_TEST(suite, test_teach_cmd);
    SUITE_ADD_TEST(suite, test_teach_two);
    SUITE_ADD_TEST(suite, test_teach_one_to_many);
    SUITE_ADD_TEST(suite, test_teach_many_to_one);
    SUITE_ADD_TEST(suite, test_teach_many_to_many);
    SUITE_ADD_TEST(suite, test_teach_two_skills);
    SUITE_ADD_TEST(suite, test_learn_skill_single);
    SUITE_ADD_TEST(suite, test_learn_skill_multi);
    SUITE_ADD_TEST(suite, test_study_no_teacher);
    SUITE_ADD_TEST(suite, test_study_with_teacher);
    SUITE_ADD_TEST(suite, test_study_with_bad_teacher);
    SUITE_ADD_TEST(suite, test_produceexp);
    SUITE_ADD_TEST(suite, test_academy_building);
    SUITE_ADD_TEST(suite, test_demon_skillchanges);
    SUITE_ADD_TEST(suite, test_study_bug_2194);
    return suite;
}