Rework wifi_data_provider_linux.cc with our D-Bus library.

content/browser/geolocation/wifi_data_provider_linux_unittest.cc

Index: content/browser/geolocation/wifi_data_provider_linux_unittest.cc
diff --git a/content/browser/geolocation/wifi_data_provider_linux_unittest.cc b/content/browser/geolocation/wifi_data_provider_linux_unittest.cc
new file mode 100644
index 0000000000000000000000000000000000000000..c8e37eda1e8e6203c5ecf6af9f2ad9348c0e636e
--- /dev/null
+++ b/content/browser/geolocation/wifi_data_provider_linux_unittest.cc
@@ -0,0 +1,215 @@
+// Copyright (c) 2011 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "content/browser/geolocation/wifi_data_provider_linux.h"
+
+#include "base/memory/ref_counted.h"
+#include "base/memory/scoped_ptr.h"
+#include "base/message_loop.h"
+#include "base/utf_string_conversions.h"
+#include "dbus/message.h"
+#include "dbus/mock_bus.h"
+#include "dbus/mock_object_proxy.h"
+#include "dbus/object_proxy.h"
+#include "testing/gmock/include/gmock/gmock.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+using ::testing::_;
+using ::testing::Invoke;
+using ::testing::Return;
+using ::testing::Unused;
+
+class GeolocationWifiDataProviderLinuxTest : public testing::Test {
+  void SetUp() {
+    // Create a mock bus.
+    dbus::Bus::Options options;
+    options.bus_type = dbus::Bus::SYSTEM;
+    mock_bus_ = new dbus::MockBus(options);
+
+    // Create a mock proxy that behaves as NetworkManager.
+    mock_network_manager_proxy_ =
+        new dbus::MockObjectProxy(mock_bus_.get(),
+                                  "org.freedesktop.NetworkManager",
+                                  "/org/freedesktop/NetworkManager");
+    // Set an expectation so mock_network_manager_proxy_'s
+    // CallMethodAndBlock() will use CreateNetowrkManagerProxyResponse()
+    // to return responses.
+    EXPECT_CALL(*mock_network_manager_proxy_,
+                CallMethodAndBlock(_, _))
+        .WillRepeatedly(Invoke(
+            this,
+            &GeolocationWifiDataProviderLinuxTest::
+            CreateNetowrkManagerProxyResponse));
+
+    // Create a mock proxy that behaves as NetworkManager/Devices/0.
+    mock_device_proxy_ =
+        new dbus::MockObjectProxy(mock_bus_.get(),
+                                  "org.freedesktop.NetworkManager",
+                                  "/org/freedesktop/NetworkManager/Devices/0");
+    EXPECT_CALL(*mock_device_proxy_,
+                CallMethodAndBlock(_, _))
+        .WillRepeatedly(Invoke(
+            this,
+            &GeolocationWifiDataProviderLinuxTest::CreateDeviceProxyResponse));
+
+    // Create a mock proxy that behaves as NetworkManager/AccessPoint/0.
+    mock_access_point_proxy_ =
+        new dbus::MockObjectProxy(
+            mock_bus_.get(),
+            "org.freedesktop.NetworkManager",
+            "/org/freedesktop/NetworkManager/AccessPoint/0");
+    EXPECT_CALL(*mock_access_point_proxy_,
+                CallMethodAndBlock(_, _))
+        .WillRepeatedly(Invoke(
+            this,
+            &GeolocationWifiDataProviderLinuxTest::
+            CreateAccessPointProxyResponse));
+
+    // Set an expectation so mock_bus_'s GetObjectProxy() for the given
+    // service name and the object path will return
+    // mock_network_manager_proxy_.
+    EXPECT_CALL(*mock_bus_, GetObjectProxy(
+        "org.freedesktop.NetworkManager",
+        "/org/freedesktop/NetworkManager"))
+        .WillOnce(Return(mock_network_manager_proxy_.get()));
+    // Likewise, set an expectation for mock_device_proxy_.
+    EXPECT_CALL(*mock_bus_, GetObjectProxy(
+        "org.freedesktop.NetworkManager",
+        "/org/freedesktop/NetworkManager/Devices/0"))
+        .WillOnce(Return(mock_device_proxy_.get()))
+        .WillOnce(Return(mock_device_proxy_.get()));
+    // Likewise, set an expectation for mock_access_point_proxy_.
+    EXPECT_CALL(*mock_bus_, GetObjectProxy(
+        "org.freedesktop.NetworkManager",
+        "/org/freedesktop/NetworkManager/AccessPoint/0"))
+        .WillOnce(Return(mock_access_point_proxy_.get()));
+
+    // Create the wlan API with the mock bus object injected.
+    wifi_provider_linux_ = new WifiDataProviderLinux;
+    wlan_api_.reset(
+        wifi_provider_linux_->NewWlanApiForTesting(mock_bus_.get()));
+    ASSERT_TRUE(wlan_api_.get());
+  }
+
+ protected:
+  // DeviceDataProviderImplBase, a super class of WifiDataProviderLinux,
+  // requires a message loop to be present. message_loop_ is defined here,
+  // as it should outlive wifi_provider_linux_.
+  MessageLoop message_loop_;
+  scoped_refptr<dbus::MockBus> mock_bus_;
+  scoped_refptr<dbus::MockObjectProxy> mock_network_manager_proxy_;
+  scoped_refptr<dbus::MockObjectProxy> mock_access_point_proxy_;
+  scoped_refptr<dbus::MockObjectProxy> mock_device_proxy_;
+  scoped_refptr<WifiDataProviderLinux>  wifi_provider_linux_;
+  scoped_ptr<WifiDataProviderCommon::WlanApiInterface> wlan_api_;
+
+ private:
+  // Creates a response for |mock_network_manager_proxy_|.
+  dbus::Response* CreateNetowrkManagerProxyResponse(
+      dbus::MethodCall* method_call,
+      Unused) {
+    if (method_call->GetInterface() == "org.freedesktop.NetworkManager" &&
+        method_call->GetMember() == "GetDevices") {
+      // The list of devices is asked. Return the object path.
+      std::vector<std::string> object_paths;
+      object_paths.push_back("/org/freedesktop/NetworkManager/Devices/0");
+
+      dbus::Response* response = dbus::Response::CreateEmpty();
+      dbus::MessageWriter writer(response);
+      writer.AppendArrayOfObjectPaths(object_paths);
+      return response;
+    }
+
+    LOG(ERROR) << "Unexpected method call: " << method_call->ToString();
+    return NULL;
+  }
+
+  // Creates a response for |mock_device_proxy_|.
+  dbus::Response* CreateDeviceProxyResponse(dbus::MethodCall* method_call,
+                                            Unused) {
+    if (method_call->GetInterface() == DBUS_INTERFACE_PROPERTIES &&
+        method_call->GetMember() == "Get") {
+      dbus::MessageReader reader(method_call);
+      std::string interface_name;
+      std::string property_name;
+      if (reader.PopString(&interface_name) &&
+          reader.PopString(&property_name)) {
+        // The device type is asked. Respond that the device type is wifi.
+        dbus::Response* response = dbus::Response::CreateEmpty();
+        dbus::MessageWriter writer(response);
+        const int kDeviceTypeWifi = 2;

[stevenjb, 2011/08/24 23:32:04]

Is the '2' to match TYPE_WIFI in network_library.h? If so and it is inconvenient
to include that header, we should comment that.

[satorux1, 2011/08/25 06:03:17]

This matches NM_DEVICE_TYPE_WIFI in wifi_data_provider_linux.cc. We could share
the constant via wifi_data_provider_linux.h, but I'd rather keep the header file
concise. Added a comment about it.

+        writer.AppendVariantOfUint32(kDeviceTypeWifi);
+        return response;
+      }
+    } else if (method_call->GetInterface() ==
+               "org.freedesktop.NetworkManager.Device.Wireless" &&
+               method_call->GetMember() == "GetAccessPoints") {
+      // The list of access points is asked. Return the object path.
+      dbus::Response* response = dbus::Response::CreateEmpty();
+      dbus::MessageWriter writer(response);
+      std::vector<std::string> object_paths;
+      object_paths.push_back("/org/freedesktop/NetworkManager/AccessPoint/0");
+      writer.AppendArrayOfObjectPaths(object_paths);
+      return response;
+    }
+
+    LOG(ERROR) << "Unexpected method call: " << method_call->ToString();
+    return NULL;
+  }
+
+
+  // Creates a response for |mock_access_point_proxy_|.
+  dbus::Response* CreateAccessPointProxyResponse(dbus::MethodCall* method_call,
+                                                 Unused) {
+    if (method_call->GetInterface() == DBUS_INTERFACE_PROPERTIES &&
+        method_call->GetMember() == "Get") {
+      dbus::MessageReader reader(method_call);
+
+      std::string interface_name;
+      std::string property_name;
+      if (reader.PopString(&interface_name) &&
+          reader.PopString(&property_name)) {
+        dbus::Response* response = dbus::Response::CreateEmpty();
+        dbus::MessageWriter writer(response);
+
+        if (property_name == "Ssid") {
+          uint8 ssid[] = {0x74, 0x65, 0x73, 0x74};  // "test"

[stevenjb, 2011/08/24 23:32:04]

nit: Use consts for all of these, hear and below, so it is easier to maintain
them.

[satorux1, 2011/08/25 06:03:17]

Done. Most values are converted to some other format like "00:11:22:33:44:55" =>
"00-11-22-33-44-55", so I didn't try to share them with the test defined below. 

+          dbus::MessageWriter variant_writer(response);
+          writer.OpenVariant("ay", &variant_writer);
+          variant_writer.AppendArrayOfBytes(ssid, arraysize(ssid));
+          writer.CloseContainer(&variant_writer);
+        } else if (property_name == "HwAddress") {
+          // This will be converted to "00-11-22-33-44-55".
+          std::string mac_address = "00:11:22:33:44:55";
+          writer.AppendVariantOfString(mac_address);
+        } else if (property_name == "Strength") {
+          // This will be converted to -50.
+          writer.AppendVariantOfByte(100);
+        } else if (property_name == "Frequency") {
+          // This will be converted to channel 4.
+          writer.AppendVariantOfUint32(2427);
+        }
+        return response;
+      }
+    }
+
+    LOG(ERROR) << "Unexpected method call: " << method_call->ToString();
+    return NULL;
+  }
+};
+
+TEST_F(GeolocationWifiDataProviderLinuxTest, GetAccessPointData) {
+  WifiData::AccessPointDataSet access_point_data_set;
+  ASSERT_TRUE(wlan_api_->GetAccessPointData(&access_point_data_set));
+
+  ASSERT_EQ(1U, access_point_data_set.size());
+  AccessPointData access_point_data = *access_point_data_set.begin();
+
+  // Check the contents of the access point data.
+  // The expected values come from CreateAccessPointProxyResponse() above.
+  EXPECT_EQ("test", UTF16ToUTF8(access_point_data.ssid));
+  EXPECT_EQ("00-11-22-33-44-55", UTF16ToUTF8(access_point_data.mac_address));
+  EXPECT_EQ(-50, access_point_data.radio_signal_strength);
+  EXPECT_EQ(4, access_point_data.channel);
+}