Andrew Jeffery | a607a0d | 2018-05-23 16:15:26 +0930 | [diff] [blame] | 1 | #include "physical.hpp" |
| 2 | |
Andrew Jeffery | 280afaf | 2018-05-24 16:15:46 +0930 | [diff] [blame] | 3 | #include <sys/param.h> |
| 4 | |
Andrew Jeffery | a607a0d | 2018-05-23 16:15:26 +0930 | [diff] [blame] | 5 | #include <sdbusplus/bus.hpp> |
| 6 | |
Andrew Jeffery | 280afaf | 2018-05-24 16:15:46 +0930 | [diff] [blame] | 7 | #include <gmock/gmock.h> |
Andrew Jeffery | a607a0d | 2018-05-23 16:15:26 +0930 | [diff] [blame] | 8 | #include <gtest/gtest.h> |
| 9 | |
Andrew Jeffery | 76544ab | 2023-02-06 18:11:30 +1030 | [diff] [blame^] | 10 | constexpr auto ledObj = "/foo/bar/led"; |
Andrew Jeffery | a607a0d | 2018-05-23 16:15:26 +0930 | [diff] [blame] | 11 | |
| 12 | using Action = sdbusplus::xyz::openbmc_project::Led::server::Physical::Action; |
George Liu | 45eba6f | 2021-05-18 14:32:20 +0800 | [diff] [blame] | 13 | namespace fs = std::filesystem; |
Andrew Jeffery | a607a0d | 2018-05-23 16:15:26 +0930 | [diff] [blame] | 14 | |
Andrew Jeffery | 280afaf | 2018-05-24 16:15:46 +0930 | [diff] [blame] | 15 | fs::path create_sandbox() |
| 16 | { |
| 17 | /* If your tests need to touch the filesystem, always use mkdtemp() or |
| 18 | * mkstemp() for creating directories and files. Tests can be run in |
| 19 | * parallel with `make -j`, and if use the same path in multiple tests they |
| 20 | * will stomp on eachother and likely fail. |
| 21 | */ |
| 22 | static constexpr auto tmplt = "/tmp/MockLed.XXXXXX"; |
| 23 | char buffer[MAXPATHLEN] = {0}; |
| 24 | |
| 25 | strncpy(buffer, tmplt, sizeof(buffer) - 1); |
| 26 | auto dir = mkdtemp(buffer); |
| 27 | if (!dir) |
| 28 | { |
| 29 | throw std::system_error(errno, std::system_category()); |
| 30 | } |
| 31 | |
| 32 | /* We want to limit behaviours to mocks, and if methods aren't mocked they |
| 33 | * may fall back to their base class implementation. Stop read/write to |
| 34 | * directory to prevent streams from creating files. |
| 35 | */ |
| 36 | if (chmod(dir, S_IXUSR | S_IXGRP) == -1) |
| 37 | { |
| 38 | throw std::system_error(errno, std::system_category()); |
| 39 | } |
| 40 | |
| 41 | return fs::path(dir); |
| 42 | } |
| 43 | |
| 44 | class MockLed : public phosphor::led::SysfsLed |
| 45 | { |
| 46 | public: |
| 47 | /* Use a no-args ctor here to avoid headaches with {Nice,Strict}Mock */ |
| 48 | MockLed() : SysfsLed(create_sandbox()) |
George Liu | 61b9063 | 2020-06-22 10:55:13 +0800 | [diff] [blame] | 49 | {} |
Andrew Jeffery | 280afaf | 2018-05-24 16:15:46 +0930 | [diff] [blame] | 50 | |
| 51 | virtual ~MockLed() |
| 52 | { |
| 53 | chmod(root.c_str(), S_IRUSR | S_IWUSR | S_IXUSR); |
| 54 | fs::remove_all(root); |
| 55 | } |
| 56 | |
| 57 | MOCK_METHOD0(getBrightness, unsigned long()); |
| 58 | MOCK_METHOD1(setBrightness, void(unsigned long value)); |
| 59 | MOCK_METHOD0(getMaxBrightness, unsigned long()); |
| 60 | MOCK_METHOD0(getTrigger, std::string()); |
| 61 | MOCK_METHOD1(setTrigger, void(const std::string& trigger)); |
| 62 | MOCK_METHOD0(getDelayOn, unsigned long()); |
| 63 | MOCK_METHOD1(setDelayOn, void(unsigned long ms)); |
| 64 | MOCK_METHOD0(getDelayOff, unsigned long()); |
| 65 | MOCK_METHOD1(setDelayOff, void(unsigned long ms)); |
| 66 | }; |
| 67 | |
Andrew Jeffery | aee9c2c | 2018-05-25 14:05:40 +0930 | [diff] [blame] | 68 | using ::testing::InSequence; |
Andrew Jeffery | 280afaf | 2018-05-24 16:15:46 +0930 | [diff] [blame] | 69 | using ::testing::NiceMock; |
| 70 | using ::testing::Return; |
| 71 | using ::testing::Throw; |
| 72 | |
Andrew Jeffery | 5669270 | 2018-05-25 11:41:43 +0930 | [diff] [blame] | 73 | TEST(Physical, ctor_none_trigger) |
Andrew Jeffery | a607a0d | 2018-05-23 16:15:26 +0930 | [diff] [blame] | 74 | { |
Patrick Williams | ff3d538 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 75 | sdbusplus::bus_t bus = sdbusplus::bus::new_default(); |
Andrew Jeffery | 280afaf | 2018-05-24 16:15:46 +0930 | [diff] [blame] | 76 | /* NiceMock ignores calls to methods with no expectations defined */ |
| 77 | NiceMock<MockLed> led; |
| 78 | ON_CALL(led, getTrigger()).WillByDefault(Return("none")); |
Andrew Jeffery | 76544ab | 2023-02-06 18:11:30 +1030 | [diff] [blame^] | 79 | phosphor::led::Physical phy(bus, ledObj, led); |
Vishwanatha Subbanna | db21bc0 | 2021-03-26 00:32:46 -0500 | [diff] [blame] | 80 | EXPECT_EQ(phy.state(), Action::Off); |
Andrew Jeffery | a607a0d | 2018-05-23 16:15:26 +0930 | [diff] [blame] | 81 | } |
| 82 | |
Vishwanatha Subbanna | a8a275f | 2021-03-26 00:33:34 -0500 | [diff] [blame] | 83 | TEST(Physical, ctor_maxbrightness_and_brightness_read_127) |
| 84 | { |
Patrick Williams | ff3d538 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 85 | sdbusplus::bus_t bus = sdbusplus::bus::new_default(); |
Vishwanatha Subbanna | a8a275f | 2021-03-26 00:33:34 -0500 | [diff] [blame] | 86 | /* NiceMock ignores calls to methods with no expectations defined */ |
| 87 | NiceMock<MockLed> led; |
| 88 | EXPECT_CALL(led, getTrigger()).WillRepeatedly(Return("none")); |
| 89 | EXPECT_CALL(led, getBrightness()).WillOnce(Return(127)); |
| 90 | EXPECT_CALL(led, getMaxBrightness()).WillOnce(Return(127)); |
Andrew Jeffery | 76544ab | 2023-02-06 18:11:30 +1030 | [diff] [blame^] | 91 | phosphor::led::Physical phy(bus, ledObj, led); |
Vishwanatha Subbanna | a8a275f | 2021-03-26 00:33:34 -0500 | [diff] [blame] | 92 | EXPECT_EQ(phy.state(), Action::On); |
| 93 | } |
| 94 | |
| 95 | TEST(Physical, ctor_maxbrightness_and_brightness_read_0) |
| 96 | { |
Patrick Williams | ff3d538 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 97 | sdbusplus::bus_t bus = sdbusplus::bus::new_default(); |
Vishwanatha Subbanna | a8a275f | 2021-03-26 00:33:34 -0500 | [diff] [blame] | 98 | /* NiceMock ignores calls to methods with no expectations defined */ |
| 99 | NiceMock<MockLed> led; |
| 100 | EXPECT_CALL(led, getTrigger()).WillRepeatedly(Return("none")); |
| 101 | EXPECT_CALL(led, getBrightness()).WillOnce(Return(0)); |
| 102 | EXPECT_CALL(led, getMaxBrightness()).WillOnce(Return(0)); |
Andrew Jeffery | 76544ab | 2023-02-06 18:11:30 +1030 | [diff] [blame^] | 103 | phosphor::led::Physical phy(bus, ledObj, led); |
Vishwanatha Subbanna | a8a275f | 2021-03-26 00:33:34 -0500 | [diff] [blame] | 104 | EXPECT_EQ(phy.state(), Action::Off); |
| 105 | } |
| 106 | |
| 107 | TEST(Physical, ctor_only_maxbrightness_read_127) |
| 108 | { |
Patrick Williams | ff3d538 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 109 | sdbusplus::bus_t bus = sdbusplus::bus::new_default(); |
Vishwanatha Subbanna | a8a275f | 2021-03-26 00:33:34 -0500 | [diff] [blame] | 110 | /* NiceMock ignores calls to methods with no expectations defined */ |
| 111 | NiceMock<MockLed> led; |
| 112 | EXPECT_CALL(led, getTrigger()).WillRepeatedly(Return("none")); |
| 113 | EXPECT_CALL(led, getBrightness()).WillOnce(Return(0)); |
| 114 | EXPECT_CALL(led, getMaxBrightness()).WillOnce(Return(127)); |
Andrew Jeffery | 76544ab | 2023-02-06 18:11:30 +1030 | [diff] [blame^] | 115 | phosphor::led::Physical phy(bus, ledObj, led); |
Vishwanatha Subbanna | a8a275f | 2021-03-26 00:33:34 -0500 | [diff] [blame] | 116 | EXPECT_EQ(phy.state(), Action::Off); |
| 117 | } |
| 118 | |
| 119 | TEST(Physical, ctor_only_brightness_read_127) |
| 120 | { |
Patrick Williams | ff3d538 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 121 | sdbusplus::bus_t bus = sdbusplus::bus::new_default(); |
Vishwanatha Subbanna | a8a275f | 2021-03-26 00:33:34 -0500 | [diff] [blame] | 122 | /* NiceMock ignores calls to methods with no expectations defined */ |
| 123 | NiceMock<MockLed> led; |
| 124 | EXPECT_CALL(led, getTrigger()).WillRepeatedly(Return("none")); |
| 125 | EXPECT_CALL(led, getBrightness()).WillOnce(Return(127)); |
| 126 | EXPECT_CALL(led, getMaxBrightness()).WillOnce(Return(0)); |
Andrew Jeffery | 76544ab | 2023-02-06 18:11:30 +1030 | [diff] [blame^] | 127 | phosphor::led::Physical phy(bus, ledObj, led); |
Vishwanatha Subbanna | a8a275f | 2021-03-26 00:33:34 -0500 | [diff] [blame] | 128 | EXPECT_EQ(phy.state(), Action::Off); |
| 129 | } |
| 130 | |
Andrew Jeffery | 5669270 | 2018-05-25 11:41:43 +0930 | [diff] [blame] | 131 | TEST(Physical, ctor_timer_trigger) |
| 132 | { |
Patrick Williams | ff3d538 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 133 | sdbusplus::bus_t bus = sdbusplus::bus::new_default(); |
Andrew Jeffery | 5669270 | 2018-05-25 11:41:43 +0930 | [diff] [blame] | 134 | NiceMock<MockLed> led; |
| 135 | EXPECT_CALL(led, getTrigger()).WillOnce(Return("timer")); |
| 136 | EXPECT_CALL(led, getDelayOn()).WillOnce(Return(500)); |
| 137 | EXPECT_CALL(led, getDelayOff()).WillOnce(Return(500)); |
Andrew Jeffery | 76544ab | 2023-02-06 18:11:30 +1030 | [diff] [blame^] | 138 | phosphor::led::Physical phy(bus, ledObj, led); |
Vishwanatha Subbanna | db21bc0 | 2021-03-26 00:32:46 -0500 | [diff] [blame] | 139 | EXPECT_EQ(phy.state(), Action::Off); |
Andrew Jeffery | 5669270 | 2018-05-25 11:41:43 +0930 | [diff] [blame] | 140 | } |
| 141 | |
Andrew Jeffery | a607a0d | 2018-05-23 16:15:26 +0930 | [diff] [blame] | 142 | TEST(Physical, off) |
| 143 | { |
Patrick Williams | ff3d538 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 144 | sdbusplus::bus_t bus = sdbusplus::bus::new_default(); |
Andrew Jeffery | 280afaf | 2018-05-24 16:15:46 +0930 | [diff] [blame] | 145 | NiceMock<MockLed> led; |
Andrew Jeffery | 30726a0 | 2018-05-25 15:03:04 +0930 | [diff] [blame] | 146 | ON_CALL(led, getMaxBrightness()).WillByDefault(Return(127)); |
| 147 | EXPECT_CALL(led, getTrigger()).WillOnce(Return("none")); |
Andrew Jeffery | 8e85228 | 2023-02-06 19:29:43 +1030 | [diff] [blame] | 148 | EXPECT_CALL(led, getBrightness()) |
| 149 | .WillOnce(Return(phosphor::led::deasserted)); |
| 150 | EXPECT_CALL(led, setBrightness(phosphor::led::deasserted)).Times(0); |
Andrew Jeffery | 76544ab | 2023-02-06 18:11:30 +1030 | [diff] [blame^] | 151 | phosphor::led::Physical phy(bus, ledObj, led); |
Andrew Jeffery | 42e02d3 | 2018-05-24 13:34:05 +0930 | [diff] [blame] | 152 | phy.state(Action::Off); |
Vishwanatha Subbanna | db21bc0 | 2021-03-26 00:32:46 -0500 | [diff] [blame] | 153 | EXPECT_EQ(phy.state(), Action::Off); |
Andrew Jeffery | a607a0d | 2018-05-23 16:15:26 +0930 | [diff] [blame] | 154 | } |
| 155 | |
| 156 | TEST(Physical, on) |
| 157 | { |
Andrew Jeffery | 5b1417b | 2019-03-18 17:20:37 +1030 | [diff] [blame] | 158 | constexpr unsigned long asserted = 127; |
| 159 | |
Patrick Williams | ff3d538 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 160 | sdbusplus::bus_t bus = sdbusplus::bus::new_default(); |
Andrew Jeffery | 280afaf | 2018-05-24 16:15:46 +0930 | [diff] [blame] | 161 | NiceMock<MockLed> led; |
Andrew Jeffery | 5b1417b | 2019-03-18 17:20:37 +1030 | [diff] [blame] | 162 | ON_CALL(led, getMaxBrightness()).WillByDefault(Return(asserted)); |
Andrew Jeffery | 30726a0 | 2018-05-25 15:03:04 +0930 | [diff] [blame] | 163 | EXPECT_CALL(led, getTrigger()).WillOnce(Return("none")); |
| 164 | EXPECT_CALL(led, setTrigger("none")); |
Andrew Jeffery | 5b1417b | 2019-03-18 17:20:37 +1030 | [diff] [blame] | 165 | EXPECT_CALL(led, setBrightness(asserted)); |
Andrew Jeffery | 76544ab | 2023-02-06 18:11:30 +1030 | [diff] [blame^] | 166 | phosphor::led::Physical phy(bus, ledObj, led); |
Andrew Jeffery | 42e02d3 | 2018-05-24 13:34:05 +0930 | [diff] [blame] | 167 | phy.state(Action::On); |
Vishwanatha Subbanna | db21bc0 | 2021-03-26 00:32:46 -0500 | [diff] [blame] | 168 | EXPECT_EQ(phy.state(), Action::On); |
Andrew Jeffery | a607a0d | 2018-05-23 16:15:26 +0930 | [diff] [blame] | 169 | } |
| 170 | |
| 171 | TEST(Physical, blink) |
| 172 | { |
Patrick Williams | ff3d538 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 173 | sdbusplus::bus_t bus = sdbusplus::bus::new_default(); |
Andrew Jeffery | 280afaf | 2018-05-24 16:15:46 +0930 | [diff] [blame] | 174 | NiceMock<MockLed> led; |
Andrew Jeffery | 861e562 | 2018-05-25 14:51:45 +0930 | [diff] [blame] | 175 | EXPECT_CALL(led, getTrigger()).WillOnce(Return("none")); |
| 176 | EXPECT_CALL(led, setTrigger("timer")); |
| 177 | EXPECT_CALL(led, setDelayOn(500)); |
| 178 | EXPECT_CALL(led, setDelayOff(500)); |
Andrew Jeffery | 76544ab | 2023-02-06 18:11:30 +1030 | [diff] [blame^] | 179 | phosphor::led::Physical phy(bus, ledObj, led); |
Andrew Jeffery | 42e02d3 | 2018-05-24 13:34:05 +0930 | [diff] [blame] | 180 | phy.state(Action::Blink); |
Vishwanatha Subbanna | db21bc0 | 2021-03-26 00:32:46 -0500 | [diff] [blame] | 181 | EXPECT_EQ(phy.state(), Action::Blink); |
Andrew Jeffery | a607a0d | 2018-05-23 16:15:26 +0930 | [diff] [blame] | 182 | } |
Andrew Jeffery | 04275e0 | 2018-05-25 13:04:39 +0930 | [diff] [blame] | 183 | |
| 184 | TEST(Physical, ctor_none_trigger_asserted_brightness) |
| 185 | { |
Patrick Williams | ff3d538 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 186 | sdbusplus::bus_t bus = sdbusplus::bus::new_default(); |
Andrew Jeffery | 04275e0 | 2018-05-25 13:04:39 +0930 | [diff] [blame] | 187 | NiceMock<MockLed> led; |
| 188 | EXPECT_CALL(led, getTrigger()).WillRepeatedly(Return("none")); |
Andrew Jeffery | 5b1417b | 2019-03-18 17:20:37 +1030 | [diff] [blame] | 189 | EXPECT_CALL(led, getBrightness()).WillRepeatedly(Return(127)); |
Andrew Jeffery | 76544ab | 2023-02-06 18:11:30 +1030 | [diff] [blame^] | 190 | phosphor::led::Physical phy(bus, ledObj, led); |
Vishwanatha Subbanna | db21bc0 | 2021-03-26 00:32:46 -0500 | [diff] [blame] | 191 | EXPECT_EQ(phy.state(), Action::Off); |
Andrew Jeffery | 04275e0 | 2018-05-25 13:04:39 +0930 | [diff] [blame] | 192 | } |
Andrew Jeffery | aee9c2c | 2018-05-25 14:05:40 +0930 | [diff] [blame] | 193 | |
| 194 | TEST(Physical, on_to_off) |
| 195 | { |
| 196 | InSequence s; |
Andrew Jeffery | 5b1417b | 2019-03-18 17:20:37 +1030 | [diff] [blame] | 197 | constexpr unsigned long asserted = 127; |
Andrew Jeffery | aee9c2c | 2018-05-25 14:05:40 +0930 | [diff] [blame] | 198 | |
| 199 | auto bus = sdbusplus::bus::new_default(); |
| 200 | NiceMock<MockLed> led; |
Andrew Jeffery | 5b1417b | 2019-03-18 17:20:37 +1030 | [diff] [blame] | 201 | ON_CALL(led, getMaxBrightness()).WillByDefault(Return(asserted)); |
Andrew Jeffery | aee9c2c | 2018-05-25 14:05:40 +0930 | [diff] [blame] | 202 | EXPECT_CALL(led, getTrigger()).Times(1).WillOnce(Return("none")); |
Andrew Jeffery | 8e85228 | 2023-02-06 19:29:43 +1030 | [diff] [blame] | 203 | constexpr auto deasserted = phosphor::led::deasserted; |
Andrew Jeffery | aee9c2c | 2018-05-25 14:05:40 +0930 | [diff] [blame] | 204 | EXPECT_CALL(led, getBrightness()).WillOnce(Return(deasserted)); |
Andrew Jeffery | aee9c2c | 2018-05-25 14:05:40 +0930 | [diff] [blame] | 205 | EXPECT_CALL(led, setBrightness(asserted)); |
| 206 | EXPECT_CALL(led, setBrightness(deasserted)); |
Andrew Jeffery | 76544ab | 2023-02-06 18:11:30 +1030 | [diff] [blame^] | 207 | phosphor::led::Physical phy(bus, ledObj, led); |
Andrew Jeffery | aee9c2c | 2018-05-25 14:05:40 +0930 | [diff] [blame] | 208 | phy.state(Action::On); |
Vishwanatha Subbanna | db21bc0 | 2021-03-26 00:32:46 -0500 | [diff] [blame] | 209 | EXPECT_EQ(phy.state(), Action::On); |
Andrew Jeffery | aee9c2c | 2018-05-25 14:05:40 +0930 | [diff] [blame] | 210 | phy.state(Action::Off); |
Vishwanatha Subbanna | db21bc0 | 2021-03-26 00:32:46 -0500 | [diff] [blame] | 211 | EXPECT_EQ(phy.state(), Action::Off); |
Andrew Jeffery | aee9c2c | 2018-05-25 14:05:40 +0930 | [diff] [blame] | 212 | } |