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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
# Copyright 2021 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
"""Utilities for testing pw_rpc."""
import argparse
import shlex
import subprocess
import sys
import tempfile
import time
from typing import Optional, Sequence
TEMP_DIR_MARKER = '(pw_rpc:CREATE_TEMP_DIR)'
def parse_test_server_args(
parser: Optional[argparse.ArgumentParser] = None,
) -> argparse.Namespace:
"""Parses arguments for running a Python-based integration test."""
if parser is None:
parser = argparse.ArgumentParser(
description=sys.modules['__main__'].__doc__
)
parser.add_argument(
'--test-server-command',
nargs='+',
required=True,
help='Command that starts the test server.',
)
parser.add_argument(
'--port',
type=int,
required=True,
help=(
'The port to use to connect to the test server. This value is '
'passed to the test server as the last argument.'
),
)
parser.add_argument(
'unittest_args',
nargs=argparse.REMAINDER,
help='Arguments after "--" are passed to unittest.',
)
args = parser.parse_args()
# Append the port number to the test server command.
args.test_server_command.append(str(args.port))
# Make the script name argv[0] and drop the "--".
args.unittest_args = sys.argv[:1] + args.unittest_args[1:]
return args
def _parse_subprocess_integration_test_args() -> argparse.Namespace:
parser = argparse.ArgumentParser(
description='Executes a test between two subprocesses'
)
parser.add_argument(
'--client',
required=True,
help=(
'Client command to run. '
'Use quotes and whitespace to pass client-specifc arguments.'
),
)
parser.add_argument(
'--server',
required=True,
help=(
'Server command to run. '
'Use quotes and whitespace to pass client-specifc arguments.'
),
)
parser.add_argument(
'common_args',
metavar='-- ...',
nargs=argparse.REMAINDER,
help=(
'Arguments to pass to both the server and client; '
f'pass {TEMP_DIR_MARKER} to generate a temporary directory'
),
)
args = parser.parse_args()
if not args.common_args or args.common_args[0] != '--':
parser.error('The common arguments must start with "--"')
args.common_args.pop(0)
return args
def execute_integration_test(
server: str,
client: str,
common_args: Sequence[str],
setup_time_s: float = 0.2,
) -> int:
"""Runs an RPC server and client as part of an integration test."""
temp_dir: Optional[tempfile.TemporaryDirectory] = None
if TEMP_DIR_MARKER in common_args:
temp_dir = tempfile.TemporaryDirectory(prefix='pw_rpc_test_')
common_args = [
temp_dir.name if a == TEMP_DIR_MARKER else a for a in common_args
]
try:
server_cmdline = shlex.split(server)
client_cmdline = shlex.split(client)
if common_args:
server_cmdline += [*common_args]
client_cmdline += [*common_args]
server_process = subprocess.Popen(server_cmdline)
# TODO: b/234879791 - Replace this delay with some sort of IPC.
time.sleep(setup_time_s)
result = subprocess.run(client_cmdline).returncode
server_process.terminate()
server_process.communicate()
finally:
if temp_dir:
temp_dir.cleanup()
return result
if __name__ == '__main__':
sys.exit(
execute_integration_test(
**vars(_parse_subprocess_integration_test_args())
)
)
|
