Essentials of Spirent TestCenter GUI to Script Automation · The Essentials of Spirent TestCenter...

Essentials of Spirent TestCenter GUI to Script Automation

Introduction1

Spirent Communications

Course Description

The Essentials of Spirent TestCenter GUI to Script Automation Web-based course is designed to present an overview of the features and functions of the Save As Script menu item contained within the Spirent TestCenter GUI.

Since it is a web-based course, you can choose to view only the topics of interest or the entire course.

Viewing all the topics within the course will take just under 30 minutes.

Introduction

2


Course Objectives After completing this course, participants will be able to:

Generate and run TCL, Ruby, and Perl scripts created using the Save As Script feature.

Identify and describe the key elements contained with the files generated from the Save As Script feature.

Describe the purpose of the Save As Script Additional Processing Options.

Download and install HLTAPI.

Generate HLTAPI scripts using the Save As Script feature.

Introduction

3


Spirent TestCenter GUI to Script Automation Overview

GUI to Script Content

Additional Processing Options

HLTAPI

Course Topics Overview

4


GUI to Script Automation Overview5





HLTAPI


6


GUI to Script OverviewSpirent TestCenter GUI to Script Automation Overview

The GUI to Script option enables automation on Spirent TestCenter without the typical automation overhead.

Simply configure the test within the GUI.

With the click of a button, generate the Test Script

Then execute the Test Script from a Shell.

7


GUI to Script BenefitsSpirent TestCenter GUI to Script Automation Overview

Extremely easy to create Spirent TestCenter automated test configuration.

Extremely easy to create a complete Spirent TestCenter automated test.

Automation skills NOT required.

Reduce time for writing a test case.

Minimizing errors in writing test scripts manually.

8


GUI to Script Limitations

Hard coded scripts.


Must use the Command Sequencer in the GUI in order to have a complete Spirent TestCenter automated test.

9


Spirent TestCenter Test ConfigurationSpirent TestCenter GUI to Script Automation Overview

10


Test Configuration Script GenerationSpirent TestCenter GUI to Script Automation Overview

11


Additional Automation Processing Options*Spirent TestCenter GUI to Script Automation Overview

12


Naming the ScriptsSpirent TestCenter GUI to Script Automation Overview

13


Generated FilesSpirent TestCenter GUI to Script Automation Overview

The Launcher script sources the Logic script.

The Logic script configures the test, executes the test, may send the traffic, may gather the results and disconnects from the chassis.

The XML file contains configuration data*.

14


Executing a GUI to Script Test You will execute your scripts generated by the GUI to Script feature

from an environment Shell (Tcl/Ruby/Perl).


With Tcl for example, you can execute the Launcher script either from a DoS prompt:>tclsh <Launcher Script Name>.tcl

>tclsh Save_Tcl.tcl

Or, from the Tcl Shell using the source command:% source <Launcher Script Name>.tcl

% source Save_Tcl.tcl

15


Script ResultsSpirent TestCenter GUI to Script Automation Overview

16


GUI to Script Content17





HLTAPI


18


GUI to Script Generated Files

Save As Script Menu item generates:

GUI to Script Contents

<Name>.tcl/pl/rb (Launcher file) <Name>_logic.tcl/pl/rb (Logic file) <Name>.xml (Configuration file)*.

19


Logic Script

Logic file contains the following procedures: init - Sets logging level and file locations configResultLocation - Sets the Results Location configMiscOptions - Sets the Sequencer to Stop on Error config - Defines configuration/Sets Port locations/Specifies the protocol

stack linkages for both the stream blocks and any configured protocols connect - Connect to the Chassis/Reserve Ports/Map Logical to Physical Ports apply - Download the Test Configuration to the Chassis run - Subscribe to Results/Start the Command Sequencer cleanup - Release Ports/Disconnect from Chassis/Reset Configuration


20


Configuration XML File

When Configuration XML file is created:

XML file contains all of the test configuration definitions.

Logic Script contains all the same procedures (init, config, run, etc.), however, these procedures do not contain test configuration definitions since the definitions are passed from the XML file, making the Logic file much smaller in size.

You can open the XML file in the GUI allowing a Script to GUI configuration.


21


Launcher File Launcher file: Calls in the Logic script Invokes procedures defined within the Logic script Passes Chassis/Slot/Port List into the config procedure Returns test status


22

Essentials of Spirent TestCenter GUI to Script AutomationAdditional Processing Options

23





HLTAPI


24


Additional Automation Processing Options*Additional Processing Options

25


Script to Run Before Disconnect Populating the Script to Run Before Disconnect will:


Run the stated script before the disconnecting from the Spirent TestCenter chassis.

Use these scripts to perform actions such as checking device status.

26


Prefix Procedures Populating the Prefix Procedures with will:


Add stated name to prefix of all procedures within the Logic script. Add stated name to prefix of all procedure calls within the Launcher script.

27


Encapsulate Procedures Populating the Encapsulate Procedures in Namespace will:


Encapsulate all procedures within the Logic script. Add stated namespace to the Launcher script.

28


Do Not Save Default Values Unchecking the Do Not Save Default Values will:


Present all Objects within the Logic script. Doubles the size of the Logic Script.

29


Use Default Values for Rarely Modified Settings Checking the Use Default Values for Rarely Modified Settings will:


Further reduce the size of the Logic Script.

30


Save the Configuration Data in XML File Using the Save the Configuration Data in Separate XML File will:


Create an XML File that contains the test configuration data. Allows XML File to populate GUI.

31


Create Custom Launcher Script If you use Create Custom Launcher Script you must:


Retrieve parameters using the following Tcl call: $stc::scriptParameters(-varName)

32


File Path Substitutions Using Create basePathMap Variable with the Following

Replacements will:


