Steve Fung | 6c34c25 | 2015-08-20 00:27:30 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2012 The Android Open Source Project |
| 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 | */ |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 16 | |
Ben Chan | 7e77690 | 2014-06-18 13:19:51 -0700 | [diff] [blame] | 17 | #include <base/files/file_enumerator.h> |
Ben Chan | ab6cc90 | 2014-09-05 08:21:06 -0700 | [diff] [blame] | 18 | #include <base/files/file_util.h> |
Ben Chan | 7e77690 | 2014-06-18 13:19:51 -0700 | [diff] [blame] | 19 | #include <base/files/scoped_temp_dir.h> |
Peter Qiu | 6aa551e | 2015-03-06 11:42:04 -0800 | [diff] [blame] | 20 | #include <base/strings/stringprintf.h> |
Alex Vakulenko | 74dc624 | 2015-10-13 09:23:34 -0700 | [diff] [blame] | 21 | #include <brillo/syslog_logging.h> |
Steve Fung | 6e13952 | 2015-02-05 14:54:16 -0800 | [diff] [blame] | 22 | #include <gmock/gmock.h> |
Ben Chan | 7e77690 | 2014-06-18 13:19:51 -0700 | [diff] [blame] | 23 | #include <gtest/gtest.h> |
| 24 | |
Steve Fung | 129bea5 | 2015-07-23 13:11:15 -0700 | [diff] [blame] | 25 | #include "udev_collector.h" |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 26 | |
Simon Que | 9f90aca | 2013-02-19 17:19:52 -0800 | [diff] [blame] | 27 | using base::FilePath; |
| 28 | |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 29 | namespace { |
| 30 | |
| 31 | // Dummy log config file name. |
| 32 | const char kLogConfigFileName[] = "log_config_file"; |
| 33 | |
Peter Qiu | 6aa551e | 2015-03-06 11:42:04 -0800 | [diff] [blame] | 34 | // Dummy directory for storing device coredumps. |
| 35 | const char kDevCoredumpDirectory[] = "devcoredump"; |
| 36 | |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 37 | // A bunch of random rules to put into the dummy log config file. |
| 38 | const char kLogConfigFileContents[] = |
Daniel Erat | 731da33 | 2015-01-28 09:48:10 -0700 | [diff] [blame] | 39 | "crash_reporter-udev-collection-change-card0-drm=echo change card0 drm\n" |
| 40 | "crash_reporter-udev-collection-add-state0-cpu=echo change state0 cpu\n" |
Peter Qiu | 6aa551e | 2015-03-06 11:42:04 -0800 | [diff] [blame] | 41 | "crash_reporter-udev-collection-devcoredump-iwlwifi=echo devcoredump\n" |
Daniel Erat | 731da33 | 2015-01-28 09:48:10 -0700 | [diff] [blame] | 42 | "cros_installer=echo not for udev"; |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 43 | |
Peter Qiu | 6aa551e | 2015-03-06 11:42:04 -0800 | [diff] [blame] | 44 | const char kCrashLogFilePattern[] = "*.log.gz"; |
| 45 | const char kDevCoredumpFilePattern[] = "*.devcore"; |
| 46 | |
| 47 | // Dummy content for device coredump data file. |
| 48 | const char kDevCoredumpDataContents[] = "coredump"; |
| 49 | |
| 50 | // Content for failing device's uevent file. |
| 51 | const char kFailingDeviceUeventContents[] = "DRIVER=iwlwifi\n"; |
| 52 | |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 53 | void CountCrash() {} |
| 54 | |
| 55 | bool s_consent_given = true; |
| 56 | |
| 57 | bool IsMetrics() { |
| 58 | return s_consent_given; |
| 59 | } |
| 60 | |
Peter Qiu | 6aa551e | 2015-03-06 11:42:04 -0800 | [diff] [blame] | 61 | // Returns the number of files found in the given path that matches the |
| 62 | // specified file name pattern. |
| 63 | int GetNumFiles(const FilePath& path, const std::string& file_pattern) { |
Mike Frysinger | a557c11 | 2014-02-05 22:55:39 -0500 | [diff] [blame] | 64 | base::FileEnumerator enumerator(path, false, base::FileEnumerator::FILES, |
Peter Qiu | 6aa551e | 2015-03-06 11:42:04 -0800 | [diff] [blame] | 65 | file_pattern); |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 66 | int num_files = 0; |
| 67 | for (FilePath file_path = enumerator.Next(); |
| 68 | !file_path.value().empty(); |
| 69 | file_path = enumerator.Next()) { |
| 70 | num_files++; |
| 71 | } |
| 72 | return num_files; |
| 73 | } |
| 74 | |
| 75 | } // namespace |
| 76 | |
Steve Fung | 6e13952 | 2015-02-05 14:54:16 -0800 | [diff] [blame] | 77 | class UdevCollectorMock : public UdevCollector { |
| 78 | public: |
| 79 | MOCK_METHOD0(SetUpDBus, void()); |
| 80 | }; |
| 81 | |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 82 | class UdevCollectorTest : public ::testing::Test { |
Lei Zhang | 9b1f300 | 2014-04-24 02:10:57 -0700 | [diff] [blame] | 83 | protected: |
| 84 | base::ScopedTempDir temp_dir_generator_; |
| 85 | |
| 86 | void HandleCrash(const std::string &udev_event) { |
| 87 | collector_.HandleCrash(udev_event); |
| 88 | } |
| 89 | |
Peter Qiu | 6aa551e | 2015-03-06 11:42:04 -0800 | [diff] [blame] | 90 | void GenerateDevCoredump(const std::string& device_name) { |
| 91 | // Generate coredump data file. |
| 92 | ASSERT_TRUE(CreateDirectory( |
| 93 | FilePath(base::StringPrintf("%s/%s", |
| 94 | collector_.dev_coredump_directory_.c_str(), |
| 95 | device_name.c_str())))); |
| 96 | FilePath data_path = |
| 97 | FilePath(base::StringPrintf("%s/%s/data", |
| 98 | collector_.dev_coredump_directory_.c_str(), |
| 99 | device_name.c_str())); |
| 100 | ASSERT_EQ(strlen(kDevCoredumpDataContents), |
| 101 | base::WriteFile(data_path, |
| 102 | kDevCoredumpDataContents, |
| 103 | strlen(kDevCoredumpDataContents))); |
| 104 | // Generate uevent file for failing device. |
| 105 | ASSERT_TRUE(CreateDirectory( |
| 106 | FilePath(base::StringPrintf("%s/%s/failing_device", |
| 107 | collector_.dev_coredump_directory_.c_str(), |
| 108 | device_name.c_str())))); |
| 109 | FilePath uevent_path = |
| 110 | FilePath(base::StringPrintf("%s/%s/failing_device/uevent", |
| 111 | collector_.dev_coredump_directory_.c_str(), |
| 112 | device_name.c_str())); |
| 113 | ASSERT_EQ(strlen(kFailingDeviceUeventContents), |
| 114 | base::WriteFile(uevent_path, |
| 115 | kFailingDeviceUeventContents, |
| 116 | strlen(kFailingDeviceUeventContents))); |
| 117 | } |
| 118 | |
Lei Zhang | 9b1f300 | 2014-04-24 02:10:57 -0700 | [diff] [blame] | 119 | private: |
Alex Vakulenko | 0dfc9ce | 2014-08-14 12:55:41 -0700 | [diff] [blame] | 120 | void SetUp() override { |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 121 | s_consent_given = true; |
| 122 | |
Steve Fung | 6e13952 | 2015-02-05 14:54:16 -0800 | [diff] [blame] | 123 | EXPECT_CALL(collector_, SetUpDBus()).WillRepeatedly(testing::Return()); |
| 124 | |
Lei Zhang | 9b1f300 | 2014-04-24 02:10:57 -0700 | [diff] [blame] | 125 | collector_.Initialize(CountCrash, IsMetrics); |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 126 | |
Lei Zhang | 9b1f300 | 2014-04-24 02:10:57 -0700 | [diff] [blame] | 127 | ASSERT_TRUE(temp_dir_generator_.CreateUniqueTempDir()); |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 128 | |
| 129 | FilePath log_config_path = |
Lei Zhang | 9b1f300 | 2014-04-24 02:10:57 -0700 | [diff] [blame] | 130 | temp_dir_generator_.path().Append(kLogConfigFileName); |
| 131 | collector_.log_config_path_ = log_config_path; |
| 132 | collector_.ForceCrashDirectory(temp_dir_generator_.path()); |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 133 | |
Peter Qiu | 6aa551e | 2015-03-06 11:42:04 -0800 | [diff] [blame] | 134 | FilePath dev_coredump_path = |
| 135 | temp_dir_generator_.path().Append(kDevCoredumpDirectory); |
| 136 | collector_.dev_coredump_directory_ = dev_coredump_path.value(); |
| 137 | |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 138 | // Write to a dummy log config file. |
| 139 | ASSERT_EQ(strlen(kLogConfigFileContents), |
Ben Chan | f30c641 | 2014-05-22 23:09:01 -0700 | [diff] [blame] | 140 | base::WriteFile(log_config_path, |
| 141 | kLogConfigFileContents, |
| 142 | strlen(kLogConfigFileContents))); |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 143 | |
Alex Vakulenko | 74dc624 | 2015-10-13 09:23:34 -0700 | [diff] [blame] | 144 | brillo::ClearLog(); |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 145 | } |
| 146 | |
Steve Fung | 6e13952 | 2015-02-05 14:54:16 -0800 | [diff] [blame] | 147 | UdevCollectorMock collector_; |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 148 | }; |
| 149 | |
| 150 | TEST_F(UdevCollectorTest, TestNoConsent) { |
| 151 | s_consent_given = false; |
Lei Zhang | 9b1f300 | 2014-04-24 02:10:57 -0700 | [diff] [blame] | 152 | HandleCrash("ACTION=change:KERNEL=card0:SUBSYSTEM=drm"); |
Peter Qiu | 6aa551e | 2015-03-06 11:42:04 -0800 | [diff] [blame] | 153 | EXPECT_EQ(0, GetNumFiles(temp_dir_generator_.path(), kCrashLogFilePattern)); |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 154 | } |
| 155 | |
| 156 | TEST_F(UdevCollectorTest, TestNoMatch) { |
| 157 | // No rule should match this. |
Lei Zhang | 9b1f300 | 2014-04-24 02:10:57 -0700 | [diff] [blame] | 158 | HandleCrash("ACTION=change:KERNEL=foo:SUBSYSTEM=bar"); |
Peter Qiu | 6aa551e | 2015-03-06 11:42:04 -0800 | [diff] [blame] | 159 | EXPECT_EQ(0, GetNumFiles(temp_dir_generator_.path(), kCrashLogFilePattern)); |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 160 | } |
| 161 | |
| 162 | TEST_F(UdevCollectorTest, TestMatches) { |
| 163 | // Try multiple udev events in sequence. The number of log files generated |
| 164 | // should increase. |
Lei Zhang | 9b1f300 | 2014-04-24 02:10:57 -0700 | [diff] [blame] | 165 | HandleCrash("ACTION=change:KERNEL=card0:SUBSYSTEM=drm"); |
Peter Qiu | 6aa551e | 2015-03-06 11:42:04 -0800 | [diff] [blame] | 166 | EXPECT_EQ(1, GetNumFiles(temp_dir_generator_.path(), kCrashLogFilePattern)); |
Lei Zhang | 9b1f300 | 2014-04-24 02:10:57 -0700 | [diff] [blame] | 167 | HandleCrash("ACTION=add:KERNEL=state0:SUBSYSTEM=cpu"); |
Peter Qiu | 6aa551e | 2015-03-06 11:42:04 -0800 | [diff] [blame] | 168 | EXPECT_EQ(2, GetNumFiles(temp_dir_generator_.path(), kCrashLogFilePattern)); |
| 169 | } |
| 170 | |
| 171 | TEST_F(UdevCollectorTest, TestDevCoredump) { |
| 172 | GenerateDevCoredump("devcd0"); |
| 173 | HandleCrash("ACTION=add:KERNEL_NUMBER=0:SUBSYSTEM=devcoredump"); |
| 174 | EXPECT_EQ(1, GetNumFiles(temp_dir_generator_.path(), |
| 175 | kDevCoredumpFilePattern)); |
| 176 | GenerateDevCoredump("devcd1"); |
| 177 | HandleCrash("ACTION=add:KERNEL_NUMBER=1:SUBSYSTEM=devcoredump"); |
| 178 | EXPECT_EQ(2, GetNumFiles(temp_dir_generator_.path(), |
| 179 | kDevCoredumpFilePattern)); |
Simon Que | acc7938 | 2012-05-04 18:10:09 -0700 | [diff] [blame] | 180 | } |
| 181 | |
| 182 | // TODO(sque, crosbug.com/32238) - test wildcard cases, multiple identical udev |
| 183 | // events. |