File: fake_origin_test_server_mixin.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (74 lines) | stat: -rw-r--r-- 2,685 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
// Copyright 2024 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_APP_MODE_TEST_FAKE_ORIGIN_TEST_SERVER_MIXIN_H_
#define CHROME_BROWSER_APP_MODE_TEST_FAKE_ORIGIN_TEST_SERVER_MIXIN_H_

#include <cstddef>
#include <string_view>

#include "base/check_deref.h"
#include "base/command_line.h"
#include "base/files/file_path.h"
#include "chrome/test/base/mixin_based_in_process_browser_test.h"
#include "net/test/embedded_test_server/embedded_test_server.h"
#include "url/gurl.h"

namespace ash {

// This mixin sets up an `EmbeddedTestServer` configured to serve the files in
// Chrome's src/`path_to_be_served` under the given `origin`.
//
// This allows tests to serve content on a "real" origin like
// "http://your.app.com", instead of "http://127.0.0.1:<port>" with a varying
// port number.
//
// Both HTTP and HTTPS `origin` schemes are supported.
class FakeOriginTestServerMixin : public InProcessBrowserTestMixin {
 public:
  FakeOriginTestServerMixin(InProcessBrowserTestMixinHost* host,
                            GURL origin,
                            base::FilePath::StringViewType path_to_be_served);
  FakeOriginTestServerMixin(const FakeOriginTestServerMixin&) = delete;
  FakeOriginTestServerMixin operator=(const FakeOriginTestServerMixin&) =
      delete;

  ~FakeOriginTestServerMixin() override;

  const GURL& origin() const { return origin_; }

  // Returns the `origin_` URL with `url_suffix` appended to it. For example
  // given `url_suffix` is `/path?q=123` the URL would be
  // "https://foo.com/path?q=123".
  //
  // `url_suffix` must start with "/".
  GURL GetUrl(std::string_view url_suffix) const;

  net::test_server::EmbeddedTestServer& server() { return server_; }

  const net::test_server::EmbeddedTestServer& server() const { return server_; }

  // InProcessBrowserTestMixin overrides:
  void SetUp() override;
  void SetUpCommandLine(base::CommandLine* command_line) override;
  void SetUpOnMainThread() override;

 private:
  // The origin to be served. Must be a URL with scheme and host, optionally
  // followed by a port and a trailing slash.
  //
  // For example, "https://foo.com/" and "http://127.0.0.1:3244" are allowed but
  // "https://foo.com/bar" and "http://127.0.0.1:3244?q=123" are not.
  GURL origin_;

  // Path to the directory to be served, relative to Chrome's src/ directory.
  base::FilePath path_to_be_served_;

  net::test_server::EmbeddedTestServer server_;
  net::test_server::EmbeddedTestServerHandle server_handle_;
};

}  // namespace ash

#endif  // CHROME_BROWSER_APP_MODE_TEST_FAKE_ORIGIN_TEST_SERVER_MIXIN_H_