chrome/test/base/javascript_browser_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 CHROME_TEST_BASE_JAVASCRIPT_BROWSER_TEST_H_
#define CHROME_TEST_BASE_JAVASCRIPT_BROWSER_TEST_H_

#include <vector>

#include "base/macros.h"
#include "base/strings/string16.h"
#include "base/values.h"
#include "chrome/test/base/in_process_browser_test.h"

// A base class providing construction of javascript testing assets.
class JavaScriptBrowserTest : public InProcessBrowserTest {
 public:
  static const base::FilePath::CharType kA11yAuditLibraryJSPath[];
  static const base::FilePath::CharType kChaiJSPath[];
  static const base::FilePath::CharType kMockJSPath[];
  static const base::FilePath::CharType kWebUILibraryJS[];
  static const base::FilePath::CharType kWebUITestFolder[];

  // Add a custom helper JS library for your test.
  // If a relative path is specified, it'll be read
  // as relative to the test data dir.
  void AddLibrary(const base::FilePath& library_path);

 protected:
  JavaScriptBrowserTest();

  ~JavaScriptBrowserTest() override;

  // InProcessBrowserTest overrides.
  void SetUpOnMainThread() override;

  // Builds a vector of strings of all added javascript libraries suitable for
  // execution by subclasses.
  void BuildJavascriptLibraries(std::vector<base::string16>* libraries);

  // Builds a string with a call to the runTest JS function, passing the
  // given |is_async|, |test_name| and its |args|.
  // This is then suitable for execution by subclasses in a
  // |RunJavaScriptBrowserTestF| call.
  base::string16 BuildRunTestJSCall(bool is_async,
                                    const std::string& test_name,
                                    std::vector<base::Value> args);

 private:
  // User added libraries.
  std::vector<base::FilePath> user_libraries_;

  // User library search paths.
  std::vector<base::FilePath> library_search_paths_;

  DISALLOW_COPY_AND_ASSIGN(JavaScriptBrowserTest);
};

#endif  // CHROME_TEST_BASE_JAVASCRIPT_BROWSER_TEST_H_