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