blob: c91fb94e52982b94816c030836e4eff029144bdb [file] [log] [blame]
Andrew Jefferya607a0d2018-05-23 16:15:26 +09301#include "physical.hpp"
2
Andrew Jeffery280afaf2018-05-24 16:15:46 +09303#include <sys/param.h>
4
Andrew Jefferya607a0d2018-05-23 16:15:26 +09305#include <sdbusplus/bus.hpp>
6
Andrew Jeffery280afaf2018-05-24 16:15:46 +09307#include <gmock/gmock.h>
Andrew Jefferya607a0d2018-05-23 16:15:26 +09308#include <gtest/gtest.h>
9
10constexpr auto LED_OBJ = "/foo/bar/led";
Andrew Jefferya607a0d2018-05-23 16:15:26 +093011
12using Action = sdbusplus::xyz::openbmc_project::Led::server::Physical::Action;
Andrew Jeffery42e02d32018-05-24 13:34:05 +093013namespace fs = std::experimental::filesystem;
Andrew Jefferya607a0d2018-05-23 16:15:26 +093014
Andrew Jeffery280afaf2018-05-24 16:15:46 +093015fs::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
44class 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 Liu61b90632020-06-22 10:55:13 +080049 {}
Andrew Jeffery280afaf2018-05-24 16:15:46 +093050
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 Jefferyaee9c2c2018-05-25 14:05:40 +093068using ::testing::InSequence;
Andrew Jeffery280afaf2018-05-24 16:15:46 +093069using ::testing::NiceMock;
70using ::testing::Return;
71using ::testing::Throw;
72
Andrew Jeffery56692702018-05-25 11:41:43 +093073TEST(Physical, ctor_none_trigger)
Andrew Jefferya607a0d2018-05-23 16:15:26 +093074{
75 sdbusplus::bus::bus bus = sdbusplus::bus::new_default();
Andrew Jeffery280afaf2018-05-24 16:15:46 +093076 /* NiceMock ignores calls to methods with no expectations defined */
77 NiceMock<MockLed> led;
78 ON_CALL(led, getTrigger()).WillByDefault(Return("none"));
Andrew Jeffery42e02d32018-05-24 13:34:05 +093079 phosphor::led::Physical phy(bus, LED_OBJ, led);
Vishwanatha Subbannadb21bc02021-03-26 00:32:46 -050080 EXPECT_EQ(phy.state(), Action::Off);
Andrew Jefferya607a0d2018-05-23 16:15:26 +093081}
82
Vishwanatha Subbannaa8a275f2021-03-26 00:33:34 -050083TEST(Physical, ctor_maxbrightness_and_brightness_read_127)
84{
85 sdbusplus::bus::bus bus = sdbusplus::bus::new_default();
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));
91 phosphor::led::Physical phy(bus, LED_OBJ, led);
92 EXPECT_EQ(phy.state(), Action::On);
93}
94
95TEST(Physical, ctor_maxbrightness_and_brightness_read_0)
96{
97 sdbusplus::bus::bus bus = sdbusplus::bus::new_default();
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));
103 phosphor::led::Physical phy(bus, LED_OBJ, led);
104 EXPECT_EQ(phy.state(), Action::Off);
105}
106
107TEST(Physical, ctor_only_maxbrightness_read_127)
108{
109 sdbusplus::bus::bus bus = sdbusplus::bus::new_default();
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));
115 phosphor::led::Physical phy(bus, LED_OBJ, led);
116 EXPECT_EQ(phy.state(), Action::Off);
117}
118
119TEST(Physical, ctor_only_brightness_read_127)
120{
121 sdbusplus::bus::bus bus = sdbusplus::bus::new_default();
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));
127 phosphor::led::Physical phy(bus, LED_OBJ, led);
128 EXPECT_EQ(phy.state(), Action::Off);
129}
130
Andrew Jeffery56692702018-05-25 11:41:43 +0930131TEST(Physical, ctor_timer_trigger)
132{
133 sdbusplus::bus::bus bus = sdbusplus::bus::new_default();
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));
138 phosphor::led::Physical phy(bus, LED_OBJ, led);
Vishwanatha Subbannadb21bc02021-03-26 00:32:46 -0500139 EXPECT_EQ(phy.state(), Action::Off);
Andrew Jeffery56692702018-05-25 11:41:43 +0930140}
141
Andrew Jefferya607a0d2018-05-23 16:15:26 +0930142TEST(Physical, off)
143{
144 sdbusplus::bus::bus bus = sdbusplus::bus::new_default();
Andrew Jeffery280afaf2018-05-24 16:15:46 +0930145 NiceMock<MockLed> led;
Andrew Jeffery30726a02018-05-25 15:03:04 +0930146 ON_CALL(led, getMaxBrightness()).WillByDefault(Return(127));
147 EXPECT_CALL(led, getTrigger()).WillOnce(Return("none"));
148 EXPECT_CALL(led, getBrightness()).WillOnce(Return(phosphor::led::DEASSERT));
149 EXPECT_CALL(led, setBrightness(phosphor::led::DEASSERT)).Times(0);
Andrew Jeffery42e02d32018-05-24 13:34:05 +0930150 phosphor::led::Physical phy(bus, LED_OBJ, led);
151 phy.state(Action::Off);
Vishwanatha Subbannadb21bc02021-03-26 00:32:46 -0500152 EXPECT_EQ(phy.state(), Action::Off);
Andrew Jefferya607a0d2018-05-23 16:15:26 +0930153}
154
155TEST(Physical, on)
156{
Andrew Jeffery5b1417b2019-03-18 17:20:37 +1030157 constexpr unsigned long asserted = 127;
158
Andrew Jefferya607a0d2018-05-23 16:15:26 +0930159 sdbusplus::bus::bus bus = sdbusplus::bus::new_default();
Andrew Jeffery280afaf2018-05-24 16:15:46 +0930160 NiceMock<MockLed> led;
Andrew Jeffery5b1417b2019-03-18 17:20:37 +1030161 ON_CALL(led, getMaxBrightness()).WillByDefault(Return(asserted));
Andrew Jeffery30726a02018-05-25 15:03:04 +0930162 EXPECT_CALL(led, getTrigger()).WillOnce(Return("none"));
163 EXPECT_CALL(led, setTrigger("none"));
Andrew Jeffery5b1417b2019-03-18 17:20:37 +1030164 EXPECT_CALL(led, setBrightness(asserted));
Andrew Jeffery42e02d32018-05-24 13:34:05 +0930165 phosphor::led::Physical phy(bus, LED_OBJ, led);
166 phy.state(Action::On);
Vishwanatha Subbannadb21bc02021-03-26 00:32:46 -0500167 EXPECT_EQ(phy.state(), Action::On);
Andrew Jefferya607a0d2018-05-23 16:15:26 +0930168}
169
170TEST(Physical, blink)
171{
172 sdbusplus::bus::bus bus = sdbusplus::bus::new_default();
Andrew Jeffery280afaf2018-05-24 16:15:46 +0930173 NiceMock<MockLed> led;
Andrew Jeffery861e5622018-05-25 14:51:45 +0930174 EXPECT_CALL(led, getTrigger()).WillOnce(Return("none"));
175 EXPECT_CALL(led, setTrigger("timer"));
176 EXPECT_CALL(led, setDelayOn(500));
177 EXPECT_CALL(led, setDelayOff(500));
Andrew Jeffery42e02d32018-05-24 13:34:05 +0930178 phosphor::led::Physical phy(bus, LED_OBJ, led);
179 phy.state(Action::Blink);
Vishwanatha Subbannadb21bc02021-03-26 00:32:46 -0500180 EXPECT_EQ(phy.state(), Action::Blink);
Andrew Jefferya607a0d2018-05-23 16:15:26 +0930181}
Andrew Jeffery04275e02018-05-25 13:04:39 +0930182
183TEST(Physical, ctor_none_trigger_asserted_brightness)
184{
185 sdbusplus::bus::bus bus = sdbusplus::bus::new_default();
186 NiceMock<MockLed> led;
187 EXPECT_CALL(led, getTrigger()).WillRepeatedly(Return("none"));
Andrew Jeffery5b1417b2019-03-18 17:20:37 +1030188 EXPECT_CALL(led, getBrightness()).WillRepeatedly(Return(127));
Andrew Jeffery04275e02018-05-25 13:04:39 +0930189 phosphor::led::Physical phy(bus, LED_OBJ, led);
Vishwanatha Subbannadb21bc02021-03-26 00:32:46 -0500190 EXPECT_EQ(phy.state(), Action::Off);
Andrew Jeffery04275e02018-05-25 13:04:39 +0930191}
Andrew Jefferyaee9c2c2018-05-25 14:05:40 +0930192
193TEST(Physical, on_to_off)
194{
195 InSequence s;
Andrew Jeffery5b1417b2019-03-18 17:20:37 +1030196 constexpr unsigned long asserted = 127;
Andrew Jefferyaee9c2c2018-05-25 14:05:40 +0930197
198 auto bus = sdbusplus::bus::new_default();
199 NiceMock<MockLed> led;
Andrew Jeffery5b1417b2019-03-18 17:20:37 +1030200 ON_CALL(led, getMaxBrightness()).WillByDefault(Return(asserted));
Andrew Jefferyaee9c2c2018-05-25 14:05:40 +0930201 EXPECT_CALL(led, getTrigger()).Times(1).WillOnce(Return("none"));
202 constexpr auto deasserted = phosphor::led::DEASSERT;
203 EXPECT_CALL(led, getBrightness()).WillOnce(Return(deasserted));
Andrew Jefferyaee9c2c2018-05-25 14:05:40 +0930204 EXPECT_CALL(led, setBrightness(asserted));
205 EXPECT_CALL(led, setBrightness(deasserted));
206 phosphor::led::Physical phy(bus, LED_OBJ, led);
207 phy.state(Action::On);
Vishwanatha Subbannadb21bc02021-03-26 00:32:46 -0500208 EXPECT_EQ(phy.state(), Action::On);
Andrew Jefferyaee9c2c2018-05-25 14:05:40 +0930209 phy.state(Action::Off);
Vishwanatha Subbannadb21bc02021-03-26 00:32:46 -0500210 EXPECT_EQ(phy.state(), Action::Off);
Andrew Jefferyaee9c2c2018-05-25 14:05:40 +0930211}