summaryrefslogtreecommitdiff
path: root/src/third_party/wiredtiger/test/cppsuite/test_harness/test.h
blob: 8c5e2d17434fbf78fe9576c28b42e0c0e5a40a5f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/*-
 * Public Domain 2014-present MongoDB, Inc.
 * Public Domain 2008-2014 WiredTiger, Inc.
 *
 * This is free and unencumbered software released into the public domain.
 *
 * Anyone is free to copy, modify, publish, use, compile, sell, or
 * distribute this software, either in source code form or as a compiled
 * binary, for any purpose, commercial or non-commercial, and by any
 * means.
 *
 * In jurisdictions that recognize copyright laws, the author or authors
 * of this software dedicate any and all copyright interest in the
 * software to the public domain. We make this dedication for the benefit
 * of the public at large and to the detriment of our heirs and
 * successors. We intend this dedication to be an overt act of
 * relinquishment in perpetuity of all present and future rights to this
 * software under copyright law.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef TEST_H
#define TEST_H

#include <vector>
#include <string>

extern "C" {
#include "wiredtiger.h"
}

#include "checkpoint_manager.h"
#include "connection_manager.h"
#include "runtime_monitor.h"
#include "workload/database_operation.h"
#include "workload_generator.h"

namespace test_harness {
class test_args {
    public:
    test_args(const std::string &config, const std::string &name, const std::string &wt_open_config)
        : test_config(config), test_name(name), wt_open_config(wt_open_config)
    {
    }
    const std::string test_config;
    const std::string test_name;
    const std::string wt_open_config;
};

/*
 * The base class for a test, the standard usage pattern is to just call run().
 */
class test : public database_operation {
    public:
    test(const test_args &args);
    ~test();

    /* Delete the copy constructor and the assignment operator. */
    test(const test &) = delete;
    test &operator=(const test &) = delete;

    /*
     * The primary run function that most tests will be able to utilize without much other code.
     */
    virtual void run();

    /*
     * Getters for all the major components, used if a test wants more control over the test
     * program.
     */
    workload_generator *get_workload_generator();
    runtime_monitor *get_runtime_monitor();
    timestamp_manager *get_timestamp_manager();
    thread_manager *get_thread_manager();

    protected:
    configuration *_config;

    private:
    const test_args &_args;
    std::vector<component *> _components;
    checkpoint_manager *_checkpoint_manager = nullptr;
    runtime_monitor *_runtime_monitor = nullptr;
    thread_manager *_thread_manager = nullptr;
    timestamp_manager *_timestamp_manager = nullptr;
    workload_generator *_workload_generator = nullptr;
    workload_tracking *_workload_tracking = nullptr;
    /*
     * FIX-ME-Test-Framework: We can't put this code in the destructor of `test` since it will run
     * before the destructors of each of our members (meaning that sessions will get closed after
     * the connection gets closed). To work around this, we've added a member with a destructor that
     * closes the connection.
     */
    struct connection_closer {
        ~connection_closer()
        {
            connection_manager::instance().close();
        }
    } _connection_closer;
    database _database;
};
} // namespace test_harness

#endif