Valkyrie Knowledge Base

ValkyrieRun User Manual

This manual explains how to use the ValkyrieRun application to execute Valkyrie2544 and Valkyrie1564 test configurations.

Overview

The Valkyrie2544 and Valkyrie1564 test applications enable the user to create, edit and execute RFC 2544- and Y.1564-compliant test configurations. The use of a GUI application works fine for interactive sessions but is not preferable in fully-automated test scenarios.

The ValkyrieRun application enables the user to execute any test configuration created by the GUI test applications from the command line, and is thus a better solution for use by automated scripts.

Note that ValkyrieRun does not have any editing capabilities w.r.t. the test configurations. It is only capable of executing a test configuration. Test configurations must as stated above be created with the GUI applications.

Note: The Valkyrie3918 application is capable of executing its configuration files from the command line without a separate command-line utility like the ValkyrieRun. In the future, the Valkyrie2544 and Valkyrie1564 will be migrated to have this capability as well.

Installation and Location

The ValkyrieRun application will automatically be installed by the normal Xena Setup program if the user selects to install the Xena GUI test applications. After installation ValkyrieRun can be found in the Xena subdirectory within the standard Windows “Program Files” directory (usually “C:Program Files”).

The installer will install one ValkyrieRun executable for each of the GUI applications supported. The executable will be called “run_.exe” where the part indicates the GUI application name (xena2544 or xena1564), and the part indicates the current version of the GUI application. Example: The ValkyrieRun executable for Valkyrie1564 will be called “xena1564run.exe”.

Alongside this application, you will find a Windows command line batch file called “run.cmd” which will call the last version installed. Note that when you upgrade the application software the installer will not remove older versions.

Command Line Syntax

ValkyrieRun will display the valid command-line options when invoked either with no options or with the -h/–help option.

ValkyrieRun - Xena Test Configuration Executer
Copyright © Xena Networks ApS 2012 - 2013
 
ERROR: The option --config is mandatory and must be provided.
 
Valid options:
 
  -c, --config        Required. Path to test configuration file.
  -t, --testtype      Test type to execute: { conf (*) | perf } (Y.1564 only).
  -u, --user          Set the username (default: xenacli)
  -r, --reportpath    Path where reports are saved.
  -o, --company       Company name.
  -l, --logo          Path to logo file.
  -h, --help          Display this help screen.


The options are explained in detail below:

Option Explanation
-c, –config Specifies the full path to the test configuration file to execute. This option is mandatory.
-t, –testtype Specify the overall test-type (Configuration or Performance) to execute for Y.1564 tests. The default is Configuration.
-u, –user Specifies the username used to login to the Xena testers. The default is “xenacli”.
-r, –reportpath Specifies the full path where the resulting reports shall be saved.
The default directory is %PROGRAMDATA%XenaNetworksXenaRunReports
-o, –company Specifies the name of the Tester Company which is used in the report. The default is “Xena Networks”.
-l, –logo Specifies the full path to a logo image file that is used in the PDF report. The default is the Xena Networks logo.
-h, –help Display the valid command-line options.

The options may be specified with either the shortform (e.g. -c) or the longform (e.g. –config) syntax.

Output

ValkyrieRun will output progress information to the standard output console. With the exception of the initial header information all lines printed will be prefixed with one of the following severity indicators:

  • INFO: Normal informational message.
  • WARN: A warning message. The test execution will continue but the results may not be as you expect.
  • ERROR: An error message. The test execution will be aborted.

Obtaining the Report File Path

The calling script may need to perform some post-processing actions on the generated report, either by parsing the data (for the XML format) or sending the report somewhere else (by email or by copying it to a remote server). The generated reports may, however, contain a timestamp (if specified in the test configuration) and it is thus not really possible to figure out what the resulting report is called in advance.

ValkyrieRun will, therefore, log the full path of the generated report(s) to the console using the following format:

INFO:  report written to []

The calling script will thus be able to obtain the path to the generated report file by parsing the output. The report path will be contained within the “[” and “]” brackets. can be either “PDF” or “XML”.

Troubleshooting

If you experience a problem with the ValkyrieRun please contact Xena support staff on [email protected] and describe the problem. The ValkyrieRun program logs various information to the %PROGRAMDATA%XenaXenaRunLogs directory. It may expedite the support if you could attach this logfile and a copy of the test configuration file to the problem description.

Samples

ValkyrieRun can, of course, be invoked from any scripting language. Below you will find two sample Python scripts that show how this can be done.

The “simplelaunch.py” script shows how a configuration file may be loaded and executed. The “xmlparser.py” expands on this sample and shows how the XML result file can be parsed and the results extracted.

simplelaunch.py    xmlparser.py