/
golden_test.h
85 lines (73 loc) · 3.11 KB
/
golden_test.h
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
/**
* Copyright (C) 2022-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.
*/
#pragma once
#include <boost/filesystem/path.hpp>
#include <boost/filesystem/path_traits.hpp>
#include <boost/optional/optional.hpp>
#include <functional>
#include <string>
#include "mongo/base/string_data.h"
#include "mongo/unittest/framework.h"
#include "mongo/unittest/golden_test_base.h"
#include "mongo/unittest/test_info.h"
#include "mongo/unittest/unittest.h"
namespace mongo::unittest {
namespace fs = ::boost::filesystem;
class GoldenTestContext : public GoldenTestContextBase {
public:
/** Format of the test header*/
enum HeaderFormat {
/** A simple text header, suitable for unstructured text output.*/
Text,
};
explicit GoldenTestContext(
const GoldenTestConfig* config,
const TestInfo* testInfo = UnitTest::getInstance()->currentTestInfo(),
bool validateOnClose = true)
: GoldenTestContextBase(
config,
fs::path(sanitizeName(testInfo->suiteName().toString())) /
fs::path(sanitizeName(testInfo->testName().toString()) + ".txt"),
validateOnClose,
[this](auto const&... args) { return onError(args...); }),
_testInfo(testInfo) {}
/**
* Prints the test header in a specified format.
*/
void printTestHeader(HeaderFormat format);
// Disable move/copy because onError captures 'this' address.
GoldenTestContext(GoldenTestContext&&) = delete;
protected:
void onError(const std::string& message,
const std::string& actualStr,
const boost::optional<std::string>& expectedStr);
private:
const TestInfo* _testInfo;
};
} // namespace mongo::unittest