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

#ifndef PDF_TEST_TEST_HELPERS_H_
#define PDF_TEST_TEST_HELPERS_H_

#include <string_view>

#include "base/containers/span.h"
#include "base/files/file_path.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/blink/public/web/web_print_params.h"
#include "third_party/skia/include/core/SkColor.h"
#include "third_party/skia/include/core/SkRefCnt.h"
#include "ui/gfx/geometry/rect_f.h"
#include "ui/gfx/geometry/size_f.h"
#include "v8/include/v8-forward.h"

class SkBitmap;
class SkImage;
class SkSurface;

namespace base::test {
class TaskEnvironment;
}  // namespace base::test

namespace gfx {
class Size;
}  // namespace gfx

namespace chrome_pdf {

// blink::WebPrintParams takes values in CSS pixels, not points.
inline constexpr gfx::SizeF kUSLetterSize = {816, 1056};
inline constexpr gfx::RectF kUSLetterRect = {{0, 0}, kUSLetterSize};
inline constexpr gfx::RectF kPrintableAreaRect = {{24, 24}, {768, 977.33333}};

// Resolves a file path within //pdf/test/data. `path` must be relative. Returns
// the empty path if the source root can't be found.
base::FilePath GetTestDataFilePath(const base::FilePath& path);

// Gets a file path that includes a platform-identifying suffix in its file
// name. If `filename` has an extension, then the suffix is inserted right
// before that. Since expectation files are typically generated on Linux, no
// suffix is generated for that platform.  A suffix is only generated for
// Windows or macOS platforms.
base::FilePath::StringType GetTestDataPathWithPlatformSuffix(
    std::string_view filename);

// Returns the file path for a reference file located in `sub_directory` within
// //pdf/test/data with name `test_filename`. Set `use_platform_suffix` to true
// if the file name includes platform-identifying suffixes. See comments for
// `GetTestDataPathWithPlatformSuffix()`.
base::FilePath GetReferenceFilePath(
    base::FilePath::StringViewType sub_directory,
    std::string_view test_filename,
    bool use_platform_suffix);

// Matches `actual_image` against the PNG at the file path `expected_png_file`.
// The path must be relative to //pdf/test/data.
testing::AssertionResult MatchesPngFile(
    const SkImage& actual_image,
    const base::FilePath& expected_png_file);

// Same as MatchesPngFile() above, but with a fuzzy pixel comparator.
testing::AssertionResult FuzzyMatchesPngFile(
    const SkImage& actual_image,
    const base::FilePath& expected_png_file);

// Returns true if all pixels are blank.
bool IsBitmapBlank(const SkBitmap& bitmap);
bool IsImageBlank(const SkImage& image);

// Takes `pdf_data` and loads it using PDFium. Then renders the page at
// `page_index` to a bitmap of `size_in_points` and checks if it matches
// `expected_png_file` exactly.
void CheckPdfRendering(base::span<const uint8_t> pdf_data,
                       int page_index,
                       const gfx::Size& size_in_points,
                       const base::FilePath& expected_png_file);

// Same as CheckPdfRendering(), but with a fuzzy pixel comparator.
void CheckFuzzyPdfRendering(base::span<const uint8_t> pdf_data,
                            int page_index,
                            const gfx::Size& size_in_points,
                            const base::FilePath& expected_png_file);

// Creates a Skia surface with dimensions `size` and filled with `color`.
sk_sp<SkSurface> CreateSkiaSurfaceForTesting(const gfx::Size& size,
                                             SkColor color);

// Creates a Skia image with dimensions `size` and filled with `color`.
sk_sp<SkImage> CreateSkiaImageForTesting(const gfx::Size& size, SkColor color);

// Retrieves the `v8::Isolate` the test harness created when initializing blink.
v8::Isolate* GetBlinkIsolate();

// Stores the `v8::Isolate` the test harness created when initializing blink.
void SetBlinkIsolate(v8::Isolate* isolate);

// Get print parameters for general use in tests.
blink::WebPrintParams GetDefaultPrintParams();

// Sets the global PDF test task environment.
void SetPdfTestTaskEnvironment(base::test::TaskEnvironment* task_environment);

// Returns the global PDF test task environment. Should always exist for any
// tests in the PDF test suite, otherwise crashes if no task environment was
// set.
base::test::TaskEnvironment& GetPdfTestTaskEnvironment();

}  // namespace chrome_pdf

#endif  // PDF_TEST_TEST_HELPERS_H_