{"type":"doc","content":[{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Starting with the Frankfurt release, this method is deprecated and this page will no longer be maintained. Visit ","type":"text"},{"text":"this page","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/onap/vvp-test-engine/tree/master/ovp_testsuite"}}]},{"text":" for instructions on executing the testsuite.","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"type":"hardBreak"},{"text":"About","type":"text"}]},{"type":"paragraph","content":[{"text":"This page contains instructions for executing the ","type":"text"},{"text":"VNF Lifecycle Validation","type":"text","marks":[{"type":"link","attrs":{"href":"https://wiki.lfnetworking.org/display/LN/VNF+Validation+Minimum+Viable+Product"}}]},{"text":" automation flow for ","type":"text"},{"text":"heat-based","type":"text","marks":[{"type":"strong"}]},{"text":" VNFs. The result will be a ","type":"text"},{"text":".tar.gz ","type":"text","marks":[{"type":"strong"}]},{"text":"file that can be used to submit to the ","type":"text"},{"text":"OVP Portal","type":"text","marks":[{"type":"link","attrs":{"href":"https://vnf-verified.lfnetworking.org/#/"}}]},{"text":" to obtain a certification badge for a VNF. The execution is very similar to ","type":"text"},{"text":"running the other ONAP demo VNFs","type":"text","marks":[{"type":"link","attrs":{"href":"https://lf-onap.atlassian.net/wiki/display/DW/Running+the+ONAP+Demos"}}]},{"text":", however there are some additional steps detailed below. ","type":"text"}]},{"type":"paragraph","content":[{"text":"This will be introduced in the El Alto release, and will not be backwards compatible with previous ONAP releases. ","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Prerequisites","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ONAP deployed via OOM","type":"text","marks":[{"type":"link","attrs":{"href":"https://onap.readthedocs.io/en/latest/submodules/oom.git/docs/oom_quickstart_guide.html"}}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"An OpenStack deployment.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"kubectl","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"bash","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"VNF Heat Templates","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Preload json files","type":"text"}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"After deploying ONAP, you need to configure ONAP with:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A cloud owner","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A cloud region","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A subscriber","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A service type","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A project name","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"An owning entity","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A platform","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A line of business","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A cloud site","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"If you're not familiar with how to configure ONAP, there are guides that use ","type":"text"},{"text":"robot","type":"text","marks":[{"type":"link","attrs":{"href":"https://onap.readthedocs.io/en/latest/submodules/integration.git/docs/docs_robot.html"}}]},{"text":" or ","type":"text"},{"text":"direct api requests","type":"text","marks":[{"type":"link","attrs":{"href":"https://lf-onap.atlassian.net/wiki/pages/viewpage.action?pageId=16268543"}}]},{"text":" available to help, as well as a ","type":"text"},{"text":"guide for adding a new OpenStack site ","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.onap.org/en/latest/guides/onap-user/cloud_site/openstack/index.html"}}]},{"text":"to ONAP. ","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Preparing the VNF","type":"text"}]},{"type":"paragraph","content":[{"text":"The vnf lifecycle validation testsuite requires the VNF to be packaged into a specific directory hierarchy, shown below.","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"vnf_folder\n├── /templates\n| └── base.yaml\n| └── base.env\n| └── incremental_0.yaml\n| └── incremental_0.env\n| └── ...\n├── /preloads\n| └── base_preload.json\n| └── incremental_0_preload.json\n| └── ...\n└── vnf-details.json\n\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The name for vnf_folder is free-form, and can be located anywhere on your computer. The path to this folder will be passed to the testsuite as an argument.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/templates should contain your ","type":"text"},{"text":"VVP-compliant","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.onap.org/en/latest/submodules/vvp/documentation.git/docs/index.html"}}]},{"text":" VNF heat templates.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/preloads should contain a preload file for each VNF module (TODO: add link to preload documentation).","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For a VNF-API preload: vnf-name, vnf-type, generic-vnf-type, and generic-vnf-name should be empty strings.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For a GR-API preload: vnf-name, vnf-type, vf-module-type, and vf-module-name should be empty strings.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"This information will be populated at runtime by the testsuite.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"vnf-details should be a json file with the information that will be used by ONAP to instantiate the VNF. The structure of vnf-details is shown below.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"vnf-details.json","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"vnf_name\": \"The Vnf Name\",\n \"description\": \"Description of the VNF\",\n \"modules\": [\n {\n \"filename\": \"base.yaml\",\n \"isBase\": \"true\",\n \"preload\": \"base_preload.json\"\n },\n {\n \"filename\": \"incremental_0.yaml\",\n \"isBase\": \"false\",\n \"preload\": \"incremental_0.json\"\n },\n\t\t...\n ],\n \"api_type\": \"[gr_api] or [vnf_api]\", \n \"subscriber\": \"\",\n \"service_type\": \"\",\n \"tenant_name\": \"\",\n \"region_id\": \"\",\n \"cloud_owner\": \"\",\n \"project_name\": \"\",\n \"owning_entity\": \"\",\n \"platform\": \"\",\n \"line_of_business\": \"\",\n \"os_password\": \"\"\n}\n\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"modules must contain an entry for each module of the VNF. Only one module can be a base module.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"api_type should match the format of the preloads that are provided in the package.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The other information should match what was used to configure ONAP during the pre-requisite section of this guide.","type":"text"}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Running the testsuite","type":"text"}]},{"type":"paragraph","content":[{"text":"The script to execute the testsuite is located in the OOM project. Clone the OOM repository and cd to the robot folder.","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"$ git clone ssh://@gerrit.onap.org:29418/oom --recurse-submodules\n$ cd oom/kubernetes/robot\n$ ./instantiate-k8s.sh --help\n./instantiate-k8s.sh [options]\n \nrequired:\n-n, --namespace namespace that robot pod is running under.\n-f, --folder path to folder containing heat templates, preloads, and vnf-details.json.\n \nadditional options:\n-p, --poll some cloud environments (like azure) have a short time out value when executing\n kubectl. If your shell exits before the testsuite finishes, using this option\n will poll the testsuite logs every 30 seconds until the test finishes.\n-t, --tag robot testcase tag to execute (default is instantiate_vnf).\n \nThis script executes the VNF instantiation robot testsuite.\n- It copies the VNF folder to the robot container that is part of the ONAP deployment.\n- It models, distributes, and instantiates a heat-based VNF.\n- It copies the logs to an output directory, and creates a tarball for upload to the OVP portal.\n\n\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Execution","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"$ ./instantiate-k8s.sh --namespace onap --folder /tmp/vnf-instantiation/examples/VNF_API/pass/multi_module/ --poll\n...\n...\n...\n...\n------------------------------------------------------------------------------\nTestsuites.Vnf Instantiation :: The main driver for instantiating ... | PASS |\n1 critical test, 1 passed, 0 failed\n1 test total, 1 passed, 0 failed\n==============================================================================\nTestsuites | PASS |\n1 critical test, 1 passed, 0 failed\n1 test total, 1 passed, 0 failed\n==============================================================================\nOutput: /share/logs/0003_ete_instantiate_vnf/output.xml\n+ set +x\ntestsuite has finished\nCopying Results from pod...\n/tmp/vnf-instantiation /tmp/vnf-instantiation\na log.html\na results.json\na stack_report.json\na validation-scripts.json\n/tmp/vnf-instantiation\nVNF test results: /tmp/vnfdata.46749/vnf_heat_results.tar.gz\n\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"The testsuite takes about 10-15 minutes for a simple VNF, and will take longer for a more complicated VNF.","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Results","type":"text"}]},{"type":"paragraph","content":[{"text":"Once the testsuite is finished, it will create a directory and tarball in /tmp (the name of the directory and file is shown at the end of the stdout of the script). There will be a results.json in that directory that has the ultimate outcome of the test, in the structure shown below.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Log files","type":"text"}]},{"type":"paragraph","content":[{"text":"The output file will have 4 log files in it.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"results.json","type":"text","marks":[{"type":"strong"}]},{"text":": This is high-level results file of all of the test steps, and is consumed by the OVP portal.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"report.json","type":"text","marks":[{"type":"strong"}]},{"text":": This is the output of the vvp validation scripts.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"stack_report.json","type":"text","marks":[{"type":"strong"}]},{"text":": This is the output from querying openstack to validate the heat modules.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"log.html","type":"text","marks":[{"type":"strong"}]},{"text":": This is the robot log, and contains each execution step of the testcase.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"results.json","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"{\n \"vnf_checksum\": \"afc57604a3b3b7401d5b8648328807b594d7711355a2315095ac57db4c334a50\", \n \"build_tag\": \"vnf-validation-53270\", \n \"version\": \"2019.09\", \n \"test_date\": \"2019-09-04 17:50:10.575\", \n \"duration\": 437.002, \n \"vnf_type\": \"heat\", \n \"testcases_list\": [\n {\n \"mandatory\": \"true\", \n \"name\": \"onap-vvp.validate.heat\", \n \"result\": \"PASS\", \n \"objective\": \"onap heat template validation\", \n \"sub_testcase\": [], \n \"portal_key_file\": \"report.json\"\n }, \n {\n \"mandatory\": \"true\", \n \"name\": \"onap-vvp.lifecycle_validate.heat\", \n \"result\": \"PASS\", \n \"objective\": \"onap vnf lifecycle validation\", \n \"sub_testcase\": [\n {\n \"name\": \"model-and-distribute\", \n \"result\": \"PASS\"\n }, \n {\n \"name\": \"instantiation\", \n \"result\": \"PASS\"\n }\n ], \n \"portal_key_file\": \"log.html\"\n }, \n {\n \"mandatory\": \"true\", \n \"name\": \"stack_validation\", \n \"result\": \"PASS\", \n \"objective\": \"onap vnf openstack validation\", \n \"sub_testcase\": [], \n \"portal_key_file\": \"stack_report.json\"\n }\n ]\n}\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"If the result is \"PASS\", that means the testsuite was successful and the tarball is ready for submission to the ","type":"text"},{"text":"OVP portal","type":"text","marks":[{"type":"link","attrs":{"href":"https://vnf-verified.lfnetworking.org/#/"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Examples","type":"text"}]},{"type":"paragraph","content":[{"text":"Attached to this page are simple examples that you can use to try out the testcase, along with the output tarballs that are generated. To run one of the examples, download one of the zip files named input-* and unzip it to your computer, then follow the instructions from the section ","type":"text"},{"text":"Running the testsuite","type":"text","marks":[{"type":"strong"}]},{"text":" above.","type":"text"}]},{"type":"paragraph","content":[{"type":"mediaInline","attrs":{"id":"a5795755-69e3-44eb-bf66-eca2ab0e5fe3","collection":"contentId-16389301"}},{"type":"mediaInline","attrs":{"id":"4cc92e40-9820-4f23-ab78-07eaa7c589b9","collection":"contentId-16389301"}},{"type":"mediaInline","attrs":{"id":"0bf1e52d-0d29-4ec5-9da8-a051ec1dfa9e","collection":"contentId-16389301"}},{"type":"mediaInline","attrs":{"id":"68088e04-8cf2-429f-8237-cc61df381235","collection":"contentId-16389301"}}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}