chromeos/dbus/dbus_client_bundle.cc

   1 // Copyright 2014 The Chromium 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 "chromeos/dbus/dbus_client_bundle.h"
   6
   7 #include <vector>
   8
   9 #include "base/command_line.h"
  10 #include "base/strings/string_split.h"
  11 #include "base/strings/string_util.h"
  12 #include "chromeos/chromeos_switches.h"
  13 #include "chromeos/dbus/amplifier_client.h"
  14 #include "chromeos/dbus/ap_manager_client.h"
  15 #include "chromeos/dbus/audio_dsp_client.h"
  16 #include "chromeos/dbus/bluetooth_adapter_client.h"
  17 #include "chromeos/dbus/bluetooth_agent_manager_client.h"
  18 #include "chromeos/dbus/bluetooth_device_client.h"
  19 #include "chromeos/dbus/bluetooth_gatt_characteristic_client.h"
  20 #include "chromeos/dbus/bluetooth_gatt_descriptor_client.h"
  21 #include "chromeos/dbus/bluetooth_gatt_manager_client.h"
  22 #include "chromeos/dbus/bluetooth_gatt_service_client.h"
  23 #include "chromeos/dbus/bluetooth_input_client.h"
  24 #include "chromeos/dbus/bluetooth_le_advertising_manager_client.h"
  25 #include "chromeos/dbus/bluetooth_media_client.h"
  26 #include "chromeos/dbus/bluetooth_media_transport_client.h"
  27 #include "chromeos/dbus/bluetooth_profile_manager_client.h"
  28 #include "chromeos/dbus/cras_audio_client.h"
  29 #include "chromeos/dbus/cros_disks_client.h"
  30 #include "chromeos/dbus/cryptohome_client.h"
  31 #include "chromeos/dbus/debug_daemon_client.h"
  32 #include "chromeos/dbus/easy_unlock_client.h"
  33 #include "chromeos/dbus/fake_amplifier_client.h"
  34 #include "chromeos/dbus/fake_ap_manager_client.h"
  35 #include "chromeos/dbus/fake_audio_dsp_client.h"
  36 #include "chromeos/dbus/fake_bluetooth_adapter_client.h"
  37 #include "chromeos/dbus/fake_bluetooth_agent_manager_client.h"
  38 #include "chromeos/dbus/fake_bluetooth_device_client.h"
  39 #include "chromeos/dbus/fake_bluetooth_gatt_characteristic_client.h"
  40 #include "chromeos/dbus/fake_bluetooth_gatt_descriptor_client.h"
  41 #include "chromeos/dbus/fake_bluetooth_gatt_manager_client.h"
  42 #include "chromeos/dbus/fake_bluetooth_gatt_service_client.h"
  43 #include "chromeos/dbus/fake_bluetooth_input_client.h"
  44 #include "chromeos/dbus/fake_bluetooth_le_advertising_manager_client.h"
  45 #include "chromeos/dbus/fake_bluetooth_media_client.h"
  46 #include "chromeos/dbus/fake_bluetooth_media_transport_client.h"
  47 #include "chromeos/dbus/fake_bluetooth_profile_manager_client.h"
  48 #include "chromeos/dbus/fake_cras_audio_client.h"
  49 #include "chromeos/dbus/fake_cryptohome_client.h"
  50 #include "chromeos/dbus/fake_debug_daemon_client.h"
  51 #include "chromeos/dbus/fake_easy_unlock_client.h"
  52 #include "chromeos/dbus/fake_gsm_sms_client.h"
  53 #include "chromeos/dbus/fake_image_burner_client.h"
  54 #include "chromeos/dbus/fake_introspectable_client.h"
  55 #include "chromeos/dbus/fake_lorgnette_manager_client.h"
  56 #include "chromeos/dbus/fake_modem_messaging_client.h"
  57 #include "chromeos/dbus/fake_nfc_adapter_client.h"
  58 #include "chromeos/dbus/fake_nfc_device_client.h"
  59 #include "chromeos/dbus/fake_nfc_manager_client.h"
  60 #include "chromeos/dbus/fake_nfc_record_client.h"
  61 #include "chromeos/dbus/fake_nfc_tag_client.h"
  62 #include "chromeos/dbus/fake_peer_daemon_manager_client.h"
  63 #include "chromeos/dbus/fake_permission_broker_client.h"
  64 #include "chromeos/dbus/fake_privet_daemon_manager_client.h"
  65 #include "chromeos/dbus/fake_shill_device_client.h"
  66 #include "chromeos/dbus/fake_shill_ipconfig_client.h"
  67 #include "chromeos/dbus/fake_shill_manager_client.h"
  68 #include "chromeos/dbus/fake_shill_profile_client.h"
  69 #include "chromeos/dbus/fake_shill_service_client.h"
  70 #include "chromeos/dbus/fake_shill_third_party_vpn_driver_client.h"
  71 #include "chromeos/dbus/fake_sms_client.h"
  72 #include "chromeos/dbus/fake_system_clock_client.h"
  73 #include "chromeos/dbus/gsm_sms_client.h"
  74 #include "chromeos/dbus/image_burner_client.h"
  75 #include "chromeos/dbus/introspectable_client.h"
  76 #include "chromeos/dbus/lorgnette_manager_client.h"
  77 #include "chromeos/dbus/modem_messaging_client.h"
  78 #include "chromeos/dbus/nfc_adapter_client.h"
  79 #include "chromeos/dbus/nfc_device_client.h"
  80 #include "chromeos/dbus/nfc_manager_client.h"
  81 #include "chromeos/dbus/nfc_record_client.h"
  82 #include "chromeos/dbus/nfc_tag_client.h"
  83 #include "chromeos/dbus/peer_daemon_manager_client.h"
  84 #include "chromeos/dbus/permission_broker_client.h"
  85 #include "chromeos/dbus/power_manager_client.h"
  86 #include "chromeos/dbus/power_policy_controller.h"
  87 #include "chromeos/dbus/privet_daemon_manager_client.h"
  88 #include "chromeos/dbus/session_manager_client.h"
  89 #include "chromeos/dbus/shill_device_client.h"
  90 #include "chromeos/dbus/shill_ipconfig_client.h"
  91 #include "chromeos/dbus/shill_manager_client.h"
  92 #include "chromeos/dbus/shill_profile_client.h"
  93 #include "chromeos/dbus/shill_service_client.h"
  94 #include "chromeos/dbus/shill_third_party_vpn_driver_client.h"
  95 #include "chromeos/dbus/sms_client.h"
  96 #include "chromeos/dbus/system_clock_client.h"
  97 #include "chromeos/dbus/update_engine_client.h"
  98
  99 namespace chromeos {
 100
 101 namespace {
 102
 103 // Command line switch mapping for --dbus-unstub-clients.
 104 const struct {
 105   const char* param_name;
 106   DBusClientBundle::DBusClientType client_type;
 107 } client_type_map[] = {
 108     { "amplifier",  DBusClientBundle::AMPLIFIER },
 109     { "ap",  DBusClientBundle::AP_MANAGER },
 110     { "audio_dsp",  DBusClientBundle::AUDIO_DSP },
 111     { "bluetooth",  DBusClientBundle::BLUETOOTH },
 112     { "cras",  DBusClientBundle::CRAS },
 113     { "cros_disks",  DBusClientBundle::CROS_DISKS },
 114     { "cryptohome",  DBusClientBundle::CRYPTOHOME },
 115     { "debug_daemon",  DBusClientBundle::DEBUG_DAEMON },
 116     { "easy_unlock",  DBusClientBundle::EASY_UNLOCK },
 117     { "lorgnette_manager",  DBusClientBundle::LORGNETTE_MANAGER },
 118     { "shill",  DBusClientBundle::SHILL },
 119     { "gsm_sms",  DBusClientBundle::GSM_SMS },
 120     { "image_burner",  DBusClientBundle::IMAGE_BURNER },
 121     { "introspectable",  DBusClientBundle::INTROSPECTABLE },
 122     { "modem_messaging",  DBusClientBundle::MODEM_MESSAGING },
 123     { "nfc",  DBusClientBundle::NFC },
 124     { "peer_daemon",  DBusClientBundle::PEER_DAEMON },
 125     { "permission_broker",  DBusClientBundle::PERMISSION_BROKER },
 126     { "power_manager",  DBusClientBundle::POWER_MANAGER },
 127     { "privet_daemon", DBusClientBundle::PRIVET_DAEMON },
 128     { "session_manager",  DBusClientBundle::SESSION_MANAGER },
 129     { "sms",  DBusClientBundle::SMS },
 130     { "system_clock",  DBusClientBundle::SYSTEM_CLOCK },
 131     { "update_engine",  DBusClientBundle::UPDATE_ENGINE },
 132 };
 133
 134 // Parses single command line param value for dbus subsystem. If successful,
 135 // returns its enum representation. Otherwise returns NO_CLIENT.
 136 DBusClientBundle::DBusClientType GetDBusClientType(
 137     const std::string& client_type_name) {
 138   for (size_t i = 0; i < arraysize(client_type_map); i++) {
 139     if (base::LowerCaseEqualsASCII(client_type_name,
 140                                    client_type_map[i].param_name))
 141       return client_type_map[i].client_type;
 142   }
 143   return DBusClientBundle::NO_CLIENT;
 144 }
 145
 146 }  // namespace
 147
 148 DBusClientBundle::DBusClientBundle(DBusClientTypeMask unstub_client_mask)
 149     : unstub_client_mask_(unstub_client_mask) {
 150   if (!IsUsingStub(AMPLIFIER))
 151     amplifier_client_.reset(AmplifierClient::Create());
 152   else
 153     amplifier_client_.reset(new FakeAmplifierClient);
 154
 155   if (!IsUsingStub(AUDIO_DSP))
 156     audio_dsp_client_.reset(AudioDspClient::Create());
 157   else
 158     audio_dsp_client_.reset(new FakeAudioDspClient);
 159
 160   if (!IsUsingStub(BLUETOOTH)) {
 161     bluetooth_adapter_client_.reset(BluetoothAdapterClient::Create());
 162     bluetooth_le_advertising_manager_client_.reset(
 163         BluetoothLEAdvertisingManagerClient::Create());
 164     bluetooth_agent_manager_client_.reset(
 165         BluetoothAgentManagerClient::Create());
 166     bluetooth_device_client_.reset(BluetoothDeviceClient::Create());
 167     bluetooth_input_client_.reset(BluetoothInputClient::Create());
 168     bluetooth_media_client_.reset(BluetoothMediaClient::Create());
 169     bluetooth_media_transport_client_.reset(
 170         BluetoothMediaTransportClient::Create());
 171     bluetooth_profile_manager_client_.reset(
 172         BluetoothProfileManagerClient::Create());
 173     bluetooth_gatt_characteristic_client_.reset(
 174         BluetoothGattCharacteristicClient::Create());
 175     bluetooth_gatt_descriptor_client_.reset(
 176         BluetoothGattDescriptorClient::Create());
 177     bluetooth_gatt_manager_client_.reset(
 178         BluetoothGattManagerClient::Create());
 179     bluetooth_gatt_service_client_.reset(
 180         BluetoothGattServiceClient::Create());
 181   } else {
 182     bluetooth_adapter_client_.reset(new FakeBluetoothAdapterClient);
 183     bluetooth_le_advertising_manager_client_.reset(
 184         new FakeBluetoothLEAdvertisingManagerClient);
 185     bluetooth_agent_manager_client_.reset(new FakeBluetoothAgentManagerClient);
 186     bluetooth_device_client_.reset(new FakeBluetoothDeviceClient);
 187     bluetooth_input_client_.reset(new FakeBluetoothInputClient);
 188     bluetooth_media_client_.reset(new FakeBluetoothMediaClient);
 189     bluetooth_media_transport_client_.reset(
 190         new FakeBluetoothMediaTransportClient);
 191     bluetooth_profile_manager_client_.reset(
 192         new FakeBluetoothProfileManagerClient);
 193     bluetooth_gatt_characteristic_client_.reset(
 194         new FakeBluetoothGattCharacteristicClient);
 195     bluetooth_gatt_descriptor_client_.reset(
 196         new FakeBluetoothGattDescriptorClient);
 197     bluetooth_gatt_manager_client_.reset(new FakeBluetoothGattManagerClient);
 198     bluetooth_gatt_service_client_.reset(new FakeBluetoothGattServiceClient);
 199   }
 200
 201   if (!IsUsingStub(CRAS))
 202     cras_audio_client_.reset(CrasAudioClient::Create());
 203   else
 204     cras_audio_client_.reset(new FakeCrasAudioClient);
 205
 206   cros_disks_client_.reset(CrosDisksClient::Create(
 207       IsUsingStub(CROS_DISKS) ? STUB_DBUS_CLIENT_IMPLEMENTATION
 208                               : REAL_DBUS_CLIENT_IMPLEMENTATION));
 209
 210   if (!IsUsingStub(CRYPTOHOME))
 211     cryptohome_client_.reset(CryptohomeClient::Create());
 212   else
 213     cryptohome_client_.reset(new FakeCryptohomeClient);
 214
 215   if (!IsUsingStub(DEBUG_DAEMON))
 216     debug_daemon_client_.reset(DebugDaemonClient::Create());
 217   else
 218     debug_daemon_client_.reset(new FakeDebugDaemonClient);
 219
 220   if (!IsUsingStub(EASY_UNLOCK))
 221     easy_unlock_client_.reset(EasyUnlockClient::Create());
 222   else
 223     easy_unlock_client_.reset(new FakeEasyUnlockClient);
 224
 225   if (!IsUsingStub(LORGNETTE_MANAGER))
 226     lorgnette_manager_client_.reset(LorgnetteManagerClient::Create());
 227   else
 228     lorgnette_manager_client_.reset(new FakeLorgnetteManagerClient);
 229
 230   if (!IsUsingStub(SHILL)) {
 231     shill_manager_client_.reset(ShillManagerClient::Create());
 232     shill_device_client_.reset(ShillDeviceClient::Create());
 233     shill_ipconfig_client_.reset(ShillIPConfigClient::Create());
 234     shill_service_client_.reset(ShillServiceClient::Create());
 235     shill_profile_client_.reset(ShillProfileClient::Create());
 236     shill_third_party_vpn_driver_client_.reset(
 237         ShillThirdPartyVpnDriverClient::Create());
 238   } else {
 239     shill_manager_client_.reset(new FakeShillManagerClient);
 240     shill_device_client_.reset(new FakeShillDeviceClient);
 241     shill_ipconfig_client_.reset(new FakeShillIPConfigClient);
 242     shill_service_client_.reset(new FakeShillServiceClient);
 243     shill_profile_client_.reset(new FakeShillProfileClient);
 244     shill_third_party_vpn_driver_client_.reset(
 245         new FakeShillThirdPartyVpnDriverClient);
 246   }
 247
 248   if (!IsUsingStub(GSM_SMS)) {
 249     gsm_sms_client_.reset(GsmSMSClient::Create());
 250   } else {
 251     FakeGsmSMSClient* gsm_sms_client = new FakeGsmSMSClient();
 252     gsm_sms_client->set_sms_test_message_switch_present(
 253         base::CommandLine::ForCurrentProcess()->HasSwitch(
 254             chromeos::switches::kSmsTestMessages));
 255     gsm_sms_client_.reset(gsm_sms_client);
 256   }
 257
 258   if (!IsUsingStub(IMAGE_BURNER))
 259     image_burner_client_.reset(ImageBurnerClient::Create());
 260   else
 261     image_burner_client_.reset(new FakeImageBurnerClient);
 262
 263   if (!IsUsingStub(INTROSPECTABLE))
 264     introspectable_client_.reset(IntrospectableClient::Create());
 265   else
 266     introspectable_client_.reset(new FakeIntrospectableClient);
 267
 268   if (!IsUsingStub(MODEM_MESSAGING))
 269     modem_messaging_client_.reset(ModemMessagingClient::Create());
 270   else
 271     modem_messaging_client_.reset(new FakeModemMessagingClient);
 272
 273   // Create the NFC clients in the correct order based on their dependencies.
 274   if (!IsUsingStub(NFC)) {
 275     nfc_manager_client_.reset(NfcManagerClient::Create());
 276     nfc_adapter_client_.reset(
 277         NfcAdapterClient::Create(nfc_manager_client_.get()));
 278     nfc_device_client_.reset(
 279         NfcDeviceClient::Create(nfc_adapter_client_.get()));
 280     nfc_tag_client_.reset(NfcTagClient::Create(nfc_adapter_client_.get()));
 281     nfc_record_client_.reset(NfcRecordClient::Create(nfc_device_client_.get(),
 282                                                      nfc_tag_client_.get()));
 283   } else {
 284     nfc_manager_client_.reset(new FakeNfcManagerClient);
 285     nfc_adapter_client_.reset(new FakeNfcAdapterClient);
 286     nfc_device_client_.reset(new FakeNfcDeviceClient);
 287     nfc_tag_client_.reset(new FakeNfcTagClient);
 288     nfc_record_client_.reset(new FakeNfcRecordClient);
 289   }
 290
 291   if (!IsUsingStub(PEER_DAEMON))
 292     peer_daemon_manager_client_.reset(PeerDaemonManagerClient::Create());
 293   else
 294     peer_daemon_manager_client_.reset(new FakePeerDaemonManagerClient);
 295
 296   if (!IsUsingStub(PERMISSION_BROKER))
 297     permission_broker_client_.reset(PermissionBrokerClient::Create());
 298   else
 299     permission_broker_client_.reset(new FakePermissionBrokerClient);
 300
 301   if (!IsUsingStub(PRIVET_DAEMON))
 302     privet_daemon_manager_client_.reset(PrivetDaemonManagerClient::Create());
 303   else
 304     privet_daemon_manager_client_.reset(new FakePrivetDaemonManagerClient);
 305
 306   if (!IsUsingStub(AP_MANAGER))
 307     ap_manager_client_.reset(ApManagerClient::Create());
 308   else
 309     ap_manager_client_.reset(new FakeApManagerClient);
 310
 311   power_manager_client_.reset(PowerManagerClient::Create(
 312       IsUsingStub(POWER_MANAGER) ? STUB_DBUS_CLIENT_IMPLEMENTATION
 313                                  : REAL_DBUS_CLIENT_IMPLEMENTATION));
 314
 315   session_manager_client_.reset(SessionManagerClient::Create(
 316       IsUsingStub(SESSION_MANAGER) ? STUB_DBUS_CLIENT_IMPLEMENTATION
 317                                    : REAL_DBUS_CLIENT_IMPLEMENTATION));
 318
 319   if (!IsUsingStub(SMS))
 320     sms_client_.reset(SMSClient::Create());
 321   else
 322     sms_client_.reset(new FakeSMSClient);
 323
 324   if (!IsUsingStub(SYSTEM_CLOCK))
 325     system_clock_client_.reset(SystemClockClient::Create());
 326   else
 327     system_clock_client_.reset(new FakeSystemClockClient);
 328
 329   update_engine_client_.reset(UpdateEngineClient::Create(
 330       IsUsingStub(UPDATE_ENGINE) ? STUB_DBUS_CLIENT_IMPLEMENTATION
 331                                  : REAL_DBUS_CLIENT_IMPLEMENTATION));
 332 }
 333
 334 DBusClientBundle::~DBusClientBundle() {
 335 }
 336
 337 bool DBusClientBundle::IsUsingStub(DBusClientType client) {
 338   return !(unstub_client_mask_ & client);
 339 }
 340
 341 bool DBusClientBundle::IsUsingAnyRealClient() {
 342   // 'Using any real client' is equivalent to 'Unstubbed any client'.
 343   return unstub_client_mask_ != 0;
 344 }
 345
 346 void DBusClientBundle::SetupDefaultEnvironment() {
 347   ShillManagerClient::TestInterface* manager =
 348       shill_manager_client_->GetTestInterface();
 349   if (manager)
 350     manager->SetupDefaultEnvironment();
 351 }
 352
 353 // static
 354 DBusClientBundle::DBusClientTypeMask DBusClientBundle::ParseUnstubList(
 355     const std::string& unstub_list) {
 356   DBusClientTypeMask unstub_mask = 0;
 357   std::vector<std::string> unstub_components;
 358   base::SplitString(unstub_list, ',', &unstub_components);
 359   for (std::vector<std::string>::const_iterator iter =
 360           unstub_components.begin();
 361        iter != unstub_components.end(); ++iter) {
 362     DBusClientBundle::DBusClientType client = GetDBusClientType(*iter);
 363     if (client != NO_CLIENT) {
 364       LOG(WARNING) << "Unstubbing dbus client for " << *iter;
 365       unstub_mask |= client;
 366     } else {
 367       LOG(ERROR) << "Unknown dbus client: " << *iter;
 368     }
 369   }
 370
 371   return unstub_mask;
 372 }
 373
 374 }  // namespace chromeos