Implement a ReadyPromptContent that displays a prompt to accept, temporarily ...

chrome_frame/test/ready_mode_unittest.cc

+// Copyright (c) 2010 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 <atlbase.h>
+#include <atlapp.h>
+#include <atlmisc.h>
+#include <atlwin.h>
+
+#include "testing/gtest/include/gtest/gtest.h"
+#include "testing/gmock/include/gmock/gmock.h"
+
+#include "base/logging.h"
+#include "base/scoped_ptr.h"
+#include "base/win/registry.h"
+#include "chrome_frame/infobars/infobar_content.h"
+#include "chrome_frame/ready_mode/internal/installation_state.h"
+#include "chrome_frame/ready_mode/internal/ready_mode_state.h"
+#include "chrome_frame/ready_mode/internal/ready_prompt_content.h"
+#include "chrome_frame/ready_mode/internal/ready_prompt_window.h"
+#include "chrome_frame/ready_mode/internal/registry_ready_mode_state.h"
+#include "chrome_frame/ready_mode/ready_mode_manager.h"
+#include "chrome_frame/simple_resource_loader.h"
+#include "chrome_frame/test/chrome_frame_test_utils.h"
+
+namespace {
+
+class SetResourceInstance {
+ public:
+  SetResourceInstance() {
+    SimpleResourceLoader* loader_instance = SimpleResourceLoader::instance();
+    DCHECK(loader_instance != NULL);
+    res_dll_ = loader_instance->GetResourceModuleHandle();
+    old_res_dll_ = ATL::_AtlBaseModule.SetResourceInstance(res_dll_);
+  }
+
+  ~SetResourceInstance() {
+    DCHECK_EQ(res_dll_, ATL::_AtlBaseModule.SetResourceInstance(old_res_dll_));

[grt (UTC plus 2), 2010/12/11 03:12:06]

Should EXPECT_EQ be used here (and above) so that the test doesn't crash if the
world is out of whack?

[erikwright (departed), 2010/12/14 16:15:17]

If this fails, all later tests would potentially be out of whack: better to fail
hard. But the one above could fail without affecting other tests. Also, DCHECK
was a poor choice since it would've been a no-op in release.

+  }
+
+ private:
+  HMODULE res_dll_;
+  HMODULE old_res_dll_;
+};
+
+class SimpleWindow : public CWindowImpl<SimpleWindow,
+                                        CWindow,
+                                        CFrameWinTraits> {
+ public:
+  virtual ~SimpleWindow() {
+    if (IsWindow())
+      DestroyWindow();
+  }
+
+  static BOOL CALLBACK EnumChildProc(HWND hwnd, LPARAM l_param) {
+    HWND* out = reinterpret_cast<HWND*>(l_param);
+    EXPECT_TRUE(out != NULL);
+
+    if (out == NULL)
+      return FALSE;
+
+    EXPECT_TRUE(*out == NULL || ::IsChild(*out, hwnd));
+
+    if (*out == NULL)
+      *out = hwnd;
+
+    return TRUE;
+  }
+
+  HWND GetZeroOrOneChildWindows() {
+    HWND child = NULL;
+    EnumChildWindows(m_hWnd, EnumChildProc, reinterpret_cast<LPARAM>(&child));
+    return child;
+  }
+
+  BEGIN_MSG_MAP(SimpleWindow)
+  END_MSG_MAP()
+};
+
+class MockInfobarContentFrame : public InfobarContent::Frame {
+ public:
+  // InfobarContent::Frame implementation
+  MOCK_METHOD0(GetFrameWindow, HWND(void));
+  MOCK_METHOD0(CloseInfobar, void(void));
+};  // class Frame
+
+class MockReadyModeState : public ReadyModeState {
+ public:
+  // ReadyModeState implementation
+  MOCK_METHOD0(TemporarilyDeclineChromeFrame, void(void));
+  MOCK_METHOD0(PermanentlyDeclineChromeFrame, void(void));
+  MOCK_METHOD0(AcceptChromeFrame, void(void));
+};
+
+ACTION_P(ReturnPointee, pointer) {
+  return *pointer;
+}
+
+ACTION_P2(SetPointeeTo, pointer, value) {
+  *pointer = value;
+}
+
+class MockInstallationState : public InstallationState {
+ public:
+  // InstallationState implementation
+  MOCK_METHOD0(IsProductInstalled, bool(void));
+  MOCK_METHOD0(IsProductRegistered, bool(void));
+  MOCK_METHOD0(InstallProduct, bool(void));
+  MOCK_METHOD0(UnregisterProduct, bool(void));
+};  // MockInstallationState
+
+class MockRegistryReadyModeStateObserver
+    : public RegistryReadyModeState::Observer {
+ public:
+  // RegistryReadyModeState::Observer implementation
+  MOCK_METHOD0(OnStateChange, void(void));
+};  // class MockRegistryReadyModeStateObserver
+
+}  // namespace
+
+class ReadyPromptTest : public testing::Test {
+ public:
+  ReadyPromptTest() {
+    hwnd_ = window_.Create(NULL);
+    DCHECK(hwnd_ != NULL);
+    window_.ShowWindow(SW_SHOW);
+    DCHECK(window_.IsWindowVisible());
+    EXPECT_CALL(frame_, GetFrameWindow()).Times(testing::AnyNumber())
+        .WillRepeatedly(testing::Return(hwnd_));
+  }
+
+ protected:
+  SimpleWindow window_;
+  HWND hwnd_;
+  MockInfobarContentFrame frame_;
+  SetResourceInstance set_resource_instance_;
+};
+
+class ReadyPromptWindowTest : public ReadyPromptTest {
+ public:
+  ReadyPromptWindowTest() {
+    // owned by ReadyPromptWindow
+    state_ = new MockReadyModeState();
+    ready_prompt_window_ = (new ReadyPromptWindow())->Initialize(&frame_,
+                                                                 state_);
+  }
+
+  void SetUp() {
+    ReadyPromptTest::SetUp();
+
+    ASSERT_TRUE(ready_prompt_window_ != NULL);
+    RECT position = {0, 0, 800, 39};
+    ASSERT_TRUE(ready_prompt_window_->SetWindowPos(HWND_TOP, &position,
+                                                   SWP_SHOWWINDOW));
+  }
+
+ protected:
+  MockReadyModeState* state_;
+  base::WeakPtr<ReadyPromptWindow> ready_prompt_window_;
+};  // class ReadyPromptWindowTest
+
+class ReadyPromptWindowButtonTest : public ReadyPromptWindowTest {
+ public:
+  void TearDown() {
+    ASSERT_TRUE(ready_prompt_window_ != NULL);
+    ASSERT_TRUE(ready_prompt_window_->DestroyWindow());
+    ASSERT_TRUE(ready_prompt_window_ == NULL);
+    ASSERT_FALSE(message_loop_.WasTimedOut());
+
+    ReadyPromptWindowTest::TearDown();
+  }
+
+ protected:
+  struct ClickOnCaptionData {
+    const wchar_t* target_caption;
+    bool found;
+  };  // struct ClickOnCaptionData
+
+  static BOOL CALLBACK ClickOnCaptionProc(HWND hwnd, LPARAM l_param) {
+    wchar_t window_caption[256] = {0};
+    size_t buffer_length = arraysize(window_caption);
+
+    ClickOnCaptionData* data = reinterpret_cast<ClickOnCaptionData*>(l_param);
+    EXPECT_TRUE(data->target_caption != NULL);
+
+    if (data->target_caption == NULL)
+      return FALSE;
+
+    if (wcsnlen(data->target_caption, buffer_length + 1) == buffer_length + 1)
+      return FALSE;
+
+    if (::GetWindowText(hwnd, window_caption, buffer_length) ==
+        static_cast<int>(buffer_length)) {
+      return TRUE;
+    }
+
+    if (wcscmp(data->target_caption, window_caption) == 0) {
+      EXPECT_FALSE(data->found);
+
+      CRect client_rect;
+      EXPECT_TRUE(::GetClientRect(hwnd, client_rect));
+
+      CPoint center_point(client_rect.CenterPoint());
+      LPARAM coordinates = (center_point.y << 16) | center_point.x;
+
+      ::PostMessage(hwnd, WM_LBUTTONDOWN, 0, coordinates);
+      ::PostMessage(hwnd, WM_LBUTTONUP, 0, coordinates);
+
+      data->found = true;
+    }
+
+    return TRUE;
+  }
+
+  bool ClickOnCaption(const std::wstring& caption) {
+    ClickOnCaptionData data = {caption.c_str(), false};
+
+    ::EnumChildWindows(hwnd_, ClickOnCaptionProc,
+                       reinterpret_cast<LPARAM>(&data));
+    return data.found;
+  }
+
+  void RunUntilCloseInfobar() {
+    EXPECT_CALL(frame_, CloseInfobar()).WillOnce(QUIT_LOOP(message_loop_));
+    ASSERT_NO_FATAL_FAILURE(message_loop_.RunFor(5));  // seconds
+  }
+
+  chrome_frame_test::TimedMsgLoop message_loop_;
+};
+
+TEST_F(ReadyPromptTest, ReadyPromptContentTest) {
+  // owned by ReadyPromptContent
+  MockReadyModeState* state = new MockReadyModeState();
+  scoped_ptr<ReadyPromptContent> content_(new ReadyPromptContent(state));
+
+  content_->InstallInFrame(&frame_);
+
+  // Ensure that, if a child is created, it is not visible yet.
+  HWND child_hwnd = window_.GetZeroOrOneChildWindows();
+  if (child_hwnd != NULL) {
+    CWindow child(child_hwnd);
+    RECT child_dimensions;
+    EXPECT_TRUE(child.GetClientRect(&child_dimensions));
+    EXPECT_FALSE(child.IsWindowVisible() && !::IsRectEmpty(&child_dimensions));
+  }
+
+  int desired_height = content_->GetDesiredSize(400, 0);
+  EXPECT_GT(desired_height, 0);
+  RECT dimensions = {10, 15, 410, 20};
+  content_->SetDimensions(dimensions);
+
+  child_hwnd = window_.GetZeroOrOneChildWindows();
+  EXPECT_TRUE(child_hwnd != NULL);
+
+  if (child_hwnd != NULL) {
+    CWindow child(child_hwnd);
+    EXPECT_TRUE(child.IsWindowVisible());
+    RECT child_dimensions;
+    EXPECT_TRUE(child.GetWindowRect(&child_dimensions));
+    EXPECT_TRUE(window_.ScreenToClient(&child_dimensions));
+    EXPECT_TRUE(::EqualRect(&child_dimensions, &dimensions));
+  }
+
+  // Being visible doesn't change the desired height
+  EXPECT_EQ(desired_height, content_->GetDesiredSize(400, 0));
+
+  content_.reset();
+
+  EXPECT_TRUE(window_.GetZeroOrOneChildWindows() == NULL);
+}
+
+TEST_F(ReadyPromptWindowTest, Destroy) {
+  // Should delete associated mocks, not invoke on ReadyModeState
+  ready_prompt_window_->DestroyWindow();
+}
+
+TEST_F(ReadyPromptWindowButtonTest, ClickYes) {
+  EXPECT_CALL(*state_, AcceptChromeFrame());
+  ASSERT_TRUE(ClickOnCaption(L"&Yes"));
+  RunUntilCloseInfobar();
+}
+
+TEST_F(ReadyPromptWindowButtonTest, ClickRemindMeLater) {
+  EXPECT_CALL(*state_, TemporarilyDeclineChromeFrame());
+  ASSERT_TRUE(ClickOnCaption(L"Remind me &Later"));
+  RunUntilCloseInfobar();
+}
+
+TEST_F(ReadyPromptWindowButtonTest, ClickNo) {
+  EXPECT_CALL(*state_, PermanentlyDeclineChromeFrame());
+  ASSERT_TRUE(ClickOnCaption(L"&No"));
+  RunUntilCloseInfobar();
+}
+
+class ReadyModeRegistryTest : public testing::Test {
+ public:
+  class TimeControlledRegistryReadyModeState : public RegistryReadyModeState {
+   public:
+    TimeControlledRegistryReadyModeState(
+        const std::wstring& key_name,
+        base::TimeDelta temporary_decline_duration,
+        InstallationState* installation_state,
+        Observer* observer)
+        : RegistryReadyModeState(key_name, temporary_decline_duration,
+                                 installation_state, observer),
+          now_(base::Time::Now()) {
+    }
+
+    base::Time now_;
+
+   protected:
+    virtual base::Time GetNow() {
+      return now_;
+    }
+  };  // class TimeControlledRegistryReadyModeState
+
+  ReadyModeRegistryTest()
+      : is_product_registered_(true),
+        is_product_installed_(false),
+        observer_(NULL),
+        installation_state_(NULL) {
+  }
+
+  virtual void SetUp() {
+    base::win::RegKey key;
+    ASSERT_TRUE(key.Create(HKEY_CURRENT_USER, kRootKey, KEY_ALL_ACCESS));
+    observer_ = new MockRegistryReadyModeStateObserver();
+    installation_state_ = new MockInstallationState();
+
+    EXPECT_CALL(*installation_state_, IsProductRegistered())
+        .Times(testing::AnyNumber())
+        .WillRepeatedly(ReturnPointee(&is_product_registered_));
+    EXPECT_CALL(*installation_state_, IsProductInstalled())
+        .Times(testing::AnyNumber())
+        .WillRepeatedly(ReturnPointee(&is_product_installed_));
+
+    ready_mode_state_.reset(new TimeControlledRegistryReadyModeState(
+      kRootKey,
+      base::TimeDelta::FromSeconds(kTemporaryDeclineDurationInSeconds),
+      installation_state_,
+      observer_));
+  }
+
+  virtual void TearDown() {
+    base::win::RegKey key;
+    EXPECT_TRUE(key.Open(HKEY_CURRENT_USER, L"", KEY_ALL_ACCESS));
+    EXPECT_TRUE(key.DeleteKey(kRootKey));
+  }
+
+ protected:
+  void AdjustClockBySeconds(int seconds) {
+    ready_mode_state_->now_ += base::TimeDelta::FromSeconds(seconds);
+  }
+
+  void ExpectUnregisterProductAndReturn(bool success) {
+    EXPECT_CALL(*installation_state_, UnregisterProduct())
+        .WillOnce(testing::DoAll(
+            SetPointeeTo(&is_product_registered_, !success),
+            testing::Return(success)));
+  }
+
+  void ExpectInstallProductAndReturn(bool success) {
+    EXPECT_CALL(*installation_state_, InstallProduct())
+        .WillOnce(testing::DoAll(SetPointeeTo(&is_product_installed_, success),
+                                 testing::Return(success)));
+  }
+
+  bool is_product_registered_;
+  bool is_product_installed_;
+  MockInstallationState* installation_state_;
+  MockRegistryReadyModeStateObserver* observer_;
+
+  scoped_ptr<TimeControlledRegistryReadyModeState> ready_mode_state_;
+  base::win::RegKey config_key;
+  static const wchar_t kRootKey[];
+  static const int kTemporaryDeclineDurationInSeconds;
+};
+
+const int ReadyModeRegistryTest::kTemporaryDeclineDurationInSeconds = 2;
+const wchar_t ReadyModeRegistryTest::kRootKey[]  = L"chrome_frame_unittests";
+
+TEST_F(ReadyModeRegistryTest, CallNothing) {
+  // expect it to delete the two mocks... Google Mock fails if they are leaked.
+}
+
+TEST_F(ReadyModeRegistryTest, NotInstalledStatus) {
+  ASSERT_EQ(READY_MODE_ACTIVE, ready_mode_state_->GetStatus());
+}
+
+TEST_F(ReadyModeRegistryTest, NotRegisteredStatus) {
+  is_product_registered_ = false;
+  ASSERT_EQ(READY_MODE_PERMANENTLY_DECLINED, ready_mode_state_->GetStatus());
+}
+
+TEST_F(ReadyModeRegistryTest, InstalledStatus) {
+  is_product_installed_ = true;
+  ASSERT_EQ(READY_MODE_ACCEPTED, ready_mode_state_->GetStatus());
+}
+
+TEST_F(ReadyModeRegistryTest, TemporarilyDeclineChromeFrame) {
+  ASSERT_EQ(READY_MODE_ACTIVE, ready_mode_state_->GetStatus());
+
+  EXPECT_CALL(*observer_, OnStateChange());
+  ready_mode_state_->TemporarilyDeclineChromeFrame();
+
+  ASSERT_EQ(READY_MODE_TEMPORARILY_DECLINED, ready_mode_state_->GetStatus());
+
+  AdjustClockBySeconds(kTemporaryDeclineDurationInSeconds + 1);
+  ASSERT_EQ(READY_MODE_ACTIVE, ready_mode_state_->GetStatus());
+}
+
+TEST_F(ReadyModeRegistryTest, TemporarilyDeclineChromeFrameSetClockBack) {
+  ASSERT_EQ(READY_MODE_ACTIVE, ready_mode_state_->GetStatus());
+
+  EXPECT_CALL(*observer_, OnStateChange());
+  ready_mode_state_->TemporarilyDeclineChromeFrame();
+
+  ASSERT_EQ(READY_MODE_TEMPORARILY_DECLINED, ready_mode_state_->GetStatus());
+
+  AdjustClockBySeconds(kTemporaryDeclineDurationInSeconds + 1);
+  ASSERT_EQ(READY_MODE_ACTIVE, ready_mode_state_->GetStatus());
+}
+
+TEST_F(ReadyModeRegistryTest, PermanentlyDeclineChromeFrame) {
+  ASSERT_EQ(READY_MODE_ACTIVE, ready_mode_state_->GetStatus());
+
+  EXPECT_CALL(*observer_, OnStateChange());
+  ExpectUnregisterProductAndReturn(true);
+  ready_mode_state_->PermanentlyDeclineChromeFrame();
+
+  ASSERT_EQ(READY_MODE_PERMANENTLY_DECLINED, ready_mode_state_->GetStatus());
+}
+
+TEST_F(ReadyModeRegistryTest, PermanentlyDeclineChromeFrameFailUnregister) {
+  ASSERT_EQ(READY_MODE_ACTIVE, ready_mode_state_->GetStatus());
+
+  EXPECT_CALL(*observer_, OnStateChange());
+  ExpectUnregisterProductAndReturn(false);
+  ready_mode_state_->PermanentlyDeclineChromeFrame();
+
+  ASSERT_EQ(READY_MODE_PERMANENTLY_DECLINED, ready_mode_state_->GetStatus());
+}
+
+TEST_F(ReadyModeRegistryTest, AcceptChromeFrame) {
+  ASSERT_EQ(READY_MODE_ACTIVE, ready_mode_state_->GetStatus());
+
+  EXPECT_CALL(*observer_, OnStateChange());
+  ExpectInstallProductAndReturn(true);
+  ready_mode_state_->AcceptChromeFrame();
+
+  ASSERT_EQ(READY_MODE_ACCEPTED, ready_mode_state_->GetStatus());
+}
+
+// TODO(erikwright): What do we actually want to happen if the install fails?
+// Stay in Ready Mode? Attempt to unregister (deactivate ready mode)?
+//
+// Which component is responsible for messaging the user? The installer? The
+// InstallationState implementation? The ReadyModeState implementation?
+TEST_F(ReadyModeRegistryTest, AcceptChromeFrameInstallFails) {
+  ASSERT_EQ(READY_MODE_ACTIVE, ready_mode_state_->GetStatus());
+
+  ExpectInstallProductAndReturn(false);
+  ready_mode_state_->AcceptChromeFrame();
+
+  ASSERT_EQ(READY_MODE_ACTIVE, ready_mode_state_->GetStatus());
+}