chrome/browser/cocoa/browser_test_helper.h

// Copyright (c) 2009 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.

#ifndef CHROME_BROWSER_COCOA_BROWSER_TEST_HELPER_H_
#define CHROME_BROWSER_COCOA_BROWSER_TEST_HELPER_H_
#pragma once

#include "chrome/browser/browser_thread.h"
#include "chrome/browser/profile.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/test/testing_profile.h"

// Base class which contains a valid Browser*.  Lots of boilerplate to
// recycle between unit test classes.
//
// This class creates fake UI, file, and IO threads because many objects that
// are attached to the TestingProfile (and other objects) have traits that limit
// their destruction to certain threads. For example, the URLRequestContext can
// only be deleted on the IO thread; without this fake IO thread, the object
// would never be deleted and would report as a leak under Valgrind. Note that
// these are fake threads and they all share the same MessageLoop.
//
// TODO(jrg): move up a level (chrome/browser/cocoa -->
// chrome/browser), and use in non-Mac unit tests such as
// back_forward_menu_model_unittest.cc,
// navigation_controller_unittest.cc, ..
class BrowserTestHelper {
 public:
  BrowserTestHelper()
      : ui_thread_(BrowserThread::UI, &message_loop_),
        file_thread_(new BrowserThread(BrowserThread::FILE, &message_loop_)),
        io_thread_(new BrowserThread(BrowserThread::IO, &message_loop_)) {
    profile_.reset(new TestingProfile());
    profile_->CreateBookmarkModel(true);
    profile_->BlockUntilBookmarkModelLoaded();

    // TODO(shess): These are needed in case someone creates a browser
    // window off of browser_.  pkasting indicates that other
    // platforms use a stub |BrowserWindow| and thus don't need to do
    // this.
    // http://crbug.com/39725
    profile_->CreateAutocompleteClassifier();
    profile_->CreateTemplateURLModel();

    browser_.reset(new Browser(Browser::TYPE_NORMAL, profile_.get()));
  }

  virtual ~BrowserTestHelper() {
    // Delete the testing profile on the UI thread. But first release the
    // browser, since it may trigger accesses to the profile upon destruction.
    browser_.reset();

    // Drop any new tasks for the IO and FILE threads.
    io_thread_.reset();
    file_thread_.reset();

    message_loop_.DeleteSoon(FROM_HERE, profile_.release());
    message_loop_.RunAllPending();
  }

  virtual TestingProfile* profile() const { return profile_.get(); }
  Browser* browser() const { return browser_.get(); }

  // Creates the browser window. To close this window call |CloseBrowserWindow|.
  // Do NOT call close directly on the window.
  BrowserWindow* CreateBrowserWindow() {
    browser_->CreateBrowserWindow();
    return browser_->window();
  }

  // Closes the window for this browser. This must only be called after
  // CreateBrowserWindow().
  void CloseBrowserWindow() {
    // Check to make sure a window was actually created.
    DCHECK(browser_->window());
    browser_->CloseAllTabs();
    browser_->CloseWindow();
    // |browser_| will be deleted by its BrowserWindowController.
    ignore_result(browser_.release());
  }

 private:
  scoped_ptr<TestingProfile> profile_;
  scoped_ptr<Browser> browser_;
  MessageLoopForUI message_loop_;
  BrowserThread ui_thread_;
  scoped_ptr<BrowserThread> file_thread_;
  scoped_ptr<BrowserThread> io_thread_;
};

#endif  // CHROME_BROWSER_COCOA_BROWSER_TEST_HELPER_H_