summaryrefslogtreecommitdiffstats
path: root/docs/testing/testusage.rst
diff options
context:
space:
mode:
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.