CrOS Tether: Create HostScanScheduler, which schedules scans for devices which can serve as tether …

chromeos/components/tether/host_scan_scheduler_unittest.cc

+// Copyright 2014 The Chromium Authors. All rights reserved.

[Tim Song, 2016/12/17 05:13:41]

2016

+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "chromeos/components/tether/host_scan_scheduler.h"
+
+#include "base/memory/ptr_util.h"
+#include "chromeos/components/tether/host_scanner.h"
+#include "chromeos/dbus/power_manager_client.h"
+#include "chromeos/login/login_state.h"
+#include "chromeos/network/network_handler.h"
+#include "chromeos/network/network_state.h"
+#include "chromeos/network/network_state_handler.h"
+#include "components/cryptauth/cryptauth_device_manager.h"
+#include "testing/gmock/include/gmock/gmock.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace chromeos {
+
+namespace tether {
+
+namespace {}  // namespace
+
+class HostScanSchedulerTest : public testing::Test {
+ protected:
+  class TestContext : public HostScanScheduler::Context {
+   public:
+    TestContext(HostScanSchedulerTest* test)
+        : test_(test),
+          observer_(nullptr),
+          is_authenticated_user_logged_in(true),
+          is_network_connected_or_connecting(false),
+          are_tether_hosts_synced(true) {}
+
+    void AddObserver(HostScanScheduler* host_scan_scheduler) override {
+      observer_ = host_scan_scheduler;
+    }
+
+    void RemoveObserver(HostScanScheduler* host_scan_scheduler) override {
+      if (observer_ == host_scan_scheduler) {
+        observer_ = nullptr;
+      }
+      EXPECT_FALSE(IsObserverSet());
+    }
+
+    bool IsAuthenticatedUserLoggedIn() const override {
+      return is_authenticated_user_logged_in;
+    }
+
+    bool IsNetworkConnectedOrConnecting() const override {
+      return is_network_connected_or_connecting;
+    }
+
+    bool AreTetherHostsSynced() const override {
+      return are_tether_hosts_synced;
+    }
+
+    bool IsObserverSet() const {
+      return observer_ != nullptr &&
+             observer_ == test_->host_scan_scheduler_.get();

[Tim Song, 2016/12/17 05:13:41]

Assert this condition instead.

[Kyle Horimoto, 2016/12/19 21:10:47]

This function is called in both EXPECT_FALSE() and EXPECT_TRUE(), so I'm leaving
as-is.

+    }
+
+    void SetIsAuthenticatedUserLoggedIn(bool value) {
+      is_authenticated_user_logged_in = value;
+    }
+
+    void SetIsNetworkConnectedOrConnecting(bool value) {
+      is_network_connected_or_connecting = value;
+    }
+
+    void AreTetherHostsSynced(bool value) { are_tether_hosts_synced = value; }

[Tim Song, 2016/12/17 05:13:41]

rename to set_are_thether_hosts_synced()

[Kyle Horimoto, 2016/12/19 21:10:47]

Done.

+
+   private:
+    const HostScanSchedulerTest* test_;
+
+    HostScanScheduler* observer_;
+    bool is_authenticated_user_logged_in;
+    bool is_network_connected_or_connecting;
+    bool are_tether_hosts_synced;
+  };
+
+  class MockHostScanner : public HostScanner {

[Tim Song, 2016/12/17 05:13:41]

This should be FakeHostScanner, as there are no mock functions.

[Kyle Horimoto, 2016/12/19 21:10:47]

Done.

+   public:
+    MockHostScanner() : num_scans_started_(0) {}
+    ~MockHostScanner() override {}
+
+    void StartScan() override { num_scans_started_++; }
+
+    int num_scans_started() { return num_scans_started_; }
+
+   private:
+    int num_scans_started_;
+  };
+
+  HostScanSchedulerTest() {}
+
+  void SetUp() override {
+    test_context_ = new TestContext(this);
+    mock_host_scanner_ = new MockHostScanner();
+
+    host_scan_scheduler_.reset(new HostScanScheduler(
+        base::WrapUnique(test_context_), base::WrapUnique(mock_host_scanner_)));
+
+    EXPECT_FALSE(test_context_->IsObserverSet());
+    host_scan_scheduler_->InitializeAutomaticScans();
+    EXPECT_TRUE(test_context_->IsObserverSet());
+  }
+
+  void TearDown() override {
+    EXPECT_TRUE(test_context_->IsObserverSet());
+    host_scan_scheduler_.reset();
+  }
+
+  void TestScheduleScanNowIfPossible(bool is_authenticated_user_logged_in,
+                                     bool is_network_connected_or_connecting,
+                                     bool are_tether_hosts_synced,
+                                     int num_expected_scans) {
+    test_context_->SetIsAuthenticatedUserLoggedIn(
+        is_authenticated_user_logged_in);
+    test_context_->SetIsNetworkConnectedOrConnecting(
+        is_network_connected_or_connecting);
+    test_context_->AreTetherHostsSynced(are_tether_hosts_synced);
+    host_scan_scheduler_->ScheduleScanNowIfPossible();
+    EXPECT_EQ(num_expected_scans, mock_host_scanner_->num_scans_started());
+  }
+
+  std::unique_ptr<HostScanScheduler> host_scan_scheduler_;
+
+  TestContext* test_context_;
+  MockHostScanner* mock_host_scanner_;
+};
+
+TEST_F(HostScanSchedulerTest, TestObserverAddedAndRemoved) {
+  // Intentionally empty. This test just ensures that adding/removing observers
+  // (in setUp() and tearDown()) works.
+}
+
+TEST_F(HostScanSchedulerTest, TestScheduleScanNowIfPossible) {
+  EXPECT_EQ(0, mock_host_scanner_->num_scans_started());
+
+  // A scan should only be started when an authenticated user is logged in,
+  // the network is not connected/connecting, and tether hosts are synced.
+  TestScheduleScanNowIfPossible(false, false, false, 0);
+  TestScheduleScanNowIfPossible(true, false, false, 0);
+  TestScheduleScanNowIfPossible(false, true, false, 0);
+  TestScheduleScanNowIfPossible(false, false, true, 0);
+  TestScheduleScanNowIfPossible(true, true, false, 0);
+  TestScheduleScanNowIfPossible(true, false, true, 1);
+  TestScheduleScanNowIfPossible(false, true, true, 1);
+  TestScheduleScanNowIfPossible(true, true, true, 1);
+}
+
+TEST_F(HostScanSchedulerTest, TestLoggedInStateChange) {
+  EXPECT_EQ(0, mock_host_scanner_->num_scans_started());
+
+  test_context_->SetIsAuthenticatedUserLoggedIn(true);
+  test_context_->SetIsNetworkConnectedOrConnecting(false);
+  test_context_->AreTetherHostsSynced(true);

[Tim Song, 2016/12/17 05:13:41]

Maybe initialize |test_context_| to these values in setUp()? I noticed it's
duplicated a few times in these tests.

+
+  host_scan_scheduler_->LoggedInStateChanged();
+  EXPECT_EQ(1, mock_host_scanner_->num_scans_started());
+
+  // Change a condition so that it should not scan, and re-trigger; there should
+  // still be only 1 started scan.
+  test_context_->SetIsAuthenticatedUserLoggedIn(false);
+  host_scan_scheduler_->LoggedInStateChanged();
+  EXPECT_EQ(1, mock_host_scanner_->num_scans_started());
+}
+
+TEST_F(HostScanSchedulerTest, TestSuspendDone) {
+  EXPECT_EQ(0, mock_host_scanner_->num_scans_started());
+
+  test_context_->SetIsAuthenticatedUserLoggedIn(true);
+  test_context_->SetIsNetworkConnectedOrConnecting(false);
+  test_context_->AreTetherHostsSynced(true);
+
+  host_scan_scheduler_->SuspendDone(base::TimeDelta::FromSeconds(1));
+  EXPECT_EQ(1, mock_host_scanner_->num_scans_started());
+
+  // Change a condition so that it should not scan, and re-trigger; there should
+  // still be only 1 started scan.
+  test_context_->SetIsAuthenticatedUserLoggedIn(false);
+  host_scan_scheduler_->SuspendDone(base::TimeDelta::FromSeconds(1));
+  EXPECT_EQ(1, mock_host_scanner_->num_scans_started());
+}
+
+TEST_F(HostScanSchedulerTest, TestNetworkConnectionStateChanged) {
+  EXPECT_EQ(0, mock_host_scanner_->num_scans_started());
+
+  test_context_->SetIsAuthenticatedUserLoggedIn(true);
+  test_context_->SetIsNetworkConnectedOrConnecting(false);
+  test_context_->AreTetherHostsSynced(true);
+
+  host_scan_scheduler_->NetworkConnectionStateChanged(nullptr);
+  EXPECT_EQ(1, mock_host_scanner_->num_scans_started());
+
+  // Change a condition so that it should not scan, and re-trigger; there should
+  // still be only 1 started scan.
+  test_context_->SetIsNetworkConnectedOrConnecting(true);
+  host_scan_scheduler_->NetworkConnectionStateChanged(nullptr);
+  EXPECT_EQ(1, mock_host_scanner_->num_scans_started());
+}
+
+TEST_F(HostScanSchedulerTest, TestOnSyncFinished) {
+  EXPECT_EQ(0, mock_host_scanner_->num_scans_started());
+
+  test_context_->SetIsAuthenticatedUserLoggedIn(true);
+  test_context_->SetIsNetworkConnectedOrConnecting(false);
+  test_context_->AreTetherHostsSynced(true);
+
+  host_scan_scheduler_->OnSyncFinished(
+      cryptauth::CryptAuthDeviceManager::SyncResult::SUCCESS,
+      cryptauth::CryptAuthDeviceManager::DeviceChangeResult::CHANGED);
+  EXPECT_EQ(1, mock_host_scanner_->num_scans_started());
+
+  // Change a condition so that it should not scan, and re-trigger; there should
+  // still be only 1 started scan.
+  test_context_->AreTetherHostsSynced(false);
+  host_scan_scheduler_->OnSyncFinished(
+      cryptauth::CryptAuthDeviceManager::SyncResult::SUCCESS,
+      cryptauth::CryptAuthDeviceManager::DeviceChangeResult::UNCHANGED);
+  EXPECT_EQ(1, mock_host_scanner_->num_scans_started());
+}
+
+}  // namespace tether
+
+}  // namespace chromeos