Using Robot Command Line

Owned by Jerry Flood

Last updated: Oct 26, 2017

4 min read

1 Introduction
- 1.1 demo.sh
- 1.2 ete.sh
2 Initializing the Robot Quicklinks Web Page
3 Accessing the Robot Quicklinks Web Page
4 Accessing the Robot Logs
5 Accessing Robot Logs on The Robot VM
6 Running Robot TestSuites
7 Running demo.sh Functions

Introduction

Robot provides 2 command line intefaces which may be accessed

SSH into the Robot VM
cd /opt

demo.sh

/opt/demo.sh provides several Robot functions that streamline some of the procedures for deploying a VNF for demonstration purposes. The original functions are referenced in the sections on Installing and Running the ONAP Demos and, over time, some additional functions have been added.

^{root@vm03-robot:/opt# ./demo.sh}
^{Usage: demo.sh <command> [<parameters>]}

^{demo.sh init}
^{- Execute both init_customer + distribute}

^{demo.sh init_customer}
^{- Create demo customer (Demonstration) and services, etc.}

^{demo.sh distribute [<prefix>]}
^{- Distribute demo models (demoVFW and demoVLB)}

^{demo.sh preload <vnf_name> <module_name>}
^{- Preload data for VNF for the <module_name>}

^{demo.sh appc <module_name>}
^{- provide APPC with vFW module mount point for closed loop}

^{demo.sh init_robot}
^{- Initialize robot after all ONAP VMs have started}

^{demo.sh instantiateVFW}
^{- Instantiate vFW module for the a demo customer (DemoCust<uuid>)}

^{demo.sh deleteVNF <module_name from instantiateVFW>}
^{- Delete the module created by instantiateVFW}

^{root@vm03-robot:/opt# ./demo.sh}
^{Usage: demo.sh <command> [<parameters>]}

^{demo.sh init}
^{- Execute both init_customer + distribute}

^{demo.sh init_customer}
^{- Create demo customer (Demonstration) and services, etc.}

^{demo.sh distribute [<prefix>]}
^{- Distribute demo models (demoVFW and demoVLB)}

^{demo.sh preload <vnf_name> <module_name>}
^{- Preload data for VNF for the <module_name>}

^{demo.sh appc <module_name>}
^{- provide APPC with vFW module mount point for closed loop}

^{demo.sh init_robot}
^{- Initialize robot after all ONAP VMs have started}

^{demo.sh instantiateVFW}
^{- Instantiate vFW module for the a demo customer (DemoCust<uuid>)}

^{demo.sh deleteVNF <module_name from instantiateVFW>}
^{- Delete the module created by instantiateVFW}

ete.sh

/opt/ete/sh runs selected Robot testsuite test cases

^{root@vm03-robot:/opt# ./ete.sh} ^{Usage: ete.sh [ health \| ete \| closedloop \| instantiate \| distribute ]}

^{root@vm03-robot:/opt# ./ete.sh} ^{Usage: ete.sh [ health \| ete \| closedloop \| instantiate \| distribute ]}

Results of the tests may be viewed via a web browser. See below for details. Note that the log folder for each ete.sh execution is named ETE_<pid>.

Initializing the Robot Quicklinks Web Page

The robot container on the Robot VM is initialized with a password protected Web page that should be initialized after all of the ONAP VMs have been started. This page presents some useful information and links for the ONAP instance under test. Use the demo.sh script to initialize the web page and provide a password for the 'test' user required to access the page.

ssh into the Robot VM
cd /opt
./demo.sh init_robot

./demo.sh init_robot will prompt to enter the password for the user 'test', traditionally 'test' is used as the password as well.

oot@vm03-robot:/opt# ./demo.sh init_robot
WEB Site Password for user 'test':

Starting Xvfb on display :89 with res 1280x1024x24
Executing robot tests at log level TRACE
==============================================================================
OpenECOMP ETE
==============================================================================
OpenECOMP ETE.Robot
==============================================================================
OpenECOMP ETE.Robot.Testsuites
==============================================================================
OpenECOMP ETE.Robot.Testsuites.Update Onap Page :: Initializes ONAP Test We...
==============================================================================
Update ONAP Page | PASS |
------------------------------------------------------------------------------
OpenECOMP ETE.Robot.Testsuites.Update Onap Page :: Initializes ONA... | PASS |
1 critical test, 1 passed, 0 failed
1 test total, 1 passed, 0 failed
==============================================================================
OpenECOMP ETE.Robot.Testsuites | PASS |
1 critical test, 1 passed, 0 failed
1 test total, 1 passed, 0 failed
==============================================================================
OpenECOMP ETE.Robot | PASS |
1 critical test, 1 passed, 0 failed
1 test total, 1 passed, 0 failed
==============================================================================
OpenECOMP ETE | PASS |
1 critical test, 1 passed, 0 failed
1 test total, 1 passed, 0 failed
==============================================================================
Output: /share/logs/demo/UpdateWebPage/output.xml
Log: /share/logs/demo/UpdateWebPage/log.html
Report: /share/logs/demo/UpdateWebPage/report.html

oot@vm03-robot:/opt# ./demo.sh init_robot
WEB Site Password for user 'test':

Starting Xvfb on display :89 with res 1280x1024x24
Executing robot tests at log level TRACE
==============================================================================
OpenECOMP ETE
==============================================================================
OpenECOMP ETE.Robot
==============================================================================
OpenECOMP ETE.Robot.Testsuites
==============================================================================
OpenECOMP ETE.Robot.Testsuites.Update Onap Page :: Initializes ONAP Test We...
==============================================================================
Update ONAP Page | PASS |
------------------------------------------------------------------------------
OpenECOMP ETE.Robot.Testsuites.Update Onap Page :: Initializes ONA... | PASS |
1 critical test, 1 passed, 0 failed
1 test total, 1 passed, 0 failed
==============================================================================
OpenECOMP ETE.Robot.Testsuites | PASS |
1 critical test, 1 passed, 0 failed
1 test total, 1 passed, 0 failed
==============================================================================
OpenECOMP ETE.Robot | PASS |
1 critical test, 1 passed, 0 failed
1 test total, 1 passed, 0 failed
==============================================================================
OpenECOMP ETE | PASS |
1 critical test, 1 passed, 0 failed
1 test total, 1 passed, 0 failed
==============================================================================
Output: /share/logs/demo/UpdateWebPage/output.xml
Log: /share/logs/demo/UpdateWebPage/log.html
Report: /share/logs/demo/UpdateWebPage/report.html

Accessing the Robot Quicklinks Web Page

Access the robot page with http://<robot_vm_ip>:88. You will be prompted for credentials. Enter user 'test' with the password provided above.

Accessing the Robot Logs

The Robot Logs are best viewed via the browser at http://<robot_vm_init:88/logs/ or via the link in Quicklinks page above.

Accessing Robot Logs on The Robot VM

Robot logs are located in /opt/eteshare/logs on the Robot VM.

Running Robot TestSuites

/opt/ete/sh provides a command line interface for executing the Robot ETE testsuites.

^{Usage: ete.sh [ health | ete | closedloop | instantiate | distribute ]}

Test	Purpose	Description

Test	Purpose	Description
health	Report the health status of ONAP Components	Executed health check Rest API calls provided by each component and reports overall health status of the component.
ete	Runs full suite of ETE tests	Executes the closedloop, instantiate and distribute test suites
closedloop	Runs full suite of closed loop tests	For the following VNFs, executes customer creation, model distribution, instantation and closed loop test for vFW vLB
instantiate	Runs full suite of instantiate tests	For the following VNFs, executes customer creation, model distribution, instantation for vFW vLB vVG
distribute	Runs the full suite of model distribuition tests	For the following VNFs, executes model distribution vFW vLB vIMS vCPE

Important Note:Each test case creates new data and tears down all created data at the end of a successful test case. Tear downs are not done for failed test cases to enable debugging.

Running demo.sh Functions

/opt/demo.sh provides several command line functions that aid in manually spinning up and testing VNFs.

^{Usage: demo.sh <command> [<parameters>]}

Command	Parameters	Description

Command	Parameters	Description
init		Funnction to create Demonstration customer, services and distribute the models (demoVFW, demoVLB...) if they don't already exist. Referenced in Tutorial: Creating a Service Instance from a Design Model
prelaod	<vnf_name> <module_name>	See Tutorial: Creating a Service Instance from a Design Model
appc	<module name>	See Tutorial: Creating a Service Instance from a Design Model
init_robot		Initializes Quicklinks web page, sets web page credentials to enable accessing the robot logs
distribute	<prefix> (optional)	distribute the models (<prefix>VFW, <prefix>VLB...)
instantiateVFW		Instantiate vFW module for the a demo customer (DemoCust<uuid>)
deleteVNF -	<module_name from instantiateVFW>	Delete the module created by instantiateVFW