Matt Spinler | 97f7abc | 2019-11-06 09:40:23 -0600 | [diff] [blame] | 1 | /** |
| 2 | * Copyright © 2019 IBM Corporation |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
Matt Spinler | fdb6a20 | 2019-09-20 14:09:20 -0500 | [diff] [blame] | 16 | #include "elog_entry.hpp" |
| 17 | #include "extensions/openpower-pels/pel_types.hpp" |
Matt Spinler | 03c1d91 | 2019-07-10 14:12:15 -0500 | [diff] [blame] | 18 | #include "extensions/openpower-pels/private_header.hpp" |
| 19 | #include "extensions/openpower-pels/user_header.hpp" |
Matt Spinler | aadccc8 | 2020-04-10 14:33:42 -0500 | [diff] [blame] | 20 | #include "mocks.hpp" |
Matt Spinler | 03c1d91 | 2019-07-10 14:12:15 -0500 | [diff] [blame] | 21 | #include "pel_utils.hpp" |
| 22 | |
| 23 | #include <gtest/gtest.h> |
| 24 | |
| 25 | using namespace openpower::pels; |
Matt Spinler | aadccc8 | 2020-04-10 14:33:42 -0500 | [diff] [blame] | 26 | using ::testing::Return; |
Matt Spinler | 03c1d91 | 2019-07-10 14:12:15 -0500 | [diff] [blame] | 27 | |
| 28 | TEST(UserHeaderTest, SizeTest) |
| 29 | { |
| 30 | EXPECT_EQ(UserHeader::flattenedSize(), 24); |
| 31 | } |
| 32 | |
| 33 | TEST(UserHeaderTest, UnflattenFlattenTest) |
| 34 | { |
Matt Spinler | 42828bd | 2019-10-11 10:39:30 -0500 | [diff] [blame] | 35 | auto data = pelDataFactory(TestPELType::userHeaderSection); |
Matt Spinler | 03c1d91 | 2019-07-10 14:12:15 -0500 | [diff] [blame] | 36 | |
Matt Spinler | 42828bd | 2019-10-11 10:39:30 -0500 | [diff] [blame] | 37 | Stream stream(data); |
Matt Spinler | 03c1d91 | 2019-07-10 14:12:15 -0500 | [diff] [blame] | 38 | UserHeader uh(stream); |
| 39 | EXPECT_EQ(uh.valid(), true); |
| 40 | |
| 41 | EXPECT_EQ(uh.header().id, 0x5548); |
| 42 | EXPECT_EQ(uh.header().size, UserHeader::flattenedSize()); |
| 43 | EXPECT_EQ(uh.header().version, 0x01); |
| 44 | EXPECT_EQ(uh.header().subType, 0x0A); |
| 45 | EXPECT_EQ(uh.header().componentID, 0x0B0C); |
| 46 | |
| 47 | EXPECT_EQ(uh.subsystem(), 0x10); |
| 48 | EXPECT_EQ(uh.scope(), 0x04); |
| 49 | EXPECT_EQ(uh.severity(), 0x20); |
| 50 | EXPECT_EQ(uh.eventType(), 0x00); |
| 51 | EXPECT_EQ(uh.problemDomain(), 0x03); |
| 52 | EXPECT_EQ(uh.problemVector(), 0x04); |
| 53 | EXPECT_EQ(uh.actionFlags(), 0x80C0); |
| 54 | |
| 55 | // Now flatten into a vector and check that this vector |
| 56 | // matches the original one. |
| 57 | std::vector<uint8_t> newData; |
| 58 | Stream newStream(newData); |
| 59 | |
Matt Spinler | cf5a8d0 | 2019-09-05 12:58:53 -0500 | [diff] [blame] | 60 | uh.flatten(newStream); |
Matt Spinler | 42828bd | 2019-10-11 10:39:30 -0500 | [diff] [blame] | 61 | EXPECT_EQ(data, newData); |
Matt Spinler | 03c1d91 | 2019-07-10 14:12:15 -0500 | [diff] [blame] | 62 | } |
| 63 | |
| 64 | TEST(UserHeaderTest, ShortDataTest) |
| 65 | { |
Matt Spinler | 42828bd | 2019-10-11 10:39:30 -0500 | [diff] [blame] | 66 | auto data = pelDataFactory(TestPELType::userHeaderSection); |
| 67 | data.resize(data.size() - 1); |
Matt Spinler | 03c1d91 | 2019-07-10 14:12:15 -0500 | [diff] [blame] | 68 | |
Matt Spinler | 42828bd | 2019-10-11 10:39:30 -0500 | [diff] [blame] | 69 | Stream stream(data); |
Matt Spinler | 03c1d91 | 2019-07-10 14:12:15 -0500 | [diff] [blame] | 70 | UserHeader uh(stream); |
| 71 | |
| 72 | EXPECT_EQ(uh.valid(), false); |
| 73 | } |
| 74 | |
| 75 | TEST(UserHeaderTest, CorruptDataTest1) |
| 76 | { |
Matt Spinler | 42828bd | 2019-10-11 10:39:30 -0500 | [diff] [blame] | 77 | auto data = pelDataFactory(TestPELType::userHeaderSection); |
| 78 | data.resize(data.size() - 1); |
Matt Spinler | 03c1d91 | 2019-07-10 14:12:15 -0500 | [diff] [blame] | 79 | |
Matt Spinler | 42828bd | 2019-10-11 10:39:30 -0500 | [diff] [blame] | 80 | data.at(0) = 0; // corrupt the section ID |
Matt Spinler | 03c1d91 | 2019-07-10 14:12:15 -0500 | [diff] [blame] | 81 | |
Matt Spinler | 42828bd | 2019-10-11 10:39:30 -0500 | [diff] [blame] | 82 | Stream stream(data); |
Matt Spinler | 03c1d91 | 2019-07-10 14:12:15 -0500 | [diff] [blame] | 83 | UserHeader uh(stream); |
| 84 | |
| 85 | EXPECT_EQ(uh.valid(), false); |
| 86 | } |
| 87 | |
| 88 | TEST(UserHeaderTest, CorruptDataTest2) |
| 89 | { |
Matt Spinler | 42828bd | 2019-10-11 10:39:30 -0500 | [diff] [blame] | 90 | auto data = pelDataFactory(TestPELType::userHeaderSection); |
Matt Spinler | 03c1d91 | 2019-07-10 14:12:15 -0500 | [diff] [blame] | 91 | |
Matt Spinler | 42828bd | 2019-10-11 10:39:30 -0500 | [diff] [blame] | 92 | data.at(4) = 0x22; // corrupt the version |
Matt Spinler | 03c1d91 | 2019-07-10 14:12:15 -0500 | [diff] [blame] | 93 | |
Matt Spinler | 42828bd | 2019-10-11 10:39:30 -0500 | [diff] [blame] | 94 | Stream stream(data); |
Matt Spinler | 03c1d91 | 2019-07-10 14:12:15 -0500 | [diff] [blame] | 95 | UserHeader uh(stream); |
| 96 | |
| 97 | EXPECT_EQ(uh.valid(), false); |
| 98 | } |
Matt Spinler | fdb6a20 | 2019-09-20 14:09:20 -0500 | [diff] [blame] | 99 | |
| 100 | // Construct the User Header from the message registry |
| 101 | TEST(UserHeaderTest, ConstructionTest) |
| 102 | { |
| 103 | using namespace openpower::pels::message; |
Matt Spinler | aadccc8 | 2020-04-10 14:33:42 -0500 | [diff] [blame] | 104 | { |
| 105 | Entry regEntry; |
Matt Spinler | fdb6a20 | 2019-09-20 14:09:20 -0500 | [diff] [blame] | 106 | |
Matt Spinler | aadccc8 | 2020-04-10 14:33:42 -0500 | [diff] [blame] | 107 | regEntry.name = "test"; |
| 108 | regEntry.subsystem = 5; |
| 109 | regEntry.severity = {{"", 0x40}}; |
| 110 | regEntry.actionFlags = 0xC000; |
| 111 | regEntry.eventType = 1; |
| 112 | regEntry.eventScope = 2; |
Matt Spinler | fdb6a20 | 2019-09-20 14:09:20 -0500 | [diff] [blame] | 113 | |
Matt Spinler | aadccc8 | 2020-04-10 14:33:42 -0500 | [diff] [blame] | 114 | MockDataInterface dataIface; |
| 115 | EXPECT_CALL(dataIface, getSystemType).WillOnce(Return("systemA")); |
Matt Spinler | fdb6a20 | 2019-09-20 14:09:20 -0500 | [diff] [blame] | 116 | |
Matt Spinler | aadccc8 | 2020-04-10 14:33:42 -0500 | [diff] [blame] | 117 | UserHeader uh(regEntry, phosphor::logging::Entry::Level::Error, |
| 118 | dataIface); |
Matt Spinler | fdb6a20 | 2019-09-20 14:09:20 -0500 | [diff] [blame] | 119 | |
Matt Spinler | aadccc8 | 2020-04-10 14:33:42 -0500 | [diff] [blame] | 120 | ASSERT_TRUE(uh.valid()); |
| 121 | EXPECT_EQ(uh.header().id, 0x5548); |
| 122 | EXPECT_EQ(uh.header().size, UserHeader::flattenedSize()); |
| 123 | EXPECT_EQ(uh.header().version, 0x01); |
| 124 | EXPECT_EQ(uh.header().subType, 0x00); |
| 125 | EXPECT_EQ(uh.header().componentID, |
| 126 | static_cast<uint16_t>(ComponentID::phosphorLogging)); |
| 127 | |
| 128 | ASSERT_EQ(uh.subsystem(), 5); |
| 129 | ASSERT_EQ(uh.severity(), 0x40); |
| 130 | ASSERT_EQ(uh.eventType(), 1); |
| 131 | ASSERT_EQ(uh.scope(), 2); |
| 132 | ASSERT_EQ(uh.problemDomain(), 0); |
| 133 | ASSERT_EQ(uh.problemVector(), 0); |
| 134 | ASSERT_EQ(uh.actionFlags(), 0xC000); |
| 135 | } |
| 136 | |
| 137 | // Test the system type based severity lookups |
| 138 | { |
| 139 | Entry regEntry; |
| 140 | |
| 141 | regEntry.name = "test"; |
| 142 | regEntry.subsystem = 5; |
| 143 | regEntry.severity = {{"", 0x20}, {"systemB", 0x10}, {"systemA", 0x00}}; |
| 144 | |
| 145 | MockDataInterface dataIface; |
| 146 | EXPECT_CALL(dataIface, getSystemType) |
| 147 | .WillOnce(Return("systemA")) |
| 148 | .WillOnce(Return("systemB")) |
| 149 | .WillOnce(Return("systemC")); |
| 150 | |
| 151 | { |
| 152 | UserHeader uh(regEntry, phosphor::logging::Entry::Level::Error, |
| 153 | dataIface); |
| 154 | |
| 155 | EXPECT_EQ(uh.severity(), 0x00); |
| 156 | } |
| 157 | |
| 158 | { |
| 159 | UserHeader uh(regEntry, phosphor::logging::Entry::Level::Error, |
| 160 | dataIface); |
| 161 | |
| 162 | EXPECT_EQ(uh.severity(), 0x10); |
| 163 | } |
| 164 | |
| 165 | { |
| 166 | UserHeader uh(regEntry, phosphor::logging::Entry::Level::Error, |
| 167 | dataIface); |
| 168 | |
| 169 | EXPECT_EQ(uh.severity(), 0x20); |
| 170 | } |
| 171 | } |
Matt Spinler | fdb6a20 | 2019-09-20 14:09:20 -0500 | [diff] [blame] | 172 | } |
| 173 | |
| 174 | // Test that the severity comes from the event log if not |
| 175 | // in the message registry |
| 176 | TEST(UserHeaderTest, UseEventLogSevTest) |
| 177 | { |
| 178 | using namespace openpower::pels::message; |
| 179 | Entry regEntry; |
| 180 | |
| 181 | regEntry.name = "test"; |
| 182 | regEntry.subsystem = 5; |
| 183 | regEntry.actionFlags = 0xC000; |
| 184 | regEntry.eventType = 1; |
| 185 | regEntry.eventScope = 2; |
| 186 | // Leave off severity |
| 187 | |
Matt Spinler | aadccc8 | 2020-04-10 14:33:42 -0500 | [diff] [blame] | 188 | MockDataInterface dataIface; |
| 189 | |
| 190 | UserHeader uh(regEntry, phosphor::logging::Entry::Level::Error, dataIface); |
Matt Spinler | fdb6a20 | 2019-09-20 14:09:20 -0500 | [diff] [blame] | 191 | ASSERT_EQ(uh.severity(), 0x40); |
| 192 | } |
| 193 | |
| 194 | // Test that the optional event type & scope fields work |
| 195 | TEST(UserHeaderTest, DefaultEventTypeScopeTest) |
| 196 | { |
| 197 | using namespace openpower::pels::message; |
| 198 | Entry regEntry; |
| 199 | |
| 200 | regEntry.name = "test"; |
| 201 | regEntry.subsystem = 5; |
Matt Spinler | aadccc8 | 2020-04-10 14:33:42 -0500 | [diff] [blame] | 202 | regEntry.severity = {{"", 0x40}}; |
Matt Spinler | fdb6a20 | 2019-09-20 14:09:20 -0500 | [diff] [blame] | 203 | regEntry.actionFlags = 0xC000; |
| 204 | |
Matt Spinler | aadccc8 | 2020-04-10 14:33:42 -0500 | [diff] [blame] | 205 | MockDataInterface dataIface; |
| 206 | |
| 207 | UserHeader uh(regEntry, phosphor::logging::Entry::Level::Error, dataIface); |
Matt Spinler | fdb6a20 | 2019-09-20 14:09:20 -0500 | [diff] [blame] | 208 | |
| 209 | ASSERT_EQ(uh.eventType(), 0); |
| 210 | ASSERT_EQ(uh.scope(), 0x03); |
| 211 | } |