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