blob: 334c4344c8968487b48278ed93fa6890d14684ba (
plain)
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
// Copyright 2013 The Chromium Authors. All rights reserved.
// 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 <string>
#include "base/file_util.h"
#include "base/files/scoped_file.h"
#include "base/process/process_handle.h"
#include "net/test/spawned_test_server/base_test_server.h"
#if defined(OS_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 listening on a specific host (IP or hostname).
// |document_root| must be a relative path under the root tree.
LocalTestServer(Type type,
const std::string& host,
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);
virtual ~LocalTestServer();
// Start the test server and block until it's ready. Returns true on success.
bool Start() WARN_UNUSED_RESULT;
// Start the test server without blocking. Use this if you need multiple test
// servers (such as WebSockets and HTTP, or HTTP and HTTPS). You must call
// BlockUntilStarted on all servers your test requires before executing the
// test. For example:
//
// // Start the servers in parallel.
// ASSERT_TRUE(http_server.StartInBackground());
// ASSERT_TRUE(websocket_server.StartInBackground());
// // Wait for both servers to be ready.
// ASSERT_TRUE(http_server.BlockUntilStarted());
// ASSERT_TRUE(websocket_server.BlockUntilStarted());
// RunMyTest();
//
// Returns true on success.
bool StartInBackground() WARN_UNUSED_RESULT;
// Block until ths test server is ready. Returns true on success. See
// StartInBackground() documentation for more information.
bool BlockUntilStarted() WARN_UNUSED_RESULT;
// Stop the server started by Start().
bool Stop();
// Modify PYTHONPATH to contain libraries we need.
virtual bool SetPythonPath() const WARN_UNUSED_RESULT;
// Returns true if the base::FilePath for the testserver python script is
// successfully stored in |*testserver_path|.
virtual bool GetTestServerPath(base::FilePath* testserver_path) const
WARN_UNUSED_RESULT;
// Adds the command line arguments for the Python test server to
// |command_line|. Returns true on success.
virtual bool AddCommandLineArguments(base::CommandLine* command_line) const
WARN_UNUSED_RESULT;
// 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.
bool LaunchPython(const base::FilePath& testserver_path) WARN_UNUSED_RESULT;
// Waits for the server to start. Returns true on success.
bool WaitToStart() WARN_UNUSED_RESULT;
// Handle of the Python process running the test server.
base::ProcessHandle process_handle_;
#if defined(OS_WIN)
// JobObject used to clean up orphaned child processes.
base::win::ScopedHandle job_handle_;
// 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 defined(OS_POSIX)
// The file descriptor the child writes to when it starts.
base::ScopedFD child_fd_;
#endif
DISALLOW_COPY_AND_ASSIGN(LocalTestServer);
};
} // namespace net
#endif // NET_TEST_SPAWNED_TEST_SERVER_LOCAL_TEST_SERVER_H_
|
