diff options
| author |   Matej Klotton <mklotton@cisco.com> | 2016-11-11 11:38:55 +0100 |
|---|---|---|
| committer |   Damjan Marion <dmarion.lists@gmail.com> | 2016-11-15 15:32:48 +0000 |
| commit | 86d87c40dd97ced69c939299204fadf1859a2f50 (patch) | |
| tree | 892a3adc4906186922354ef4f9381ff490dd9415 /test/doc/index.rst | |
| parent | b7c3f2c61c25e3a9e729c5ea7e4a0117f717a2c5 (diff) | |
Update test documentation.
- update IRB, IPv4, ipv6 doc
- revert 778c2765c8ea5c6628f6d668847f0b9ae06dbf3d
Change-Id: I9af5ed9329ce5fe01392cf28d5bf321cfc647e48
Signed-off-by: Matej Klotton <mklotton@cisco.com>
Diffstat (limited to 'test/doc/index.rst')
| -rw-r--r-- | test/doc/index.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/test/doc/index.rst b/test/doc/index.rst index 323b608fdfb..8cbe961f887 100644 --- a/test/doc/index.rst +++ b/test/doc/index.rst @@ -22,7 +22,7 @@ Anatomy of a test case ###################### Python's unittest_ is used as the base framework upon which the VPP test -framework is built. A test suite in the |vtf| constists of multiple classes +framework is built. A test suite in the |vtf| consists of multiple classes derived from `VppTestCase`, which is itself derived from TestCase_. The test class defines one or more test functions, which act as test cases. @@ -44,11 +44,11 @@ Function flow when running a test case is: The tearDown function is called after each test function with the purpose of doing partial cleanup. 5. `tearDownClass <VppTestCase.tearDownClass>`: - Method called once after running all of the test funnctions to perform + Method called once after running all of the test functions to perform the final cleanup. Test temporary directory and VPP life cycle -################################################ +########################################### Test separation is achieved by separating the test files and vpp instances. Each test creates a temporary directory and it's name is used to create @@ -60,7 +60,7 @@ are stored in this temporary test directory. Virtual environment ################### -Virtualenv_ is a python module which provides a means to crate an environment +Virtualenv_ is a python module which provides a means to create an environment containing the dependencies required by the |vtf|, allowing a separation from any existing system-wide packages. |vtf|'s Makefile automatically creates a virtualenv_ inside build-root and installs the required packages @@ -72,7 +72,7 @@ Naming conventions Most unit tests do some kind of packet manipulation - sending and receiving packets between VPP and virtual hosts connected to the VPP. Referring -to the sides, addresses, etc.. is always done as if looking from the VPP side, +to the sides, addresses, etc. is always done as if looking from the VPP side, thus: * *local_* prefix is used for the VPP side. |