summaryrefslogtreecommitdiff
path: root/test/redfish-core/include/utils/collection_test.cpp
blob: 378aef90d7642dafd218ff79a1f7132c1c48f09c (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
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright OpenBMC Authors

#include "async_resp.hpp"
#include "utils/collection.hpp"

#include <boost/system/errc.hpp>
#include <boost/url/url.hpp>
#include <nlohmann/json.hpp>

#include <memory>

#include <gtest/gtest.h>

namespace redfish::collection_util
{
namespace
{

TEST(CollectionUtil, GetJsonArrayAtConvertsValueToArray)
{
    nlohmann::json value = 123;
    nlohmann::json::array_t& arr = details::getJsonArrayAt(value);
    EXPECT_TRUE(value.is_array());
    EXPECT_TRUE(arr.empty());
}

TEST(CollectionUtil, GetJsonArrayAtCreatesNestedArray)
{
    nlohmann::json root;
    nlohmann::json::array_t& arr = details::getJsonArrayAt(
        root[nlohmann::json::json_pointer("/Links/Members")]);
    EXPECT_TRUE(root["Links"]["Members"].is_array());
    EXPECT_TRUE(arr.empty());
}

TEST(CollectionUtil, GetJsonArrayAtConvertsNonArrayToArray)
{
    nlohmann::json root;
    root["Links"]["Members"] = {{"unexpected", "value"}};

    nlohmann::json::array_t& arr = details::getJsonArrayAt(
        root[nlohmann::json::json_pointer("/Links/Members")]);

    EXPECT_TRUE(root["Links"]["Members"].is_array());
    EXPECT_TRUE(arr.empty());
}

TEST(CollectionUtil, GetJsonArrayPreservesExistingArray)
{
    nlohmann::json root;
    root["Members"] =
        nlohmann::json::array({{{"@odata.id", "/redfish/v1/Managers/bmc"}}});

    nlohmann::json::array_t& arr = getJsonArray(root, "Members");

    ASSERT_TRUE(root["Members"].is_array());
    EXPECT_EQ(arr.size(), 1);
    EXPECT_EQ(arr.front()["@odata.id"], "/redfish/v1/Managers/bmc");
}

TEST(CollectionUtil, HandleCollectionMembersIoErrorPreservesExistingMembers)
{
    auto asyncResp = std::make_shared<bmcweb::AsyncResp>();
    asyncResp->res.jsonValue["Members"] = nlohmann::json::array(
        {{{"@odata.id",
           "/redfish/v1/UpdateService/SoftwareInventory/existing"}}});

    handleCollectionMembers(
        asyncResp,
        boost::urls::url("/redfish/v1/UpdateService/SoftwareInventory"),
        nlohmann::json::json_pointer("/Members"),
        make_error_code(boost::system::errc::io_error), {});

    ASSERT_TRUE(asyncResp->res.jsonValue["Members"].is_array());
    EXPECT_EQ(asyncResp->res.jsonValue["Members"].size(), 1);
    EXPECT_EQ(asyncResp->res.jsonValue["Members@odata.count"], 1);
}

TEST(CollectionUtil, HandleCollectionMembersIoErrorCreatesEmptyMembersArray)
{
    auto asyncResp = std::make_shared<bmcweb::AsyncResp>();

    handleCollectionMembers(
        asyncResp,
        boost::urls::url("/redfish/v1/UpdateService/SoftwareInventory"),
        nlohmann::json::json_pointer("/Members"),
        make_error_code(boost::system::errc::io_error), {});

    ASSERT_TRUE(asyncResp->res.jsonValue["Members"].is_array());
    EXPECT_TRUE(asyncResp->res.jsonValue["Members"].empty());
    EXPECT_EQ(asyncResp->res.jsonValue["Members@odata.count"], 0);
}

TEST(CollectionUtil, HandleCollectionMembersEmptyJsonKeyReturnsInternalError)
{
    auto asyncResp = std::make_shared<bmcweb::AsyncResp>();

    handleCollectionMembers(
        asyncResp,
        boost::urls::url("/redfish/v1/UpdateService/SoftwareInventory"),
        nlohmann::json::json_pointer(), {}, {});

    EXPECT_EQ(asyncResp->res.resultInt(), 500);
    EXPECT_TRUE(asyncResp->res.jsonValue.contains("error"));
}

TEST(CollectionUtil, HandleCollectionMembersAppendsMembersAndUpdatesCount)
{
    auto asyncResp = std::make_shared<bmcweb::AsyncResp>();
    asyncResp->res.jsonValue["Members"] = nlohmann::json::array(
        {{{"@odata.id",
           "/redfish/v1/UpdateService/SoftwareInventory/existing"}}});

    dbus::utility::MapperGetSubTreePathsResponse objects = {
        "/xyz/openbmc_project/software/C",
        "/xyz/openbmc_project/software/B",
        "/xyz/openbmc_project/software/A",
    };

    handleCollectionMembers(
        asyncResp,
        boost::urls::url("/redfish/v1/UpdateService/SoftwareInventory"),
        nlohmann::json::json_pointer("/Members"), {}, objects);

    const nlohmann::json& members = asyncResp->res.jsonValue["Members"];
    ASSERT_TRUE(members.is_array());
    EXPECT_EQ(members.size(), 4);
    EXPECT_EQ(asyncResp->res.jsonValue["Members@odata.count"], 4);
    EXPECT_EQ(members[0]["@odata.id"],
              "/redfish/v1/UpdateService/SoftwareInventory/A");
    EXPECT_EQ(members[1]["@odata.id"],
              "/redfish/v1/UpdateService/SoftwareInventory/B");
    EXPECT_EQ(members[2]["@odata.id"],
              "/redfish/v1/UpdateService/SoftwareInventory/C");
    EXPECT_EQ(members[3]["@odata.id"],
              "/redfish/v1/UpdateService/SoftwareInventory/existing");
}

TEST(CollectionUtil, HandleCollectionMembersSkipsObjectsWithEmptyLeaf)
{
    auto asyncResp = std::make_shared<bmcweb::AsyncResp>();
    dbus::utility::MapperGetSubTreePathsResponse objects = {
        "/xyz/openbmc_project/software/",
        "/xyz/openbmc_project/software/A",
    };

    handleCollectionMembers(
        asyncResp,
        boost::urls::url("/redfish/v1/UpdateService/SoftwareInventory"),
        nlohmann::json::json_pointer("/Members"), {}, objects);

    const nlohmann::json& members = asyncResp->res.jsonValue["Members"];
    ASSERT_TRUE(members.is_array());
    ASSERT_EQ(members.size(), 1);
    EXPECT_EQ(members[0]["@odata.id"],
              "/redfish/v1/UpdateService/SoftwareInventory/A");
    EXPECT_EQ(asyncResp->res.jsonValue["Members@odata.count"], 1);
}

} // namespace
} // namespace redfish::collection_util