Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #include "shill/vpn_driver.h" |
| 6 | |
| 7 | #include <base/stl_util.h> |
| 8 | #include <base/string_number_conversions.h> |
| 9 | #include <chromeos/dbus/service_constants.h> |
| 10 | #include <gmock/gmock.h> |
| 11 | #include <gtest/gtest.h> |
| 12 | |
Darin Petkov | 0e9735d | 2012-04-24 12:33:45 +0200 | [diff] [blame] | 13 | #include "shill/event_dispatcher.h" |
| 14 | #include "shill/glib.h" |
| 15 | #include "shill/mock_connection.h" |
| 16 | #include "shill/mock_device_info.h" |
| 17 | #include "shill/mock_glib.h" |
| 18 | #include "shill/mock_manager.h" |
| 19 | #include "shill/mock_metrics.h" |
| 20 | #include "shill/mock_service.h" |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 21 | #include "shill/mock_store.h" |
Darin Petkov | 0e9735d | 2012-04-24 12:33:45 +0200 | [diff] [blame] | 22 | #include "shill/nice_mock_control.h" |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 23 | #include "shill/property_store.h" |
Paul Stewart | 8e7e459 | 2012-04-29 09:47:48 -0700 | [diff] [blame] | 24 | #include "shill/property_store_inspector.h" |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 25 | |
| 26 | using std::string; |
| 27 | using testing::_; |
| 28 | using testing::AnyNumber; |
Darin Petkov | 0e9735d | 2012-04-24 12:33:45 +0200 | [diff] [blame] | 29 | using testing::NiceMock; |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 30 | using testing::Return; |
| 31 | using testing::SetArgumentPointee; |
Darin Petkov | 0e9735d | 2012-04-24 12:33:45 +0200 | [diff] [blame] | 32 | using testing::StrictMock; |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 33 | using testing::Test; |
| 34 | |
| 35 | namespace shill { |
| 36 | |
| 37 | namespace { |
| 38 | const char kHostProperty[] = "VPN.Host"; |
| 39 | const char kOTPProperty[] = "VPN.OTP"; |
Darin Petkov | cb71529 | 2012-04-25 13:04:37 +0200 | [diff] [blame] | 40 | const char kPINProperty[] = "VPN.PIN"; |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 41 | const char kPasswordProperty[] = "VPN.Password"; |
| 42 | const char kPortProperty[] = "VPN.Port"; |
Darin Petkov | cb71529 | 2012-04-25 13:04:37 +0200 | [diff] [blame] | 43 | |
| 44 | const char kPIN[] = "5555"; |
| 45 | const char kPassword[] = "random-password"; |
| 46 | const char kPort[] = "1234"; |
| 47 | const char kStorageID[] = "vpn_service_id"; |
| 48 | |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 49 | } // namespace |
| 50 | |
| 51 | class VPNDriverUnderTest : public VPNDriver { |
| 52 | public: |
Darin Petkov | 0e9735d | 2012-04-24 12:33:45 +0200 | [diff] [blame] | 53 | VPNDriverUnderTest(Manager *manager); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 54 | virtual ~VPNDriverUnderTest() {} |
| 55 | |
| 56 | // Inherited from VPNDriver. |
| 57 | MOCK_METHOD2(ClaimInterface, bool(const string &link_name, |
| 58 | int interface_index)); |
| 59 | MOCK_METHOD2(Connect, void(const VPNServiceRefPtr &service, Error *error)); |
| 60 | MOCK_METHOD0(Disconnect, void()); |
Darin Petkov | 5eb0542 | 2012-05-11 15:45:25 +0200 | [diff] [blame] | 61 | MOCK_METHOD0(OnConnectionDisconnected, void()); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 62 | MOCK_CONST_METHOD0(GetProviderType, string()); |
| 63 | |
| 64 | private: |
| 65 | static const Property kProperties[]; |
| 66 | |
| 67 | DISALLOW_COPY_AND_ASSIGN(VPNDriverUnderTest); |
| 68 | }; |
| 69 | |
| 70 | // static |
| 71 | const VPNDriverUnderTest::Property VPNDriverUnderTest::kProperties[] = { |
| 72 | { kHostProperty, 0 }, |
Darin Petkov | cb71529 | 2012-04-25 13:04:37 +0200 | [diff] [blame] | 73 | { kOTPProperty, Property::kEphemeral }, |
| 74 | { kPINProperty, Property::kWriteOnly }, |
| 75 | { kPasswordProperty, Property::kCredential }, |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 76 | { kPortProperty, 0 }, |
| 77 | { flimflam::kProviderNameProperty, 0 }, |
| 78 | }; |
| 79 | |
Darin Petkov | 0e9735d | 2012-04-24 12:33:45 +0200 | [diff] [blame] | 80 | VPNDriverUnderTest::VPNDriverUnderTest(Manager *manager) |
| 81 | : VPNDriver(manager, kProperties, arraysize(kProperties)) {} |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 82 | |
| 83 | class VPNDriverTest : public Test { |
| 84 | public: |
Darin Petkov | 0e9735d | 2012-04-24 12:33:45 +0200 | [diff] [blame] | 85 | VPNDriverTest() |
| 86 | : device_info_(&control_, &dispatcher_, &metrics_, &manager_), |
| 87 | manager_(&control_, &dispatcher_, &metrics_, &glib_), |
| 88 | driver_(&manager_) {} |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 89 | |
| 90 | virtual ~VPNDriverTest() {} |
| 91 | |
| 92 | protected: |
| 93 | void SetArg(const string &arg, const string &value) { |
| 94 | driver_.args()->SetString(arg, value); |
| 95 | } |
| 96 | |
| 97 | KeyValueStore *GetArgs() { return driver_.args(); } |
| 98 | |
Paul Stewart | 8e7e459 | 2012-04-29 09:47:48 -0700 | [diff] [blame] | 99 | bool GetProviderProperty(const PropertyStore &store, |
| 100 | const string &key, |
| 101 | string *value); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 102 | |
Darin Petkov | 0e9735d | 2012-04-24 12:33:45 +0200 | [diff] [blame] | 103 | NiceMockControl control_; |
| 104 | NiceMock<MockDeviceInfo> device_info_; |
| 105 | EventDispatcher dispatcher_; |
| 106 | MockMetrics metrics_; |
| 107 | MockGLib glib_; |
| 108 | MockManager manager_; |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 109 | VPNDriverUnderTest driver_; |
| 110 | }; |
| 111 | |
Paul Stewart | 8e7e459 | 2012-04-29 09:47:48 -0700 | [diff] [blame] | 112 | bool VPNDriverTest::GetProviderProperty(const PropertyStore &store, |
| 113 | const string &key, |
| 114 | string *value) { |
| 115 | Error error; |
| 116 | PropertyStoreInspector inspector(&store); |
| 117 | KeyValueStore provider_properties; |
| 118 | EXPECT_TRUE(inspector.GetKeyValueStoreProperty( |
| 119 | flimflam::kProviderProperty, &provider_properties, &error)); |
| 120 | if (!provider_properties.ContainsString(key)) { |
| 121 | return false; |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 122 | } |
Paul Stewart | 8e7e459 | 2012-04-29 09:47:48 -0700 | [diff] [blame] | 123 | if (value != NULL) { |
| 124 | *value = provider_properties.GetString(key); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 125 | } |
Paul Stewart | 8e7e459 | 2012-04-29 09:47:48 -0700 | [diff] [blame] | 126 | return true; |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 127 | } |
| 128 | |
| 129 | TEST_F(VPNDriverTest, Load) { |
| 130 | MockStore storage; |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 131 | EXPECT_CALL(storage, GetString(kStorageID, _, _)) |
| 132 | .WillRepeatedly(Return(false)); |
Darin Petkov | cb71529 | 2012-04-25 13:04:37 +0200 | [diff] [blame] | 133 | EXPECT_CALL(storage, GetString(_, kOTPProperty, _)).Times(0); |
| 134 | EXPECT_CALL(storage, GetCryptedString(_, kOTPProperty, _)).Times(0); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 135 | EXPECT_CALL(storage, GetString(kStorageID, kPortProperty, _)) |
Darin Petkov | cb71529 | 2012-04-25 13:04:37 +0200 | [diff] [blame] | 136 | .WillOnce(DoAll(SetArgumentPointee<2>(string(kPort)), Return(true))); |
| 137 | EXPECT_CALL(storage, GetString(kStorageID, kPINProperty, _)) |
| 138 | .WillOnce(DoAll(SetArgumentPointee<2>(string(kPIN)), Return(true))); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 139 | EXPECT_CALL(storage, GetCryptedString(kStorageID, kPasswordProperty, _)) |
Darin Petkov | cb71529 | 2012-04-25 13:04:37 +0200 | [diff] [blame] | 140 | .WillOnce(DoAll(SetArgumentPointee<2>(string(kPassword)), Return(true))); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 141 | EXPECT_TRUE(driver_.Load(&storage, kStorageID)); |
| 142 | EXPECT_EQ(kPort, GetArgs()->LookupString(kPortProperty, "")); |
Darin Petkov | cb71529 | 2012-04-25 13:04:37 +0200 | [diff] [blame] | 143 | EXPECT_EQ(kPIN, GetArgs()->LookupString(kPINProperty, "")); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 144 | EXPECT_EQ(kPassword, GetArgs()->LookupString(kPasswordProperty, "")); |
| 145 | } |
| 146 | |
| 147 | TEST_F(VPNDriverTest, Store) { |
Darin Petkov | cb71529 | 2012-04-25 13:04:37 +0200 | [diff] [blame] | 148 | SetArg(kPINProperty, kPIN); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 149 | SetArg(kPortProperty, kPort); |
| 150 | SetArg(kPasswordProperty, kPassword); |
| 151 | SetArg(kOTPProperty, "987654"); |
| 152 | MockStore storage; |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 153 | EXPECT_CALL(storage, SetString(kStorageID, kPortProperty, kPort)) |
| 154 | .WillOnce(Return(true)); |
Darin Petkov | cb71529 | 2012-04-25 13:04:37 +0200 | [diff] [blame] | 155 | EXPECT_CALL(storage, SetString(kStorageID, kPINProperty, kPIN)) |
| 156 | .WillOnce(Return(true)); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 157 | EXPECT_CALL(storage, |
| 158 | SetCryptedString(kStorageID, kPasswordProperty, kPassword)) |
| 159 | .WillOnce(Return(true)); |
Darin Petkov | cb71529 | 2012-04-25 13:04:37 +0200 | [diff] [blame] | 160 | EXPECT_CALL(storage, SetCryptedString(_, kOTPProperty, _)).Times(0); |
| 161 | EXPECT_CALL(storage, SetString(_, kOTPProperty, _)).Times(0); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 162 | EXPECT_CALL(storage, DeleteKey(kStorageID, _)).Times(AnyNumber()); |
| 163 | EXPECT_CALL(storage, DeleteKey(kStorageID, kHostProperty)).Times(1); |
Darin Petkov | cb71529 | 2012-04-25 13:04:37 +0200 | [diff] [blame] | 164 | EXPECT_TRUE(driver_.Save(&storage, kStorageID, true)); |
| 165 | } |
| 166 | |
| 167 | TEST_F(VPNDriverTest, StoreNoCredentials) { |
| 168 | SetArg(kPasswordProperty, kPassword); |
| 169 | MockStore storage; |
| 170 | EXPECT_CALL(storage, SetString(_, kPasswordProperty, _)).Times(0); |
| 171 | EXPECT_CALL(storage, SetCryptedString(_, kPasswordProperty, _)).Times(0); |
| 172 | EXPECT_CALL(storage, DeleteKey(kStorageID, _)).Times(AnyNumber()); |
| 173 | EXPECT_CALL(storage, DeleteKey(kStorageID, kPasswordProperty)).Times(1); |
| 174 | EXPECT_TRUE(driver_.Save(&storage, kStorageID, false)); |
| 175 | } |
| 176 | |
| 177 | TEST_F(VPNDriverTest, UnloadCredentials) { |
| 178 | SetArg(kOTPProperty, "654321"); |
| 179 | SetArg(kPasswordProperty, kPassword); |
| 180 | SetArg(kPortProperty, kPort); |
| 181 | driver_.UnloadCredentials(); |
| 182 | EXPECT_FALSE(GetArgs()->ContainsString(kOTPProperty)); |
| 183 | EXPECT_FALSE(GetArgs()->ContainsString(kPasswordProperty)); |
| 184 | EXPECT_EQ(kPort, GetArgs()->LookupString(kPortProperty, "")); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 185 | } |
| 186 | |
| 187 | TEST_F(VPNDriverTest, InitPropertyStore) { |
| 188 | // Figure out if the store is actually hooked up to the driver argument |
| 189 | // KeyValueStore. |
| 190 | PropertyStore store; |
| 191 | driver_.InitPropertyStore(&store); |
Paul Stewart | 8e7e459 | 2012-04-29 09:47:48 -0700 | [diff] [blame] | 192 | PropertyStoreInspector inspector(&store); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 193 | |
| 194 | // An un-set property should not be readable. |
Paul Stewart | 8e7e459 | 2012-04-29 09:47:48 -0700 | [diff] [blame] | 195 | EXPECT_FALSE(inspector.ContainsStringProperty(kPortProperty)); |
| 196 | EXPECT_FALSE(GetProviderProperty(store, kPortProperty, NULL)); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 197 | |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 198 | const string kProviderName = "boo"; |
| 199 | SetArg(kPortProperty, kPort); |
| 200 | SetArg(kPasswordProperty, kPassword); |
| 201 | SetArg(flimflam::kProviderNameProperty, kProviderName); |
| 202 | |
| 203 | // We should not be able to read a property out of the driver args using the |
| 204 | // key to the args directly. |
Paul Stewart | 8e7e459 | 2012-04-29 09:47:48 -0700 | [diff] [blame] | 205 | EXPECT_FALSE(inspector.ContainsStringProperty(kPortProperty)); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 206 | |
| 207 | // We should instead be able to find it within the "Provider" stringmap. |
Paul Stewart | 8e7e459 | 2012-04-29 09:47:48 -0700 | [diff] [blame] | 208 | string value; |
| 209 | EXPECT_TRUE(GetProviderProperty(store, kPortProperty, &value)); |
| 210 | EXPECT_EQ(kPort, value); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 211 | |
| 212 | // Properties that start with the prefix "Provider." should be mapped to the |
| 213 | // name in the Properties dict with the prefix removed. |
Paul Stewart | 8e7e459 | 2012-04-29 09:47:48 -0700 | [diff] [blame] | 214 | EXPECT_TRUE(GetProviderProperty(store, flimflam::kNameProperty, &value)); |
| 215 | EXPECT_EQ(kProviderName, value); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 216 | |
Paul Stewart | 8e7e459 | 2012-04-29 09:47:48 -0700 | [diff] [blame] | 217 | // If we clear a property, we should no longer be able to find it. |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 218 | { |
| 219 | Error error; |
| 220 | EXPECT_TRUE(store.ClearProperty(kPortProperty, &error)); |
| 221 | EXPECT_TRUE(error.IsSuccess()); |
Paul Stewart | 8e7e459 | 2012-04-29 09:47:48 -0700 | [diff] [blame] | 222 | EXPECT_FALSE(GetProviderProperty(store, kPortProperty, NULL)); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 223 | } |
| 224 | |
| 225 | // A second attempt to clear this property should return an error. |
| 226 | { |
| 227 | Error error; |
| 228 | EXPECT_FALSE(store.ClearProperty(kPortProperty, &error)); |
| 229 | EXPECT_EQ(Error::kNotFound, error.type()); |
| 230 | } |
| 231 | |
Darin Petkov | cb71529 | 2012-04-25 13:04:37 +0200 | [diff] [blame] | 232 | // Test write only properties. |
Paul Stewart | 8e7e459 | 2012-04-29 09:47:48 -0700 | [diff] [blame] | 233 | EXPECT_FALSE(GetProviderProperty(store, kPINProperty, NULL)); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 234 | |
| 235 | // Write properties to the driver args using the PropertyStore interface. |
Darin Petkov | cb71529 | 2012-04-25 13:04:37 +0200 | [diff] [blame] | 236 | { |
| 237 | const string kValue = "some-value"; |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 238 | Error error; |
Darin Petkov | cb71529 | 2012-04-25 13:04:37 +0200 | [diff] [blame] | 239 | EXPECT_TRUE(store.SetStringProperty(kPINProperty, kValue, &error)); |
| 240 | EXPECT_EQ(kValue, GetArgs()->GetString(kPINProperty)); |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 241 | } |
| 242 | } |
| 243 | |
Darin Petkov | b451d6e | 2012-04-23 11:56:41 +0200 | [diff] [blame] | 244 | } // namespace shill |