summaryrefslogtreecommitdiffstats
path: root/docs/testing/testusage.rst
diff options
context:
space:
mode:
authorserena.spinoso <serena.spinoso@polito.it>2017-03-16 16:18:24 +0100
committerZhipeng (Howard) Huang <huangzhipeng@huawei.com>2017-03-18 23:30:02 +0000
commit457196231fb0d1df4842ac0e6bf8c10260dc9d0b (patch)
tree6f5ccb3f58f1ba00dd14583d24cdcb829b62bda9 /docs/testing/testusage.rst
parente51c927ec522ef92fac14a7b783262113af285be (diff)
Add verigraph documentationdanube.2.0danube.1.0stable/danube
Add user guide and test usage documentation. Add examples of service graphs to use verigraph. Change-Id: I3e454e03fa2de99bad0761e3e4a0eab98f2e0b23 Signed-off-by: serena.spinoso <serena.spinoso@polito.it> (cherry picked from commit 7d6f6962fb9c5ff6d815241d5d15c86c4c6a501b)
Diffstat (limited to 'docs/testing/testusage.rst')
-rw-r--r--docs/testing/testusage.rst56
1 files changed, 55 insertions, 1 deletions
diff --git a/docs/testing/testusage.rst b/docs/testing/testusage.rst
index 405d6bd..36b9c00 100644
--- a/docs/testing/testusage.rst
+++ b/docs/testing/testusage.rst
@@ -3,7 +3,7 @@
Parser tosca2heat test usage
-===========================
+============================
1. run tox in tosca-parser sub project
.. code-block:: bash
@@ -52,3 +52,57 @@ or
# run tox
tox
+Parser VeriGraph test usage
+===========================
+
+VeriGraph is accessible via both a RESTfull API and a gRPC interface.
+
+**RESTful API**
+
+1. Run the Python tester
+
+.. code-block:: bash
+
+ cd parser/verigraph/tester
+ python test.py
+
+**gRPC API**
+
+1. Compile the code
+
+.. code-block:: bash
+
+ cd parser/verigraph
+ ant -f buildVeriGraph_gRPC.xml build
+
+2. Run both client and server
+
+.. code-block:: bash
+
+ cd parser/verigraph
+ ant -f buildVeriGraph_gRPC.xml run
+
+3. Run only the testing client
+
+.. code-block:: bash
+
+ cd parser/verigraph
+ ant -f buildVeriGraph_gRPC.xml run-client
+
+4. Run only the gRPC server
+
+.. code-block:: bash
+
+ cd parser/verigraph
+ ant -f buildVeriGraph_gRPC.xml run-server
+
+5. Run all tests and print out the partial results and global result
+
+.. code-block:: bash
+
+ cd parser/verigraph
+ # This target has the needed dependencies to compile the code
+ # and run both client and server
+ ant -f buildVeriGraph_gRPC.xml run-test
+
+Note that the execution of these tests may take up to 1-2 minutes when successful.