Skip to content

Commit 5d6bb69

Browse files
committed
Update documentation on h2spec usage
1 parent 0c72d68 commit 5d6bb69

File tree

3 files changed

+22
-2
lines changed

3 files changed

+22
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ deproxy server, and workload tests should use wrk client and nginx server.
7272

7373
- Host for testing framework: `Python2`, `python2-paramiko`,
7474
`python-configparser`, `python-subprocess32`, `wrk`, `ab`, `python-scapy`,
75-
`python-cryptography`, `scapy-ssl_tls` (installed with `pip`)
75+
`python-cryptography`, `scapy-ssl_tls` (installed with `pip`), `h2spec`
7676
- All hosts except previous one: `sftp-server`
7777
- Host for running TempestaFW: Linux kernel with Tempesta, TempestaFW sources,
7878
`systemtap`, `tcpdump`, `bc`
@@ -83,6 +83,9 @@ deproxy server, and workload tests should use wrk client and nginx server.
8383
`ab` is Apache benchmark tool, that can be found in `apache2-utils` package in
8484
Debian or `httpd-tools` in CentOS.
8585

86+
`h2spec` is HTTP/2 conformance test suite. Can't be installed from package
87+
manager and must be retrieved from [GitHub](https://github.com/summerwind/h2spec/releases/latest).
88+
8689
Unfortunately, CentOS does not have `python-subprocess32` package, but it can be
8790
downloaded from [CentOS CBS](https://cbs.centos.org/koji/buildinfo?buildID=10904)
8891

@@ -151,7 +154,7 @@ names available in PATH.
151154
#### Tempesta Section
152155

153156
`ip` — IPv4/IPv6 address of the TempestaFW host in test network, as reachable
154-
from the client and server hosts.
157+
from the client and server hosts.
155158

156159
`hostname`, `port`, `user` — address and credentials used to reach the host via
157160
SSH. If hostname is `localhost`, TempestaFW will be ran locally.

framework/external_client.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,17 @@
66
__license__ = 'GPL2'
77

88
class ExternalTester(client.Client):
9+
"""The class allows to run various 3d-party test suites or any programs
10+
against Tempesta. Required properties of `client` definitions inside
11+
`tester.TempestaTest` class:
12+
- `type` - common attribute for all definitions. Must have value `external`
13+
- `binary` - binary to run. The `binary` value is checked against tests
14+
config file and alias from `Client` section can be used for that
15+
`binary` value. Thus full path mustn't apper in test description just
16+
in config file.
17+
- `cmd_args` - initial list of command line arguments. Can be updated
18+
in runtime via modifying `options` (list of strings) member.
19+
"""
920

1021
def __init__(self, cmd_args, **kwargs):
1122
client.Client.__init__(self, **kwargs)

tests_config.ini.sample

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,12 @@ ab = ab
7878
#
7979
wrk = wrk
8080

81+
# h2spec conformance testing tool for HTTP/2 implementation.
82+
#
83+
# ex.: h2spec = /home/user/bin/h2spec
84+
#
85+
h2spec = h2spec
86+
8187

8288
[Tempesta]
8389
# Configuration for the host running TempestaFW. It may be configured to run

0 commit comments

Comments
 (0)