chrome/browser/pdf/pdf_extension_test_base.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_PDF_PDF_EXTENSION_TEST_BASE_H_
#define CHROME_BROWSER_PDF_PDF_EXTENSION_TEST_BASE_H_

#include <memory>
#include <string>
#include <vector>

#include "base/test/scoped_feature_list.h"
#include "chrome/browser/extensions/extension_apitest.h"
#include "chrome/browser/pdf/test_pdf_viewer_stream_manager.h"
#include "components/guest_view/browser/test_guest_view_manager.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/abseil-cpp/absl/types/variant.h"
#include "third_party/blink/public/common/input/web_mouse_event.h"

class GURL;

namespace content {
class BrowserContext;
class RenderFrameHost;
class WebContents;
}  // namespace content

namespace extensions {
class MimeHandlerViewGuest;
}

namespace gfx {
class Point;
}

class PDFExtensionTestBase : public extensions::ExtensionApiTest {
 public:
  PDFExtensionTestBase();

  ~PDFExtensionTestBase() override;

  // extensions::ExtensionApiTest:
  void SetUpCommandLine(base::CommandLine* command_line) override;
  void SetUpOnMainThread() override;
  void TearDownOnMainThread() override;
  base::FilePath GetTestResourcesParentDir() override;

  bool PdfIsExpectedToLoad(const std::string& pdf_file);

  // Load the PDF at the given URL and ensure it has finished loading. Return
  // true if it loads successfully or false if it fails. If it doesn't finish
  // loading the test will hang. This is done from outside of the BrowserPlugin
  // guest to ensure sending messages to/from the plugin works correctly from
  // there, since the PdfScriptingApi relies on doing this as well.
  testing::AssertionResult LoadPdf(const GURL& url);

  // Same as LoadPDF(), but loads into a new tab.
  testing::AssertionResult LoadPdfInNewTab(const GURL& url);

  // Same as LoadPdf(), but also returns a pointer to the `MimeHandlerViewGuest`
  // for the loaded PDF. Returns nullptr if the load fails.
  extensions::MimeHandlerViewGuest* LoadPdfGetMimeHandlerView(const GURL& url);

  // Same as LoadPdf(), but also returns a pointer to the `MimeHandlerViewGuest`
  // for the loaded PDF in a new tab. Returns nullptr if the load fails.
  extensions::MimeHandlerViewGuest* LoadPdfInNewTabGetMimeHandlerView(
      const GURL& url);

  void TestGetSelectedTextReply(const GURL& url, bool expect_success);

  content::WebContents* GetActiveWebContents();

  // For OOPIF PDF viewer, returns the active `WebContents`, as there is only a
  // single `WebContents`. For GuestView PDF viewer, returns the embedder
  // `WebContents`.
  content::WebContents* GetEmbedderWebContents();

 protected:
  guest_view::TestGuestViewManager* GetGuestViewManager(
      content::BrowserContext* profile = nullptr);

  pdf::TestPdfViewerStreamManager* GetTestPdfViewerStreamManager(
      content::WebContents* contents);

  void CreateTestPdfViewerStreamManager();

  content::RenderFrameHost* GetPluginFrame(
      extensions::MimeHandlerViewGuest* guest) const;

  int CountPDFProcesses();

  // TODO(crbug.com/1445746): Remove this once there are no more existing use
  // cases.
  void SimulateMouseClickAt(extensions::MimeHandlerViewGuest* guest,
                            int modifiers,
                            blink::WebMouseEvent::Button button,
                            const gfx::Point& point_in_guest);

  void SimulateMouseClickAt(content::RenderFrameHost* extension_host,
                            content::WebContents* contents,
                            int modifiers,
                            blink::WebMouseEvent::Button button,
                            const gfx::Point& point_in_extension);

  // Returns true if the test should use the OOPIF PDF viewer instead of the
  // GuestView PDF viewer.
  // TODO(crbug.com/1445746): Remove once only OOPIF PDF viewer is used.
  virtual bool UseOopif() const;

  // Hooks to set up feature flags.
  virtual std::vector<base::test::FeatureRef> GetEnabledFeatures() const;
  virtual std::vector<base::test::FeatureRef> GetDisabledFeatures() const;

 private:
  // Check if the PDF loaded. The test will fail if the frame tree does not have
  // exactly one PDF extension host and one PDF content host. For GuestView PDF
  // viewer, the test will also fail if there is not exactly one GuestView.
  testing::AssertionResult EnsurePDFHasLoadedWithValidFrameTree();

  base::test::ScopedFeatureList feature_list_;
  absl::variant<absl::monostate,
                std::unique_ptr<guest_view::TestGuestViewManagerFactory>,
                std::unique_ptr<pdf::TestPdfViewerStreamManagerFactory>>
      factory_;
};

#endif  // CHROME_BROWSER_PDF_PDF_EXTENSION_TEST_BASE_H_