Matt Spinler | 09d6400 | 2019-09-11 14:29:46 -0500 | [diff] [blame] | 1 | #include "extensions/openpower-pels/data_interface.hpp" |
Matt Spinler | f60ac27 | 2019-12-11 13:47:50 -0600 | [diff] [blame] | 2 | #include "extensions/openpower-pels/host_interface.hpp" |
| 3 | |
| 4 | #include <fcntl.h> |
| 5 | |
Matt Spinler | f60ac27 | 2019-12-11 13:47:50 -0600 | [diff] [blame] | 6 | #include <sdeventplus/source/io.hpp> |
Matt Spinler | 09d6400 | 2019-09-11 14:29:46 -0500 | [diff] [blame] | 7 | |
Patrick Williams | 2544b41 | 2022-10-04 08:41:06 -0500 | [diff] [blame^] | 8 | #include <filesystem> |
| 9 | |
Matt Spinler | 09d6400 | 2019-09-11 14:29:46 -0500 | [diff] [blame] | 10 | #include <gmock/gmock.h> |
| 11 | |
| 12 | namespace openpower |
| 13 | { |
| 14 | namespace pels |
| 15 | { |
| 16 | |
| 17 | class MockDataInterface : public DataInterfaceBase |
| 18 | { |
| 19 | public: |
Patrick Williams | 2544b41 | 2022-10-04 08:41:06 -0500 | [diff] [blame^] | 20 | MockDataInterface() {} |
Matt Spinler | f60ac27 | 2019-12-11 13:47:50 -0600 | [diff] [blame] | 21 | MOCK_METHOD(std::string, getMachineTypeModel, (), (const override)); |
| 22 | MOCK_METHOD(std::string, getMachineSerialNumber, (), (const override)); |
| 23 | MOCK_METHOD(std::string, getServerFWVersion, (), (const override)); |
| 24 | MOCK_METHOD(std::string, getBMCFWVersion, (), (const override)); |
Matt Spinler | 677381b | 2020-01-23 10:04:29 -0600 | [diff] [blame] | 25 | MOCK_METHOD(std::string, getBMCFWVersionID, (), (const override)); |
Matt Spinler | 24a8558 | 2020-01-27 16:40:21 -0600 | [diff] [blame] | 26 | MOCK_METHOD(bool, getHostPELEnablement, (), (const override)); |
Matt Spinler | 4aa23a1 | 2020-02-03 15:05:09 -0600 | [diff] [blame] | 27 | MOCK_METHOD(std::string, getBMCState, (), (const override)); |
| 28 | MOCK_METHOD(std::string, getChassisState, (), (const override)); |
| 29 | MOCK_METHOD(std::string, getHostState, (), (const override)); |
Matt Spinler | 075e5ba | 2020-02-21 15:46:00 -0600 | [diff] [blame] | 30 | MOCK_METHOD(std::string, getMotherboardCCIN, (), (const override)); |
Matt Spinler | 60c4e79 | 2020-03-13 13:45:36 -0500 | [diff] [blame] | 31 | MOCK_METHOD(void, getHWCalloutFields, |
Matt Spinler | 9b90e2a | 2020-04-14 10:59:04 -0500 | [diff] [blame] | 32 | (const std::string&, std::string&, std::string&, std::string&), |
Matt Spinler | 60c4e79 | 2020-03-13 13:45:36 -0500 | [diff] [blame] | 33 | (const override)); |
Matt Spinler | 9b90e2a | 2020-04-14 10:59:04 -0500 | [diff] [blame] | 34 | MOCK_METHOD(std::string, getLocationCode, (const std::string&), |
| 35 | (const override)); |
Matt Spinler | 1ab6696 | 2020-10-29 13:21:44 -0500 | [diff] [blame] | 36 | MOCK_METHOD(std::vector<std::string>, getSystemNames, (), (const override)); |
Matt Spinler | 5fb24c1 | 2020-06-04 11:21:33 -0500 | [diff] [blame] | 37 | MOCK_METHOD(std::string, expandLocationCode, (const std::string&, uint16_t), |
| 38 | (const override)); |
| 39 | MOCK_METHOD(std::string, getInventoryFromLocCode, |
Matt Spinler | 2f9225a | 2020-08-05 12:58:49 -0500 | [diff] [blame] | 40 | (const std::string&, uint16_t, bool), (const override)); |
Matt Spinler | 34a904c | 2020-08-05 14:53:28 -0500 | [diff] [blame] | 41 | MOCK_METHOD(void, assertLEDGroup, (const std::string&, bool), |
| 42 | (const override)); |
Matt Spinler | 993168d | 2021-04-07 16:05:03 -0500 | [diff] [blame] | 43 | MOCK_METHOD(void, setFunctional, (const std::string&, bool), |
| 44 | (const override)); |
Ben Tyner | e32b7e7 | 2021-05-18 12:38:40 -0500 | [diff] [blame] | 45 | MOCK_METHOD(std::vector<uint8_t>, getSystemIMKeyword, (), (const override)); |
Sumit Kumar | 3b8ed7f | 2021-05-18 12:38:35 -0500 | [diff] [blame] | 46 | MOCK_METHOD(bool, getQuiesceOnError, (), (const override)); |
Sumit Kumar | 76198a2 | 2021-07-15 05:59:57 -0500 | [diff] [blame] | 47 | MOCK_METHOD(void, setCriticalAssociation, (const std::string&), |
| 48 | (const override)); |
Sumit Kumar | 9d43a72 | 2021-08-24 09:46:19 -0500 | [diff] [blame] | 49 | MOCK_METHOD(std::vector<bool>, checkDumpStatus, |
| 50 | (const std::vector<std::string>&), (const override)); |
Sumit Kumar | 2c36fdd | 2021-09-21 03:12:11 -0500 | [diff] [blame] | 51 | MOCK_METHOD(std::string, getBootState, (), (const override)); |
Jayanth Othayoth | ecaa2fc | 2021-11-05 02:02:52 -0500 | [diff] [blame] | 52 | MOCK_METHOD(void, createGuardRecord, |
| 53 | (const std::vector<uint8_t>&, const std::string&, |
| 54 | const std::string&), |
| 55 | (const override)); |
Sumit Kumar | 3e27443 | 2021-09-14 06:37:56 -0500 | [diff] [blame] | 56 | MOCK_METHOD(void, createProgressSRC, |
| 57 | (const uint64_t&, const std::vector<uint8_t>&), |
| 58 | (const override)); |
Sumit Kumar | 027bf28 | 2022-01-24 11:25:19 -0600 | [diff] [blame] | 59 | MOCK_METHOD(std::vector<uint32_t>, getLogIDWithHwIsolation, (), |
| 60 | (const override)); |
Matt Spinler | 34a904c | 2020-08-05 14:53:28 -0500 | [diff] [blame] | 61 | |
Matt Spinler | f60ac27 | 2019-12-11 13:47:50 -0600 | [diff] [blame] | 62 | void changeHostState(bool newState) |
| 63 | { |
Matt Spinler | 4aa23a1 | 2020-02-03 15:05:09 -0600 | [diff] [blame] | 64 | setHostUp(newState); |
Matt Spinler | f60ac27 | 2019-12-11 13:47:50 -0600 | [diff] [blame] | 65 | } |
| 66 | |
| 67 | void setHMCManaged(bool managed) |
| 68 | { |
| 69 | _hmcManaged = managed; |
| 70 | } |
| 71 | }; |
| 72 | |
| 73 | /** |
| 74 | * @brief The mock HostInterface class |
Matt Spinler | 5342d9a | 2019-12-12 11:03:39 -0600 | [diff] [blame] | 75 | * |
| 76 | * This replaces the PLDM calls with a FIFO for the asynchronous |
| 77 | * responses. |
Matt Spinler | f60ac27 | 2019-12-11 13:47:50 -0600 | [diff] [blame] | 78 | */ |
| 79 | class MockHostInterface : public HostInterface |
| 80 | { |
| 81 | public: |
Matt Spinler | 5342d9a | 2019-12-12 11:03:39 -0600 | [diff] [blame] | 82 | /** |
| 83 | * @brief Constructor |
| 84 | * |
| 85 | * @param[in] event - The sd_event object |
| 86 | * @param[in] dataIface - The DataInterface class |
| 87 | */ |
Matt Spinler | f60ac27 | 2019-12-11 13:47:50 -0600 | [diff] [blame] | 88 | MockHostInterface(sd_event* event, DataInterfaceBase& dataIface) : |
| 89 | HostInterface(event, dataIface) |
| 90 | { |
Matt Spinler | 5342d9a | 2019-12-12 11:03:39 -0600 | [diff] [blame] | 91 | char templ[] = "/tmp/cmdfifoXXXXXX"; |
| 92 | std::filesystem::path dir = mkdtemp(templ); |
| 93 | _fifo = dir / "fifo"; |
Matt Spinler | f60ac27 | 2019-12-11 13:47:50 -0600 | [diff] [blame] | 94 | } |
| 95 | |
Matt Spinler | 5342d9a | 2019-12-12 11:03:39 -0600 | [diff] [blame] | 96 | /** |
| 97 | * @brief Destructor |
| 98 | */ |
Matt Spinler | f60ac27 | 2019-12-11 13:47:50 -0600 | [diff] [blame] | 99 | virtual ~MockHostInterface() |
| 100 | { |
Matt Spinler | 5342d9a | 2019-12-12 11:03:39 -0600 | [diff] [blame] | 101 | std::filesystem::remove_all(_fifo.parent_path()); |
Matt Spinler | f60ac27 | 2019-12-11 13:47:50 -0600 | [diff] [blame] | 102 | } |
| 103 | |
| 104 | MOCK_METHOD(CmdStatus, sendNewLogCmd, (uint32_t, uint32_t), (override)); |
| 105 | |
Matt Spinler | 5342d9a | 2019-12-12 11:03:39 -0600 | [diff] [blame] | 106 | /** |
| 107 | * @brief Cancels waiting for a command response |
| 108 | */ |
| 109 | virtual void cancelCmd() override |
| 110 | { |
| 111 | _inProgress = false; |
| 112 | _source = nullptr; |
| 113 | } |
| 114 | |
| 115 | /** |
| 116 | * @brief Returns the amount of time to wait before retrying after |
| 117 | * a failed send command. |
| 118 | * |
| 119 | * @return milliseconds - The amount of time to wait |
| 120 | */ |
| 121 | virtual std::chrono::milliseconds getSendRetryDelay() const override |
| 122 | { |
| 123 | return std::chrono::milliseconds(2); |
| 124 | } |
| 125 | |
| 126 | /** |
| 127 | * @brief Returns the amount of time to wait before retrying after |
| 128 | * a command receive. |
| 129 | * |
| 130 | * @return milliseconds - The amount of time to wait |
| 131 | */ |
| 132 | virtual std::chrono::milliseconds getReceiveRetryDelay() const override |
| 133 | { |
| 134 | return std::chrono::milliseconds(2); |
| 135 | } |
| 136 | |
| 137 | /** |
Matt Spinler | 41293cb | 2019-12-12 13:11:09 -0600 | [diff] [blame] | 138 | * @brief Returns the amount of time to wait before retrying if the |
| 139 | * host firmware's PEL storage was full and it can't store |
| 140 | * any more logs until it is freed up somehow. |
| 141 | * |
| 142 | * @return milliseconds - The amount of time to wait |
| 143 | */ |
| 144 | virtual std::chrono::milliseconds getHostFullRetryDelay() const override |
| 145 | { |
Matt Spinler | 6aae6a0 | 2020-02-07 12:46:07 -0600 | [diff] [blame] | 146 | return std::chrono::milliseconds(400); |
Matt Spinler | 41293cb | 2019-12-12 13:11:09 -0600 | [diff] [blame] | 147 | } |
| 148 | |
| 149 | /** |
Matt Spinler | e5f7508 | 2022-01-24 16:09:51 -0600 | [diff] [blame] | 150 | * @brief Returns the amount of time to wait after the host is up |
| 151 | * before sending commands. |
| 152 | * |
| 153 | * @return milliseconds - The amount of time to wait |
| 154 | */ |
| 155 | virtual std::chrono::milliseconds getHostUpDelay() const override |
| 156 | { |
| 157 | return std::chrono::milliseconds(0); |
| 158 | } |
| 159 | |
| 160 | /** |
Matt Spinler | 5342d9a | 2019-12-12 11:03:39 -0600 | [diff] [blame] | 161 | * @brief Returns the number of commands processed |
| 162 | */ |
| 163 | size_t numCmdsProcessed() const |
| 164 | { |
| 165 | return _cmdsProcessed; |
| 166 | } |
| 167 | |
| 168 | /** |
| 169 | * @brief Writes the data passed in to the FIFO |
| 170 | * |
| 171 | * @param[in] hostResponse - use a 0 to indicate success |
| 172 | * |
| 173 | * @return CmdStatus - success or failure |
| 174 | */ |
| 175 | CmdStatus send(uint8_t hostResponse) |
| 176 | { |
| 177 | // Create a FIFO once. |
| 178 | if (!std::filesystem::exists(_fifo)) |
| 179 | { |
| 180 | if (mkfifo(_fifo.c_str(), 0622)) |
| 181 | { |
| 182 | ADD_FAILURE() << "Failed mkfifo " << _fifo << strerror(errno); |
| 183 | exit(-1); |
| 184 | } |
| 185 | } |
| 186 | |
| 187 | // Open it and register the reponse callback to |
| 188 | // be used on FD activity. |
| 189 | int fd = open(_fifo.c_str(), O_NONBLOCK | O_RDWR); |
| 190 | EXPECT_TRUE(fd >= 0) << "Unable to open FIFO"; |
| 191 | |
| 192 | auto callback = [this](sdeventplus::source::IO& source, int fd, |
| 193 | uint32_t events) { |
| 194 | this->receive(source, fd, events); |
| 195 | }; |
| 196 | |
| 197 | try |
| 198 | { |
| 199 | _source = std::make_unique<sdeventplus::source::IO>( |
| 200 | _event, fd, EPOLLIN, |
| 201 | std::bind(callback, std::placeholders::_1, |
| 202 | std::placeholders::_2, std::placeholders::_3)); |
| 203 | } |
Patrick Williams | 66491c6 | 2021-10-06 12:23:37 -0500 | [diff] [blame] | 204 | catch (const std::exception& e) |
Matt Spinler | 5342d9a | 2019-12-12 11:03:39 -0600 | [diff] [blame] | 205 | { |
| 206 | ADD_FAILURE() << "Event exception: " << e.what(); |
| 207 | close(fd); |
| 208 | return CmdStatus::failure; |
| 209 | } |
| 210 | |
| 211 | // Write the fake host reponse to the FIFO |
| 212 | auto bytesWritten = write(fd, &hostResponse, sizeof(hostResponse)); |
| 213 | EXPECT_EQ(bytesWritten, sizeof(hostResponse)); |
| 214 | |
| 215 | _inProgress = true; |
| 216 | |
| 217 | return CmdStatus::success; |
| 218 | } |
| 219 | |
Matt Spinler | f60ac27 | 2019-12-11 13:47:50 -0600 | [diff] [blame] | 220 | protected: |
Matt Spinler | 5342d9a | 2019-12-12 11:03:39 -0600 | [diff] [blame] | 221 | /** |
| 222 | * @brief Reads the data written to the fifo and then calls |
| 223 | * the subscriber's callback. |
| 224 | * |
| 225 | * Nonzero data indicates a command failure (for testing bad path). |
| 226 | * |
| 227 | * @param[in] source - The event source object |
| 228 | * @param[in] fd - The file descriptor used |
| 229 | * @param[in] events - The event bits |
| 230 | */ |
Patrick Williams | d26fa3e | 2021-04-21 15:22:23 -0500 | [diff] [blame] | 231 | void receive(sdeventplus::source::IO& /*source*/, int /*fd*/, |
Matt Spinler | f60ac27 | 2019-12-11 13:47:50 -0600 | [diff] [blame] | 232 | uint32_t events) override |
| 233 | { |
Matt Spinler | 5342d9a | 2019-12-12 11:03:39 -0600 | [diff] [blame] | 234 | if (!(events & EPOLLIN)) |
| 235 | { |
| 236 | return; |
| 237 | } |
| 238 | |
| 239 | _inProgress = false; |
| 240 | |
| 241 | int newFD = open(_fifo.c_str(), O_NONBLOCK | O_RDONLY); |
| 242 | ASSERT_TRUE(newFD >= 0) << "Failed to open FIFO"; |
| 243 | |
| 244 | // Read the host success/failure response from the FIFO. |
| 245 | uint8_t data; |
| 246 | auto bytesRead = read(newFD, &data, sizeof(data)); |
| 247 | EXPECT_EQ(bytesRead, sizeof(data)); |
| 248 | |
| 249 | close(newFD); |
| 250 | |
| 251 | ResponseStatus status = ResponseStatus::success; |
| 252 | if (data != 0) |
| 253 | { |
| 254 | status = ResponseStatus::failure; |
| 255 | } |
| 256 | |
Matt Spinler | a44efe4 | 2020-03-03 10:30:16 -0600 | [diff] [blame] | 257 | callResponseFunc(status); |
Matt Spinler | 5342d9a | 2019-12-12 11:03:39 -0600 | [diff] [blame] | 258 | |
Matt Spinler | f60ac27 | 2019-12-11 13:47:50 -0600 | [diff] [blame] | 259 | // Keep account of the number of commands responses for testing. |
| 260 | _cmdsProcessed++; |
| 261 | } |
| 262 | |
| 263 | private: |
Matt Spinler | 5342d9a | 2019-12-12 11:03:39 -0600 | [diff] [blame] | 264 | /** |
| 265 | * @brief The event source for the fifo |
| 266 | */ |
| 267 | std::unique_ptr<sdeventplus::source::IO> _source; |
| 268 | |
| 269 | /** |
| 270 | * @brief the path to the fifo |
| 271 | */ |
| 272 | std::filesystem::path _fifo; |
| 273 | |
| 274 | /** |
| 275 | * @brief The number of commands processed |
| 276 | */ |
Matt Spinler | f60ac27 | 2019-12-11 13:47:50 -0600 | [diff] [blame] | 277 | size_t _cmdsProcessed = 0; |
Matt Spinler | 09d6400 | 2019-09-11 14:29:46 -0500 | [diff] [blame] | 278 | }; |
| 279 | |
| 280 | } // namespace pels |
| 281 | } // namespace openpower |