Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 1 | #include "dbus_environment.hpp" |
Krzysztof Grobelny | 51f0fd5 | 2021-12-28 16:32:08 +0100 | [diff] [blame] | 2 | #include "fakes/clock_fake.hpp" |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 3 | #include "helpers.hpp" |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 4 | #include "mocks/json_storage_mock.hpp" |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 5 | #include "mocks/metric_mock.hpp" |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 6 | #include "mocks/report_manager_mock.hpp" |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 7 | #include "params/report_params.hpp" |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 8 | #include "report.hpp" |
| 9 | #include "report_manager.hpp" |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 10 | #include "utils/clock.hpp" |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 11 | #include "utils/contains.hpp" |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 12 | #include "utils/conv_container.hpp" |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 13 | #include "utils/transform.hpp" |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 14 | #include "utils/tstring.hpp" |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 15 | |
| 16 | #include <sdbusplus/exception.hpp> |
| 17 | |
| 18 | using namespace testing; |
| 19 | using namespace std::literals::string_literals; |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 20 | using namespace std::chrono_literals; |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 21 | namespace tstring = utils::tstring; |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 22 | |
Krzysztof Grobelny | 51f0fd5 | 2021-12-28 16:32:08 +0100 | [diff] [blame] | 23 | constexpr Milliseconds systemTimestamp = 55ms; |
| 24 | |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 25 | class TestReport : public Test |
| 26 | { |
| 27 | public: |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 28 | ReportParams defaultParams; |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 29 | |
| 30 | std::unique_ptr<ReportManagerMock> reportManagerMock = |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 31 | std::make_unique<NiceMock<ReportManagerMock>>(); |
| 32 | testing::NiceMock<StorageMock> storageMock; |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 33 | std::vector<std::shared_ptr<MetricMock>> metricMocks; |
Krzysztof Grobelny | 51f0fd5 | 2021-12-28 16:32:08 +0100 | [diff] [blame] | 34 | std::unique_ptr<ClockFake> clockFakePtr = std::make_unique<ClockFake>(); |
| 35 | ClockFake& clockFake = *clockFakePtr; |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 36 | std::unique_ptr<Report> sut; |
| 37 | |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 38 | MockFunction<void()> checkPoint; |
| 39 | |
Krzysztof Grobelny | 51f0fd5 | 2021-12-28 16:32:08 +0100 | [diff] [blame] | 40 | TestReport() |
| 41 | { |
| 42 | clockFake.system.set(systemTimestamp); |
| 43 | } |
| 44 | |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 45 | void initMetricMocks( |
| 46 | const std::vector<LabeledMetricParameters>& metricParameters) |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 47 | { |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 48 | for (auto i = metricMocks.size(); i < metricParameters.size(); ++i) |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 49 | { |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 50 | metricMocks.emplace_back(std::make_shared<NiceMock<MetricMock>>()); |
| 51 | } |
| 52 | metricMocks.resize(metricParameters.size()); |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 53 | |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 54 | std::vector<MetricValue> readings{{MetricValue{"a", "b", 17.1, 114}, |
| 55 | MetricValue{"aa", "bb", 42.0, 74}}}; |
| 56 | readings.resize(metricParameters.size()); |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 57 | |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 58 | for (size_t i = 0; i < metricParameters.size(); ++i) |
| 59 | { |
| 60 | ON_CALL(*metricMocks[i], getReadings()) |
Krzysztof Grobelny | 8069771 | 2021-03-04 09:49:27 +0000 | [diff] [blame] | 61 | .WillByDefault(Return(std::vector({readings[i]}))); |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 62 | ON_CALL(*metricMocks[i], dumpConfiguration()) |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 63 | .WillByDefault(Return(metricParameters[i])); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 64 | } |
| 65 | } |
| 66 | |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 67 | void SetUp() override |
| 68 | { |
| 69 | sut = makeReport(ReportParams()); |
| 70 | } |
| 71 | |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 72 | static interfaces::JsonStorage::FilePath to_file_path(std::string id) |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 73 | { |
| 74 | return interfaces::JsonStorage::FilePath( |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 75 | std::to_string(std::hash<std::string>{}(id))); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 76 | } |
| 77 | |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 78 | std::unique_ptr<Report> makeReport(const ReportParams& params) |
| 79 | { |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 80 | initMetricMocks(params.metricParameters()); |
| 81 | |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 82 | return std::make_unique<Report>( |
| 83 | DbusEnvironment::getIoc(), DbusEnvironment::getObjServer(), |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 84 | params.reportId(), params.reportName(), params.reportingType(), |
| 85 | params.reportActions(), params.interval(), params.appendLimit(), |
| 86 | params.reportUpdates(), *reportManagerMock, storageMock, |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 87 | utils::convContainer<std::shared_ptr<interfaces::Metric>>( |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 88 | metricMocks), |
Szymon Dompke | b4ef22e | 2022-02-07 15:15:12 +0100 | [diff] [blame] | 89 | params.enabled(), std::move(clockFakePtr), params.triggerIds()); |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 90 | } |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 91 | |
| 92 | template <class T> |
| 93 | static T getProperty(const std::string& path, const std::string& property) |
| 94 | { |
Szymon Dompke | e28aa53 | 2021-10-27 12:33:12 +0200 | [diff] [blame] | 95 | return DbusEnvironment::getProperty<T>(path, Report::reportIfaceName, |
| 96 | property); |
| 97 | } |
| 98 | |
| 99 | template <class T> |
| 100 | static boost::system::error_code setProperty(const std::string& path, |
| 101 | const std::string& property, |
| 102 | const T& newValue) |
| 103 | { |
| 104 | return DbusEnvironment::setProperty<T>(path, Report::reportIfaceName, |
| 105 | property, newValue); |
Krzysztof Grobelny | f32f6fe | 2020-10-30 13:51:58 +0100 | [diff] [blame] | 106 | } |
| 107 | |
| 108 | boost::system::error_code call(const std::string& path, |
| 109 | const std::string& interface, |
| 110 | const std::string& method) |
| 111 | { |
| 112 | std::promise<boost::system::error_code> methodPromise; |
| 113 | DbusEnvironment::getBus()->async_method_call( |
| 114 | [&methodPromise](boost::system::error_code ec) { |
| 115 | methodPromise.set_value(ec); |
| 116 | }, |
| 117 | DbusEnvironment::serviceName(), path, interface, method); |
| 118 | return DbusEnvironment::waitForFuture(methodPromise.get_future()); |
| 119 | } |
| 120 | |
| 121 | boost::system::error_code update(const std::string& path) |
| 122 | { |
| 123 | return call(path, Report::reportIfaceName, "Update"); |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 124 | } |
| 125 | |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 126 | boost::system::error_code deleteReport(const std::string& path) |
| 127 | { |
Krzysztof Grobelny | f32f6fe | 2020-10-30 13:51:58 +0100 | [diff] [blame] | 128 | return call(path, Report::deleteIfaceName, "Delete"); |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 129 | } |
| 130 | }; |
| 131 | |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 132 | TEST_F(TestReport, returnsId) |
| 133 | { |
| 134 | EXPECT_THAT(sut->getId(), Eq(defaultParams.reportId())); |
| 135 | } |
| 136 | |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 137 | TEST_F(TestReport, verifyIfPropertiesHaveValidValue) |
| 138 | { |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 139 | EXPECT_THAT(getProperty<bool>(sut->getPath(), "Enabled"), |
| 140 | Eq(defaultParams.enabled())); |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 141 | EXPECT_THAT(getProperty<uint64_t>(sut->getPath(), "Interval"), |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 142 | Eq(defaultParams.interval().count())); |
| 143 | EXPECT_THAT(getProperty<bool>(sut->getPath(), "Persistency"), Eq(true)); |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 144 | EXPECT_THAT( |
| 145 | getProperty<std::vector<std::string>>(sut->getPath(), "ReportActions"), |
| 146 | Eq(utils::transform(defaultParams.reportActions(), [](const auto v) { |
| 147 | return utils::enumToString(v); |
| 148 | }))); |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 149 | EXPECT_THAT(getProperty<bool>(sut->getPath(), "EmitsReadingsUpdate"), |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 150 | Eq(utils::contains(defaultParams.reportActions(), |
| 151 | ReportAction::emitsReadingsUpdate))); |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame] | 152 | EXPECT_THAT(getProperty<uint64_t>(sut->getPath(), "AppendLimit"), |
| 153 | Eq(defaultParams.appendLimit())); |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 154 | EXPECT_THAT(getProperty<std::string>(sut->getPath(), "ReportingType"), |
| 155 | Eq(utils::enumToString(defaultParams.reportingType()))); |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame] | 156 | EXPECT_THAT(getProperty<std::string>(sut->getPath(), "ReportUpdates"), |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 157 | Eq(utils::enumToString(defaultParams.reportUpdates()))); |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 158 | EXPECT_THAT( |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 159 | getProperty<bool>(sut->getPath(), "LogToMetricReportsCollection"), |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 160 | Eq(utils::contains(defaultParams.reportActions(), |
| 161 | ReportAction::logToMetricReportsCollection))); |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 162 | EXPECT_THAT(getProperty<ReadingParameters>( |
| 163 | sut->getPath(), "ReadingParametersFutureVersion"), |
| 164 | Eq(toReadingParameters(defaultParams.metricParameters()))); |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 165 | EXPECT_THAT(getProperty<std::string>(sut->getPath(), "Name"), |
| 166 | Eq(defaultParams.reportName())); |
Szymon Dompke | b4ef22e | 2022-02-07 15:15:12 +0100 | [diff] [blame] | 167 | EXPECT_THAT( |
| 168 | getProperty<std::vector<std::string>>(sut->getPath(), "TriggerIds"), |
| 169 | Eq(std::vector<std::string>())); |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 170 | } |
| 171 | |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 172 | TEST_F(TestReport, readingsAreInitialyEmpty) |
| 173 | { |
| 174 | EXPECT_THAT(getProperty<Readings>(sut->getPath(), "Readings"), |
| 175 | Eq(Readings{})); |
| 176 | } |
| 177 | |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 178 | TEST_F(TestReport, setEnabledWithNewValue) |
| 179 | { |
| 180 | bool newValue = !defaultParams.enabled(); |
| 181 | EXPECT_THAT(setProperty(sut->getPath(), "Enabled", newValue).value(), |
| 182 | Eq(boost::system::errc::success)); |
| 183 | EXPECT_THAT(getProperty<bool>(sut->getPath(), "Enabled"), Eq(newValue)); |
| 184 | } |
| 185 | |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 186 | TEST_F(TestReport, setIntervalWithValidValue) |
| 187 | { |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 188 | uint64_t newValue = defaultParams.interval().count() + 1; |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 189 | EXPECT_THAT(setProperty(sut->getPath(), "Interval", newValue).value(), |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 190 | Eq(boost::system::errc::success)); |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 191 | EXPECT_THAT(getProperty<uint64_t>(sut->getPath(), "Interval"), |
| 192 | Eq(newValue)); |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 193 | } |
| 194 | |
Szymon Dompke | 3e2cc9d | 2021-12-14 12:00:52 +0100 | [diff] [blame] | 195 | TEST_F( |
| 196 | TestReport, |
| 197 | settingIntervalWithInvalidValueDoesNotChangePropertyAndReturnsInvalidArgument) |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 198 | { |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 199 | uint64_t newValue = defaultParams.interval().count() - 1; |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 200 | EXPECT_THAT(setProperty(sut->getPath(), "Interval", newValue).value(), |
Szymon Dompke | 3e2cc9d | 2021-12-14 12:00:52 +0100 | [diff] [blame] | 201 | Eq(boost::system::errc::invalid_argument)); |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 202 | EXPECT_THAT(getProperty<uint64_t>(sut->getPath(), "Interval"), |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 203 | Eq(defaultParams.interval().count())); |
| 204 | } |
| 205 | |
Wludzik, Jozef | b1ff1f6 | 2020-10-23 13:20:52 +0200 | [diff] [blame] | 206 | TEST_F(TestReport, settingEmitsReadingsUpdateHaveNoEffect) |
| 207 | { |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 208 | EXPECT_THAT( |
| 209 | setProperty(sut->getPath(), "EmitsReadingsUpdate", true).value(), |
| 210 | Eq(boost::system::errc::read_only_file_system)); |
Wludzik, Jozef | b1ff1f6 | 2020-10-23 13:20:52 +0200 | [diff] [blame] | 211 | EXPECT_THAT(getProperty<bool>(sut->getPath(), "EmitsReadingsUpdate"), |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 212 | Eq(utils::contains(defaultParams.reportActions(), |
| 213 | ReportAction::emitsReadingsUpdate))); |
Wludzik, Jozef | b1ff1f6 | 2020-10-23 13:20:52 +0200 | [diff] [blame] | 214 | } |
| 215 | |
| 216 | TEST_F(TestReport, settingLogToMetricReportCollectionHaveNoEffect) |
| 217 | { |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 218 | EXPECT_THAT( |
| 219 | setProperty(sut->getPath(), "LogToMetricReportsCollection", true) |
| 220 | .value(), |
| 221 | Eq(boost::system::errc::read_only_file_system)); |
Wludzik, Jozef | b1ff1f6 | 2020-10-23 13:20:52 +0200 | [diff] [blame] | 222 | EXPECT_THAT( |
| 223 | getProperty<bool>(sut->getPath(), "LogToMetricReportsCollection"), |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 224 | Eq(utils::contains(defaultParams.reportActions(), |
| 225 | ReportAction::logToMetricReportsCollection))); |
Wludzik, Jozef | b1ff1f6 | 2020-10-23 13:20:52 +0200 | [diff] [blame] | 226 | } |
| 227 | |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 228 | TEST_F(TestReport, settingPersistencyToFalseRemovesReportFromStorage) |
| 229 | { |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 230 | EXPECT_CALL(storageMock, remove(to_file_path(sut->getId()))); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 231 | |
| 232 | bool persistency = false; |
| 233 | EXPECT_THAT(setProperty(sut->getPath(), "Persistency", persistency).value(), |
| 234 | Eq(boost::system::errc::success)); |
| 235 | EXPECT_THAT(getProperty<bool>(sut->getPath(), "Persistency"), |
| 236 | Eq(persistency)); |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 237 | } |
| 238 | |
| 239 | TEST_F(TestReport, deleteReport) |
| 240 | { |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 241 | EXPECT_CALL(*reportManagerMock, removeReport(sut.get())); |
| 242 | auto ec = deleteReport(sut->getPath()); |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 243 | EXPECT_THAT(ec, Eq(boost::system::errc::success)); |
| 244 | } |
| 245 | |
| 246 | TEST_F(TestReport, deletingNonExistingReportReturnInvalidRequestDescriptor) |
| 247 | { |
| 248 | auto ec = deleteReport(Report::reportDir + "NonExisting"s); |
| 249 | EXPECT_THAT(ec.value(), Eq(EBADR)); |
| 250 | } |
| 251 | |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 252 | TEST_F(TestReport, deleteReportExpectThatFileIsRemoveFromStorage) |
| 253 | { |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 254 | EXPECT_CALL(storageMock, remove(to_file_path(sut->getId()))); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 255 | auto ec = deleteReport(sut->getPath()); |
| 256 | EXPECT_THAT(ec, Eq(boost::system::errc::success)); |
| 257 | } |
| 258 | |
Szymon Dompke | b4ef22e | 2022-02-07 15:15:12 +0100 | [diff] [blame] | 259 | TEST_F(TestReport, triggerIdsAreUpdatedProperly) |
| 260 | { |
| 261 | sut->updateTriggerIds("trigger1", TriggerIdUpdate::Add); |
| 262 | EXPECT_THAT( |
| 263 | getProperty<std::vector<std::string>>(sut->getPath(), "TriggerIds"), |
| 264 | UnorderedElementsAre("trigger1")); |
| 265 | |
| 266 | sut->updateTriggerIds("trigger2", TriggerIdUpdate::Add); |
| 267 | EXPECT_THAT( |
| 268 | getProperty<std::vector<std::string>>(sut->getPath(), "TriggerIds"), |
| 269 | UnorderedElementsAre("trigger1", "trigger2")); |
| 270 | |
| 271 | sut->updateTriggerIds("trigger3", TriggerIdUpdate::Add); |
| 272 | EXPECT_THAT( |
| 273 | getProperty<std::vector<std::string>>(sut->getPath(), "TriggerIds"), |
| 274 | UnorderedElementsAre("trigger1", "trigger2", "trigger3")); |
| 275 | |
| 276 | sut->updateTriggerIds("trigger1", TriggerIdUpdate::Remove); |
| 277 | EXPECT_THAT( |
| 278 | getProperty<std::vector<std::string>>(sut->getPath(), "TriggerIds"), |
| 279 | UnorderedElementsAre("trigger2", "trigger3")); |
| 280 | } |
| 281 | |
| 282 | TEST_F(TestReport, successWhenRemovingSameTriggerIdMultipleTimes) |
| 283 | { |
| 284 | sut->updateTriggerIds("trigger1", TriggerIdUpdate::Add); |
| 285 | sut->updateTriggerIds("trigger2", TriggerIdUpdate::Add); |
| 286 | sut->updateTriggerIds("trigger1", TriggerIdUpdate::Remove); |
| 287 | sut->updateTriggerIds("trigger1", TriggerIdUpdate::Remove); |
| 288 | EXPECT_THAT( |
| 289 | getProperty<std::vector<std::string>>(sut->getPath(), "TriggerIds"), |
| 290 | UnorderedElementsAre("trigger2")); |
| 291 | } |
| 292 | |
| 293 | TEST_F(TestReport, successWhenRemovingNonExistingTriggerId) |
| 294 | { |
| 295 | sut->updateTriggerIds("trigger1", TriggerIdUpdate::Add); |
| 296 | sut->updateTriggerIds("notTrigger", TriggerIdUpdate::Remove); |
| 297 | EXPECT_THAT( |
| 298 | getProperty<std::vector<std::string>>(sut->getPath(), "TriggerIds"), |
| 299 | UnorderedElementsAre("trigger1")); |
| 300 | } |
| 301 | |
| 302 | TEST_F(TestReport, noDuplicatesWhenSameTriggerIdIsAdded) |
| 303 | { |
| 304 | sut->updateTriggerIds("trigger1", TriggerIdUpdate::Add); |
| 305 | sut->updateTriggerIds("trigger2", TriggerIdUpdate::Add); |
| 306 | sut->updateTriggerIds("trigger1", TriggerIdUpdate::Add); |
| 307 | EXPECT_THAT( |
| 308 | getProperty<std::vector<std::string>>(sut->getPath(), "TriggerIds"), |
| 309 | UnorderedElementsAre("trigger1", "trigger2")); |
| 310 | } |
| 311 | |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 312 | class TestReportStore : |
| 313 | public TestReport, |
| 314 | public WithParamInterface<std::pair<std::string, nlohmann::json>> |
| 315 | { |
| 316 | public: |
| 317 | void SetUp() override |
| 318 | {} |
| 319 | |
| 320 | nlohmann::json storedConfiguration; |
| 321 | }; |
| 322 | |
| 323 | INSTANTIATE_TEST_SUITE_P( |
| 324 | _, TestReportStore, |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 325 | Values(std::make_pair("Enabled"s, nlohmann::json(ReportParams().enabled())), |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 326 | std::make_pair("Version"s, nlohmann::json(6)), |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 327 | std::make_pair("Id"s, nlohmann::json(ReportParams().reportId())), |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 328 | std::make_pair("Name"s, nlohmann::json(ReportParams().reportName())), |
| 329 | std::make_pair("ReportingType", |
| 330 | nlohmann::json(ReportParams().reportingType())), |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 331 | std::make_pair("ReportActions", nlohmann::json(utils::transform( |
| 332 | ReportParams().reportActions(), |
| 333 | [](const auto v) { |
| 334 | return utils::toUnderlying( |
| 335 | v); |
| 336 | }))), |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 337 | std::make_pair("Interval", |
| 338 | nlohmann::json(ReportParams().interval().count())), |
Krzysztof Grobelny | e6c417c | 2022-02-02 17:25:53 +0100 | [diff] [blame] | 339 | std::make_pair("AppendLimit", |
| 340 | nlohmann::json(ReportParams().appendLimit())), |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 341 | std::make_pair( |
| 342 | "ReadingParameters", |
| 343 | nlohmann::json( |
| 344 | {{{tstring::SensorPath::str(), |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 345 | {{{tstring::Service::str(), "Service"}, |
| 346 | {tstring::Path::str(), |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 347 | "/xyz/openbmc_project/sensors/power/p1"}, |
| 348 | {tstring::Metadata::str(), "metadata1"}}}}, |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 349 | {tstring::OperationType::str(), OperationType::single}, |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 350 | {tstring::Id::str(), "MetricId1"}, |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 351 | {tstring::CollectionTimeScope::str(), |
| 352 | CollectionTimeScope::point}, |
| 353 | {tstring::CollectionDuration::str(), 0}}, |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 354 | {{tstring::SensorPath::str(), |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 355 | {{{tstring::Service::str(), "Service"}, |
| 356 | {tstring::Path::str(), |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 357 | "/xyz/openbmc_project/sensors/power/p2"}, |
| 358 | {tstring::Metadata::str(), "metadata2"}}}}, |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 359 | {tstring::OperationType::str(), OperationType::single}, |
| 360 | {tstring::Id::str(), "MetricId2"}, |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 361 | {tstring::CollectionTimeScope::str(), |
| 362 | CollectionTimeScope::point}, |
| 363 | {tstring::CollectionDuration::str(), 0}}})))); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 364 | |
| 365 | TEST_P(TestReportStore, settingPersistencyToTrueStoresReport) |
| 366 | { |
| 367 | sut = makeReport(ReportParams()); |
| 368 | |
| 369 | { |
| 370 | InSequence seq; |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 371 | EXPECT_CALL(storageMock, remove(to_file_path(sut->getId()))); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 372 | EXPECT_CALL(checkPoint, Call()); |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 373 | EXPECT_CALL(storageMock, store(to_file_path(sut->getId()), _)) |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 374 | .WillOnce(SaveArg<1>(&storedConfiguration)); |
| 375 | } |
| 376 | |
| 377 | setProperty(sut->getPath(), "Persistency", false); |
| 378 | checkPoint.Call(); |
| 379 | setProperty(sut->getPath(), "Persistency", true); |
| 380 | |
| 381 | const auto& [key, value] = GetParam(); |
| 382 | |
| 383 | ASSERT_THAT(storedConfiguration.at(key), Eq(value)); |
| 384 | } |
| 385 | |
| 386 | TEST_P(TestReportStore, reportIsSavedToStorageAfterCreated) |
| 387 | { |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 388 | EXPECT_CALL(storageMock, store(to_file_path(ReportParams().reportId()), _)) |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 389 | .WillOnce(SaveArg<1>(&storedConfiguration)); |
| 390 | |
| 391 | sut = makeReport(ReportParams()); |
| 392 | |
| 393 | const auto& [key, value] = GetParam(); |
| 394 | |
| 395 | ASSERT_THAT(storedConfiguration.at(key), Eq(value)); |
| 396 | } |
| 397 | |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 398 | class TestReportValidNames : |
| 399 | public TestReport, |
| 400 | public WithParamInterface<ReportParams> |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 401 | { |
| 402 | public: |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 403 | void SetUp() override |
| 404 | {} |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 405 | }; |
| 406 | |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 407 | INSTANTIATE_TEST_SUITE_P( |
| 408 | ValidNames, TestReportValidNames, |
| 409 | Values(ReportParams().reportName("Valid_1"), |
| 410 | ReportParams().reportName("Valid_1/Valid_2"), |
| 411 | ReportParams().reportName("Valid_1/Valid_2/Valid_3"))); |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 412 | |
| 413 | TEST_P(TestReportValidNames, reportCtorDoesNotThrowOnValidName) |
| 414 | { |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 415 | EXPECT_NO_THROW(makeReport(GetParam())); |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 416 | } |
| 417 | |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 418 | class TestReportInvalidIds : |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 419 | public TestReport, |
| 420 | public WithParamInterface<ReportParams> |
| 421 | { |
| 422 | public: |
| 423 | void SetUp() override |
| 424 | {} |
| 425 | }; |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 426 | |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 427 | INSTANTIATE_TEST_SUITE_P(InvalidNames, TestReportInvalidIds, |
| 428 | Values(ReportParams().reportId("/"), |
| 429 | ReportParams().reportId("/Invalid"), |
| 430 | ReportParams().reportId("Invalid/"), |
| 431 | ReportParams().reportId("Invalid/Invalid/"), |
| 432 | ReportParams().reportId("Invalid?"))); |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 433 | |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 434 | TEST_P(TestReportInvalidIds, failsToCreateReportWithInvalidName) |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 435 | { |
| 436 | EXPECT_CALL(storageMock, store).Times(0); |
Krzysztof Grobelny | b8cc78d | 2021-11-29 15:54:53 +0100 | [diff] [blame] | 437 | |
| 438 | EXPECT_THROW(makeReport(GetParam()), sdbusplus::exception::SdBusError); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 439 | } |
| 440 | |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 441 | class TestReportAllReportTypes : |
| 442 | public TestReport, |
| 443 | public WithParamInterface<ReportParams> |
| 444 | { |
Wludzik, Jozef | b1ff1f6 | 2020-10-23 13:20:52 +0200 | [diff] [blame] | 445 | public: |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 446 | void SetUp() override |
| 447 | { |
| 448 | sut = makeReport(GetParam()); |
| 449 | } |
| 450 | }; |
| 451 | |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 452 | INSTANTIATE_TEST_SUITE_P( |
| 453 | _, TestReportAllReportTypes, |
| 454 | Values(ReportParams().reportingType(ReportingType::onRequest), |
| 455 | ReportParams().reportingType(ReportingType::onChange), |
| 456 | ReportParams().reportingType(ReportingType::periodic))); |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 457 | |
| 458 | TEST_P(TestReportAllReportTypes, returnPropertValueOfReportType) |
| 459 | { |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 460 | EXPECT_THAT(utils::toReportingType( |
| 461 | getProperty<std::string>(sut->getPath(), "ReportingType")), |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 462 | Eq(GetParam().reportingType())); |
| 463 | } |
| 464 | |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 465 | TEST_P(TestReportAllReportTypes, updateReadingsCallEnabledPropertyOff) |
| 466 | { |
Krzysztof Grobelny | 51f0fd5 | 2021-12-28 16:32:08 +0100 | [diff] [blame] | 467 | clockFake.system.advance(10ms); |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 468 | |
| 469 | setProperty(sut->getPath(), "Enabled", false); |
| 470 | sut->updateReadings(); |
| 471 | const auto [timestamp, readings] = |
| 472 | getProperty<Readings>(sut->getPath(), "Readings"); |
| 473 | |
| 474 | EXPECT_THAT(getProperty<bool>(sut->getPath(), "Enabled"), Eq(false)); |
Krzysztof Grobelny | 51f0fd5 | 2021-12-28 16:32:08 +0100 | [diff] [blame] | 475 | EXPECT_THAT(Milliseconds{timestamp}, Eq(0ms)); |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 476 | } |
| 477 | |
| 478 | TEST_P(TestReportAllReportTypes, updateReadingsCallEnabledPropertyOn) |
Wludzik, Jozef | d960e1f | 2021-01-08 09:25:59 +0100 | [diff] [blame] | 479 | { |
Krzysztof Grobelny | 51f0fd5 | 2021-12-28 16:32:08 +0100 | [diff] [blame] | 480 | clockFake.system.advance(10ms); |
Wludzik, Jozef | d960e1f | 2021-01-08 09:25:59 +0100 | [diff] [blame] | 481 | |
| 482 | sut->updateReadings(); |
Wludzik, Jozef | d960e1f | 2021-01-08 09:25:59 +0100 | [diff] [blame] | 483 | const auto [timestamp, readings] = |
| 484 | getProperty<Readings>(sut->getPath(), "Readings"); |
| 485 | |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 486 | EXPECT_THAT(getProperty<bool>(sut->getPath(), "Enabled"), Eq(true)); |
Krzysztof Grobelny | 51f0fd5 | 2021-12-28 16:32:08 +0100 | [diff] [blame] | 487 | EXPECT_THAT(Milliseconds{timestamp}, Eq(systemTimestamp + 10ms)); |
Wludzik, Jozef | d960e1f | 2021-01-08 09:25:59 +0100 | [diff] [blame] | 488 | } |
| 489 | |
Krzysztof Grobelny | f32f6fe | 2020-10-30 13:51:58 +0100 | [diff] [blame] | 490 | class TestReportOnRequestType : public TestReport |
| 491 | { |
| 492 | void SetUp() override |
| 493 | { |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 494 | sut = |
| 495 | makeReport(ReportParams().reportingType(ReportingType::onRequest)); |
Krzysztof Grobelny | f32f6fe | 2020-10-30 13:51:58 +0100 | [diff] [blame] | 496 | } |
| 497 | }; |
| 498 | |
| 499 | TEST_F(TestReportOnRequestType, updatesReadingTimestamp) |
| 500 | { |
Krzysztof Grobelny | 51f0fd5 | 2021-12-28 16:32:08 +0100 | [diff] [blame] | 501 | clockFake.system.advance(10ms); |
Krzysztof Grobelny | f32f6fe | 2020-10-30 13:51:58 +0100 | [diff] [blame] | 502 | |
| 503 | ASSERT_THAT(update(sut->getPath()), Eq(boost::system::errc::success)); |
| 504 | |
| 505 | const auto [timestamp, readings] = |
| 506 | getProperty<Readings>(sut->getPath(), "Readings"); |
| 507 | |
Krzysztof Grobelny | 51f0fd5 | 2021-12-28 16:32:08 +0100 | [diff] [blame] | 508 | EXPECT_THAT(Milliseconds{timestamp}, Eq(systemTimestamp + 10ms)); |
Krzysztof Grobelny | f32f6fe | 2020-10-30 13:51:58 +0100 | [diff] [blame] | 509 | } |
| 510 | |
| 511 | TEST_F(TestReportOnRequestType, updatesReadingWhenUpdateIsCalled) |
| 512 | { |
| 513 | ASSERT_THAT(update(sut->getPath()), Eq(boost::system::errc::success)); |
| 514 | |
| 515 | const auto [timestamp, readings] = |
| 516 | getProperty<Readings>(sut->getPath(), "Readings"); |
| 517 | |
| 518 | EXPECT_THAT(readings, |
| 519 | ElementsAre(std::make_tuple("a"s, "b"s, 17.1, 114u), |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 520 | std::make_tuple("aa"s, "bb"s, 42.0, 74u))); |
Krzysztof Grobelny | f32f6fe | 2020-10-30 13:51:58 +0100 | [diff] [blame] | 521 | } |
| 522 | |
| 523 | class TestReportNonOnRequestType : |
| 524 | public TestReport, |
| 525 | public WithParamInterface<ReportParams> |
| 526 | { |
| 527 | void SetUp() override |
| 528 | { |
| 529 | sut = makeReport(GetParam()); |
| 530 | } |
| 531 | }; |
| 532 | |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 533 | INSTANTIATE_TEST_SUITE_P( |
| 534 | _, TestReportNonOnRequestType, |
| 535 | Values(ReportParams().reportingType(ReportingType::periodic), |
| 536 | ReportParams().reportingType(ReportingType::onChange))); |
Krzysztof Grobelny | f32f6fe | 2020-10-30 13:51:58 +0100 | [diff] [blame] | 537 | |
| 538 | TEST_P(TestReportNonOnRequestType, readingsAreNotUpdateOnUpdateCall) |
| 539 | { |
| 540 | ASSERT_THAT(update(sut->getPath()), Eq(boost::system::errc::success)); |
| 541 | |
| 542 | EXPECT_THAT(getProperty<Readings>(sut->getPath(), "Readings"), |
| 543 | Eq(Readings{})); |
| 544 | } |
| 545 | |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 546 | class TestReportNonPeriodicReport : |
| 547 | public TestReport, |
| 548 | public WithParamInterface<ReportParams> |
| 549 | { |
Wludzik, Jozef | b1ff1f6 | 2020-10-23 13:20:52 +0200 | [diff] [blame] | 550 | public: |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 551 | void SetUp() override |
| 552 | { |
| 553 | sut = makeReport(GetParam()); |
| 554 | } |
| 555 | }; |
| 556 | |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 557 | INSTANTIATE_TEST_SUITE_P( |
| 558 | _, TestReportNonPeriodicReport, |
| 559 | Values(ReportParams().reportingType(ReportingType::onRequest), |
| 560 | ReportParams().reportingType(ReportingType::onChange))); |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 561 | |
| 562 | TEST_P(TestReportNonPeriodicReport, readingsAreNotUpdatedAfterIntervalExpires) |
| 563 | { |
| 564 | DbusEnvironment::sleepFor(ReportManager::minInterval + 1ms); |
| 565 | |
| 566 | EXPECT_THAT(getProperty<Readings>(sut->getPath(), "Readings"), |
| 567 | Eq(Readings{})); |
| 568 | } |
| 569 | |
| 570 | class TestReportPeriodicReport : public TestReport |
| 571 | { |
| 572 | void SetUp() override |
| 573 | { |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 574 | sut = makeReport(ReportParams().reportingType(ReportingType::periodic)); |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 575 | } |
| 576 | }; |
| 577 | |
| 578 | TEST_F(TestReportPeriodicReport, readingTimestampIsUpdatedAfterIntervalExpires) |
| 579 | { |
Krzysztof Grobelny | 51f0fd5 | 2021-12-28 16:32:08 +0100 | [diff] [blame] | 580 | clockFake.system.advance(10ms); |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 581 | DbusEnvironment::sleepFor(ReportManager::minInterval + 1ms); |
| 582 | |
| 583 | const auto [timestamp, readings] = |
| 584 | getProperty<Readings>(sut->getPath(), "Readings"); |
| 585 | |
Krzysztof Grobelny | 51f0fd5 | 2021-12-28 16:32:08 +0100 | [diff] [blame] | 586 | EXPECT_THAT(Milliseconds{timestamp}, Eq(systemTimestamp + 10ms)); |
Krzysztof Grobelny | c8e3a64 | 2020-10-23 12:29:16 +0200 | [diff] [blame] | 587 | } |
| 588 | |
| 589 | TEST_F(TestReportPeriodicReport, readingsAreUpdatedAfterIntervalExpires) |
| 590 | { |
| 591 | DbusEnvironment::sleepFor(ReportManager::minInterval + 1ms); |
| 592 | |
| 593 | const auto [timestamp, readings] = |
| 594 | getProperty<Readings>(sut->getPath(), "Readings"); |
| 595 | |
| 596 | EXPECT_THAT(readings, |
| 597 | ElementsAre(std::make_tuple("a"s, "b"s, 17.1, 114u), |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame] | 598 | std::make_tuple("aa"s, "bb"s, 42.0, 74u))); |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 599 | } |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 600 | |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame] | 601 | struct ReportUpdatesReportParams |
| 602 | { |
| 603 | ReportParams reportParams; |
| 604 | std::vector<ReadingData> expectedReadings; |
| 605 | bool expectedEnabled; |
| 606 | }; |
| 607 | |
| 608 | class TestReportWithReportUpdatesAndLimit : |
| 609 | public TestReport, |
| 610 | public WithParamInterface<ReportUpdatesReportParams> |
| 611 | { |
| 612 | void SetUp() override |
| 613 | { |
| 614 | sut = makeReport(ReportParams(GetParam().reportParams) |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 615 | .reportingType(ReportingType::periodic) |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame] | 616 | .interval(std::chrono::hours(1000))); |
| 617 | } |
| 618 | }; |
| 619 | |
| 620 | INSTANTIATE_TEST_SUITE_P( |
| 621 | _, TestReportWithReportUpdatesAndLimit, |
| 622 | Values( |
| 623 | ReportUpdatesReportParams{ |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 624 | ReportParams() |
| 625 | .reportUpdates(ReportUpdates::appendWrapsWhenFull) |
| 626 | .appendLimit(5), |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame] | 627 | std::vector<ReadingData>{{std::make_tuple("aa"s, "bb"s, 42.0, 74u), |
| 628 | std::make_tuple("a"s, "b"s, 17.1, 114u), |
| 629 | std::make_tuple("aa"s, "bb"s, 42.0, 74u), |
| 630 | std::make_tuple("aa"s, "bb"s, 42.0, 74u), |
| 631 | std::make_tuple("a"s, "b"s, 17.1, 114u)}}, |
| 632 | true}, |
| 633 | ReportUpdatesReportParams{ |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 634 | ReportParams() |
| 635 | .reportUpdates(ReportUpdates::appendWrapsWhenFull) |
| 636 | .appendLimit(4), |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame] | 637 | std::vector<ReadingData>{ |
| 638 | {std::make_tuple("a"s, "b"s, 17.1, 114u), |
| 639 | std::make_tuple("aa"s, "bb"s, 42.0, 74u), |
| 640 | std::make_tuple("a"s, "b"s, 17.1, 114u), |
| 641 | std::make_tuple("aa"s, "bb"s, 42.0, 74u)}}, |
| 642 | true}, |
| 643 | ReportUpdatesReportParams{ |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 644 | ReportParams() |
| 645 | .reportUpdates(ReportUpdates::appendWrapsWhenFull) |
| 646 | .appendLimit(0), |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame] | 647 | std::vector<ReadingData>{}, true}, |
| 648 | ReportUpdatesReportParams{ |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 649 | ReportParams() |
| 650 | .reportUpdates(ReportUpdates::appendStopsWhenFull) |
| 651 | .appendLimit(10), |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame] | 652 | std::vector<ReadingData>{ |
| 653 | {std::make_tuple("a"s, "b"s, 17.1, 114u), |
| 654 | std::make_tuple("aa"s, "bb"s, 42.0, 74u), |
| 655 | std::make_tuple("a"s, "b"s, 17.1, 114u), |
| 656 | std::make_tuple("aa"s, "bb"s, 42.0, 74u), |
| 657 | std::make_tuple("a"s, "b"s, 17.1, 114u), |
| 658 | std::make_tuple("aa"s, "bb"s, 42.0, 74u), |
| 659 | std::make_tuple("a"s, "b"s, 17.1, 114u), |
| 660 | std::make_tuple("aa"s, "bb"s, 42.0, 74u)}}, |
| 661 | true}, |
| 662 | ReportUpdatesReportParams{ |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 663 | ReportParams() |
| 664 | .reportUpdates(ReportUpdates::appendStopsWhenFull) |
| 665 | .appendLimit(5), |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame] | 666 | std::vector<ReadingData>{{std::make_tuple("a"s, "b"s, 17.1, 114u), |
| 667 | std::make_tuple("aa"s, "bb"s, 42.0, 74u), |
| 668 | std::make_tuple("a"s, "b"s, 17.1, 114u), |
| 669 | std::make_tuple("aa"s, "bb"s, 42.0, 74u), |
| 670 | std::make_tuple("a"s, "b"s, 17.1, 114u)}}, |
| 671 | false}, |
| 672 | ReportUpdatesReportParams{ |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 673 | ReportParams() |
| 674 | .reportUpdates(ReportUpdates::appendStopsWhenFull) |
| 675 | .appendLimit(4), |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame] | 676 | std::vector<ReadingData>{ |
| 677 | {std::make_tuple("a"s, "b"s, 17.1, 114u), |
| 678 | std::make_tuple("aa"s, "bb"s, 42.0, 74u), |
| 679 | std::make_tuple("a"s, "b"s, 17.1, 114u), |
| 680 | std::make_tuple("aa"s, "bb"s, 42.0, 74u)}}, |
| 681 | false}, |
| 682 | ReportUpdatesReportParams{ |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 683 | ReportParams() |
| 684 | .reportUpdates(ReportUpdates::appendStopsWhenFull) |
| 685 | .appendLimit(0), |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame] | 686 | std::vector<ReadingData>{}, false}, |
| 687 | ReportUpdatesReportParams{ |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 688 | ReportParams() |
| 689 | .reportUpdates(ReportUpdates::overwrite) |
| 690 | .appendLimit(500), |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame] | 691 | std::vector<ReadingData>{ |
| 692 | {std::make_tuple("a"s, "b"s, 17.1, 114u), |
| 693 | std::make_tuple("aa"s, "bb"s, 42.0, 74u)}}, |
| 694 | true}, |
| 695 | ReportUpdatesReportParams{ |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 696 | ReportParams() |
| 697 | .reportUpdates(ReportUpdates::overwrite) |
| 698 | .appendLimit(1), |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame] | 699 | std::vector<ReadingData>{ |
| 700 | {std::make_tuple("a"s, "b"s, 17.1, 114u), |
| 701 | std::make_tuple("aa"s, "bb"s, 42.0, 74u)}}, |
| 702 | true}, |
| 703 | ReportUpdatesReportParams{ |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 704 | ReportParams() |
| 705 | .reportUpdates(ReportUpdates::overwrite) |
| 706 | .appendLimit(0), |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame] | 707 | std::vector<ReadingData>{ |
| 708 | {std::make_tuple("a"s, "b"s, 17.1, 114u), |
| 709 | std::make_tuple("aa"s, "bb"s, 42.0, 74u)}}, |
| 710 | true})); |
| 711 | |
| 712 | TEST_P(TestReportWithReportUpdatesAndLimit, |
| 713 | readingsAreUpdatedAfterIntervalExpires) |
| 714 | { |
| 715 | for (int i = 0; i < 4; i++) |
| 716 | { |
| 717 | sut->updateReadings(); |
| 718 | } |
| 719 | |
| 720 | const auto [timestamp, readings] = |
| 721 | getProperty<Readings>(sut->getPath(), "Readings"); |
| 722 | const auto enabled = getProperty<bool>(sut->getPath(), "Enabled"); |
| 723 | |
| 724 | EXPECT_THAT(readings, ElementsAreArray(GetParam().expectedReadings)); |
| 725 | EXPECT_EQ(enabled, GetParam().expectedEnabled); |
| 726 | } |
| 727 | |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 728 | class TestReportInitialization : public TestReport |
| 729 | { |
| 730 | public: |
| 731 | void SetUp() override |
| 732 | {} |
| 733 | |
| 734 | void monitorProc(sdbusplus::message::message& msg) |
| 735 | { |
| 736 | std::string iface; |
| 737 | std::vector<std::pair<std::string, std::variant<Readings>>> |
| 738 | changed_properties; |
| 739 | std::vector<std::string> invalidated_properties; |
| 740 | |
| 741 | msg.read(iface, changed_properties, invalidated_properties); |
| 742 | |
| 743 | if (iface == Report::reportIfaceName) |
| 744 | { |
| 745 | for (const auto& [name, value] : changed_properties) |
| 746 | { |
| 747 | if (name == "Readings") |
| 748 | { |
| 749 | readingsUpdated.Call(); |
| 750 | } |
| 751 | } |
| 752 | } |
| 753 | } |
| 754 | |
| 755 | void makeMonitor() |
| 756 | { |
Patrick Williams | 3a62ee1 | 2021-12-03 10:13:25 -0600 | [diff] [blame] | 757 | monitor = std::make_unique<sdbusplus::bus::match_t>( |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 758 | *DbusEnvironment::getBus(), |
| 759 | sdbusplus::bus::match::rules::propertiesChanged( |
| 760 | sut->getPath(), Report::reportIfaceName), |
| 761 | [this](auto& msg) { monitorProc(msg); }); |
| 762 | } |
| 763 | |
Patrick Williams | 3a62ee1 | 2021-12-03 10:13:25 -0600 | [diff] [blame] | 764 | std::unique_ptr<sdbusplus::bus::match_t> monitor; |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 765 | MockFunction<void()> readingsUpdated; |
| 766 | }; |
| 767 | |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 768 | TEST_F(TestReportInitialization, |
| 769 | metricsAreInitializedWhenEnabledReportConstructed) |
Krzysztof Grobelny | 6ccfcbf | 2020-11-04 09:31:36 +0100 | [diff] [blame] | 770 | { |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 771 | initMetricMocks(defaultParams.metricParameters()); |
Krzysztof Grobelny | 6ccfcbf | 2020-11-04 09:31:36 +0100 | [diff] [blame] | 772 | for (auto& metric : metricMocks) |
| 773 | { |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 774 | EXPECT_CALL(*metric, initialize()).Times(1); |
Krzysztof Grobelny | 6ccfcbf | 2020-11-04 09:31:36 +0100 | [diff] [blame] | 775 | } |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 776 | sut = makeReport(defaultParams.enabled(true)); |
| 777 | } |
Krzysztof Grobelny | 6ccfcbf | 2020-11-04 09:31:36 +0100 | [diff] [blame] | 778 | |
Lukasz Kazmierczak | 7e098e9 | 2021-09-16 15:59:56 +0200 | [diff] [blame] | 779 | TEST_F(TestReportInitialization, |
| 780 | metricsAreNotInitializedWhenDisabledReportConstructed) |
| 781 | { |
| 782 | initMetricMocks(defaultParams.metricParameters()); |
| 783 | for (auto& metric : metricMocks) |
| 784 | { |
| 785 | EXPECT_CALL(*metric, initialize()).Times(0); |
| 786 | } |
| 787 | sut = makeReport(defaultParams.enabled(false)); |
Krzysztof Grobelny | 6ccfcbf | 2020-11-04 09:31:36 +0100 | [diff] [blame] | 788 | } |
| 789 | |
Wludzik, Jozef | b1ff1f6 | 2020-10-23 13:20:52 +0200 | [diff] [blame] | 790 | TEST_F(TestReportInitialization, |
| 791 | emitReadingsUpdateIsTrueReadingsPropertiesChangedSingalEmits) |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 792 | { |
Wludzik, Jozef | b1ff1f6 | 2020-10-23 13:20:52 +0200 | [diff] [blame] | 793 | EXPECT_CALL(readingsUpdated, Call()) |
| 794 | .WillOnce( |
| 795 | InvokeWithoutArgs(DbusEnvironment::setPromise("readingsUpdated"))); |
| 796 | |
| 797 | const auto elapsed = DbusEnvironment::measureTime([this] { |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 798 | sut = |
| 799 | makeReport(defaultParams.reportingType(ReportingType::periodic) |
| 800 | .reportActions({ReportAction::emitsReadingsUpdate})); |
Wludzik, Jozef | b1ff1f6 | 2020-10-23 13:20:52 +0200 | [diff] [blame] | 801 | makeMonitor(); |
| 802 | EXPECT_TRUE(DbusEnvironment::waitForFuture("readingsUpdated")); |
| 803 | }); |
| 804 | |
| 805 | EXPECT_THAT(elapsed, AllOf(Ge(defaultParams.interval()), |
| 806 | Lt(defaultParams.interval() * 2))); |
| 807 | } |
| 808 | |
| 809 | TEST_F(TestReportInitialization, |
| 810 | emitReadingsUpdateIsFalseReadingsPropertiesChangesSigalDoesNotEmits) |
| 811 | { |
| 812 | EXPECT_CALL(readingsUpdated, Call()).Times(0); |
| 813 | |
| 814 | sut = makeReport( |
Krzysztof Grobelny | 51497a0 | 2021-11-09 14:56:22 +0100 | [diff] [blame] | 815 | defaultParams.reportingType(ReportingType::periodic).reportActions({})); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 816 | makeMonitor(); |
Wludzik, Jozef | b1ff1f6 | 2020-10-23 13:20:52 +0200 | [diff] [blame] | 817 | DbusEnvironment::sleepFor(defaultParams.interval() * 2); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 818 | } |
Szymon Dompke | 3eb5686 | 2021-09-20 15:32:04 +0200 | [diff] [blame] | 819 | |
| 820 | TEST_F(TestReportInitialization, appendLimitDeducedProperly) |
| 821 | { |
| 822 | sut = makeReport( |
| 823 | ReportParams().appendLimit(std::numeric_limits<uint64_t>::max())); |
| 824 | auto appendLimit = getProperty<uint64_t>(sut->getPath(), "AppendLimit"); |
| 825 | EXPECT_EQ(appendLimit, 2ull); |
| 826 | } |
Krzysztof Grobelny | e6c417c | 2022-02-02 17:25:53 +0100 | [diff] [blame] | 827 | |
| 828 | TEST_F(TestReportInitialization, appendLimitSetToUintMaxIsStoredCorrectly) |
| 829 | { |
| 830 | nlohmann::json storedConfiguration; |
| 831 | |
| 832 | EXPECT_CALL(storageMock, store(to_file_path(ReportParams().reportId()), _)) |
| 833 | .WillOnce(SaveArg<1>(&storedConfiguration)); |
| 834 | |
| 835 | sut = makeReport( |
| 836 | ReportParams().appendLimit(std::numeric_limits<uint64_t>::max())); |
| 837 | |
| 838 | ASSERT_THAT(storedConfiguration.at("AppendLimit"), |
| 839 | Eq(std::numeric_limits<uint64_t>::max())); |
| 840 | } |
Szymon Dompke | b4ef22e | 2022-02-07 15:15:12 +0100 | [diff] [blame] | 841 | |
| 842 | TEST_F(TestReportInitialization, triggerIdsPropertyIsInitialzed) |
| 843 | { |
| 844 | sut = makeReport(ReportParams().triggerIds({"trigger1", "trigger2"})); |
| 845 | |
| 846 | EXPECT_THAT( |
| 847 | getProperty<std::vector<std::string>>(sut->getPath(), "TriggerIds"), |
| 848 | UnorderedElementsAre("trigger1", "trigger2")); |
| 849 | } |