Update documentation on h2spec usage

Author: vankoven

README.md

@@ -72,7 +72,7 @@ deproxy server, and workload tests should use wrk client and nginx server.
 
 - Host for testing framework: `Python2`, `python2-paramiko`,
 `python-configparser`, `python-subprocess32`, `wrk`, `ab`, `python-scapy`,
-`python-cryptography`, `scapy-ssl_tls` (installed with `pip`)
+`python-cryptography`, `scapy-ssl_tls` (installed with `pip`), `h2spec`
 - All hosts except previous one: `sftp-server`
 - Host for running TempestaFW: Linux kernel with Tempesta, TempestaFW sources,
 `systemtap`, `tcpdump`, `bc`
@@ -83,6 +83,9 @@ deproxy server, and workload tests should use wrk client and nginx server.
 `ab` is Apache benchmark tool, that can be found in `apache2-utils` package in
 Debian or `httpd-tools` in CentOS.
 
+`h2spec` is HTTP/2 conformance test suite. Can't be installed from package
+manager and must be retrieved from [GitHub](https://github.com/summerwind/h2spec/releases/latest).
+
 Unfortunately, CentOS does not have `python-subprocess32` package, but it can be
 downloaded from [CentOS CBS](https://cbs.centos.org/koji/buildinfo?buildID=10904)
 
@@ -151,7 +154,7 @@ names available in PATH.
 #### Tempesta Section
 
 `ip` — IPv4/IPv6 address of the TempestaFW host in test network, as reachable
-from the client and server hosts. 
+from the client and server hosts.
 
 `hostname`, `port`, `user` — address and credentials used to reach the host via
 SSH. If hostname is `localhost`, TempestaFW will be ran locally.

framework/external_client.py

@@ -6,6 +6,17 @@
 __license__ = 'GPL2'
 
 class ExternalTester(client.Client):
+    """The class allows to run various 3d-party test suites or any programs
+    against Tempesta. Required properties of `client` definitions inside
+    `tester.TempestaTest` class:
+    - `type` - common attribute for all definitions. Must have value `external`
+    - `binary` - binary to run. The `binary` value is checked against tests
+        config file and alias from `Client` section can be used for that
+        `binary` value. Thus full path mustn't apper in test description just
+        in config file.
+    - `cmd_args` - initial list of command line arguments. Can be updated
+        in runtime via modifying `options` (list of strings) member.
+    """
 
     def __init__(self, cmd_args, **kwargs):
         client.Client.__init__(self, **kwargs)

h2/test_h2_specs.py

@@ -94,7 +94,7 @@ class H2Spec(tester.TempestaTest):
 
     def test_h2_specs(self):
         h2spec = self.get_client('h2spec')
-        # TODO: for now run only simple test to check http2 connectivity
+        # TODO #88: for now run only simple test to check http2 connectivity
         # After all h2-related issues will be fixed, remove the line
         h2spec.options.append('generic/4')
 

tests_config.ini.sample

@@ -78,6 +78,12 @@ ab = ab
 #
 wrk = wrk
 
+# h2spec conformance testing tool for HTTP/2 implementation.
+#
+# ex.: h2spec = /home/user/bin/h2spec
+#
+h2spec = h2spec
+
 
 [Tempesta]
 # Configuration for the host running TempestaFW. It may be configured to run