aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/user_guide_verification_program.rst17
1 files changed, 16 insertions, 1 deletions
diff --git a/docs/user_guide_verification_program.rst b/docs/user_guide_verification_program.rst
index e944d8e5..462badb8 100644
--- a/docs/user_guide_verification_program.rst
+++ b/docs/user_guide_verification_program.rst
@@ -8,4 +8,19 @@
CLI verification program
==============================================
-TBD. \ No newline at end of file
+Verification program helps the author to setup the mocking environment for the HTTP profile (and
+in future it could be extended to other profile) for authoring the testing the CLI OCS YAMLs.
+
+It provides the model based test environment where author needs to setup following aspects:
+
+# Write the moco json which capture the HTTP request and response in moco style
+
+# Write the sample YAML which capture the one or more functional test case(s)
+
+# Place them under open-cli-sample directory under OPEN_CLI_HOME
+
+Once this setup is done, author can verify the OCS YAML by running the following CLI ::
+
+ oclip <command name> --verify | -V
+
+It will list out the success/failure of each test cases written in sample YAML.