ios/web/test/web_test.h

// Copyright 2014 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 IOS_WEB_TEST_WEB_TEST_H_
#define IOS_WEB_TEST_WEB_TEST_H_

#import <UIKit/UIKit.h>

#import "base/mac/scoped_nsobject.h"
#include "base/message_loop/message_loop.h"
#include "ios/web/public/test/test_browser_state.h"
#import "ios/web/public/test/test_web_client.h"
#include "ios/web/public/test/test_web_thread_bundle.h"
#include "ios/web/public/web_client.h"
#import "ios/web/web_state/ui/crw_ui_web_view_web_controller.h"
#include "testing/platform_test.h"

// A subclass of WebController overridden for testing purposes.  Specifically it
// overrides the UIWebView delegate method to intercept requests coming from
// core.js.
// TODO(jimblackler): remove use of TestWebController entirely.
@interface TestWebController : CRWUIWebViewWebController

@property(nonatomic, assign) BOOL interceptRequest;
@property(nonatomic, assign) BOOL requestIntercepted;
@property(nonatomic, assign) BOOL
    invokeShouldStartLoadWithRequestNavigationTypeDone;

@end

namespace web {

// A test fixture for web tests that need a minimum environment set up that
// mimics a web embedder.
class WebTest : public PlatformTest {
 protected:
  WebTest();
  ~WebTest() override;

  // PlatformTest methods.
  void SetUp() override;
  void TearDown() override;

  // Returns the WebClient that is used for testing.
  TestWebClient* GetWebClient() { return &client_; }

  // Returns the BrowserState that is used for testing.
  BrowserState* GetBrowserState() { return &browser_state_; }

 private:
  // The WebClient used in tests.
  TestWebClient client_;
  // The threads used for testing.
  web::TestWebThreadBundle thread_bundle_;
  // The browser state used in tests.
  TestBrowserState browser_state_;
};

#pragma mark -

// An abstract test fixture that sets up a WebControllers that can be loaded
// with test HTML and JavaScripts. Concrete subclasses override
// |CreateWebController| specifying the test WebController object.
// DEPRECATED. Please use either WebTest or WebTestWithWebController instead.
// TODO(shreyasv): Remove this after all clients have stopped using it.
// crbug.com/512910.
class WebTestBase : public WebTest, public base::MessageLoop::TaskObserver {
 public:
  ~WebTestBase() override;

 protected:
  WebTestBase();
  void SetUp() override;
  void TearDown() override;
  // Loads the specified HTML content into the WebController via public APIs.
  void LoadHtml(NSString* html);
  // Loads the specified HTML content into the WebController via public APIs.
  void LoadHtml(const std::string& html);
  // Loads |url| into the WebController via public APIs.
  // Note if anyone uses this to load web pages from the live internet, the
  // tests can be flaky / dependent on content and behavior beyond our control.
  // Use this only when it's impossible to test with static HTML using LoadHtml.
  void LoadURL(const GURL& url);
  // Blocks until both known NSRunLoop-based and known message-loop-based
  // background tasks have completed
  void WaitForBackgroundTasks();
  // Blocks until known NSRunLoop-based have completed, known message-loop-based
  // background tasks have completed and |condition| evaluates to true.
  void WaitForCondition(ConditionBlock condition);
  // Returns true if WebController message queue is empty.
  // |WaitForBackgroundTasks| does not return until until the message queue is
  // empty.
  bool MessageQueueIsEmpty() const;
  // Evaluates JavaScript and returns result as a string.
  NSString* EvaluateJavaScriptAsString(NSString* script) const;
  // Runs the given JavaScript and returns the result as a string. This method
  // is a drop-in replacement for stringByEvaluatingJavaScriptFromString with
  // the additional functionality that any JavaScript exceptions are caught and
  // logged (not dropped silently).
  NSString* RunJavaScript(NSString* script);
  // Returns a CRWWebController to be used in tests.
  virtual CRWWebController* CreateWebController() = 0;
  // TaskObserver methods (used when waiting for background tasks).
  void WillProcessTask(const base::PendingTask& pending_task) override;
  void DidProcessTask(const base::PendingTask& pending_task) override;

  // The web controller for testing.
  base::scoped_nsobject<CRWWebController> webController_;
  // true if a task has been processed.
  bool processed_a_task_;
};

#pragma mark -

// A test fixture that sets up a WebControllers that can be loaded with test
// HTML and JavaScripts. Concrete subclasses override |CreateWebController|
// specifying the test WebController object.
typedef WebTestBase WebTestWithWebController;

#pragma mark -

// A test fixtures thats creates a CRWUIWebViewWebController for testing.
// DEPRECATED. Please use WebTestWithUIWebViewWebController instead.
// TODO(shreyasv): Remove this once all clients have moved over.
// crbug.com/512910.
class UIWebViewWebTest : public WebTestWithWebController {
 protected:
  // WebTestWithWebController methods.
  CRWWebController* CreateWebController() override;

  // Invokes JS->ObjC messages directly on the web controller, registering a
  // human interaction if userIsInteraction==YES. |commands| should be a
  // stringified message queue.
  void LoadCommands(NSString* commands,
                    const GURL& origin_url,
                    BOOL user_is_interacting);
};

#pragma mark -

// A test fixtures thats creates a CRWUIWebViewWebController for testing.
typedef UIWebViewWebTest WebTestWithUIWebViewWebController;

#pragma mark -

// A test fixtures thats creates a CRWWKWebViewWebController for testing.
// DEPRECATED. Please use WebTestWithWKWebViewWebController instead.
// TODO(shreyasv): Remove this once all clients have moved over.
// crbug.com/512910.
class WKWebViewWebTest : public WebTestWithWebController {
 protected:
  // WebTestWithWebController methods.
  CRWWebController* CreateWebController() override;
};

#pragma mark -

// A test fixtures thats creates a CRWWKWebViewWebController for testing.
typedef WKWebViewWebTest WebTestWithWKWebViewWebController;

}  // namespace web

#endif // IOS_WEB_TEST_WEB_TEST_H_