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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
#include "redfish_aggregator.hpp"
#include <nlohmann/json.hpp>
#include <gtest/gtest.h> // IWYU pragma: keep
namespace redfish
{
namespace
{
TEST(IsPropertyUri, SupportedPropertyReturnsTrue)
{
EXPECT_TRUE(isPropertyUri("@Redfish.ActionInfo"));
EXPECT_TRUE(isPropertyUri("@odata.id"));
EXPECT_TRUE(isPropertyUri("Image"));
EXPECT_TRUE(isPropertyUri("MetricProperty"));
EXPECT_TRUE(isPropertyUri("TaskMonitor"));
EXPECT_TRUE(isPropertyUri("target"));
}
TEST(IsPropertyUri, CaseInsensitiveURIReturnsTrue)
{
EXPECT_TRUE(isPropertyUri("AdditionalDataURI"));
EXPECT_TRUE(isPropertyUri("DataSourceUri"));
EXPECT_TRUE(isPropertyUri("uri"));
EXPECT_TRUE(isPropertyUri("URI"));
}
TEST(IsPropertyUri, SpeificallyIgnoredPropertyReturnsFalse)
{
EXPECT_FALSE(isPropertyUri("@odata.context"));
EXPECT_FALSE(isPropertyUri("Destination"));
EXPECT_FALSE(isPropertyUri("HostName"));
EXPECT_FALSE(isPropertyUri("OriginOfCondition"));
}
TEST(IsPropertyUri, UnsupportedPropertyReturnsFalse)
{
EXPECT_FALSE(isPropertyUri("Name"));
EXPECT_FALSE(isPropertyUri("Health"));
EXPECT_FALSE(isPropertyUri("Id"));
}
TEST(addPrefixToItem, ValidURIs)
{
nlohmann::json jsonRequest;
constexpr std::array validRoots{"Cables",
"Chassis",
"Fabrics",
"PowerEquipment/FloorPDUs",
"Systems",
"TaskService/Tasks",
"TelemetryService/LogService/Entries",
"UpdateService/SoftwareInventory"};
// We're only testing prefix fixing so it's alright that some of the
// resulting URIs will not actually be possible as defined by the schema
constexpr std::array validIDs{"1",
"1/",
"Test",
"Test/",
"Extra_Test",
"Extra_Test/",
"Extra_Test/Sensors",
"Extra_Test/Sensors/",
"Extra_Test/Sensors/power_sensor",
"Extra_Test/Sensors/power_sensor/"};
// Construct URIs which should have prefix fixing applied
for (const auto& root : validRoots)
{
for (const auto& id : validIDs)
{
std::string initial("/redfish/v1/" + std::string(root) + "/");
std::string correct(initial + "asdfjkl_" + std::string(id));
initial += id;
jsonRequest["@odata.id"] = initial;
addPrefixToItem(jsonRequest["@odata.id"], "asdfjkl");
EXPECT_EQ(jsonRequest["@odata.id"], correct);
}
}
}
TEST(addPrefixToItem, UnsupportedURIs)
{
nlohmann::json jsonRequest;
constexpr std::array invalidRoots{
"FakeCollection", "JsonSchemas",
"PowerEquipment", "TaskService",
"TelemetryService/Entries", "UpdateService"};
constexpr std::array validIDs{"1",
"1/",
"Test",
"Test/",
"Extra_Test",
"Extra_Test/",
"Extra_Test/Sensors",
"Extra_Test/Sensors/",
"Extra_Test/Sensors/power_sensor",
"Extra_Test/Sensors/power_sensor/"};
// Construct URIs which should NOT have prefix fixing applied
for (const auto& root : invalidRoots)
{
for (const auto& id : validIDs)
{
std::string initial("/redfish/v1/" + std::string(root) + "/");
std::string correct(initial + "asdfjkl_" + std::string(id));
initial += id;
jsonRequest["@odata.id"] = initial;
addPrefixToItem(jsonRequest["@odata.id"], "asdfjkl");
EXPECT_EQ(jsonRequest["@odata.id"], initial);
}
}
}
TEST(addPrefixToItem, TopLevelCollections)
{
nlohmann::json jsonRequest;
constexpr std::array validRoots{"Cables",
"Chassis/",
"Fabrics",
"JsonSchemas",
"PowerEquipment/FloorPDUs",
"Systems",
"TaskService/Tasks",
"TelemetryService/LogService/Entries",
"TelemetryService/LogService/Entries/",
"UpdateService/SoftwareInventory/"};
// Construct URIs for top level collections. Prefixes should NOT be
// applied to any of the URIs
for (const auto& root : validRoots)
{
std::string initial("/redfish/v1/" + std::string(root));
jsonRequest["@odata.id"] = initial;
addPrefixToItem(jsonRequest["@odata.id"], "perfix");
EXPECT_EQ(jsonRequest["@odata.id"], initial);
}
}
TEST(addPrefixes, ParseJsonObject)
{
nlohmann::json parameter;
parameter["Name"] = "/redfish/v1/Chassis/fakeName";
parameter["@odata.id"] = "/redfish/v1/Chassis/fakeChassis";
addPrefixes(parameter, "abcd");
EXPECT_EQ(parameter["Name"], "/redfish/v1/Chassis/fakeName");
EXPECT_EQ(parameter["@odata.id"], "/redfish/v1/Chassis/abcd_fakeChassis");
}
TEST(addPrefixes, ParseJsonArray)
{
nlohmann::json array = nlohmann::json::parse(R"(
{
"Conditions": [
{
"Message": "This is a test",
"@odata.id": "/redfish/v1/Chassis/TestChassis"
},
{
"Message": "This is also a test",
"@odata.id": "/redfish/v1/Chassis/TestChassis2"
}
]
}
)",
nullptr, false);
addPrefixes(array, "5B42");
EXPECT_EQ(array["Conditions"][0]["@odata.id"],
"/redfish/v1/Chassis/5B42_TestChassis");
EXPECT_EQ(array["Conditions"][1]["@odata.id"],
"/redfish/v1/Chassis/5B42_TestChassis2");
}
TEST(addPrefixes, ParseJsonObjectNestedArray)
{
nlohmann::json objWithArray = nlohmann::json::parse(R"(
{
"Status": {
"Conditions": [
{
"Message": "This is a test",
"MessageId": "Test",
"OriginOfCondition": {
"@odata.id": "/redfish/v1/Chassis/TestChassis"
},
"Severity": "Critical"
}
],
"Health": "Critical",
"State": "Enabled"
}
}
)",
nullptr, false);
addPrefixes(objWithArray, "5B42");
nlohmann::json& array = objWithArray["Status"]["Conditions"];
EXPECT_EQ(array[0]["OriginOfCondition"]["@odata.id"],
"/redfish/v1/Chassis/5B42_TestChassis");
}
// Attempts to perform prefix fixing on a response with response code "result".
// Fixing should always occur
void assertProcessResponse(unsigned result)
{
nlohmann::json jsonResp;
jsonResp["@odata.id"] = "/redfish/v1/Chassis/TestChassis";
jsonResp["Name"] = "Test";
crow::Response resp;
resp.body() =
jsonResp.dump(2, ' ', true, nlohmann::json::error_handler_t::replace);
resp.addHeader("Content-Type", "application/json");
resp.result(result);
auto asyncResp = std::make_shared<bmcweb::AsyncResp>();
RedfishAggregator::processResponse("prefix", asyncResp, resp);
EXPECT_EQ(asyncResp->res.jsonValue["Name"], "Test");
EXPECT_EQ(asyncResp->res.jsonValue["@odata.id"],
"/redfish/v1/Chassis/prefix_TestChassis");
EXPECT_EQ(asyncResp->res.resultInt(), result);
}
TEST(processResponse, validResponseCodes)
{
assertProcessResponse(100);
assertProcessResponse(200);
assertProcessResponse(204);
assertProcessResponse(300);
assertProcessResponse(404);
assertProcessResponse(405);
assertProcessResponse(500);
assertProcessResponse(507);
}
} // namespace
} // namespace redfish
|
