Darin Petkov | 41c0e0a | 2012-01-09 16:38:53 +0100 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
Jason Glasgow | 82f9ab3 | 2012-04-04 14:27:19 -0400 | [diff] [blame] | 5 | #include "shill/modem.h" |
| 6 | |
Darin Petkov | 6f9eaa3 | 2011-08-09 15:26:44 -0700 | [diff] [blame] | 7 | #include <vector> |
| 8 | |
Ben Chan | a0ddf46 | 2014-02-06 11:32:42 -0800 | [diff] [blame] | 9 | #include <base/strings/stringprintf.h> |
Chris Masone | 626719f | 2011-08-18 16:58:48 -0700 | [diff] [blame] | 10 | #include <gmock/gmock.h> |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 11 | #include <gtest/gtest.h> |
| 12 | #include <mm/mm-modem.h> |
| 13 | #include <net/if.h> |
| 14 | #include <sys/ioctl.h> |
| 15 | |
| 16 | #include "shill/cellular.h" |
Darin Petkov | 721ac93 | 2011-11-16 15:43:09 +0100 | [diff] [blame] | 17 | #include "shill/cellular_capability_gsm.h" |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 18 | #include "shill/dbus_property_matchers.h" |
Paul Stewart | 26b327e | 2011-10-19 11:38:09 -0700 | [diff] [blame] | 19 | #include "shill/event_dispatcher.h" |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 20 | #include "shill/manager.h" |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 21 | #include "shill/mock_cellular.h" |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 22 | #include "shill/mock_device_info.h" |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 23 | #include "shill/mock_modem.h" |
Prathmesh Prabhu | 27526f1 | 2013-03-25 19:42:18 -0700 | [diff] [blame] | 24 | #include "shill/mock_modem_info.h" |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 25 | #include "shill/mock_rtnl_handler.h" |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 26 | #include "shill/proxy_factory.h" |
| 27 | #include "shill/rtnl_handler.h" |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 28 | |
| 29 | using std::string; |
Darin Petkov | 6f9eaa3 | 2011-08-09 15:26:44 -0700 | [diff] [blame] | 30 | using std::vector; |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 31 | using testing::_; |
mukesh agrawal | 12533ad | 2013-08-01 15:43:23 -0700 | [diff] [blame] | 32 | using testing::AnyNumber; |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 33 | using testing::DoAll; |
| 34 | using testing::Return; |
Chris Masone | 626719f | 2011-08-18 16:58:48 -0700 | [diff] [blame] | 35 | using testing::SetArgumentPointee; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 36 | using testing::StrEq; |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 37 | using testing::StrictMock; |
| 38 | using testing::Test; |
| 39 | |
| 40 | namespace shill { |
| 41 | |
| 42 | namespace { |
| 43 | |
| 44 | const int kTestInterfaceIndex = 5; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 45 | const char kLinkName[] = "usb0"; |
| 46 | const char kOwner[] = ":1.18"; |
Jason Glasgow | a585fc3 | 2012-06-06 11:04:09 -0400 | [diff] [blame] | 47 | const char kService[] = "org.chromium.ModemManager"; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 48 | const char kPath[] = "/org/chromium/ModemManager/Gobi/0"; |
| 49 | const unsigned char kAddress[] = {0x00, 0x01, 0x02, 0x03, 0x04, 0x05}; |
| 50 | const char kAddressAsString[] = "000102030405"; |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 51 | |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 52 | } // namespace |
| 53 | |
| 54 | class ModemTest : public Test { |
| 55 | public: |
| 56 | ModemTest() |
Prathmesh Prabhu | 27526f1 | 2013-03-25 19:42:18 -0700 | [diff] [blame] | 57 | : modem_info_(NULL, &dispatcher_, NULL, NULL, NULL), |
| 58 | device_info_(modem_info_.control_interface(), modem_info_.dispatcher(), |
| 59 | modem_info_.metrics(), modem_info_.manager()), |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 60 | modem_( |
| 61 | new StrictModem( |
| 62 | kOwner, |
Jason Glasgow | a585fc3 | 2012-06-06 11:04:09 -0400 | [diff] [blame] | 63 | kService, |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 64 | kPath, |
Prathmesh Prabhu | 27526f1 | 2013-03-25 19:42:18 -0700 | [diff] [blame] | 65 | &modem_info_)) {} |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 66 | virtual void SetUp(); |
| 67 | virtual void TearDown(); |
| 68 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 69 | void ReplaceSingletons() { |
| 70 | modem_->rtnl_handler_ = &rtnl_handler_; |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 71 | } |
| 72 | |
| 73 | protected: |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 74 | EventDispatcher dispatcher_; |
Prathmesh Prabhu | 27526f1 | 2013-03-25 19:42:18 -0700 | [diff] [blame] | 75 | MockModemInfo modem_info_; |
| 76 | MockDeviceInfo device_info_; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 77 | scoped_ptr<StrictModem> modem_; |
| 78 | MockRTNLHandler rtnl_handler_; |
| 79 | ByteString expected_address_; |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 80 | }; |
| 81 | |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 82 | void ModemTest::SetUp() { |
Jason Glasgow | e908949 | 2012-02-23 17:57:37 -0500 | [diff] [blame] | 83 | EXPECT_EQ(kOwner, modem_->owner_); |
Jason Glasgow | a585fc3 | 2012-06-06 11:04:09 -0400 | [diff] [blame] | 84 | EXPECT_EQ(kService, modem_->service_); |
Jason Glasgow | e908949 | 2012-02-23 17:57:37 -0500 | [diff] [blame] | 85 | EXPECT_EQ(kPath, modem_->path_); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 86 | ReplaceSingletons(); |
| 87 | expected_address_ = ByteString(kAddress, arraysize(kAddress)); |
| 88 | |
| 89 | EXPECT_CALL(rtnl_handler_, GetInterfaceIndex(kLinkName)). |
| 90 | WillRepeatedly(Return(kTestInterfaceIndex)); |
| 91 | |
Prathmesh Prabhu | 27526f1 | 2013-03-25 19:42:18 -0700 | [diff] [blame] | 92 | EXPECT_CALL(*modem_info_.mock_manager(), device_info()) |
| 93 | .WillRepeatedly(Return(&device_info_)); |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 94 | } |
| 95 | |
| 96 | void ModemTest::TearDown() { |
Jason Glasgow | e908949 | 2012-02-23 17:57:37 -0500 | [diff] [blame] | 97 | modem_.reset(); |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 98 | } |
| 99 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 100 | TEST_F(ModemTest, PendingDevicePropertiesAndCreate) { |
| 101 | static const char kSentinel[] = "sentinel"; |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 102 | static const uint32_t kSentinelValue = 17; |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 103 | |
Ben Chan | 876efd3 | 2012-09-28 15:25:13 -0700 | [diff] [blame] | 104 | DBusInterfaceToProperties properties; |
| 105 | properties[MM_MODEM_INTERFACE][kSentinel].writer().append_uint32( |
| 106 | kSentinelValue); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 107 | |
| 108 | EXPECT_CALL(*modem_, GetLinkName(_, _)).WillRepeatedly(DoAll( |
| 109 | SetArgumentPointee<1>(string(kLinkName)), |
| 110 | Return(true))); |
| 111 | EXPECT_CALL(rtnl_handler_, GetInterfaceIndex(StrEq(kLinkName))). |
| 112 | WillRepeatedly(Return(kTestInterfaceIndex)); |
| 113 | |
| 114 | // The first time we call CreateDeviceFromModemProperties, |
| 115 | // GetMACAddress will fail. |
Prathmesh Prabhu | 27526f1 | 2013-03-25 19:42:18 -0700 | [diff] [blame] | 116 | EXPECT_CALL(device_info_, GetMACAddress(kTestInterfaceIndex, _)). |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 117 | WillOnce(Return(false)); |
Jason Glasgow | 4c0724a | 2012-04-17 15:47:40 -0400 | [diff] [blame] | 118 | EXPECT_CALL(*modem_, GetModemInterface()). |
| 119 | WillRepeatedly(Return(MM_MODEM_INTERFACE)); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 120 | modem_->CreateDeviceFromModemProperties(properties); |
Jason Glasgow | e908949 | 2012-02-23 17:57:37 -0500 | [diff] [blame] | 121 | EXPECT_FALSE(modem_->device_.get()); |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 122 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 123 | // On the second time, we allow GetMACAddress to succeed. Now we |
| 124 | // expect a device to be built |
Prathmesh Prabhu | 27526f1 | 2013-03-25 19:42:18 -0700 | [diff] [blame] | 125 | EXPECT_CALL(device_info_, GetMACAddress(kTestInterfaceIndex, _)). |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 126 | WillOnce(DoAll(SetArgumentPointee<1>(expected_address_), |
| 127 | Return(true))); |
| 128 | |
| 129 | // modem will take ownership |
Darin Petkov | a0a0efe | 2012-06-27 12:50:01 +0200 | [diff] [blame] | 130 | MockCellular *cellular = new MockCellular( |
Prathmesh Prabhu | 27526f1 | 2013-03-25 19:42:18 -0700 | [diff] [blame] | 131 | &modem_info_, |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 132 | kLinkName, |
| 133 | kAddressAsString, |
| 134 | kTestInterfaceIndex, |
Ben Chan | 3ecdf82 | 2012-08-06 12:29:23 -0700 | [diff] [blame] | 135 | Cellular::kTypeCDMA, |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 136 | kOwner, |
Jason Glasgow | a585fc3 | 2012-06-06 11:04:09 -0400 | [diff] [blame] | 137 | kService, |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 138 | kPath, |
Ben Chan | 3ecdf82 | 2012-08-06 12:29:23 -0700 | [diff] [blame] | 139 | ProxyFactory::GetInstance()); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 140 | |
| 141 | EXPECT_CALL(*modem_, |
| 142 | ConstructCellular(StrEq(kLinkName), |
| 143 | StrEq(kAddressAsString), |
| 144 | kTestInterfaceIndex)). |
| 145 | WillOnce(Return(cellular)); |
| 146 | |
Jason Glasgow | 4c0724a | 2012-04-17 15:47:40 -0400 | [diff] [blame] | 147 | EXPECT_CALL(*cellular, OnDBusPropertiesChanged( |
| 148 | _, |
| 149 | HasDBusPropertyWithValueU32(kSentinel, kSentinelValue), |
| 150 | _)); |
Prathmesh Prabhu | 27526f1 | 2013-03-25 19:42:18 -0700 | [diff] [blame] | 151 | EXPECT_CALL(device_info_, RegisterDevice(_)); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 152 | modem_->OnDeviceInfoAvailable(kLinkName); |
| 153 | |
| 154 | EXPECT_TRUE(modem_->device_.get()); |
Darin Petkov | a0a0efe | 2012-06-27 12:50:01 +0200 | [diff] [blame] | 155 | |
mukesh agrawal | 9da0777 | 2013-05-15 14:15:17 -0700 | [diff] [blame] | 156 | // Add expectations for the eventual |modem_| destruction. |
Darin Petkov | a0a0efe | 2012-06-27 12:50:01 +0200 | [diff] [blame] | 157 | EXPECT_CALL(*cellular, DestroyService()); |
Prathmesh Prabhu | 27526f1 | 2013-03-25 19:42:18 -0700 | [diff] [blame] | 158 | EXPECT_CALL(device_info_, DeregisterDevice(_)); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 159 | } |
| 160 | |
| 161 | TEST_F(ModemTest, EarlyDeviceProperties) { |
| 162 | // OnDeviceInfoAvailable called before |
| 163 | // CreateDeviceFromModemProperties: Do nothing |
| 164 | modem_->OnDeviceInfoAvailable(kLinkName); |
| 165 | EXPECT_FALSE(modem_->device_.get()); |
| 166 | } |
| 167 | |
| 168 | TEST_F(ModemTest, CreateDeviceEarlyFailures) { |
Ben Chan | 876efd3 | 2012-09-28 15:25:13 -0700 | [diff] [blame] | 169 | DBusInterfaceToProperties properties; |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 170 | |
| 171 | EXPECT_CALL(*modem_, ConstructCellular(_, _, _)).Times(0); |
Ben Chan | 876efd3 | 2012-09-28 15:25:13 -0700 | [diff] [blame] | 172 | EXPECT_CALL(*modem_, GetModemInterface()). |
| 173 | WillRepeatedly(Return(MM_MODEM_INTERFACE)); |
| 174 | |
| 175 | // No modem interface properties: no device created |
| 176 | modem_->CreateDeviceFromModemProperties(properties); |
| 177 | EXPECT_FALSE(modem_->device_.get()); |
| 178 | |
| 179 | properties[MM_MODEM_INTERFACE] = DBusPropertiesMap(); |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 180 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 181 | // Link name, but no ifindex: no device created |
| 182 | EXPECT_CALL(*modem_, GetLinkName(_, _)).WillOnce(DoAll( |
| 183 | SetArgumentPointee<1>(string(kLinkName)), |
| 184 | Return(true))); |
| 185 | EXPECT_CALL(rtnl_handler_, GetInterfaceIndex(StrEq(kLinkName))).WillOnce( |
| 186 | Return(-1)); |
| 187 | modem_->CreateDeviceFromModemProperties(properties); |
Jason Glasgow | e908949 | 2012-02-23 17:57:37 -0500 | [diff] [blame] | 188 | EXPECT_FALSE(modem_->device_.get()); |
mukesh agrawal | 12533ad | 2013-08-01 15:43:23 -0700 | [diff] [blame] | 189 | |
| 190 | // The params are good, but the device is blacklisted. |
| 191 | EXPECT_CALL(*modem_, GetLinkName(_, _)).WillOnce(DoAll( |
| 192 | SetArgumentPointee<1>(string(kLinkName)), |
| 193 | Return(true))); |
| 194 | EXPECT_CALL(rtnl_handler_, GetInterfaceIndex(StrEq(kLinkName))) |
| 195 | .WillOnce(Return(kTestInterfaceIndex)); |
| 196 | EXPECT_CALL(device_info_, GetMACAddress(kTestInterfaceIndex, _)) |
| 197 | .WillOnce(DoAll(SetArgumentPointee<1>(expected_address_), |
| 198 | Return(true))); |
| 199 | EXPECT_CALL(device_info_, IsDeviceBlackListed(kLinkName)) |
| 200 | .WillRepeatedly(Return(true)); |
| 201 | modem_->CreateDeviceFromModemProperties(properties); |
| 202 | EXPECT_FALSE(modem_->device_.get()); |
| 203 | |
| 204 | // No link name: see CreateDevicePPP. |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 205 | } |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 206 | |
mukesh agrawal | 9da0777 | 2013-05-15 14:15:17 -0700 | [diff] [blame] | 207 | TEST_F(ModemTest, CreateDevicePPP) { |
| 208 | DBusInterfaceToProperties properties; |
| 209 | properties[MM_MODEM_INTERFACE] = DBusPropertiesMap(); |
| 210 | |
| 211 | string dev_name( |
| 212 | base::StringPrintf(Modem::kFakeDevNameFormat, Modem::fake_dev_serial_)); |
| 213 | |
| 214 | // |modem_| will take ownership. |
| 215 | MockCellular *cellular = new MockCellular( |
| 216 | &modem_info_, |
| 217 | dev_name, |
| 218 | Modem::kFakeDevAddress, |
| 219 | Modem::kFakeDevInterfaceIndex, |
| 220 | Cellular::kTypeUniversal, |
| 221 | kOwner, |
| 222 | kService, |
| 223 | kPath, |
| 224 | ProxyFactory::GetInstance()); |
| 225 | |
| 226 | EXPECT_CALL(*modem_, GetModemInterface()). |
| 227 | WillRepeatedly(Return(MM_MODEM_INTERFACE)); |
| 228 | // No link name: assumed to be a PPP dongle. |
| 229 | EXPECT_CALL(*modem_, GetLinkName(_, _)).WillOnce(Return(false)); |
| 230 | EXPECT_CALL(*modem_, |
| 231 | ConstructCellular(dev_name, |
| 232 | StrEq(Modem::kFakeDevAddress), |
| 233 | Modem::kFakeDevInterfaceIndex)). |
| 234 | WillOnce(Return(cellular)); |
| 235 | EXPECT_CALL(device_info_, RegisterDevice(_)); |
| 236 | |
| 237 | modem_->CreateDeviceFromModemProperties(properties); |
| 238 | EXPECT_TRUE(modem_->device_.get()); |
| 239 | |
| 240 | // Add expectations for the eventual |modem_| destruction. |
| 241 | EXPECT_CALL(*cellular, DestroyService()); |
| 242 | EXPECT_CALL(device_info_, DeregisterDevice(_)); |
| 243 | } |
| 244 | |
mukesh agrawal | 12533ad | 2013-08-01 15:43:23 -0700 | [diff] [blame] | 245 | TEST_F(ModemTest, GetDeviceParams) { |
| 246 | string mac_address; |
| 247 | int interface_index = 2; |
| 248 | EXPECT_CALL(rtnl_handler_, GetInterfaceIndex(_)).WillOnce(Return(-1)); |
| 249 | EXPECT_CALL(device_info_, GetMACAddress(_, _)).Times(AnyNumber()) |
| 250 | .WillRepeatedly(Return(false)); |
| 251 | EXPECT_FALSE(modem_->GetDeviceParams(&mac_address, &interface_index)); |
| 252 | EXPECT_EQ(-1, interface_index); |
| 253 | |
| 254 | EXPECT_CALL(rtnl_handler_, GetInterfaceIndex(_)).WillOnce(Return(-2)); |
| 255 | EXPECT_CALL(device_info_, GetMACAddress(_, _)).Times(AnyNumber()) |
| 256 | .WillRepeatedly(Return(false)); |
| 257 | EXPECT_FALSE(modem_->GetDeviceParams(&mac_address, &interface_index)); |
| 258 | EXPECT_EQ(-2, interface_index); |
| 259 | |
| 260 | EXPECT_CALL(rtnl_handler_, GetInterfaceIndex(_)).WillOnce(Return(1)); |
| 261 | EXPECT_CALL(device_info_, GetMACAddress(_, _)).WillOnce(Return(false)); |
| 262 | EXPECT_FALSE(modem_->GetDeviceParams(&mac_address, &interface_index)); |
| 263 | EXPECT_EQ(1, interface_index); |
| 264 | |
| 265 | EXPECT_CALL(rtnl_handler_, GetInterfaceIndex(_)).WillOnce(Return(2)); |
| 266 | EXPECT_CALL(device_info_, GetMACAddress(2, _)). |
| 267 | WillOnce(DoAll(SetArgumentPointee<1>(expected_address_), |
| 268 | Return(true))); |
| 269 | EXPECT_TRUE(modem_->GetDeviceParams(&mac_address, &interface_index)); |
| 270 | EXPECT_EQ(2, interface_index); |
| 271 | EXPECT_EQ(kAddressAsString, mac_address); |
mukesh agrawal | 12533ad | 2013-08-01 15:43:23 -0700 | [diff] [blame] | 272 | } |
| 273 | |
David Rochberg | fa1d31d | 2012-03-20 10:38:07 -0400 | [diff] [blame] | 274 | TEST_F(ModemTest, RejectPPPModem) { |
| 275 | // TODO(rochberg): Port this to ModemClassic |
Darin Petkov | e0a312e | 2011-07-20 13:45:28 -0700 | [diff] [blame] | 276 | } |
| 277 | |
| 278 | } // namespace shill |