chrome/browser/headless/headless_mode_protocol_browsertest.h

// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_HEADLESS_HEADLESS_MODE_PROTOCOL_BROWSERTEST_H_
#define CHROME_BROWSER_HEADLESS_HEADLESS_MODE_PROTOCOL_BROWSERTEST_H_

#include <string>
#include <string_view>

#include "base/command_line.h"
#include "base/values.h"
#include "chrome/browser/headless/headless_mode_devtooled_browsertest.h"

namespace headless {

class HeadlessModeProtocolBrowserTest
    : public HeadlessModeDevTooledBrowserTest {
 public:
  HeadlessModeProtocolBrowserTest();
  ~HeadlessModeProtocolBrowserTest() override;

 protected:
  void SetUpCommandLine(base::CommandLine* command_line) override;

  void RunTestScript(std::string_view script_name);

  // Implement this for tests that need to pass extra parameters to
  // JavaScript code.
  virtual base::Value::Dict GetPageUrlExtraParams();

  // HeadlessModeDevTooledBrowserTest overrides.
  void RunDevTooledTest() override;

 private:
  void OnLoadEventFired(const base::Value::Dict& params);
  void OnEvaluateResult(base::Value::Dict params);
  void OnConsoleAPICalled(const base::Value::Dict& params);

  void ProcessTestResult(const std::string& test_result);

 protected:
  void AppendCommandLineExtras(base::CommandLine* command_line,
                               std::string_view extras);
  std::string test_folder_;
  std::string script_name_;
};

#define HEADLESS_MODE_PROTOCOL_TEST(TEST_NAME, SCRIPT_NAME)            \
  IN_PROC_BROWSER_TEST_F(HeadlessModeProtocolBrowserTest, TEST_NAME) { \
    RunTestScript(SCRIPT_NAME);                                        \
  }

#define HEADLESS_MODE_PROTOCOL_TEST_F(TEST_FIXTURE, TEST_NAME, SCRIPT_NAME) \
  IN_PROC_BROWSER_TEST_F(TEST_FIXTURE, TEST_NAME) {                         \
    RunTestScript(SCRIPT_NAME);                                             \
  }

#define HEADLESS_MODE_PROTOCOL_TEST_WITH_COMMAND_LINE_EXTRAS(            \
    TEST_NAME, SCRIPT_NAME, COMMAND_LINE_EXTRAS)                         \
                                                                         \
  class HeadlessModeProtocolBrowserTestWithCommandLineExtras_##TEST_NAME \
      : public HeadlessModeProtocolBrowserTest {                         \
   public:                                                               \
    void SetUpCommandLine(base::CommandLine* command_line) override {    \
      HeadlessModeProtocolBrowserTest::SetUpCommandLine(command_line);   \
      AppendCommandLineExtras(command_line, COMMAND_LINE_EXTRAS);        \
    }                                                                    \
  };                                                                     \
                                                                         \
  IN_PROC_BROWSER_TEST_F(                                                \
      HeadlessModeProtocolBrowserTestWithCommandLineExtras_##TEST_NAME,  \
      TEST_NAME) {                                                       \
    RunTestScript(SCRIPT_NAME);                                          \
  }

}  // namespace headless

#endif  // CHROME_BROWSER_HEADLESS_HEADLESS_MODE_PROTOCOL_BROWSERTEST_H_