hs-test: added filenames to test names

- It is now possible to only run tests that are in a certain file

Type: test

Change-Id: I41665dd2bc0942c283be36a5af3e560fd65e9d03
Signed-off-by: Adrian Villin <avillin@cisco.com>

1 files changed, 24 insertions, 0 deletions

diff --git a/extras/hs-test/README.rst b/extras/hs-test/README.rst
index 1dc1039b33f..a88251af617 100644
--- a/extras/hs-test/README.rst
+++ b/extras/hs-test/README.rst
@@ -89,6 +89,30 @@ This can be put in file ``extras/hs-test/my_test.go`` and run with command ``mak
                 s.log(result)
         }
 
+
+Filtering test cases
+--------------------
+
+The framework allows us to filter test cases in a few different ways, using ``make test TEST=``:
+* Suite name
+* File name
+* Test name
+* All of the above as long as they are ordered properly, e.g. ``make test TEST=VethsSuite.http_test.go.HeaderServerTest``
+
+**Names are case sensitive!**
+
+Names don't have to be complete, as long as they are last:
+This is valid and will run all tests in every ``http`` file (if there is more than one):
+``make test TEST=VethsSuite.http``
+This is not valid:
+``make test TEST=Veths.http``
+
+They can also be left out:
+``make test TEST=http_test.go`` will run every test in ``http_test.go``
+``make test TEST=Nginx`` will run everything that has 'Nginx' in its name - suites, files and tests.
+``make test TEST=HeaderServerTest`` will only run the header server test
+
+
 Modifying the framework
 -----------------------