// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROMEOS_ASH_COMPONENTS_DBUS_SHILL_SHILL_MANAGER_CLIENT_H_
#define CHROMEOS_ASH_COMPONENTS_DBUS_SHILL_SHILL_MANAGER_CLIENT_H_
#include <string>
#include "base/component_export.h"
#include "base/scoped_observation_traits.h"
#include "base/time/time.h"
#include "base/values.h"
#include "chromeos/ash/components/dbus/shill/fake_shill_simulated_result.h"
#include "chromeos/ash/components/dbus/shill/shill_client_helper.h"
#include "chromeos/dbus/common/dbus_callback.h"
#include "third_party/cros_system_api/dbus/service_constants.h"
namespace dbus {
class Bus;
class ObjectPath;
} // namespace dbus
namespace ash {
class ShillPropertyChangedObserver;
// ShillManagerClient is used to communicate with the Shill Manager
// service. All methods should be called from the origin thread which
// initializes the DBusThreadManager instance. Most methods that make Shill
// Manager calls pass |callback| which will be invoked if the method call
// succeeds, and |error_callback| which will be invoked if the method call fails
// or returns an error response.
class COMPONENT_EXPORT(SHILL_CLIENT) ShillManagerClient {
public:
typedef ShillClientHelper::ErrorCallback ErrorCallback;
typedef ShillClientHelper::StringCallback StringCallback;
struct NetworkThrottlingStatus {
// Enable or disable network bandwidth throttling.
// Following fields are available only if |enabled| is true.
bool enabled;
// Uploading rate (kbits/s).
uint32_t upload_rate_kbits;
// Downloading rate (kbits/s).
uint32_t download_rate_kbits;
};
struct CreateP2PGroupParameter {
CreateP2PGroupParameter(
const std::optional<std::string> ssid,
const std::optional<std::string> passphrase,
const std::optional<uint32_t> frequency,
const std::optional<shill::WiFiInterfacePriority> priority);
CreateP2PGroupParameter(const std::optional<std::string> ssid,
const std::optional<std::string> passphrase);
~CreateP2PGroupParameter();
// SSID of the group to be created. If not provided, a random SSID will be
// generated by Shill.
std::optional<std::string> ssid;
// Passphrase for the group to be created. If not provided, a random
// passphrase will be generated by Shill.
std::optional<std::string> passphrase;
// P2P group's frequency.
std::optional<uint32_t> frequency;
// Priority of the WiFi P2P interface
std::optional<shill::WiFiInterfacePriority> priority;
};
struct ConnectP2PGroupParameter {
ConnectP2PGroupParameter(
const std::string ssid,
const std::string passphrase,
const std::optional<uint32_t> frequency,
const std::optional<shill::WiFiInterfacePriority> priority);
~ConnectP2PGroupParameter();
// SSID of the group to join.
std::string ssid;
// Passphrase of the group to join.
std::string passphrase;
// Frequency of the group.
std::optional<uint32_t> frequency;
// Priority of the WiFi P2P interface
std::optional<shill::WiFiInterfacePriority> priority;
};
// Interface for setting up devices, services, and technologies for testing.
// Accessed through GetTestInterface(), only implemented in the Stub Impl.
class TestInterface {
public:
virtual void AddDevice(const std::string& device_path) = 0;
virtual void RemoveDevice(const std::string& device_path) = 0;
virtual void ClearDevices() = 0;
virtual void AddTechnology(const std::string& type, bool enabled) = 0;
virtual void RemoveTechnology(const std::string& type) = 0;
virtual void SetTechnologyInitializing(const std::string& type,
bool initializing) = 0;
virtual void SetTechnologyProhibited(const std::string& type,
bool prohibited) = 0;
virtual void SetTechnologyEnabled(const std::string& type,
base::OnceClosure callback,
bool enabled) = 0;
// |network| must be a dictionary describing a Shill network configuration
// which will be appended to the results returned from
// GetNetworksForGeolocation().
virtual void AddGeoNetwork(const std::string& technology,
const base::Value::Dict& network) = 0;
// Does not create an actual profile in the ProfileClient but update the
// profiles list and sends a notification to observers. This should only be
// called by the ProfileStub. In all other cases, use
// ShillProfileClient::TestInterface::AddProfile.
virtual void AddProfile(const std::string& profile_path) = 0;
// Used to reset all properties; does not notify observers.
virtual void ClearProperties() = 0;
// Set manager property.
virtual void SetManagerProperty(const std::string& key,
const base::Value& value) = 0;
// Get stub manager properties.
virtual base::Value::Dict GetStubProperties() = 0;
// Modify services in the Manager's list.
virtual void AddManagerService(const std::string& service_path,
bool notify_observers) = 0;
virtual void RemoveManagerService(const std::string& service_path) = 0;
virtual void ClearManagerServices() = 0;
// Returns all enabled services in the given property.
virtual base::Value::List GetEnabledServiceList() const = 0;
// Restarts hotspot by disabling and enabling after configured interactive
// delay.
virtual void RestartTethering() = 0;
// Called by ShillServiceClient when a service's State property changes,
// before notifying observers. Sets the DefaultService property to empty
// if the state changes to a non-connected state.
virtual void ServiceStateChanged(const std::string& service_path,
const std::string& state) = 0;
// Called by ShillServiceClient when a service's State or Visible
// property changes. If |notify| is true, notifies observers if a list
// changed. Services are sorted first by active, inactive, or disabled
// state, then by type.
virtual void SortManagerServices(bool notify) = 0;
// Sets up the default fake environment based on default initial states
// or states provided by the command line.
virtual void SetupDefaultEnvironment() = 0;
// Returns the interactive delay (specified by the command line or a test).
virtual base::TimeDelta GetInteractiveDelay() const = 0;
// Sets the interactive delay for testing.
virtual void SetInteractiveDelay(base::TimeDelta delay) = 0;
// Sets the 'best' service to connect to on a ConnectToBestServices call.
virtual void SetBestServiceToConnect(const std::string& service_path) = 0;
// Returns the current network throttling status.
virtual const NetworkThrottlingStatus& GetNetworkThrottlingStatus() = 0;
// Returns the current Fast Transition status.
virtual bool GetFastTransitionStatus() = 0;
// Makes ConfigureService succeed, fail, or timeout.
virtual void SetSimulateConfigurationResult(
FakeShillSimulatedResult configuration_result) = 0;
// Makes SetTetheringEnabled succeed, fail, or timeout and the enable
// tethering error string when it failed.
virtual void SetSimulateTetheringEnableResult(
FakeShillSimulatedResult tethering_result,
const std::string& enable_tethering_error) = 0;
// Makes CheckTetheringReadiness succeed, fail, or timeout and the readiness
// status if CheckTetheringReadiness succeeds.
virtual void SetSimulateCheckTetheringReadinessResult(
FakeShillSimulatedResult check_readiness_result,
const std::string& readiness_status) = 0;
// Makes CreateP2PGroup succeed, fail, or timeout and simulate the result
// code if it succeeds.
virtual void SetSimulateCreateP2PGroupResult(
FakeShillSimulatedResult operation_result,
const std::string& result_code) = 0;
// Makes DestroyP2PGroup succeed, fail, or timeout and simulate the result
// code if it succeeds.
virtual void SetSimulateDestroyP2PGroupResult(
FakeShillSimulatedResult operation_result,
const std::string& result_code) = 0;
// Makes ConnectToP2PGroup succeed, fail, or timeout and simulate the result
// code if it succeeds.
virtual void SetSimulateConnectToP2PGroupResult(
FakeShillSimulatedResult operation_result,
const std::string& result_code) = 0;
// Makes DisconnectFromP2PGroup succeed, fail, or timeout and simulate the
// result code if it succeeds.
virtual void SetSimulateDisconnectFromP2PGroupResult(
FakeShillSimulatedResult operation_result,
const std::string& result_code) = 0;
// Clears profile list.
virtual void ClearProfiles() = 0;
// Set (or unset) stub client state to return nullopt on GetProperties().
virtual void SetShouldReturnNullProperties(bool value) = 0;
// Sets whether WiFi services should be visible by default when created
// using ConfigureService.
// TODO(b/274453184): Make "Visible": false the default for all WiFi
// services created using ConfigureService.
virtual void SetWifiServicesVisibleByDefault(
bool wifi_services_visible_by_default) = 0;
// Returns the shill id of the recently destroyed P2P group.
virtual int GetRecentlyDestroyedP2PGroupId() = 0;
// Returns the shill id of the recently disconnected P2P group.
virtual int GetRecentlyDisconnectedP2PGroupId() = 0;
protected:
virtual ~TestInterface() = default;
};
// Creates and initializes the global instance. |bus| must not be null.
static void Initialize(dbus::Bus* bus);
// Creates the global instance with a fake implementation.
static void InitializeFake();
// Destroys the global instance which must have been initialized.
static void Shutdown();
// Returns the global instance if initialized. May return null.
static ShillManagerClient* Get();
ShillManagerClient(const ShillManagerClient&) = delete;
ShillManagerClient& operator=(const ShillManagerClient&) = delete;
// Adds a property changed |observer|.
virtual void AddPropertyChangedObserver(
ShillPropertyChangedObserver* observer) = 0;
// Removes a property changed |observer|.
virtual void RemovePropertyChangedObserver(
ShillPropertyChangedObserver* observer) = 0;
// Calls the GetProperties DBus method and invokes |callback| when complete.
// |callback| receives a dictionary Value containing the Manager properties on
// success or nullopt on failure.
virtual void GetProperties(
chromeos::DBusMethodCallback<base::Value::Dict> callback) = 0;
// Calls the GetNetworksForGeolocation DBus method and invokes |callback| when
// complete. |callback| receives a dictionary Value containing an entry for
// available network types. See Shill manager-api documentation for details.
virtual void GetNetworksForGeolocation(
chromeos::DBusMethodCallback<base::Value::Dict> callback) = 0;
// Calls SetProperty method.
virtual void SetProperty(const std::string& name,
const base::Value& value,
base::OnceClosure callback,
ErrorCallback error_callback) = 0;
// Calls RequestScan method.
virtual void RequestScan(const std::string& type,
base::OnceClosure callback,
ErrorCallback error_callback) = 0;
// Calls EnableTechnology method.
virtual void EnableTechnology(const std::string& type,
base::OnceClosure callback,
ErrorCallback error_callback) = 0;
// Calls DisableTechnology method.
virtual void DisableTechnology(const std::string& type,
base::OnceClosure callback,
ErrorCallback error_callback) = 0;
// Calls Manager.ConfigureService with |properties| which must be a
// dictionary value describing a Shill service.
virtual void ConfigureService(const base::Value::Dict& properties,
chromeos::ObjectPathCallback callback,
ErrorCallback error_callback) = 0;
// Calls Manager.ConfigureServiceForProfile for |profile_path| with
// |properties| which must be a dictionary value describing a Shill service.
virtual void ConfigureServiceForProfile(const dbus::ObjectPath& profile_path,
const base::Value::Dict& properties,
chromeos::ObjectPathCallback callback,
ErrorCallback error_callback) = 0;
// Calls Manager.GetService with |properties| which must be a dictionary value
// describing a Service.
virtual void GetService(const base::Value::Dict& properties,
chromeos::ObjectPathCallback callback,
ErrorCallback error_callback) = 0;
// Force a fresh WiFi scan if a WiFi device is available as a way of
// ensuring that recently configured networks can be found.
// For each technology present, connects to the "best" service available.
// Called once the user is logged in and certificates are loaded.
virtual void ScanAndConnectToBestServices(base::OnceClosure callback,
ErrorCallback error_callback) = 0;
// Enable or disable network bandwidth throttling, on all interfaces on the
// system.
virtual void SetNetworkThrottlingStatus(const NetworkThrottlingStatus& status,
base::OnceClosure callback,
ErrorCallback error_callback) = 0;
// Creates a set of Passpoint credentials from |properties| in the profile
// referenced by |profile_path|.
virtual void AddPasspointCredentials(const dbus::ObjectPath& profile_path,
const base::Value::Dict& properties,
base::OnceClosure callback,
ErrorCallback error_callback) = 0;
// Removes all Passpoint credentials that matches all property of |properties|
// in the profile referenced by |profile_path|.
virtual void RemovePasspointCredentials(const dbus::ObjectPath& profile_path,
const base::Value::Dict& properties,
base::OnceClosure callback,
ErrorCallback error_callback) = 0;
// Enables or disables tethering hotspot. Only supports cellular as the
// upstream technology and WiFi as the downstream technology. This API
// will be deprecated once ChromeOS migrate to WiFi concurrency APIs.
virtual void SetTetheringEnabled(bool enabled,
StringCallback callback,
ErrorCallback error_callback) = 0;
// Enables tethering hotspot. Only supports cellular as the upstream
// technology and WiFi as the downstream technology. `priority` specifies
// the tethering interface priority and may bring down other WiFi interface
// automatically if necessary.
virtual void EnableTethering(const shill::WiFiInterfacePriority& priority,
StringCallback callback,
ErrorCallback error_callback) = 0;
// Disable tethering hotspot.
virtual void DisableTethering(StringCallback callback,
ErrorCallback error_callback) = 0;
// Checks whether the upstream technology is ready to tether. Returns a status
// string indicating the readiness. Returns "allowed" if the readiness check
// is completed and upstream is ready for tethering and "not_allowed" if the
// readiness check is completed but the upstream is not ready.
virtual void CheckTetheringReadiness(StringCallback callback,
ErrorCallback error_callback) = 0;
// Enables or disables local only hotspot.
virtual void SetLOHSEnabled(bool enabled,
base::OnceClosure callback,
ErrorCallback error_callback) = 0;
// Creates a P2P group that uses WiFi direct as the underlying medium.
virtual void CreateP2PGroup(
const CreateP2PGroupParameter& create_group_argument,
base::OnceCallback<void(base::Value::Dict result)> callback,
ErrorCallback error_callback) = 0;
// Connects to a P2P group
virtual void ConnectToP2PGroup(
const ConnectP2PGroupParameter& connect_group_argument,
base::OnceCallback<void(base::Value::Dict result)> callback,
ErrorCallback error_callback) = 0;
// Destroys P2PGroup
virtual void DestroyP2PGroup(
const int shill_id,
base::OnceCallback<void(base::Value::Dict result)> callback,
ErrorCallback error_callback) = 0;
// Disconnects from P2PGroup
virtual void DisconnectFromP2PGroup(
const int shill_id,
base::OnceCallback<void(base::Value::Dict result)> callback,
ErrorCallback error_callback) = 0;
// Returns an interface for testing (stub only), or returns null.
virtual TestInterface* GetTestInterface() = 0;
protected:
friend class ShillManagerClientTest;
// Initialize/Shutdown should be used instead.
ShillManagerClient();
virtual ~ShillManagerClient();
};
} // namespace ash
namespace base {
template <>
struct ScopedObservationTraits<ash::ShillManagerClient,
ash::ShillPropertyChangedObserver> {
static void AddObserver(ash::ShillManagerClient* source,
ash::ShillPropertyChangedObserver* observer) {
source->AddPropertyChangedObserver(observer);
}
static void RemoveObserver(ash::ShillManagerClient* source,
ash::ShillPropertyChangedObserver* observer) {
source->RemovePropertyChangedObserver(observer);
}
};
} // namespace base
#endif // CHROMEOS_ASH_COMPONENTS_DBUS_SHILL_SHILL_MANAGER_CLIENT_H_
Codebase Browser
chromium