forked from npshub/mantid
-
Notifications
You must be signed in to change notification settings - Fork 0
/
UsageServiceTest.h
162 lines (141 loc) · 6.29 KB
/
UsageServiceTest.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
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
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
// NScD Oak Ridge National Laboratory, European Spallation Source,
// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
#include <cxxtest/TestSuite.h>
#include "MantidKernel/UsageService.h"
#include <algorithm>
#include <json/json.h>
using Mantid::Kernel::UsageServiceImpl;
class TestableUsageService : public UsageServiceImpl {
public:
TestableUsageService() : UsageServiceImpl() {}
/// generates the message body for a startup message
std::string generateStartupMessage() override { return UsageServiceImpl::generateStartupMessage(); }
/// generates the message body for a feature usage message
std::string generateFeatureUsageMessage() override { return UsageServiceImpl::generateFeatureUsageMessage(); }
protected:
/// sends a report over the internet
int sendReport(const std::string &message, const std::string &url) override {
UNUSED_ARG(message);
UNUSED_ARG(url);
// do nothing
return 200;
}
};
class UsageServiceTest : public CxxTest::TestSuite {
public:
// This pair of boilerplate methods prevent the suite being created statically
// This means the constructor isn't called when running other tests
static UsageServiceTest *createSuite() { return new UsageServiceTest(); }
static void destroySuite(UsageServiceTest *suite) { delete suite; }
void test_enabled() {
TestableUsageService usageService;
TS_ASSERT_EQUALS(usageService.isEnabled(), false);
usageService.setEnabled(false);
TS_ASSERT_EQUALS(usageService.isEnabled(), false);
usageService.setInterval(1000);
TS_ASSERT_EQUALS(usageService.isEnabled(), false);
usageService.setEnabled(true);
TS_ASSERT_EQUALS(usageService.isEnabled(), true);
usageService.setInterval(10000);
TS_ASSERT_EQUALS(usageService.isEnabled(), true);
usageService.setEnabled(false);
TS_ASSERT_EQUALS(usageService.isEnabled(), false);
}
void test_startupMessage() {
TestableUsageService usageService;
std::string name = "My testing application name";
usageService.setApplicationName(name);
std::string message = usageService.generateStartupMessage();
::Json::Reader reader;
::Json::Value root;
reader.parse(message, root);
auto members = root.getMemberNames();
std::vector<std::string> expectedMembers{"ParaView", "application", "host", "mantidSha1", "mantidVersion",
"osArch", "osName", "osReadable", "osVersion", "uid"};
for (auto expectedMember : expectedMembers) {
TSM_ASSERT(expectedMember + " not found",
std::find(members.begin(), members.end(), expectedMember) != members.end());
}
TS_ASSERT_EQUALS(root["application"].asString(), name);
}
void test_FeatureUsageMessage() {
TestableUsageService usageService;
usageService.setInterval(10000);
usageService.setEnabled(true);
usageService.registerFeatureUsage(Mantid::Kernel::FeatureType::Algorithm, "MyAlg.v1", true);
usageService.registerFeatureUsage(Mantid::Kernel::FeatureType::Interface, "MyAlg.v1", true);
for (size_t i = 0; i < 10000; i++) {
usageService.registerFeatureUsage(Mantid::Kernel::FeatureType::Algorithm, "MyLoopAlg.v1", false);
}
usageService.registerFeatureUsage(Mantid::Kernel::FeatureType::Algorithm, "MyLoopAlg.v1", true);
usageService.registerFeatureUsage(Mantid::Kernel::FeatureType::Algorithm, {"MyAlg.v1", "Method1"}, true);
std::string message = usageService.generateFeatureUsageMessage();
::Json::Reader reader;
::Json::Value root;
reader.parse(message, root);
auto members = root.getMemberNames();
std::vector<std::string> expectedMembers{"mantidVersion", "features"};
for (auto expectedMember : expectedMembers) {
TSM_ASSERT(expectedMember + " not found",
std::find(members.begin(), members.end(), expectedMember) != members.end());
}
auto features = root["features"];
for (auto &feature : features) {
std::string name = feature["name"].asString();
std::string type = feature["type"].asString();
bool internal = feature["internal"].asBool();
size_t count = feature["count"].asUInt();
bool correct = false;
if (type == "Algorithm" && name == "MyAlg.v1" && internal == true && count == 1)
correct = true;
if (type == "Interface" && name == "MyAlg.v1" && internal == true && count == 1)
correct = true;
if (type == "Algorithm" && name == "MyLoopAlg.v1" && internal == false && count == 10000)
correct = true;
if (type == "Algorithm" && name == "MyLoopAlg.v1" && internal == true && count == 1)
correct = true;
if (type == "Algorithm" && name == "MyAlg.v1->Method1" && internal == true && count == 1)
correct = true;
TSM_ASSERT("Usage record was not as expected", correct)
}
}
void test_Flush() {
TestableUsageService usageService;
usageService.setInterval(10000);
usageService.setEnabled(true);
for (size_t i = 0; i < 10; i++) {
usageService.registerFeatureUsage(Mantid::Kernel::FeatureType::Algorithm, {"MyLoopAlg.v1"}, false);
}
// this should empty the feature usage list
usageService.flush();
// so this should no be empty
TS_ASSERT_EQUALS(usageService.generateFeatureUsageMessage(), "");
}
void test_Shutdown() {
TestableUsageService usageService;
usageService.setInterval(10000);
usageService.setEnabled(true);
for (size_t i = 0; i < 10; i++) {
usageService.registerFeatureUsage(Mantid::Kernel::FeatureType::Algorithm, {"MyLoopAlg.v1"}, false);
}
// this should empty the feature usage list
usageService.shutdown();
// so this should no be empty
TS_ASSERT_EQUALS(usageService.generateFeatureUsageMessage(), "");
// and it should be disabled
TS_ASSERT_EQUALS(usageService.isEnabled(), false);
}
void test_setApplicationName() {
TestableUsageService usageService;
// test default first
TS_ASSERT_EQUALS(usageService.getApplicationName(), "python");
std::string name = "My testing application name";
usageService.setApplicationName(name);
TS_ASSERT_EQUALS(usageService.getApplicationName(), name);
}
};