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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef NET_TEST_SPAWNED_TEST_SERVER_LOCAL_TEST_SERVER_H_
#define NET_TEST_SPAWNED_TEST_SERVER_LOCAL_TEST_SERVER_H_
#include <vector>
#include "base/files/file_util.h"
#include "base/files/scoped_file.h"
#include "base/process/process.h"
#include "build/build_config.h"
#include "net/test/spawned_test_server/base_test_server.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
#if BUILDFLAG(IS_WIN)
#include "base/win/scoped_handle.h"
#endif
namespace base {
class CommandLine;
}
namespace net {
// The LocalTestServer runs an external Python-based test server in the
// same machine in which the LocalTestServer runs.
class LocalTestServer : public BaseTestServer {
public:
// Initialize a TestServer. |document_root| must be a relative path under the
// root tree.
LocalTestServer(Type type, const base::FilePath& document_root);
// Initialize a TestServer with a specific set of SSLOptions.
// |document_root| must be a relative path under the root tree.
LocalTestServer(Type type,
const SSLOptions& ssl_options,
const base::FilePath& document_root);
LocalTestServer(const LocalTestServer&) = delete;
LocalTestServer& operator=(const LocalTestServer&) = delete;
~LocalTestServer() override;
// BaseTestServer overrides.
[[nodiscard]] bool StartInBackground() override;
[[nodiscard]] bool BlockUntilStarted() override;
// Stop the server started by Start().
bool Stop();
// Returns the directories to use as the PYTHONPATH, or nullopt on error.
virtual absl::optional<std::vector<base::FilePath>> GetPythonPath() const;
// Returns true if the base::FilePath for the testserver python script is
// successfully stored in |*testserver_path|.
[[nodiscard]] virtual bool GetTestServerPath(
base::FilePath* testserver_path) const;
// Adds the command line arguments for the Python test server to
// |command_line|. Returns true on success.
[[nodiscard]] virtual bool AddCommandLineArguments(
base::CommandLine* command_line) const;
// Returns the actual path of document root for test cases. This function
// should be called by test cases to retrieve the actual document root path.
base::FilePath GetDocumentRoot() const { return document_root(); }
private:
bool Init(const base::FilePath& document_root);
// Launches the Python test server. Returns true on success. |testserver_path|
// is the path to the test server script. |python_path| is the list of
// directories to use as the PYTHONPATH environment variable.
[[nodiscard]] bool LaunchPython(
const base::FilePath& testserver_path,
const std::vector<base::FilePath>& python_path);
// Waits for the server to start. Returns true on success.
[[nodiscard]] bool WaitToStart();
// The Python process running the test server.
base::Process process_;
#if BUILDFLAG(IS_WIN)
// The pipe file handle we read from.
base::win::ScopedHandle child_read_fd_;
// The pipe file handle the child and we write to.
base::win::ScopedHandle child_write_fd_;
#endif
#if BUILDFLAG(IS_POSIX)
// The file descriptor the child writes to when it starts.
base::ScopedFD child_fd_;
#endif
};
} // namespace net
#endif // NET_TEST_SPAWNED_TEST_SERVER_LOCAL_TEST_SERVER_H_
|
