summaryrefslogtreecommitdiff
path: root/src/mongo/dbtests/framework_options.cpp
blob: 863c9bcf06eb5ff4e1fed8e4dc1a82815a4effa8 (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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218

/**
 *    Copyright (C) 2018-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kDefault

#include "mongo/platform/basic.h"


#include "mongo/dbtests/framework_options.h"

#include <boost/filesystem/operations.hpp>
#include <iostream>

#include "mongo/base/status.h"
#include "mongo/bson/util/builder.h"
#include "mongo/db/query/find.h"
#include "mongo/db/storage/storage_options.h"
#include "mongo/dbtests/dbtests.h"
#include "mongo/unittest/unittest.h"
#include "mongo/util/log.h"
#include "mongo/util/options_parser/startup_options.h"
#include "mongo/util/password.h"

namespace mongo {

namespace {

// This specifies default dbpath for our testing framework
const std::string default_test_dbpath = "/tmp/unittest";

}  // namespace

using std::cout;
using std::endl;
using std::string;
using std::vector;

FrameworkGlobalParams frameworkGlobalParams;

Status addTestFrameworkOptions(moe::OptionSection* options) {
    options->addOptionChaining("help", "help,h", moe::Switch, "show this usage information");

    options
        ->addOptionChaining(
            "dbpath",
            "dbpath",
            moe::String,
            "db data path for this test run. NOTE: the contents of this directory will "
            "be overwritten if it already exists")
        .setDefault(moe::Value(default_test_dbpath));

    options->addOptionChaining("debug", "debug", moe::Switch, "run tests with verbose output");

    options->addOptionChaining("list", "list,l", moe::Switch, "list available test suites");

    options->addOptionChaining(
        "filter", "filter,f", moe::String, "string substring filter on test name");

    options->addOptionChaining("verbose", "verbose,v", moe::Switch, "verbose");

    options->addOptionChaining(
        "dur", "dur", moe::Switch, "enable journaling (currently the default)");

    options->addOptionChaining("nodur", "nodur", moe::Switch, "disable journaling");

    options->addOptionChaining("seed", "seed", moe::UnsignedLongLong, "random number seed");

    options->addOptionChaining("runs", "runs", moe::Int, "number of times to run each test");

    options->addOptionChaining(
        "perfHist", "perfHist", moe::Unsigned, "number of back runs of perf stats to display");

    // If set to true, storage engine maintains the data history. Else, it won't maintain the data
    // history. This setting applies only to 'wiredTiger' storage engine.
    options
        ->addOptionChaining("replication.enableMajorityReadConcern",
                            "enableMajorityReadConcern",
                            moe::Bool,
                            "enables majority readConcern")
        .setDefault(moe::Value(true));
    options
        ->addOptionChaining(
            "storage.engine", "storageEngine", moe::String, "what storage engine to use")
        .setDefault(moe::Value(std::string("wiredTiger")));

    options->addOptionChaining("suites", "suites", moe::StringVector, "test suites to run")
        .hidden()
        .positional(1, -1);

    return Status::OK();
}

std::string getTestFrameworkHelp(StringData name, const moe::OptionSection& options) {
    StringBuilder sb;
    sb << "usage: " << name << " [options] [suite]...\n"
       << options.helpString() << "suite: run the specified test suite(s) only\n";
    return sb.str();
}

bool handlePreValidationTestFrameworkOptions(const moe::Environment& params,
                                             const std::vector<std::string>& args) {
    if (params.count("help")) {
        std::cout << getTestFrameworkHelp(args[0], moe::startupOptions) << std::endl;
        return false;
    }

    if (params.count("list")) {
        std::vector<std::string> suiteNames = mongo::unittest::getAllSuiteNames();
        for (std::vector<std::string>::const_iterator i = suiteNames.begin(); i != suiteNames.end();
             ++i) {
            std::cout << *i << std::endl;
        }
        return false;
    }

    return true;
}

Status storeTestFrameworkOptions(const moe::Environment& params,
                                 const std::vector<std::string>& args) {
    if (params.count("dbpath")) {
        frameworkGlobalParams.dbpathSpec = params["dbpath"].as<string>();
    }

    if (params.count("seed")) {
        frameworkGlobalParams.seed = params["seed"].as<unsigned long long>();
    }

    if (params.count("runs")) {
        frameworkGlobalParams.runsPerTest = params["runs"].as<int>();
    }

    if (params.count("perfHist")) {
        frameworkGlobalParams.perfHist = params["perfHist"].as<unsigned>();
    }


    if (params.count("debug") || params.count("verbose")) {
        logger::globalLogDomain()->setMinimumLoggedSeverity(logger::LogSeverity::Debug(1));
    }

    boost::filesystem::path p(frameworkGlobalParams.dbpathSpec);

    /* remove the contents of the test directory if it exists. */
    try {
        if (boost::filesystem::exists(p)) {
            if (!boost::filesystem::is_directory(p)) {
                StringBuilder sb;
                sb << "ERROR: path \"" << p.string() << "\" is not a directory";
                sb << getTestFrameworkHelp(args[0], moe::startupOptions);
                return Status(ErrorCodes::BadValue, sb.str());
            }
            boost::filesystem::directory_iterator end_iter;
            for (boost::filesystem::directory_iterator dir_iter(p); dir_iter != end_iter;
                 ++dir_iter) {
                boost::filesystem::remove_all(*dir_iter);
            }
        } else {
            boost::filesystem::create_directory(p);
        }
    } catch (const boost::filesystem::filesystem_error& e) {
        StringBuilder sb;
        sb << "boost::filesystem threw exception: " << e.what();
        return Status(ErrorCodes::BadValue, sb.str());
    }

    DEV log() << "DEBUG build" << endl;

    string dbpathString = p.string();
    storageGlobalParams.dbpath = dbpathString.c_str();

    storageGlobalParams.engine = params["storage.engine"].as<string>();

    if (storageGlobalParams.engine == "wiredTiger" &&
        params.count("replication.enableMajorityReadConcern")) {
        serverGlobalParams.enableMajorityReadConcern =
            params["replication.enableMajorityReadConcern"].as<bool>();
    }

    if (params.count("suites")) {
        frameworkGlobalParams.suites = params["suites"].as<vector<string>>();
    }

    frameworkGlobalParams.filter = "";
    if (params.count("filter")) {
        frameworkGlobalParams.filter = params["filter"].as<string>();
    }

    return Status::OK();
}
}