Allow you to create a Replace/With Table that is inserted into Launcher Script.

33

Essentials of Spirent TestCenter GUI to Script AutomationHLTAPI

34





HLTAPI


35


Spirent HLTAPI Description Spirent HLTAPI (High Level Test API) is designed to hide the lower

level APIs of Spirent TestCenter. This greatly reduces the need for any test script changes if there are changes to Spirent's lower level APIs in newer releases.

Spirent HLTAPI supports Tcl, Perl and Python. Depending on automation preferences or requirements, test specialists can use any of these languages for tests.

Spirent HLTAPI is a self-contained package built on top of the Spirent TestCenter native API library. In order to use the Spirent HLTAPI, the Spirent TestCenter native API library is required.

HLTAPI

36


Download Spirent TestCenter HLTAPI Download the Spirent TestCenter HLTAPI from

support.spirent.com

Install Spirent TestCenter HLTAPI

37


Unzip HLTAPI Install Spirent TestCenter HLTAPI

Unzip the downloaded HLTAPI package to a folder (such as C:/HLTAPI_4.52_GA).

38


Modify TCLLIBPATH

Add the “C:/HLTAPI_4.52_GA/SourceCode” into the Windows Environment Variable TCLLIBPATH.


39


Verify Installation Launch a Tcl shell and type “package require SpirentHltApi”. The

version information indicates that you have successfully installed HLTAPI.


40


Register HLTAPI in Spirent TestCenter To register the Save as HLTAPI tool in Spirent TestCenter: Launch Spirent TestCenter. From the menu bar, select Tools > Options >

Tcl/Tk to make sure the Tcl/Tk installation path is correct (C:\Tcl).


41


Register HLTAPI in Spirent TestCenter Continued Launch the command line window and type the following command: tclsh C:\HLTAPI_4.52_GA\SourceCode\tools\toolRegister.tcl 4.56


Ensure the .property file (C:\HLTAPI_4.52_GA\SourceCode\tools) is NOT “Read-only”.

42


Close Spirent TestCenter Close Spirent TestCenter GUI.


This completes the installation of the Spirent TestCenter HLTAPI.43


HLTAPI Documentation HLTAPI Documentation is located in the folder of

C:\HLTAPI_4.52_GA\UserDoc after HLTAPI installation.


44


Launch the Save as HLTAPI Wizard Open Spirent TestCenter. In the menu bar, go to Tools > Custom Tools, and click Save as

HLTAPI.

Save as HLTAPI Wizard

45


Save as HLTAPI WizardSave as HLTAPI Wizard

46


Save as HLTAPI Wizard Options See Appendix A within the STC Automation HLTAPI Command

Reference for definitions of the Wizard Options.


47


HLTAPI Limitations

The arguments of HLTAPI do not have a one-to-one correlation with Spirent Test Center's native API objects.

Some functions and arguments are not supported by Save as HLTAPI. In these cases, you would have to modify the script manually.


48


Save as HLTAPI for Tcl

Select radio button HLTAPI for Tcl (default)

Select the Browse button

Select a file folder

Select the Generate button

HLTAPI for TCL

49


Save as HLTAPI for Tcl Select Yes if you wish to view the generated script.

HLTAPI for TCL

50


Execute HLTAPI Tcl Script Make sure the test ports are available and source the generated

script in Tcl shell: source Test_hltapi.tcl

HLTAPI for TCL

51


Save as HLTAPI for PerlHLTAPI for Perl

Select radio button HLTAPI for Perl




52


Save as HLTAPI for PerlHLTAPI for Perl

Select Yes if you wish to view the generated script.

53


Setup HLTAPI Perl Execution Environment Install Perl in a folder such as C:\Perl.

HLTAPI for Perl

Copy the HLTAPI for Perl library files, hltapiserver.srv and sth.pm (from the SourceCode\hltapiForPerl folder) to your Perl library such as C:\Perl\site\lib.

Perl LibraryC:\Perl\site\lib

54


Setup HLTAPI Perl Execution Environment Continued Add the variable value C:/Tcl/bin/tclsh (no quotation marks) into

the Windows Environment Variable STC_TCL.

HLTAPI Perl requires this environment variable.

HLTAPI for Perl

55


Execute HLTAPI Perl Script Make sure the test ports available and run HLTAPI for Perl script:

perl Test_hltapi.pl

HLTAPI for Perl

56


Save as HLTAPI for PythonHLTAPI for Python

Select radio button HLTAPI for Python




57


Save as HLTAPI for PythonHLTAPI for Python

Select Yes if you wish to view the generated script.

58


Setup HLTAPI Python Execution Environment Install Python in a folder such as C:\Python27.

HLTAPI for Python

Copy the HLTAPI for Python library files, hltapiserver.srv and sth.py (from \SourceCode\hltapiForPython) to your Python library such as C:\Python27\Lib.

Python LibraryC:\Python27\Lib

59


Setup HLTAPI Python Execution Environment Add the C:/Tcl/bin/tclsh (no quotation marks) into the Windows

Environment Variable STC_TCL. HLTAPI Python requires this environment variable.

HLTAPI for Python

60


Execute HLTAPI Python Script Make sure the test ports available and run HLTAPI for Python script:

python Test_hltapi.py

HLTAPI for Python

61


© Spirent Communications, Inc. All of the company names and/or brand names and/or product names and/or logos referred to in this document, in particular the name “Spirent” and its logo device, are either registered trademarks or trademarks pending registration in accordance with relevant national laws. All rights reserved. Specifications subject to change without notice

spirent.com

Thank You

62

Essentials of Spirent TestCenter GUI to Script Automation · The Essentials of Spirent TestCenter...

Documents

Transcript of Essentials of Spirent TestCenter GUI to Script Automation · The Essentials of Spirent TestCenter...