summaryrefslogtreecommitdiffstats
path: root/vpp-api/java/jvpp/org/openvpp
diff options
context:
space:
mode:
authorMaros Marsalek <mmarsale@cisco.com>2016-04-26 15:03:26 +0200
committerEd Warnicke <hagbard@gmail.com>2016-05-02 21:19:26 +0000
commit047bf8494950eb9404598b2d9315718c3e3e81a2 (patch)
tree3e4ce881226c95ffba42ba0024a8f46fd8ad060f /vpp-api/java/jvpp/org/openvpp
parent72c7a2eadbc55aa4944822fc0e6a958d3578512a (diff)
HONEYCOMB-10: JVpp documentation
Change-Id: Ibca8fc8c1962ca36d91898c1523afb2df6dfdc49 Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
Diffstat (limited to 'vpp-api/java/jvpp/org/openvpp')
-rw-r--r--vpp-api/java/jvpp/org/openvpp/jvpp/test/Readme.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/vpp-api/java/jvpp/org/openvpp/jvpp/test/Readme.txt b/vpp-api/java/jvpp/org/openvpp/jvpp/test/Readme.txt
new file mode 100644
index 00000000000..df4100dd973
--- /dev/null
+++ b/vpp-api/java/jvpp/org/openvpp/jvpp/test/Readme.txt
@@ -0,0 +1,13 @@
+This package contains basic tests for jvpp. To run the tests:
+
+- Make sure VPP is running
+- From VPP's build-root/ folder execute:
+ - sudo java -cp .:build-vpp-native/vpp-api/java/jvpp-1.0.0.jar org.openvpp.jvpp.test.ControlPingTest
+ - sudo java -cp .:build-vpp-native/vpp-api/java/jvpp-1.0.0.jar org.openvpp.jvpp.test.FutureApiTest
+ - sudo java -cp .:build-vpp-native/vpp-api/java/jvpp-1.0.0.jar org.openvpp.jvpp.test.CallbackApiTest
+
+Available tests:
+ControlPingTest - Simple test executing a single control ping using low level JVpp APIs
+CallbackApiTest - Similar to ControlPingTest, invokes more complex calls (e.g. interface dump) using low level JVpp APIs
+FutureApiTest - Execution of more complex calls using Future based JVpp facade
+CallbackJVppFacadeTest - Execution of more complex calls using Callback based JVpp facade \ No newline at end of file