blob: a2c3b5a206a0f46ae93a11216b16d83bc95eb5be [file] [log] [blame]
Matt Spinler09d64002019-09-11 14:29:46 -05001#include "extensions/openpower-pels/data_interface.hpp"
Matt Spinlerf60ac272019-12-11 13:47:50 -06002#include "extensions/openpower-pels/host_interface.hpp"
3
4#include <fcntl.h>
5
6#include <filesystem>
7#include <sdeventplus/source/io.hpp>
Matt Spinler09d64002019-09-11 14:29:46 -05008
9#include <gmock/gmock.h>
10
11namespace openpower
12{
13namespace pels
14{
15
16class MockDataInterface : public DataInterfaceBase
17{
18 public:
19 MockDataInterface()
20 {
21 }
Matt Spinlerf60ac272019-12-11 13:47:50 -060022 MOCK_METHOD(std::string, getMachineTypeModel, (), (const override));
23 MOCK_METHOD(std::string, getMachineSerialNumber, (), (const override));
24 MOCK_METHOD(std::string, getServerFWVersion, (), (const override));
25 MOCK_METHOD(std::string, getBMCFWVersion, (), (const override));
Matt Spinler677381b2020-01-23 10:04:29 -060026 MOCK_METHOD(std::string, getBMCFWVersionID, (), (const override));
Matt Spinler24a85582020-01-27 16:40:21 -060027 MOCK_METHOD(bool, getHostPELEnablement, (), (const override));
Matt Spinler4aa23a12020-02-03 15:05:09 -060028 MOCK_METHOD(std::string, getBMCState, (), (const override));
29 MOCK_METHOD(std::string, getChassisState, (), (const override));
30 MOCK_METHOD(std::string, getHostState, (), (const override));
Matt Spinler075e5ba2020-02-21 15:46:00 -060031 MOCK_METHOD(std::string, getMotherboardCCIN, (), (const override));
Matt Spinler60c4e792020-03-13 13:45:36 -050032 MOCK_METHOD(void, getHWCalloutFields,
Matt Spinler9b90e2a2020-04-14 10:59:04 -050033 (const std::string&, std::string&, std::string&, std::string&),
Matt Spinler60c4e792020-03-13 13:45:36 -050034 (const override));
Matt Spinler9b90e2a2020-04-14 10:59:04 -050035 MOCK_METHOD(std::string, getLocationCode, (const std::string&),
36 (const override));
Matt Spinler1ab66962020-10-29 13:21:44 -050037 MOCK_METHOD(std::vector<std::string>, getSystemNames, (), (const override));
Matt Spinler5fb24c12020-06-04 11:21:33 -050038 MOCK_METHOD(std::string, expandLocationCode, (const std::string&, uint16_t),
39 (const override));
40 MOCK_METHOD(std::string, getInventoryFromLocCode,
Matt Spinler2f9225a2020-08-05 12:58:49 -050041 (const std::string&, uint16_t, bool), (const override));
Matt Spinler34a904c2020-08-05 14:53:28 -050042 MOCK_METHOD(void, assertLEDGroup, (const std::string&, bool),
43 (const override));
Matt Spinler993168d2021-04-07 16:05:03 -050044 MOCK_METHOD(void, setFunctional, (const std::string&, bool),
45 (const override));
Matt Spinler34a904c2020-08-05 14:53:28 -050046
Matt Spinlerf60ac272019-12-11 13:47:50 -060047 void changeHostState(bool newState)
48 {
Matt Spinler4aa23a12020-02-03 15:05:09 -060049 setHostUp(newState);
Matt Spinlerf60ac272019-12-11 13:47:50 -060050 }
51
52 void setHMCManaged(bool managed)
53 {
54 _hmcManaged = managed;
55 }
56};
57
58/**
59 * @brief The mock HostInterface class
Matt Spinler5342d9a2019-12-12 11:03:39 -060060 *
61 * This replaces the PLDM calls with a FIFO for the asynchronous
62 * responses.
Matt Spinlerf60ac272019-12-11 13:47:50 -060063 */
64class MockHostInterface : public HostInterface
65{
66 public:
Matt Spinler5342d9a2019-12-12 11:03:39 -060067 /**
68 * @brief Constructor
69 *
70 * @param[in] event - The sd_event object
71 * @param[in] dataIface - The DataInterface class
72 */
Matt Spinlerf60ac272019-12-11 13:47:50 -060073 MockHostInterface(sd_event* event, DataInterfaceBase& dataIface) :
74 HostInterface(event, dataIface)
75 {
Matt Spinler5342d9a2019-12-12 11:03:39 -060076 char templ[] = "/tmp/cmdfifoXXXXXX";
77 std::filesystem::path dir = mkdtemp(templ);
78 _fifo = dir / "fifo";
Matt Spinlerf60ac272019-12-11 13:47:50 -060079 }
80
Matt Spinler5342d9a2019-12-12 11:03:39 -060081 /**
82 * @brief Destructor
83 */
Matt Spinlerf60ac272019-12-11 13:47:50 -060084 virtual ~MockHostInterface()
85 {
Matt Spinler5342d9a2019-12-12 11:03:39 -060086 std::filesystem::remove_all(_fifo.parent_path());
Matt Spinlerf60ac272019-12-11 13:47:50 -060087 }
88
89 MOCK_METHOD(CmdStatus, sendNewLogCmd, (uint32_t, uint32_t), (override));
90
Matt Spinler5342d9a2019-12-12 11:03:39 -060091 /**
92 * @brief Cancels waiting for a command response
93 */
94 virtual void cancelCmd() override
95 {
96 _inProgress = false;
97 _source = nullptr;
98 }
99
100 /**
101 * @brief Returns the amount of time to wait before retrying after
102 * a failed send command.
103 *
104 * @return milliseconds - The amount of time to wait
105 */
106 virtual std::chrono::milliseconds getSendRetryDelay() const override
107 {
108 return std::chrono::milliseconds(2);
109 }
110
111 /**
112 * @brief Returns the amount of time to wait before retrying after
113 * a command receive.
114 *
115 * @return milliseconds - The amount of time to wait
116 */
117 virtual std::chrono::milliseconds getReceiveRetryDelay() const override
118 {
119 return std::chrono::milliseconds(2);
120 }
121
122 /**
Matt Spinler41293cb2019-12-12 13:11:09 -0600123 * @brief Returns the amount of time to wait before retrying if the
124 * host firmware's PEL storage was full and it can't store
125 * any more logs until it is freed up somehow.
126 *
127 * @return milliseconds - The amount of time to wait
128 */
129 virtual std::chrono::milliseconds getHostFullRetryDelay() const override
130 {
Matt Spinler6aae6a02020-02-07 12:46:07 -0600131 return std::chrono::milliseconds(400);
Matt Spinler41293cb2019-12-12 13:11:09 -0600132 }
133
134 /**
Matt Spinler5342d9a2019-12-12 11:03:39 -0600135 * @brief Returns the number of commands processed
136 */
137 size_t numCmdsProcessed() const
138 {
139 return _cmdsProcessed;
140 }
141
142 /**
143 * @brief Writes the data passed in to the FIFO
144 *
145 * @param[in] hostResponse - use a 0 to indicate success
146 *
147 * @return CmdStatus - success or failure
148 */
149 CmdStatus send(uint8_t hostResponse)
150 {
151 // Create a FIFO once.
152 if (!std::filesystem::exists(_fifo))
153 {
154 if (mkfifo(_fifo.c_str(), 0622))
155 {
156 ADD_FAILURE() << "Failed mkfifo " << _fifo << strerror(errno);
157 exit(-1);
158 }
159 }
160
161 // Open it and register the reponse callback to
162 // be used on FD activity.
163 int fd = open(_fifo.c_str(), O_NONBLOCK | O_RDWR);
164 EXPECT_TRUE(fd >= 0) << "Unable to open FIFO";
165
166 auto callback = [this](sdeventplus::source::IO& source, int fd,
167 uint32_t events) {
168 this->receive(source, fd, events);
169 };
170
171 try
172 {
173 _source = std::make_unique<sdeventplus::source::IO>(
174 _event, fd, EPOLLIN,
175 std::bind(callback, std::placeholders::_1,
176 std::placeholders::_2, std::placeholders::_3));
177 }
178 catch (std::exception& e)
179 {
180 ADD_FAILURE() << "Event exception: " << e.what();
181 close(fd);
182 return CmdStatus::failure;
183 }
184
185 // Write the fake host reponse to the FIFO
186 auto bytesWritten = write(fd, &hostResponse, sizeof(hostResponse));
187 EXPECT_EQ(bytesWritten, sizeof(hostResponse));
188
189 _inProgress = true;
190
191 return CmdStatus::success;
192 }
193
Matt Spinlerf60ac272019-12-11 13:47:50 -0600194 protected:
Matt Spinler5342d9a2019-12-12 11:03:39 -0600195 /**
196 * @brief Reads the data written to the fifo and then calls
197 * the subscriber's callback.
198 *
199 * Nonzero data indicates a command failure (for testing bad path).
200 *
201 * @param[in] source - The event source object
202 * @param[in] fd - The file descriptor used
203 * @param[in] events - The event bits
204 */
Matt Spinlerf60ac272019-12-11 13:47:50 -0600205 void receive(sdeventplus::source::IO& source, int fd,
206 uint32_t events) override
207 {
Matt Spinler5342d9a2019-12-12 11:03:39 -0600208 if (!(events & EPOLLIN))
209 {
210 return;
211 }
212
213 _inProgress = false;
214
215 int newFD = open(_fifo.c_str(), O_NONBLOCK | O_RDONLY);
216 ASSERT_TRUE(newFD >= 0) << "Failed to open FIFO";
217
218 // Read the host success/failure response from the FIFO.
219 uint8_t data;
220 auto bytesRead = read(newFD, &data, sizeof(data));
221 EXPECT_EQ(bytesRead, sizeof(data));
222
223 close(newFD);
224
225 ResponseStatus status = ResponseStatus::success;
226 if (data != 0)
227 {
228 status = ResponseStatus::failure;
229 }
230
Matt Spinlera44efe42020-03-03 10:30:16 -0600231 callResponseFunc(status);
Matt Spinler5342d9a2019-12-12 11:03:39 -0600232
Matt Spinlerf60ac272019-12-11 13:47:50 -0600233 // Keep account of the number of commands responses for testing.
234 _cmdsProcessed++;
235 }
236
237 private:
Matt Spinler5342d9a2019-12-12 11:03:39 -0600238 /**
239 * @brief The event source for the fifo
240 */
241 std::unique_ptr<sdeventplus::source::IO> _source;
242
243 /**
244 * @brief the path to the fifo
245 */
246 std::filesystem::path _fifo;
247
248 /**
249 * @brief The number of commands processed
250 */
Matt Spinlerf60ac272019-12-11 13:47:50 -0600251 size_t _cmdsProcessed = 0;
Matt Spinler09d64002019-09-11 14:29:46 -0500252};
253
254} // namespace pels
255} // namespace openpower