Installation Guide Spirent iTest ®
Release 8.5 Rev B
April 2021 Spirent Communications, Inc. 27349 Agoura Road Calabasas, CA 91301 USA Copyright © 2021 Spirent Communications, Inc. All Rights Reserved. All of the company names and/or brand names and/or product names referred to in this document, in particular, the name “Spirent” and its logo device, are either registered trademarks or trademarks of Spirent plc and its subsidiaries, pending registration in accordance with relevant national laws. All other registered trademarks or trademarks are the property of their respective owners. The information contained in this document is subject to change without notice and does not represent a commitment on the part of Spirent Communications. The information in this document is believed to be accurate and reliable, however, Spirent Communications assumes no responsibility or liability for any errors or inaccuracies that may appear in the document. Limited Warranty Spirent Communications, Inc. (“Spirent”) warrants that its Products will conform to the description on the face of order, that it will convey good title thereto, and that the Product will be delivered free from any lawful security interest or other lien or encumbrance. Spirent further warrants to Customer that hardware which it supplies and the tangible media on which it supplies software will be free from significant defects in materials and workmanship for a period of twelve (12) months, except as otherwise noted, from the date of delivery (the “Hardware Warranty Period”), under normal use and conditions. To the extent the Product is or contains software (“Software”), Spirent also warrants that, if properly used by Customer in accordance with the Software License Agreement, the Software which it supplies will operate in material conformity with the specifications supplied by Spirent for such Software for a period of ninety (90) days from the date of delivery (the “Software Warranty Period”). The “Product Warranty Period” shall mean the Hardware Warranty Period or the Software Warranty Period, as applicable. Spirent does not warrant that the functions contained in the Software will meet a specific requirement or that the operation will be uninterrupted or error free. Spirent shall have no warranty obligations whatsoever with respect to any Software which has been modified in any manner by Customer or any third party. Defective Products and Software under warranty shall be, at Spirent's discretion, repaired or replaced or a credit issued to Customer's account for an amount equal to the price paid for such Product provided that: (a) such Product is returned to Spirent after first obtaining a return authorization number and shipping instructions, freight prepaid, to Spirent's location in the United States; (b) Customer provides a written explanation of the defect or Software failure claimed by Customer; and (c) the claimed defect actually exists and was not caused by neglect, accident, misuse, improper installation, improper repair, fire, flood, lightning, power surges, earthquake, or alteration. Spirent will ship repaired Products to Customer, freight prepaid, based on reasonable best efforts after the receipt of defective Products. Except as otherwise stated, any claim on account of defective materials or for any other cause whatsoever will conclusively be deemed waived by Customer unless written notice thereof is given to Spirent within the Warranty Period. Spirent reserves the right to change the warranty and service policy set forth above at any time, after reasonable notice and without liability to Customer. TO THE EXTENT PERMITTED BY APPLICABLE LAW, ALL IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE, ARE HEREBY EXCLUDED, AND THE LIABILITY OF SPIRENT, IF ANY, FOR DAMAGE RELATING TO ANY ALLEGEDLY DEFECTIVE PRODUCT SHALL BE LIMITED TO THE ACTUAL PRICE PAID BY THE CUSTOMER FOR SUCH PRODUCT. THE PROVISIONS SET FORTH ABOVE STATE SPIRENT'S ENTIRE RESPONSIBILITY AND CUSTOMER'S SOLE AND EXCLUSIVE REMEDY WITH RESPECT TO ANY BREACH OF ANY WARRANTY.
Contents
iTest System Requirements ...... 7 Hardware requirements, Linux, Microsoft Windows, macOS...... 7 Supported Operating Systems and other configurations ...... 7 X server support ...... 8 Licensing Pre-requisites ...... 8 Spirent and Third-party Software...... 9 Spirent Smartflow support ...... 11 IxNetwork version support ...... 11 iTest Session Profile Interoperability ...... 12 iTest GUI Support Matrix (Windows and Linux)...... 15 Limitations of iTest 8.5 Support for Windows 10 and Windows Server 2019 ...... 21 iTest Installation...... 23 Installing iTest on Microsoft Windows ...... 23 What is installed ...... 23 Before you begin ...... 24 Installing iTest on Windows...... 25 Installing iTest on Linux Systems ...... 29 Additional settings required to execute iTest Sessions on Linux...... 29 What is installed ...... 30 Updating the external test report database ...... 31 Licensing ...... 31 Support for the installation process ...... 31 Getting to the release notes ...... 31 To install iTest on Linux...... 31 Installing iTest on Apple macOS ...... 35 Installing iTestRT (Linux and Windows) ...... 38
Migrating iTest Workspaces to New Versions of SVN ...... 41 Replace Old Working Copy with a New Working Copy ...... 41 Replace Old with a New Working Copy and Rename it...... 42
Troubleshooting Installation Issues...... 45 Follow this procedure if installation fails or un-installation of an earlier version fails: ...... 45 Linux ...... 45 Windows ...... 45 Updating iTest using the update site for All users requires additional actions...... 46
Installing iTest at a Central Location ...... 47 Advantages of central access to iTest...... 47 Disadvantages...... 47 Updating the external test report database ...... 47 Installation instructions ...... 47
Configuring the iTest Update Site and Upgrading from the Update Server . . . 49 Setting up the iTest update site ...... 49 Updating iTest from the Update Site ...... 50
3 iTest Installation Guide
Updating the external test report database ...... 50 Updating iTestRT...... 50 Updating iTest using a (local) update file ...... 50 Updating iTest ...... 51 Using the Update Site to update iTest...... 53 Getting to the release notes ...... 54 Updating iTestRT from the Update Site...... 54 To update iTestRT...... 54
Installing/Updating Independently Released Software ...... 59 To Install/Update Independently Released Software...... 59 Installation Steps: ...... 60 Install a new software ...... 61 Update an existing software ...... 61 Revert changes or Uninstall a software...... 62 Using iTestRT to Install / Update / Uninstall Independently Release Software ...... 63
Installing Spirent Traffic Generators ...... 65 Installing Spirent Avalanche software for use with iTest ...... 65 Overview ...... 65 Installing Spirent Avalanche ...... 65 Restart/Reset/Refresh Avalanche ...... 65 Installing Spirent TestCenter™ software for use with iTest ...... 67 About the bll.log file ...... 69 Installing Spirent Landslide™ NTAF software for use with iTest ...... 70 Configuring Landslide for operation with iTest ...... 70 Installing the NTAF server and starting the NTAF proxy...... 73
Installing Ixia Traffic Generators ...... 77 Installing Ixia (formerly Agilent) QuickTest Software for Use with iTest ...... 77 Installing Ixia N2X on Linux ...... 77 Installing Ixia QuickTest on Microsoft Windows ...... 78 Installing Aptixia IxLoad software for use with iTest ...... 80 Installing supporting software on Linux ...... 80 Configuring Ixia IxOS 9.01 GA for use with iTest ...... 80 Installing supporting software on Microsoft Windows ...... 81 Installing AptIxia IxNetwork software for use with iTest...... 83 Installing Ixia IxOS on Linux ...... 83 Installing Ixia IxOS on Microsoft Windows...... 83 Installing IxiaTraffic software for use with iTest ...... 84 Installing Ixia IxOS on Linux ...... 84 Installing Ixia IxOS on Microsoft Windows...... 85
Installing Quality Management Integration ...... 87 Installing the iTest adapter for IBM Rational Quality Manager...... 87 Install RQM adapter for Server version 6.0.1, 6.0.2 or higher ...... 87 Install RQM adapter for Server version prior to 6.0.1 ...... 89
Installing NTAF Server...... 91 Instructions for configuring NTAF servers ...... 91 To specify the NTAF installation directory...... 91 Overview: Multiple host setup ...... 92 Multiple host architecture, Landslide ...... 92 GUI capture compared with execution/replay ...... 93
4
Install iTest Test Report Database ...... 95 Setting up a MySQL database for use with iTest...... 95 Updating the test report database for new releases of iTest ...... 98
Configuration Tips ...... 99 iTest Selenium—IE settings to Replay Selenium Test Case ...... 99 Security Settings for IE ...... 100
How to Contact Us ...... 103
5 iTest Installation Guide
6 C H A P T E R 1 iTest System Requirements
Hardware requirements, Linux, Microsoft Windows, macOS
Single iTest user 64-bit Systems
Hardware Minimum Requirement Recommended Requirement
CPU Intel Processor, 2.10 GHz or faster Intel Processor, 2.90 GHz or faster processor processor
Memory 4GB RAM 8GB RAM
Disk space required 20GB 40GB (for installation and utilization)
Multiple iTest users Multiply the (single-user) memory requirement by the number of number of expected concurrent users.
Note iTest requires a minimum of 1.5GB of free disk space for installation. The total disk space requirement varies based on the usage. It is recommended that a minimum of 20GB disk space be allocated for a single user installation and 500GB or more disk space for multi user installations.
Supported Operating Systems and other configurations All iTest regression, stress, and performance tests run on the following system configurations:
OS Product Windows Linux Mac
OS Flavor iTest 64-bit Windows 10 Pro 64-bit RHEL 7.6 (64-bit) macOS Catalina Windows Server 2019 (64-bit) Ubuntu 20.04 LTS (64-bit)
iTestRT 64-bit Windows 10 Pro 64-bit RHEL 7.6 (64-bit) N/A Windows Server 2019 64-bit Ubuntu 20.04 LTS (64-bit)
Java Version used to RUN iTest SE 11 SE 11
Java Version used to COMPILE SE 11 SE 11 SE 11 iTest
Eclipse Version 4.15 4.15 4.15
Tcl Version 8.4, 8.5, 8.6.10 8.4, 8.5, 8.6.10 8.4, 8.5, 8.6.10
7 iTest Installation Guide
OS Product Windows Linux Mac
vSphere ESXi Server 6.7
vSphere Client 6.7 Windows 10 Pro (64-bit)
vSphere Web Client 6.7 (a subset RHEL 7.6 (64-bit) Not applicable of vSphere Client) Ubuntu 20.04 (64-bit)
X server support Certain Linux users use X servers to display the iTest GUI on a different computer than where iTest is actually running. There are many X servers available and Spirent does not test every X server. Spirent supports iTest on standard X servers installed on RHEL 7.6. iTest should work on other X servers, but we cannot vouch for the stability of iTest on these other X servers.
Licensing Pre-requisites iTest implements a Date Based Version (DBV) system to determine the software release version and whether you are allowed to use the latest iTest release version. The following table lists where the release version may be found, how you may determine the current release version in your environment, and whether you may proceed with the install or upgrade process.
Important It is recommend that not to proceed with product installation or upgrade until this determination has been made.
Where is the version number? The the version number exists in the following two locations: • In the product software, which indicates the version number and the date released (for example, 2021.04 for v8.5) • In the license key on the license server.
How can you determine the License File consists of a number of features, below is the format of the current license DBV on your current license file file(s): and decipher the license type? INCREMENT
INCREMENT SUPPORT_ENTITLEMENT_ITEST spirentd 2021.04 permanent 1 • For a subscription license, you will see a date that indicates the validity.
INCREMENT SUPPORT_ENTITLEMENT_ITEST spirentd 2021.04 15-april-2021 5 What is the current release DBV format is YYYY.MM for each release based on the year and month of the release. format Important The product can be upgraded only if license file DBV >= product release DBV
8 Chapter 1 iTest System Requirements
Spirent and Third-party Software
Note “Supported” means that iTest will run with the specified version of software and Spirent will provide full support for the integration.
Tip Review this chapter and use the Install/Upgrade column to verify that the software requirements are met in your environment before installing or upgrading iTest. Incompatible software may impact functionality.
Linux Windows macOS Install/ Upgrade
Browsers
Internet Explorer IE11 fix 4056568 N/A Supported
FireFox: v52.6 ESR (non-ESR versions are not officially supported) Supported Supported Supported Note To ensure iTest interoperability does not break, disable Firefox auto-update. See https://support.mozilla.org/en-US/kb/how-stop-firefox-makin g-automatic-connections.
Chrome: v84-89 Supported Supported Supported
Tcl Interpreters
You must install Tcl to use iTest with any traffic generation software. Agilent has been tested with Tcl 8.4 only.
ActiveTcl 8.4, 8.5, 8.6.10 Supported Supported Not Supported
Python Interpreters
Python 3.8.5 Supported Supported Supported
Test report database support
MySQL Server 5.1, 5.5, 5.7 Supported Supported Supported
Oracle Database —Oracle 11g Express Supported Supported Supported
License Server
FLEXnet 11.16.6 - Linux and Windows Supported Supported N/A (See also APT License Server Installation Guide)
(Continued)
9 iTest Installation Guide
Linux Windows macOS Install/ Upgrade
Spirent Traffic Generators
All traffic generator sessions are not based on REST require TCL to be installed. Supported Tcl 8.4.19. iTest / Spirent Avalanche sessions on: Supported Supported Not Spirent Avalanche: 5.18 Supported iTest / Spirent Landslide sessions: Supported Supported Supported Certification for Spirent Landslide REST: 20.0 GA
Certification for Spirent Landslide NTAF: 20.0 GA Not Supported
Spirent TestCenter sessions on: Supported Supported Supported Spirent TestCenter REST 5.19
Spirent TestCenter 5.19 Not Supported
CyberFlood sessions on: Supported Supported Supported CyberFlood 21.1
Spirent TestCenter cards 12 Port 10/100/1000 Dual Media Rev B\EDM-2003B
TestCenter CLI sessions 4.69, 4.66 Deprecated Supported on TestCenter Important This session type is deprecated. We strongly 4.20 and 4.15 recommend that you migrate existing test cases to the TestCenter session type.
TestCenter NTAF sessions on Deprecated TestCenter 4.53, 4.47 Supported on TestCenter 4.53, 4.47, 4.30 and 4.20
Spirent Smartflow 5.6.005.1 Not See Supported “Spirent Smartflow support”, page 11
(Continued)
10 Chapter 1 iTest System Requirements
Linux Windows macOS Install/ Upgrade
Ixia Traffic Generators
You must install Tcl to use iTest with any traffic generation software. IxiaOS 5.0, 4.1, and 4.0 have been tested with Tcl 8.4 only. ixOS (ix Traffic)
9.10 EA (Windows), 9.10 (Linux) Supported Supported Not Supported ixNetwork
9.10 EA (Windows), 9.10 (Linux) Supported Supported Not Supported ixNetwork REST
9.10 EA (Windows), 9.10 (Linux), 9.10 macOS Catalina Supported Supported Supported ixLoad
9.10 EA (Windows), 9.10 (Linux) Supported Supported Not Supported ixLoad REST
9.10 EA (Windows), 9.10 (Linux), 9.10 macOS Catalina Supported Supported Supported ixN2X Packets and Protocols (formerly Agilent N2X) - End of Life, no longer supported
IBM Rational
Rational Quality Management 6.0.4 N/A Supported Not Supported
Rational Functional Tester 8.1 N/A Supported Not Supported
Spirent Smartflow support
Supported Test types for basic workflow (traffic Test types that are not supported: generation)
• Frame Loss • Latency Snap Shot • Jitter • Latency Distribution • Latency Over Time • Multiple flow testing with different test types in a single • Jumbo SAI file is not supported • Latency • Log and CSV files are not generated properly for Smartflow SAI files • Throughput • Smart Tracker
IxNetwork version support The IxNetwork Tcl Automation software was re-written for version IxNetwork 5.40. To enable iTest to use the new IxNetwork APIs, you can use the following new session profile property setting (in the IxNetwork property group) to specify the IxNetwork API version.
11 iTest Installation Guide
iTest Session Profile Interoperability
Linux Windows macOS Install/Upgrade
Ranorex sessions
Ranorex v9.3.2 Not Supported Supported Not Supported Internet Explorer 11 Not Supported Supported Capture and execution (replay)
All Firefox 52.6 ESR Not Supported Supported Capture and execution (replay) (See Note below)
Chrome v80+ Supported Supported Capture and execution (replay)
Flex Script 3.4, 3.5 and 4.5 Supported Supported Not Supported
Selenium sessions
Internet Explorer 11 fix 4056568 Not Supported Supported Not (without vulnerability to Meltdown and Spectre) Supported Execution (replay) only Note Selenium playback/replay is not supported on Windows IE, when Velocity Agent is installed as a service.
Firefox (Windows) v52.6 ESR (without vulnerability to Supported Supported Meltdown and Spectre) (non-ESR versions are not officially supported) Capture and replay Firefox (Linux) v52.6 ESR (without vulnerability to Meltdown and Spectre) (non-ESR versions are not officially supported) Capture and execution (replay)
Firefox (macOS) v52.6 ESR Not Supported
Chrome v84 - 89 Supported Supported Supported Chrome v84+ (without vulnerability to Meltdown and Spectre)
Capture only: Supported Supported Not Selenium IDE 3.2.4 Supported For execution (replay): IE WebDriver:3.8.0 Firefox WebDriver: 2.53 Chrome Driver 2.29 Selenium-java 2.53
Note Firefox ESR versions are not correctly instrumented using the instrumentation wizard. In order to use Firefox ESR, follow these steps. (See https://www.ranorex.com/forum/) • Install Firefox non-ESR in parallel to Firefox ESR • Instrument Firefox non-ESR using the Ranorex Instrumentation Wizard/tool • Drag the Ranorex Firefox extension from the Ranorex installation folder into Firefox ESR and accept installation in Firefox • Uninstall the non-ESR Firefox version.
continued
12 Chapter 1 iTest System Requirements
Linux Windows macOS Install/Upgrade
Selenium Grid
Internet Explorer 11 fix 4056568 (without vulnerability to Not Supported Supported Not Meltdown and Spectre) Supported Grid Replay
Firefox (Windows) 52.6 ESR (without vulnerability to Meltdown Not Supported Supported Not and Spectre) Supported (all non-ESR versions are not officially supported)
Firefox (Linux) v52.6 ESR (without vulnerability to Meltdown and Supported Not Supported Not Spectre) Supported (non-ESR versions are not officially supported) Capture and execution (replay)
Chrome v84+ (without vulnerability to Meltdown and Spectre) Supported Supported Supported (Driver 2.29)
Python Sessions —Python version 3.8.5 Supported Supported Supported Python Automation Library—Python SpirentSLC-8.5 compatible with Python 3.8.5 versions
VM Ware Sessions Supported Supported Not VMware 6.7 (VMware standalone) Supported vSphere Client 6.7 vSphere Web Client 6.7 (a subset of vSphere Client): Linux Note The vSphere client must be installed on your machine, to ensure that the vSphere sessions run as expected.
Sessions N/A Supported N/A Flash/FLEX 3.4, 3.5, and 4.5
BASH Sessions Supported Not Supported Supported
SNMP sessions Supported Supported Supported iReasoning 5.0.27 (in iTest)
WireShark Sessions Supported Supported Supported WireShark 3.2.4 WinPCap 4.1.1
OpenStack REST API v2 Supported Supported Not Supported
Eggplant 18.0.5 Not Supported Supported Not Supported
CloudStress 2279 or higher Supported Supported Supported
ADB Supported Supported Not Supported
Spirent Netconf Supported Supported Not Supported
continued
13 iTest Installation Guide
Linux Windows macOS Install/Upgrade
Zephyr Integration Supported Supported Not JIRA v6.4.12; ZAPI add-on 1.6.0.16002096 Supported Zephyr for JIRA add-on 2.6.3.26302127
VNC Servers Supported Supported Not RealVnc_5.2.2, RealVnc_5.2.3, RealVnc_5.3.0 Supported Supported RFB protocol versions: 3.3, 3.7, 3.8 Supported security types (authentication): None, VNC Authentication
The table below shows compatibility between browser, web driver to replay and Selenium IDE to capture.
Browser Replay: Web driver Type Capture: Selenium IDE type
Firefox 52.6 ESR FireFox driver Selenium IDE v3.2.4
Chrome 84-89 Chrome driver n/a
Internet Explorer 11 IE driver n/a
Firefox 52.6 ESR (supported Gecko driver (implemented, but not Selenium IDE v3.1.1 version in iTest) tested yet) Selenium IDE v2.9.3 is not FireFox driver is not supported for this supported for this version version
Chrome 84-89 (supported Chrome driver Selenium IDE v3.2.4 version in iTest)
Internet Explorer 11 (supported IE driver n/a version in iTest)
Important To support new version of FireFox need to use only new type of web driver and new type of Selenium IDE. This is potential source of new bugs and problems.
14 Chapter 1 iTest System Requirements iTest GUI Support Matrix (Windows and Linux)
Note “Supported” means that iTest will run on the platform and Spirent will provide support for the platform. Some platforms have specified limitations.
iTest 8.5 is built using Eclipse, which is supported on many other platforms. Users should therefore not have problems running Spirent iTest on unsupported platforms that are supported by Eclipse. Because Spirent does not systematically test the other platforms, however, we cannot vouch for them.
Tip To determine which version of Red Hat Linux is installed, type the following command at the shell: > cat /etc/redhat-release
The table below lists the iTest sessions supported on 64-bit Microsoft Windows OS, Windows Server 2019, and Linux OS.
“CLI Sessions”, page 16 “Enterprise Sessions”, page 19
“Protocol Sessions”, page 17 “Traffic Generator Sessions”, page 20
“GUI Sessions”, page 18 “Non-Session Features”, page 21
Note The session types list all the sessions and indicates on which Microsoft Windows OS, architecture, and product (iTestRT 64-bit) they are supported as follows. For iTest GUI, iTest RT, and Agent 32/64bit • Y: Complete support on current OS • N: Not supported • (**): Including IxTraffic, IxNetwork, IxLoad • (*1): No support for iTest GUI 64 bit • (*2): Limited support for iTest GUI 64 bit • (*3): No support for iTest RT 64bit • (*4): No support for Velocity Agent 64 bit • (*5): Limited support for Velocity Agent 64 bit • (*6): Support Firefox and Chrome and not IE • (*7): Limited support for STC commands • (*8): Not certified • (*9): iTest STC v5.03 UI does not support MX2-11AX-2 • (*10): Landslide REST command ConfigureTestcaseFavoriteParameters displays updated response. • (*11) Without TCL-Based Ixia
15 iTest Installation Guide
CLI Sessions See note on page 15 for a description of the support matrix.
OS Type CLI Sessions
Name Arch Telnet SSH CMD Serial Bash Process File Syslog TCL Python
Windows
Windows x64 Y Y Y Y (*8) N Y Y Y Y Y Server 2019
Windows x64 Y Y Y Y N Y Y Y Y Y Pro 10
Linux
RHEL7.6 x64 Y Y N N Y Y Y Y Y Y
Ubuntu x64 Y Y N N Y Y Y Y Y Y 20.04 macOS x64 Y Y N N Y Y Y N N Y Catalina
16 Chapter 1 iTest System Requirements
Protocol Sessions See note on page 15 for a description of the support matrix.
OS Type Protocol Sessions
Name Arch SNMP HTTP UDP XMPP Wireshark
Windows
Windows Server x64 Y Y Y Y Y 2019
Windows Pro 10 x64 Y Y Y Y Y
Linux
RHEL7.6 x64 Y Y Y Y Y
Ubuntu 20.04 x64 Y Y Y Y Y macOS Catalina x64 Y N N N Y
17 iTest Installation Guide
GUI Sessions See note on page 15 for a description of the support matrix.
OS Type GUI Sessions
Name Arch Selenium Swing Ranorex VNC RFT Chat-XMPP
Windows
Windows x64 Y Y Y Y N Y Server 2019
Windows Pro x64 Y Y Y Y N Y 10
Linux
RHEL7.6 x64 Y Y N Y N Y
Ubuntu 20.04 x64 Y Y N Y N Y
macOS x64 Y (Chrome N N N N N Catalina only)
18 Chapter 1 iTest System Requirements
Enterprise Sessions See note on page 15 for a description of the support matrix.
OS Type Enterprise Sessions
Name Arch VM Mail Mail Data Web XML- REST Eggplant ADB OpenStack CloudStress ware (SMTP) (POP3) base services RPC Neutron
Windows
Windows x64 Y Y Y Y Y Y Y Y Y (*8) Y Y Server 2019
Windows x64 Y Y Y Y Y Y Y Y Y (*8) Y Y Pro 10
Linux
RHEL 7.6 x64 Y Y Y Y Y Y Y N Y (*8) Y Y
Ubuntu x64 Y Y Y Y Y Y Y N Y (*8) Y Y 20.04 macOS x64 N N N N N N Y N N N Y Catalina
19 iTest Installation Guide
Traffic Generator Sessions See note on page 15 for a description of the support matrix.
OS Type Traffic Generator Sessions
Name Arch STC STC Avalanche CyberFlood Landslide Landslide Ixia (**) REST NTAF REST (*10)
Windows
Windows x64 Y (*7)(*9) Y (*9) Y Y Y Y Y Server 2019
Windows x64 Y Y (*9) Y Y Y Y Y Pro 10 (*7)(*9)
Linux
RHEL7.6 x64 Y Y (*9) Y Y Y Y Y (*7)(*9)
Ubuntu x64 Y Y (*9) Y Y Y Y Y 20.04 (*7)(*9)
macOS x64 N Y (*9) N Y N Y Y (Ixia Catalina REST)
20 Chapter 1 iTest System Requirements
Non-Session Features See note on page 15 for a description of the support matrix.
OS Type Non-session features
Name Arch RQM Zephyr Session Builder
Windows
Windows x64 Y(*8) Y Y (*8) Server 2019
Windows x64 Y(*8) Y Y (*8) Pro 10
Linux
RHEL 7.6 x64 Y(*8) Y Y(*8)
Ubuntu x64 Y(*8) Y Y (*8) 20.04
macOS x64 N N Y Catalina
Limitations of iTest 8.5 Support for Windows 10 and Windows Server 2019
Serial Port sessions Test cases require a workaround (due to serial device behavior): For exit steps in a captured test case, modify the following properties in the Serial command properties > Completion property group: • Uncheck Wait for first character before starting idle • Set the Completion criteria property to: Prompt matches OR device has not sent data during the idle channel interval
21 iTest Installation Guide
22 C H A P T E R 2 iTest Installation
Note iTest installer (Windows and Linux) includes PyDev (Python IDE) and RED (Robot Editor) plugins for your ease of work. See the following for more details: PyDev: https://marketplace.eclipse.org/content/pydev-python-ide-eclipse
RED: https://marketplace.eclipse.org/content/red-robot-editor
iTest Installer for macOS does not include PyDev (Python IDE). If required, install PyDev plugin on macOS as per the instructions in https://www.pydev.org/manual_101_install.html, section Installing with the update site.
This chapter describes steps for installing iTest and iTestRT on these environment.
“Installing iTest on Microsoft Windows” on page 23
“Installing iTest on Linux Systems” on page 29
“Installing iTest on Apple macOS” on page 35
“Installing iTestRT (Linux and Windows)” on page 38
Installing iTest on Microsoft Windows Spirent recommends that you upgrade all instances of iTest at the same time to avoid licensing or file sharing issues. Spirent strongly recommends that you uninstall earlier versions of iTest. The installer performs a clean uninstall of earlier versions before starting the installation process.
Note Most install iTest Enterprise on developers’ computers for authoring test cases and iTestRT on regression hosts for headless execution. To ensure fastest installation, iTest and iTestRT are delivered in separate downloads. Each must be installed separately. Instructions for installing iTestRT appear later in this chapter, in section “Installing iTestRT (Linux and Windows)” on page 38.
What is installed The following applications are installed as described in this chapter:
iTest is a stand-alone GUI (graphical user interface) application
iTestRT is a separate installer and described in described later in this Chapter in “Installing iTestRT (Linux and Windows)” on page 38.
iTestCLI is an early command line version of iTest used for headless execution. It has been deprecated and we strongly recommend that you use iTestRT instead.
23 iTest Installation Guide
Before you begin This section lists the tasks performed before you install. See APT License Server Installation Guide.
IMPORTANT: If you are updating iTest and you use a license server for end-user licensing The upgrade process does not preserve the licensing settings (it deletes the licensing settings). Perform the following before upgrading: Take note of the IP address or hostname of the license server:
1 In iTest, click Help > Configure iTest Licensing
2 On the iTest Licensing page, click the License Sources tab.
3 Take note of the Host name — you will use the name or IP address to configure the upgraded software.
4 Make a note of the Port number if it is not the default Port.
Updating the external test report database If you store iTest test reports in a centralized external database (instead of the built-in database), then follow the instructions in, Chapter 12, “Install iTest Test Report Database”, section “Updating the test report database for new releases of iTest” on page 98.
Licensing VMs (for example, Windows Remote Desktop) are not supported. See APT License Server Installation Guide.
Windows: iTest over VPN is not supported
NAT addresses are not supported
Support for the installation process If you have any questions or encounter errors during the installation process, contact Spirent Customer Support at [email protected]. If possible, please include the text and/or a screen shot of the error messages to speed up the support process.
24 Chapter 2 iTest Installation
Getting to the release notes Release notes for iTest are hosted on the Spirent Customer Support Center and include “What’s new in this release” information. At any time while using iTest, click Help > View iTest Release Notes.
Important iTest release 8.5 bundle the tshark/text2pcap binaries with iTest, iTestRT, and Agent installation.
Installing iTest on Windows
Step 1 Optional: Archive your current work It is recommended to save your workspace before upgrading. The upgrade process may modify the working documents and if there is a problem with the upgrade, the archived workspace can be used with the previous iTest version.
Note If you currently store iTest files in a source control system, you do not need to archive your work because you can use the source control system to roll back.
When you complete the update, you’ll import the archived documents into a new workspace so you can continue working on the documents. You’ll use the Export wizard to create the archive.
1 Start iTest and click File > Export. The Export wizard starts.
2 On the Export page, select General > Archive File and then click Next.
3 On the Archive File page:
a Click the Select All button to select all projects. b In the To archive file text box, browse to an appropriate directory and specify a filename for the target archive (zip) file.
25 iTest Installation Guide
c Click Finish. iTest creates the archive file.
4 Exit iTest. Now continue with Step 2 Verify permission settings.
Step 2 Verify permission settings
You must use an account with Administrator privileges to install iTest. You must also log in as administrator when updating iTest or when installing a new plug-in through the update site.
Step 3 Start the iTest Setup wizard
Microsoft Windows
Locate the iTest installation files and then double-click the iTest-8.5.msi file to start the wizard. Use the wizard to install iTest
1 If you are upgrading, then the installer displays dialog boxes confirming that you want to uninstall the currently installed iTest. Click OK in these dialog boxes.
2 On the License Agreement page, select I Accept the terms in the license agreement to agree to the license agreement.
3 Click Advanced or Install buttons.
26 Chapter 2 iTest Installation
Install iTest for...
Current user... Click Install to set up iTest for Current User Only The installation wizard prepares iTest to be used by you, the Current User (the one who performs installation). iTest installs in the following location: C:\Users\
All users of this Click Advanced and the installation wizard displays two options. machine • Install iTest for Current User Only OR • Install iTest for all users of this machine. The installation wizard prepares iTest to be installed based on the option you selected and also provides you with options to choose how you want the features to be installed. • If you select Current User Only, the installation wizard does not provide you with an option to choose installation location. Go to Step 4 (below). • If you select all users of this machine, the installation wizard provides you with an option to change the default installation location. Note: Installing iTest for all users of a machine requires administrative privileges. By default, iTest for use by all users of a machine installs in the following location, which you may change as required: C:\Program Files\Spirent Communications\iTest x.x\ On the Destination Folder page, specify a different installation folder or leave the default folder as is (recommended), and click Next. Go to Step 4 (below).
4 On the Product Features page, select the way you want the features to be installed and then click Install.
Remove the feature options that is not required by clicking the red cross (X) in a drop-down.
27 iTest Installation Guide
5 The Installing iTest page opens. The installation process takes only a few moments.
6 When installation is complete, the Completed the iTest x.x Setup Wizard page opens. Click Finish to close the installation wizard.
7 The User Access Control dialog appears. Click Yes to agree.
8 Start iTest by typing iTest in the Start Menu and press Enter.
9 iTest prompts for workspace location on first start. Enter your workspace location, click OK and start working with iTest.
Note Add the curl.exe binary file to the list of the firewall exceptions to make sure that the REST sessions work as required:
Not adding the curl.exe binary file to the list of firewall exceptions may cause issues if the Windows firewall does not allow any network activities for the external curl executable.
Step 4 Start iTest and configure an end-user account
Important Start iTest while logged in using an account with your normal working privileges. As with any application, if you create a document having logged in using an account with Administrator privileges and then later try to use the document logged in using an account with different privileges, iTest will not allow access to the document.
To configure licensing for an end-user account for iTest, follow the instructions that appear in the Online help for iTest and in the iTest User Guide. If you encounter trouble during installation, see Chapter 4, “Troubleshooting Installation Issues”.
28 Chapter 2 iTest Installation
Installing iTest on Linux Systems Spirent recommends that you upgrade all instances of iTest at the same time to avoid licensing or file sharing issues.
Important Ensure that you have installed Python 3 on you system as iTest Linux installer requires Python 3 to run install and uninstall Python scripts.
Note Most persons install iTest Enterprise on developers’ computers for authoring test cases and iTestRT on regression hosts for headless execution. To ensure fastest installation, the two installers are available as a separate downloads. Instructions appear in “Installing iTestRT (Linux and Windows)” on page 38.
Spirent strongly recommends that you uninstall earlier versions of iTest. The iTest installer performs a clean uninstall of earlier versions before starting the installation process.
Additional settings required to execute iTest Sessions on Linux The following lists additional settings required to execute some iTest sessions on Linux environment and also certain settings for Ubuntu systems.
Set the PS1 For iTest to correctly install on Linux, In some cases, it’s necessary to set the PS1 environment variable to environment $, for example by issuing export PS1="$" from bash. variable
Swing sessions To use Swing sessions in iTest on RHEL and Ubuntu platforms, you must add JAVA_HOME environment variable as follows:
Use "java -XshowSettings:properties -version" command to verify Java installation on Linux platforms.
e.g., java.home = /usr/lib/jvm/java-11-openjdk-amd64 Add JAVA_HOME environment variable in source /etc/environment eg: JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64 Save and reboot the VM.
Wireshark sessions To use Wireshark session on Linux systems you must install Wireshark manually. Important iTest does not support the Tethereal network protocol analyzer. iTest requires you to install tshark/wireshark. • To install Wireshark on Ubuntu enter the following command on the terminal:
$sudo apt-get install wireshark tshark • To install Wireshark on RHEL enter the following command on the terminal:
$su -c "yum install wireshark" Note Ensure that you add Wireshark installation path to the PATH environment variable.
To ensure that Wireshark session terminate properly, install util-linux (Linux utilities) and procps packages (to provide programs to monitor and halt system processes) on your system (if not installed).
• RHEL 7.6: sudo yum install util-linux procps • Ubuntu 20.04 LTS: sudo apt install util-linux procps REST sessions In order to run REST sessions, Linux users are required to install cURL.Follow these instructions to install cURL on RHEL and Ubuntu.
RHEL 7.6: Go to a terminal (CTRL + ALT + T) and install Curl as follows: yum install curl (Refer to http://curl.haxx.se/ for details.).
29 iTest Installation Guide
Ranorex In order to run Ranorex session successfully in iTestRT add the environment variable RanorexPath that includes the Ranorex installation path as value eg: C:\Program Files (x86)\Ranorex\Studio.
Starting iTest on Starting iTestGUI on some Ubuntu systems with Unity as the Desktop environment intermittently displays some Ubuntu the following error: systems LIBDBUSMENU-GTK-CRITICAL **: watch_submenu: assertion `GTK_IS_MENU_SHELL(menu)' failed Workaround: To resolve any such issues while working on some Ubuntu systems with Unity as the Desktop environment, iTestGUI requires you to disable Ubuntu's menu proxy. That is, set UBUNTU_MENUPROXY environment variable as 0. To disable Ubuntu's menu proxy, run iTestGUI form the terminal as shown below.
/itest/gui/folder/ $ UBUNTU_MENUPROXY=0 ./iTest
Important If updating iTest and using a license server for end-user licensing: The upgrade process deletes the licensing settings. To save time when configuring licensing for the upgraded version of iTest, perform the following quick procedure before upgrading: Take note of the IP address or hostname of the license server:
1 In iTest, click Help > Configure iTest Licensing
2 On the iTest Licensing page, click the License Sources tab.
3 Take note of the Host name — you will use the name or IP address to configure the upgraded software. (Make a note of the Port number if it is not the default Port).
See also APT License Server Installation Guide.
What is installed The following applications are installed by the process described in this chapter:
iTest is a stand-alone GUI application (graphical user interface).
iTestRT is the standalone command line (“headless”) version of iTest, described in detail in the Online help and in the iTest User Guide. iTestRT is installed in a separate process as described in “Installing iTestRT (Linux and Windows)” on page 38.
30 Chapter 2 iTest Installation
Updating the external test report database If you store iTest test reports in a centralized external database (instead of the built-in database), then follow the instructions in “Updating the test report database for new releases of iTest” on page 98.
Licensing
VM support: See APT License Server Installation Guide.
Windows: iTest over VPN is not supported
Support for the installation process If you have any questions or encounter errors during the installation process, contact Spirent Customer Support at [email protected]. If possible, please include the text and/or a screen shot of the error messages to speed up the support process.
Getting to the release notes Release notes for iTest are hosted on the Spirent Customer Support Center and include “What’s new in this release” information. At any time while using iTest, click Help > View iTest Release Notes.
To install iTest on Linux
Note The cURL (for use with REST sessions) is not bundled with iTest 8.5 for Linux platform. You have to install cURL separately after installing iTest on Linux.
Step 1 Optional: Archive your current work If you are upgrading from an earlier version of iTest, then, before continuing with the installation process, you have the option to archive your existing work. Because the upgrade process modifies your working documents, the archive will give you the option to return to the earlier version of iTest if you want to roll back from the new version.
Note If you currently store your iTest files in a source control system, you do not need to archive your work because you can use the source control system to roll back.
When you complete the update, you’ll import the archived documents into a new workspace so you can continue working on the documents. You’ll use the Export wizard to create the archive.
1 Start iTest and click File > Export. The Export wizard starts.
31 iTest Installation Guide
2 On the Export page, select General > Archive File and then click Next.
3 On the Archive File page:
a Click the Select All button to select all projects.
b In the To archive file text box, browse to an appropriate directory and specify a filename for the target archive (zip) file.
c Click Finish. iTest creates the archive file.
4 Exit iTest. Now continue with “Install iTest” on page 33.
32 Chapter 2 iTest Installation
Step 2 If you are installing RedHat 7.6 X86-64 (64-bit): Perform the following steps before starting the installation process (run all commands with ROOT privilege):
1 To prevent a Bad ELF Interpreter error when launching the iTest installer from the shell:
yum install glibc.i686 2 To ensure that the installer UI can start, install gtk for i686 and packages for X server:
yum install gtk2.i686 yum install libXtst.i686 yum install libpk-gtk-module.so yum install libcanberra-gtk-module.so 3 Run the following command to improve the appearance of the iTest user interface:
yum install gtk2-engines.i686 Step 3 Install iTest Follow these step-by-step instructions:
Note If you encounter errors during the installation process, contact Spirent Customer Support at [email protected]. If possible, please include the text or a screen shot of the error messages to speed up the support process.
1 Obtain the iTest installation zipped archive and extract files.
The extracted archive includes post-install.py and pre-uninstall.py scripts. The install and uninstall scripts must be executed using Python3.
2 Locate the iTest installation files and open a terminal window at that directory.
3 Type the following commands: If your default version of not Python 3, ensure you set to use Python 3. For example:
$alias python=python 3 $pyhton post-install.py The iTest installation wizard starts. If you are upgrading, then the installer displays dialog boxes confirming that you want to uninstall the currently installed iTest and then install the new version. Click OK in these dialog boxes.
4 When the installation process completes, a desktop icon is created to launch iTest.
CAUTION Halting the installation process can corrupt the registry.
5 Start iTest by clicking the iTest desktop icon.
33 iTest Installation Guide
6 iTest prompts for workspace location on first start. Enter your workspace location, click Launch and start working with iTest.
To use the iTest Tcl API, add or edit the TCLLIBPATH environment variable to include the path of the Tcl directory that was installed during iTest installation.
1 To prevent an XPCOM error when running iTest, install xulrunner for i686:
yum install xulrunner.i686 2 Now, in the iTest.ini file in the installation directory, add the following line as the last line in the file:
-Dorg.eclipse.swt.browser.XULRunnerPath=/usr/lib/xulrunner/ Step 5 Start iTest and configure an end-user account
Important Start iTest while logged in using an account with your normal working privileges. As with any application, if you create a document having logged in using an account with Administrator privileges and then later try to use the document logged in using an account with different privileges, iTest will not allow access to the document.
To configure licensing for an end-user account for iTest, follow the instructions that appear in the Online help for iTest and in the iTest User Guide.
Step 6 Optional: Configure iTest News updates You have the option to view news updates from Spirent as they arrive or can view them on-demand by navigating to this page and clicking Show iTest News.
3 Click Window > Preferences.
34 Chapter 2 iTest Installation
4 On the Preferences dialog box, in the Preferences tree, click iTest and then navigate to General > News.
Do not show iTest news Uncheck the box to display a dialog box that notifies whenever Spirent sends a news update. Default: checked
Check for news updates Check the box to have iTest regularly determine your installation configuration and send appropriate iTest news updates. Default: checked
Installing iTest on Apple macOS Spirent recommends that you upgrade all instances of iTest at the same time to avoid licensing or file sharing issues. Follow these step-by-step instructions:
Note If you encounter errors during the installation process, contact Spirent Customer Support at [email protected]. If possible, please include the text or a screen shot of the error messages to speed up the support process.
Step 1 Obtain files to install iTest and setup licensing server proxy
iTest installation archive (.dmg) and licensing-proxy-server.run file to set up the licensing proxy server. Due to technical reasons, iTest on macOS cannot communicate with licensing server directly. Hence, you are required to setup and run Licensing Proxy Server.
Note The Proxy can be run on any Windows/Linux machine with Java installed.
Step 2 Setup licensing proxy server to meet these reachability requirements.
Proxy machine is reachable from macOS machine with iTest installed.
macOS machine with iTest installed is reachable from the Proxy machine.
Licensing Server is reachable from the machine running the Proxy.
Note You may need to configure firewall to make proxy port open for connections from iTest machine. Once the Proxy Server is up and running and the firewall is configured as required, you are ready to run iTest on macOS.
Step 3 Start the License Proxy as a service on Linux.
1 Launch licensing-proxy-server.run on Linux as a root user.
35 iTest Installation Guide
2 Accept EULA and agree to install as daemon: Edit /etc/opt/spirent/license-proxy/proxy.conf file. Change port value if needed (9011 is default)
3 Start license-proxy service using /etc/init.d/license-proxy start:
4 Check service status, verify it is active:
Note You may check license-proxy logs using /var/opt/spirent/license-proxy/log/proxy.log
To stop service use: /etc/init.d/license-proxy stop
To uninstall service use: /opt/spirent/license-proxy/uninstall.sh
36 Chapter 2 iTest Installation
You may run the proxy server on any Windows/Linux machine with Java installed and run Licensing Proxy Server using the following command.
java -jar licensing-proxy-server-0.0.1-SNAPSHOT-jar-with-dependencies.jar On Linux, the command line can be prefix with nohup command, to leave the process running after terminal is closed. By default, the proxy server starts on port 9011 If you want to start it on a different port, provide a port number as a single argument as follows.
java -jar licensing-proxy-server-0.0.1-SNAPSHOT-jar-with-dependencies.jar 9999
Where 9999 is the required port number.
Step 4 Install iTest on macOS
1 Open the downloaded (Step 1) iTest installation archive (.dmg) file and drag the iTest icon to Applications.
2 Start iTest App on macOS. iTest prompts for workspace location on first start. Enter your workspace location, click Launch.
37 iTest Installation Guide
3 Configure license settings using proxy address and proxy port.
You may now work in iTest as required.
Note If the connection between iTest and Proxy Server is lost, all the checked out licenses will be checked back in when the predefined timeout expires. Currently this timeout is 5 minutes.
Installing iTestRT (Linux and Windows) This section provides instructions for installing iTestRT on Linux and Windows. iTestRT is the standalone command line (“headless”) version of iTest, described in detail in the Online help and in the iTest User Guide.
1 Download the iTestRT zip file (typically iTestRT-linux.xxx.xxx.zip and iTestRT-winxx.winxx.xxx.zip) from the installers directory on the installation medium.
Important As of the iTest release 8.5, the tshark/text2pcap binaries will be not bundled with iTest, iTestRT, and Agent installation.
Note To use iTestRT 64 bit, it is required that you install the 64bit version of Wireshark 1.8.4 (to resolve any installer issues).
Note To use Wireshark session on Linux systems you must install Wireshark manually. • To install Wireshark on Ubuntu enter the following command on the terminal:
$ sudo apt-get install wireshark tshark
38 Chapter 2 iTest Installation
• To install Wireshark on RHEL enter the following command on the terminal:
$ su -c "yum install wireshark"
2 Uncompress the zip into a directory of your choosing. The executable resides in the unzipped structure.
Note To run iTestRT globally, add the installation directory to the PATH environment variable.
39 iTest Installation Guide
40 C H A P T E R 3
Migrating iTest Workspaces to New Versions of SVN
iTest 8.5 uses SVN 1.7 and older versions of iTest uses SVN client 1.3.x to manage the files in your workspace. Files managed under SVN client 1.3.x are not compatible with SVN 1.7, so when you upgrade iTest, you must migrate to SVN v1.7.
Note iTest installer on macOS does not include SVN. To install SVN support in iTest on macOS, follow the instructions from https://github.com/subclipse/subclipse/wiki.
In this document, we describe two options to replace your existing working copy.
Option A: Replace an old working copy a with new working copy: Discard the old local working copy and then check out a new working copy
Option B: Replace old with a new working copy and rename it: Check out a new working copy. Discard the old local working cop. Rename the new working copy.
Replace Old Working Copy with a New Working Copy You may replace the old working copy with a new working copy by discarding the old local working copy and then checking out a new working copy.
1 First, to prevent data loss, commit to the SVN repository all local modifications in the iTest 8.4 workspace. In this example, we commit the Session Profile folder.
2 Delete the old working copy in iTest and local disk: On the SVN Repositories view, right-click the Session Profile folder and select Delete. In the Delete Resources dialog box, discard the local disk copy: Check Delete project contents on disk (cannot be undone) and then click OK.
3 Now, upgrade to iTest 8.5.
41 iTest Installation Guide
4 In iTest, open the workspace that we used in step 1 and check out the Session Profile folder from the SVN repository: On the SVN Repositories view, right-click the Session Profile folder and select Checkout.
On the Checkout from SVN dialog box, accept the default settings and click Finish.
Now everything is back to normal.
Replace Old with a New Working Copy and Rename it You may replace the existing working copy with a working by performing the following tasks:
Check out a new working copy
Discard the old local working copy
Rename the new working copy
Note The following error may display when you create a new project Could not autoshare project' SVN error The error indicates that the Subclipse plugin bundled with iTest did not recognize the new project as an SVN repository. This error does not affect functionality of iTest and can be safely ignored.
42 Chapter 3 Migrating iTest Workspaces to New Versions of SVN
1 First, to prevent data loss, commit to the SVN repository all local modifications in the iTest 8.4 workspace. In this example, we commit the Session Profile folder.
2 Now, upgrade to iTest 8.5.
3 In iTest, open the workspace that we used in step 1 and check out the Session Profile folder from the SVN repository to a new folder:
a On the SVN Repositories view, right-click the Session Profile folder and select Checkout.
b On the Checkout from SVN dialog box, specify a new folder to check out to, for example, Session Profile New and then click Finish
4 Now, in iTest, verify that the files in the new folder work as expected. If everything is OK, then delete the old Session Profile folder in iTest and local disk: On the SVN Repositories
43 iTest Installation Guide
view, right-click the Session Profile folder and select Delete. In the Delete Resources dialog box, check Delete project contents on disk (cannot be undone) and then click OK.
5 Rename Session Profile New to Session Profile: On the iTest Explorer, right-click the Session Profile New folder and select Rename. In the New Name text box, type Session Profile and then click OK.
Now everything is back to normal.
44 C H A P T E R 4
Troubleshooting Installation Issues
Note You will typically skip this chapter. This chapter provides suggestions in the case that you encounter problems while installing iTest.
The latest iTest installation will check the existence of the earlier version. If you are upgrading and you deleted the earlier version of iTest without cleaning up the registry before starting the new iTest installer, then: Installation will detect the earlier version of iTest and prompt you to uninstall. If the uninstaller of the earlier version is not found, installation will continue with a warning.
Follow this procedure if installation fails or un-installation of an earlier version fails:
Linux
1 If the iTest uninstaller utility for the earlier version exists, run it first:
users/
users/
4 Install the new version of iTest.
Windows
1 If the earlier iTest uninstaller utility exists, run it first:
C:\ Program Files (x86)\Spirent Communications \iTest
C:\Program Files\Spirent Communications\iTest_
3 In your C:\Program Files folder, there is a hidden folder named Zero G Registry. In Zero G Registry, delete the hidden file named .com.zerog.registry.xml.
4 At the command line, run regedit to open the Windows Registry Editor. Delete the following registry key:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\iTe st
45 iTest Installation Guide
Updating iTest using the update site for All users requires additional actions
iTest installed for all users (via the update-site) may have some read-only directories in the installation folder, which requires you to perform additional actions. To ensure that the updates are installed correctly, perform the following actions before starting iTest:
Right-click the configuration folder in your iTest installation directory,
Click properties, uncheck the Read-only check box and click OK.
Important Ensure that you start iTest as administrator after distributing iTest updates via the update site.
46 C H A P T E R 5
Installing iTest at a Central Location
Advantages of central access to iTest
You can ensure that the entire team is using the same version of iTest.
It is easy to move the entire team to a new service pack of iTest. One does not have to install it on every user’s computer.
It is easy to apply specific patches for the team.
You can point the entire team to the same license server and test report database server.
The entire team can use the same set of iTest preferences.
Disadvantages
Increases the startup time of iTest on the user’s computer. (You can improve startup time by using more powerful file servers and a better LAN.)
Requires users to have high-performance servers and LAN.
Updating the external test report database If you store iTest test reports in a centralized external database (instead of the built-in database), follow the instructions in “Updating the test report database for new releases of iTest”, page 98.
Installation instructions
Step 1 Install iTest on a server that can be accessed by the whole team
1 Install iTest on the server as described in either Chapter 2, “iTest Installation”, section “Installing iTest on Microsoft Windows”, page 23.
2 In iTest’s install directory, add the following lines to the beginning of the itest.ini file:
-configuration @user.home/.itest_
chmod -R 777 /tmp/itest
47 iTest Installation Guide
4 Restart iTest and then exit iTest.
5 If the configuration/.settings directory is present, remove it.
6 In Spirent iTest’s install directory, in the plugins/com.fnfr.svt.editions.team_
com.fnfr.svt.configuration.licensing.flexlm/licenseServers=itstsvr1. fnfr.com\:-1; com.fnfr.svt.configuration.licensing.flexlm/useLicenseServer=true com.fnfr.svt.configuration.licensing.flexlm/useLicenseFile=false The following lines specify the licenses to check out:
com.fnfr.itest.platform.configuration/selectedProductType=com.fnfr.pro ducttypes.enterprise com.fnfr.itest.platform.configuration/selectedProductModules=com.fnfr. svt.configuration.modules.applications.cmd;com.fnfr.svt.configuration. modules.applications.snmp;com.fnfr.svt.configuration.modules.applicati ons.mail;com.fnfr.svt.configuration.modules.virtualTestbed;com.fnfr.sv t.configuration.modules.applications.process;com.fnfr.svt.configuratio n.modules.applications.ssh;com.fnfr.svt.configuration.modules.applicat ions.telnet;com.fnfr.svt.configuration.modules.applications.database;c om.fnfr.svt.configuration.modules.autoresponsemap; 7 The iTest test report database can be served either from the default embedded database server in your iTest workspace or from a separate local database server. The default setting is to use the embedded database. To specify that iTest should use an external local database:
a In iTest, click Windows > Preferences > Spirent > General > Test Report Database
b Check Use an external database to store test reports
8 Optional, but useful and recommended: Store your organization’s project set file in the iTest install directory on the server. This makes it easy for users to import the project set after launching iTest. This means that all users can get access to the same projects from whichever source (for example, version control).
Step 2 Updating users' Path environment variables
Perform this step so that users can run itestcli and itestrt from the command line without having to open a shell and change directory to the appropriate iTest installation directory on the server: On each end-user’s computer, for the server’s mapped directory that holds the iTest executable:
• Add the directory to the PATH environment variable
• Specify the directory for the ITEST_HOME environment variable (On Linux, specify a mounted directory path. On Windows, specify a path containing a mounted drive).
Step 3 Updating users' decode.bat file If users are using traffic generator sessions and want to decode network packets, then: Add the server’s mapped directory to the decode.bat file (in the iTest installation directory). (The file contains paths to “wireshark” and other executables.)
48 C H A P T E R 6
Configuring the iTest Update Site and Upgrading from the Update Server
Important The instructions in this chapter does not apply for upgrading to iTest 8.5. from iTest 8.4 or lower versions.
This chapter lists requirements and provides instructions for the IT person who prepares the download site for use by iTest end users. In addition, the chapter also includes the following instructions:
“Setting up the iTest update site” on page 49.
“Updating iTest from the Update Site” on page 50
“Updating iTestRT from the Update Site” on page 54.
Updating the external test report database. If you store iTest test reports in a centralized external database (instead of the built-in database), then follow the instructions in “Updating the test report database for new releases of iTest” on page 98.
Important Spirent delivers software updates independent of iTest releases. See Chapter 7, “Installing/Updating Independently Released Software” for instructions on installing/updating them.
Setting up the iTest update site
Note These instructions are for the IT person who prepares the download site for use by iTest end users.
This deliverable is an Eclipse update site.
The features folder contains all iTest product features.
The plugins folder contains all plug-ins that make up the features.
The artifacts.xml and contents.jar documents are p2 artifact and metadata repository files. How you install the update site depends on the web server used to service the update site. But, at its simplest, if you copy the update site zip file to a local folder, then Eclipse users can use the zip file to download the content of the update site.
49 iTest Installation Guide
Updating iTest from the Update Site It is recommended that you determine whether the Date Based Version (DBV) value in your current license file allows you to upgrade (as follows) and then follow the instructions to upgrade Velocity.
Check the DBV value in your current license file and compare it with the product release DBV (see “Licensing Pre-requisites” on page 8, Chapter 1, “iTest System Requirements”).
If the current support license DBV is greater than or equal to the product release DBV, you are allowed to use the newer version of Velocity with the current license file. Contact Spirent support if your current license file does not support the version of Velocity to which you are upgrading.
Important The methods of updating iTest that are described in this chapter apply only for minor and patch updates, for example, iTest 8.3 to iTest 8.3.1. The update site does not support major updates, for example, the update site does not support upgrading iTest 8.3.x or lower versions to iTest 8.5.
Instructions for updating iTestRT appear in “Updating iTestRT from the Update Site” on page 54.
• Updating iTestRT See page 50.
• Updating iTest using a (local) update file See page 50.
• Using the Update Site to update iTest See page 53.
• Getting to the release notes See page 54.
Updating the external test report database If you store iTest test reports in a centralized external database (instead of the built-in database), then follow the instructions in “Updating the test report database for new releases of iTest” on page 98.
Updating iTestRT This chapter provides instructions for updating iTest, not iTestRT. Instructions for updating iTestRT appear in “Updating iTestRT from the Update Site” on page 54.
Updating iTest using a (local) update file
Note Do not use the Help > Install New Software option to update iTest.
If your computer is behind a firewall or in a network environment from which the Spirent update site is unreachable, your System Administrator will provide you with an archive file. Follow these instructions:
50 Chapter 6 Configuring the iTest Update Site and Upgrading from the Update Server
Important In order to use the update site: Log in using the account that was used to install iTest (often administrator).
For Windows systems: If, while installing iTest, you selected the option to install as administrator, then you must launch iTest by right-clicking iTest.exe and selecting Run as administrator.
Before Update 1 Make sure that you close all/any instance of iTest.
2 Perform update steps described below.
Updating iTest
Prerequisites 1 Copy the archive file to a location that is accessible by the iTest computer. Install iTest in the default directory. Ensure that you have full administrator control over the iTest installation directory.
On the iTest installation directory's Security Properties, uncheck the Read-Only flag in itest installation directory's properties.
2 Ensure that the Read-Only flag is also unchecked for the bundles.info file located in configuration/org.eclipse.equinox.simpleconfigurator folder in the iTest installation directory.
Set up the update site on iTest 1 Start iTest as administrator and click Window > Preferences.
2 On the Preferences page, open the Install/Update group and select Available Software Sites.
3 On the Available Software Sites page, click Add. 4 On the Add Site dialog box:
a Click Local and, in the Browse For Folder dialog box, select the folder that holds the archive file that you saved.
b In the Name field, type a descriptive name for the archive site (for example, file:C:/SystemTest/updateArchive).
c The name will appear in a list in a subsequent step.
d Click OK.
5 On the Available Software Sites page, select the remote site (not the local site that you just added), click Disable, and then click OK. This will shorten the update process by eliminating the search for additional update sites while iTest is being updated from the local file.
6 Click OK.
Update Process—Install updates
Note If you have already logged into iTest, go to Step 2.
51 iTest Installation Guide
1 Start iTest.
2 Click Window > Preferences, open the Install/Update group, and select Available Software Sites.
3 On the Available Software Sites page, and select the Available Software Sites. Ensure that the relevant update site is enabled.
Click Apply and Close.
4 Now begin the update process: Click Help > Check for Updates. In the Available Updates dialog box, select iTest and click Next.
5 Review what will be installed and agree to licensing. Click Next in the remaining pages to finish the wizard.
Important When the update completes, a dialog box prompts you to restart iTest. Restart iTest.
6 After the installation completes, verify as follows:
Go to Help > About iTest > iTest Installation Details and ensure that the iTest build version is the same as the one listed in Step 3 above.
52 Chapter 6 Configuring the iTest Update Site and Upgrading from the Update Server
Automatic update notifications If you have selected to be notified when updates are available (selected the checkbox Automatically find new updates and notify me on Preference > Install/Update > Automatic Updates page), iTest notifies you about any available updates when you login. When you log into iTest as non-Admin user, iTest does not notify you when new updates/patches are available, even if you select the checkbox Automatically find new updates and notify me (on Preference > Install/Update > Automatic Updates page.
Suggested workaround: Install iTest into a folder to which you have Admin access (not in Program Files) or run as administrator to install updates.
Using the Update Site to update iTest
Note This section is intended for iTest users who want to upgrade their iTest version using the update site that was configured by the System Administrator. If you are a System Administrator looking for instructions on installing the update site as Eclipse plug-ins, see “Configuring the iTest Update Site and Upgrading from the Update Server” on page 49.
Spirent releases patch and bug-fix updates to iTest on a regular basis. Spirent recommends that you update to the latest release of iTest whenever you need bug-fixes or when instructed to do so by your System Administrator.
Important The update site contains only minor, certain Independently Released Software, Custom sessions, patches, and bug fixes. You cannot update major releases using the update site. For example, you can update iTest 8.5 to iTest 8.5.1, but you cannot update iTest 8.4.x to iTest 8.5.
You must have a current license and maintenance agreement to upgrade.
53 iTest Installation Guide
Important In order to use the update site: Log in using the account that was used to install iTest (administrator). For Windows systems: If, while installing iTest, you selected the option to install as administrator, then you must launch iTest by right-clicking iTest.exe and selecting Run as administrator.
1 Click Help > Install New Software option to update iTest.
2 In the Work with field, type the following link:
http://itestupdates.spirent.com/itest_8.5/update-site
Note iTest installed for all users (via the update-site) may have some read-only directories in the installation folder, which requires you to perform additional actions. To ensure that the updates are installed correctly, perform the following actions before starting iTest: • Right-click the configuration folder in your iTest installation directory,
• Click properties, uncheck the Read-only check box and click OK.
Important Ensure that you start iTest as administrator after distributing iTest updates via the update site.
3 Start iTest and click Help > Check for Updates. iTest queries the software update site. If you have the most recent version of iTest, then an Information dialog box reports that “There is nothing to update”. Otherwise, continue:
4 On the Available Updates wizard, select the iTest entry and click Next.
5 Review what will be installed and agree to licensing. Click Next in the remaining pages to finish the wizard. When the update completes, a dialog box prompts you to restart iTest. Restart iTest.
6 Restart iTest to begin using the updated version.
Getting to the release notes Release notes for iTest are included on the Spirent Customer Support Center. The release notes include “What’s new in this release” information. At any time while using iTest, click Help > View iTest Release Notes, log into the Spirent Knowledge Base and search for “iTest Release Notes” to view the latest release notes.
Updating iTestRT from the Update Site
Note Updating the external test report database If you store iTest test reports in a centralized external database (instead of the built-in database), then follow the instructions in “Updating the test report database for new releases of iTest” on page 98.
To update iTestRT
The update script is located in the iTestRT root folder,
54 Chapter 6 Configuring the iTest Update Site and Upgrading from the Update Server
update on Linux.
Before Update Perform the following changes before update:
1 Make sure that you close all/any instance of iTest.
2 Go to the iTest installation directory.
3 Run update.bat/update script as described below (with -update
Linux
1 Using the user account that installed iTest, cd to
$ ./update # print help information for updating iTestRT Installation on local update sites If you are using a local update site, then use one of the following models:
Unpack all features on the local update site: Store the features as folders, not as JAR files. or Do not unpack the features: If you leave the files as jar files, then all feature entries in the site.xml file must have type="org.eclipse.update.core.packaged". For example:
itestrt --com.fnfr.itest.runtime.update.updateAll [password] [--ackAllLicenses] Command line options The command below shows the correct option used.
Go to the location where the Velocity Agent is installed and run the update.bat file.
C:\velocity\velocity-agent>update.bat Copyright (c) 2005-2020, Spirent Communications velocity agent update Usage: update
55 iTest Installation Guide
Usage examples To update iTestRT, execute the following command from the product installation directory:
Usage: update
56 Chapter 6 Configuring the iTest Update Site and Upgrading from the Update Server
org.eclipse.equinox.p2.director -repository http://itestupdates.spirent.com/itest_8.5/update-site/ -installIU com.fnfr.features.itest.core.feature.group ...... Uninstall C:\Users\spirent\Downloads\iTestRT-8.5\iTestRT>update -uninstall http://itestupdates.spirent.com/itest_8.5/update-site/ com.fnfr.features.itest.core Uninstalling com.fnfr.features.itest.core.feature.group 8.5.0.202008200360. Operation completed in 7093 ms.
57 iTest Installation Guide
58 C H A P T E R 7
Installing/Updating Independently Released Software
Spirent delivers software updates independent of iTest releases. The instructions in this chapter applies only for downloading, installing, and updating software released independently of iTest releases (GA - General Availability releases).
Tip See Chapter 2, “iTest Installation” for installing the latest version of iTest or upgrading to iTest 8.5 from iTest 8.4 or lower versions.
Note This chapter assumes that iTest has already been installed and you have set up update site as instructed in “Setting up the iTest update site” on page 49 (Chapter 6, “Configuring the iTest Update Site and Upgrading from the Update Server”).
To Install/Update Independently Released Software This section includes instructions for installing/updating software released independently from general iTest releases.
Note If you see an error message while installing/updating the Independently Released Software (as illustrated below), that means you originally installed iTest as an administrator. In that case, you must also install/update the Independently Released Software as an administrator. Conversely, if you originally installed iTest as a user (i.e., a non-Administrator) you must also install/update the Independently Released Software as a User.
59 iTest Installation Guide
Installation Steps:
1 Start iTest. Go to Help > Install New Software.
2 Click Add, enter a valid update site and click OK.
For example, Click Add and enter new location: http://itestupdates.spirent.com/itest_8.5/session
Click OK and wait for update-site to display the list of software.
3 Select the software.
4 Click Next and then Finish to install.
5 Restart iTest.
Note After you select the software, the Details text box displays information about the software. In addition, clicking More... display the Copyright, General Information, and License agreement. By design, the option Hide already installed items does not hide installed software list but displays “All items are already installed”.
Expand the software in the Name column (e.g., EggPlant Session in the illustration below) to see if the selected software is already installed. The Version column is populated with the installed software version. The Version column is empty next to the software not yet installed.
60 Chapter 7 Installing/Updating Independently Released Software
Install a new software
If you select a new software (that is, your iTest installation does not include the selected software yet) to be installed, follow the installation steps.
1 Start iTest. Go to Help > Install New Software.
2 Click Add, enter a valid update site and click OK.
For example, Click Add and enter new location: http://itestupdates.spirent.com/itest_8.5/sessions/
Click OK and wait for update-site to display the list of software.
3 Select the software.
4 Click Next and then Finish to install.
5 Restart iTest. After successful installation, make sure:
The software is installed and plugin is located under
Go to Help > Installation Details and see that the new software is listed in the Features or Plugins tab.
Update an existing software
Note/remember the current version of the software that you want to update.
Note You may also select an older version of the installed software instead of the latest update.
DeSelect Hide items that are already installed, to list all installed software.
Select an existing/installed software which has an update/ a newer version available on the site.
Follow these instructions to install/update the software. Update Software a Start iTest. Go to Help > Install New Software.
b Click Add, enter a valid update site and click OK.
For example, Click Add and enter new location: http://itestupdates.spirent.com/itest_8.5/sessions/
Click OK and wait for update-site to display the list of software.
c Select Ranorex Application.
d Click Next and then Finish to install.
e Restart iTest.
After successful installation, make sure:
• The updated software is installed and plugin is located under
• Go to Help > Installation Details and see that the updated software is listed in the Features or Plugins tab.
• Go to Help > Installation Details> Installation History lists a new record of history with the time of the newly updated software.
61 iTest Installation Guide
Revert changes or Uninstall a software You may revert the changes you made or uninstall an existing software. Follow these instructions. Uninstall selected software Go to Help > Installation Details > Installed software.
Select an installed software to uninstall and click Uninstall. After successful uninstall process, make sure: • The software has been removed from iTest and no longer listed in the plugins / feature folder.
• Help > Installation Details > Installed software and the Plugins tab no longer lists the software.
• Help > Installation Details > Installation History lists a record of the uninstall process. Revert changes You may use the Revert option to either revert an installed software or revert an uninstalled software.
Go to Help > Installation Details > Installation History.
Revert an installed software (new or updated). iTest will be reverted to the same state as before the software was installed. • The software will be removed from iTest. • The software will not exist in the Plugins or features folder.
• The software is no longer listed in Help > Installation Details > Installed Software or the Plugins tab.
• The Help > Installation Details > Installation History lists a record of the Uninstalling process.
Revert an uninstalled software iTest will be reverted to the same state as when the software was already installed.
• The new software will be installed and located under
• The newly installed software will be listed in Help > Installation Details > Installed Software tab.
• The Help > Installation Details > Installation History lists a record of the software installation process and the time.
• The Help > Installation Details > Plugins tab lists the latest version of the software plugins.
62 Chapter 7 Installing/Updating Independently Released Software
Using iTestRT to Install / Update / Uninstall Independently Release Software
Note The version number “itestrt update version 8.5” is an example.
$ ./update Copyright (c) 2005-2020, Spirent Communications itestrt update version 8.5 Usage: update
-install
-uninstall
-verifyOnly Only verify that the actions can be performed. Don't actually install or update anything. Can be used after -update or -install options. Install/update independently released software from a valid update-site Example: 1 Open command prompt.
2 Go to ITEST-RT directory.
Example: C:\iTestRT\
3 Execute the command below to install/update independently released software.
/update.bat -install http://itestupdates.spirent.com/itest_8.5/session com.spirent.features.itest.applications.ranorex
Note The new software after successful installation will be located under
63 iTest Installation Guide
64 C H A P T E R 8
Installing Spirent Traffic Generators
Installing Spirent Avalanche software for use with iTest
Note Skip this chapter if you do not use Spirent Avalanche software in iTest test cases.
This section describes the software installation procedure. As a result of installing the Spirent software, you will be able to use Avalanche steps in iTest test cases. Spirent Avalanche is supported only on Microsoft Windows.
Overview Avalanche software and firmware need to move together as a system. In the “Avalanche running on the chassis” situation, the system consists of:
Chassis • 5.18 firmware on the chassis and on the line cards
Windows computer • 5.18 Avalanche software • Java 11 (SE 11) • Tcl 8.4.13+
Installing Spirent Avalanche
Ensure compatibility iTest support for Spirent products is listed in “Spirent and Third-party Software” on page 9, Chapter 1, “iTest System Requirements”.
Install Tcl You must install Tcl to use iTest with any traffic generation software. Tcl version requirements are described in the iTest release notes, under “Software Interoperability”.
Install the Avalanche software Follow the Spirent installation instructions—download and install Avalanche.
Restart/Reset/Refresh Avalanche If you are using the card chassis, (as opposed to the appliance), you may sometimes see ports disappearing. In this case, follow this procedure:
1 Close the Avalanche GUI.
65 iTest Installation Guide
2 Using the Task Manager, find the process tclsh.exe and terminate it.
3 Restart the Avalanche GUI.
4 If you are using the card chassis (as opposed to the appliance), it may take 5 minutes for the cards to be available for reservation again, as when a user finishes using a port, it reboots itself (the reboot takes about 3-5 minutes).
Important If a test module in the Chassis List tree indicates “Status Not Updated,” you should select its chassis IP address and then select Equipment > Refresh Selected Chassis from the Spirent TestCenter Administration menu (or right-click and select Refresh). This updates the status of the selected chassis and their test modules. You can reserve a port group only when its status is Available.
Important After you release a port group, the port group is rebooted and unavailable for one or two minutes. If you do not release the port group, and the Layer 4-7 Application exits or loses connection with the Spirent TestCenter chassis, the port group is also rebooted and unavailable for one or two minutes. To view the current status of the port group, select its chassis' IP address and then select Equipment > Refresh Selected Chassis from the Spirent TestCenter Administration menu (or right-click and select Refresh).
66 Chapter 8 Installing Spirent Traffic Generators
Installing Spirent TestCenter™ software for use with iTest
Note Skip this chapter if you will not use Spirent TestCenter devices with iTest.
This section describes the software installation procedure. As a result of installing the software, you will be able to use Spirent TestCenter steps in iTest test cases.
Install Tcl You must install Tcl to use iTest with any traffic generation software. Tcl version requirements are described in the iTest release notes, under “Software Interoperability”.
Step 1 Installing Spirent TestCenter on Microsoft Windows
1 Install Spirent TestCenter as described in the Spirent documentation. The default path to the installation directory is:
C:\Program Files\Spirent Communications\Spirent TestCenter
Important iTest will auto-locate the Spirent TestCenter application if it is installed in the default location. Follow the remaining steps only if the application is not installed in the default location.
67 iTest Installation Guide
2 The TestCenter installer does not automatically update the installation directory in the pkgIndex.tcl file. Edit the file to supply the path to TestCenter. You specify the path as the value of the dir variable by adding a line in the following format:
set dir “
Add the text to the file in this location. IMPORTANT: Be sure to use the correct installation path.
The value of the dir variable is used in these locations to locate the required files.
3 Specify the Tcl library path.
Edit or add the environment variable TCLLIBPATH. This variable includes the paths to the pkgindex.tcl files.
4 Append the following path for the TCLLIBPATH environment variable: {C:/Program Files/Spirent Communications/Spirent TestCenter
68 Chapter 8 Installing Spirent Traffic Generators
About the bll.log file When you work with Spirent TestCenter through a Tcl interpreter, Spirent TestCenter creates a bll.log file in the interpreter’s working directory.
Important The bll.log file is the tracking mechanism for bugs. If something crashes and there is no bll.log file, there is no way to tell what happened.
Update these entries in the stcbll.ini file (located in, e.g.; C:\Program Files(x86)\ Spirent\SpirentTestCenter5.07\SpirentTestCenterApplication) to turn off logging (ALL:NONE) and to control the output file. [logger] level=ALL:NONE output=bll.log
69 iTest Installation Guide
Installing Spirent Landslide™ NTAF software for use with iTest
Important The Spirent TestCenter NTAF and Spirent Avalanche NTAF sessions are obsolete and is no longer supported.
Note Skip this chapter if you will not use Spirent Landslide devices with iTest.
This section describes the software installation procedure. As a result of installing the software, you will be able to execute Spirent Landslide test steps and sessions in iTest test cases.
Configuring Landslide for operation with iTest
Step 1 Install Tcl You must install Tcl to use iTest with Landslide. Tcl version requirements are described in “Spirent and Third-party Software” on page 9, Chapter 1, “iTest System Requirements”.
Step 2 Install the Landslide Tcl API
Directions for installing the Landslide Tcl API appear under the +Tcl API link on the Landslide server. Follow these steps:
Linux 1 Download landslidetclapi.zip and linuxtclblend.tar.gz from the Landslide Test Administration Server.
2 Create landslidetclapi folder in your linux home folder.
3 Extract landslidetclapi.zip and linuxtclblend.tar.gz files to the landslidetclapi folder. (you may use a zip utility: Winzip or the jar tool that comes with Java JDK).
4 Make sure the tclblend.dll directory and Landslide Tcl API lib directory are on your load library path (that is, edit /etc/profile file and add LD_LIBRARY_PATH and TCL_LIBRARY variables).
a Add LD_LIBRARY_PATH environment variable: ~/landslidetclapi/lib:~/landslidetclapi/lib/tcljava1.4.1.
Edit /etc/profile (or /etc/bashrc) file and add LD_LIBRARY_PATH
For example: export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/home/user/landslidetclapi/lib: /home/user/landslidetclapi/tcljava1.4.1 b Add Tcl location into TCL_LIBRARY variable:
Edit /etc/profile (or /etc/bashrc) file and add TCL_LIBRARY
TCL_LIBRARY=/usr/lib/tcl8.4 and export into /etc/profile (or /etc/bashrc) file
For example: export TCL_LIBRARY=/home/user/landslidetclapi/lib/
5 Copy the jtclsh file and rename the copy as landslidetclapi. Edit the landslidetclapi file to make the following changes:
70 Chapter 8 Installing Spirent Traffic Generators
a Change the api_home folder to point to your directory path.
For example: api_home=/home/user/landslidetclapi (~/landslidetclapi)
b Change the jre_home folder to point to your JRE runtime installation folder.
For example: jre_home (jre_home=/usr/jre1.6.0_10
Note If required, you may increase the Java memory: export JAVA_MAX_MEMORY=256m
6 Execute the landslidetclapi file
This takes you to a Tcl shell prompt (%). At the Tcl shell prompt execute the following command:
% source NtafInstall.tcl A message displays saying that the setup was completed successfully (Installation of Landslide NTAF tool files finished successfully) and the screen looks as illustrated.
Windows 1 Download landslidetclapi.zip and windowstclblend.zip
2 Create a new directory on your computer, for example: C:\landslidetclapi
3 Extract landslidetclapi.zip to C:\landslidetclapi (you may use a zip utility: Winzip or the jar tool that comes with Java JDK).
4 Make a copy of jtclsh.bat and rename copy as: landslidetclapi.bat
71 iTest Installation Guide
5 Edit landslidetclapi.bat as follows:
set API_HOME=C:/landslidetclapi (location of the Landslide API) set JRE_HOME=C:/Program Files/Java/jdk1.6.0_20/jre (location of JAVA JDK)
Note If required, you may increase the Java memory: set JAVA_MAX_MEMORY=256m
6 Extract windowstclblend.zip to the directory C:\landslidetclapi.
Then add the path C:\landslidetclapi\bin and C:\landslidetclapi\lib\tcljava1.4.0 into you local environment PATH variable.
7 Run landaslidetclapi.bat
This takes you to a Tcl shell prompt (%). At the Tcl shell prompt run source NtafInstall.tcl command to install landslide tcl api. If successful, your screen looks as illustrated.
Note Run bin/tclsh84 NtafInstall.tcl command if you do not have tcl/tk installed on local machine.
Step 3 Install the NTAF folder from the Landslide Tcl API directory
1 At a command prompt, cd to the Landslide Tcl API folder.
72 Chapter 8 Installing Spirent Traffic Generators
2 Execute the installation script — a Tcl script that must run under a Tcl shell (you can use the Tcl shell that came with Landslide). The script copies and configures all the NTAF tool files for Landslide.
tclsh NtafInstall.tcl or
tclsh84 NtafInstall.tcl
Installing the NTAF server and starting the NTAF proxy The NTAF proxy is a service that enables an NTAF requester (like iTest) to communicate with an NTAF tool (like Spirent Landslide). See also Chapter 11, “Installing NTAF Server”.
To configure the system, you install both Spirent Landslide and the proxy. iTest and Spirent Landslide can then communicate by way of the proxy.
Step 1 Install and configure the Openfire XMPP server (the “NTAF server”) End users of iTest think of the XMPP server as “the NTAF server”. Windows You must log in to Windows as admin and then install Openfire. The following instructions are valid for Openfire v3.7.1 for Microsoft Windows:
1 Download the Openfire installer from http://www.igniterealtime.org/downloads/index.jsp
73 iTest Installation Guide
2 Run the Openfire installer, accepting all defaults. When installation finishes, select Run Openfire and then click Finish. The Openfire console opens:
3 Click Launch Admin to continue the server setup in a web browser. On the browser-based setup pages, accept the default settings except:
• On the Database Settings page, select Embedded Database
• On the Administrator Account page, specify your email address and a password for the admin account.
Note If you lose the admin password, then you must uninstall Openfire and manually delete the directory where it was installed. Uninstalling Openfire without deleting the directory keeps the old password.
4 On the browser, click Login to the admin console. Log in as "admin" and use the password that you specified.
5 On the Server Manager tab, click System Properties. Add a property. Name it xmpp.pubsub.multiple-subscriptions and set its value to false. Click Save Property. 6 On the browser, click Logout to log out of the admin account. From the Openfire console, Stop and then Start the server. Windows You must start Openfire in one of the following ways:
• Log in to Windows as admin and then start Openfire • Run Openfire as a service
Step 2 Prepare the NTAF proxy
1 Install Java on the host that will run the NTAF proxy.
Important To ensure that the user interface of each session type is available to the end users of iTest, the NTAF proxy must run on the same host as iTest.
2 Ensure that the Openfire XMPP server is running.
3 Copy the NtafProxy folder from the folder where iTest is installed to a local disk.
The folder contains an NtafProxy.jar file, two Linux shell scripts (NtafProxy and NtafProxyDebug), and two Windows batch files (NtafProxy.bat and NtafProxyDebug.bat).
74 Chapter 8 Installing Spirent Traffic Generators
Step 3 Prepare the scripts that launch the NTAF proxy To launch the NTAF proxy (to enable iTest and Spirent Landslide to communicate) you execute either of the following scripts:
• NtafProxy.bat launches the proxy for normal operation
• NtafProxyDebug.bat launches the proxy and, in addition, produces debug output
Follow these instructions to prepare the scripts (they are located in the NtafProxy folder):
Linux 1 Make NtafProxy and NtafProxyDebug executable by executing the following command:
chmod a+x NtafProxy* 2 Edit the contents of the scripts to specify the XMPP server and login credentials:
NtafProxy.bat runs the following command:
java -jar NtafProxy.jar -s localhost -u spirent_proxy NtafProxyDebug.bat runs the following command:
java -jar NtafProxy.jar -s localhost -u spirent_proxy -debug true
a The -s option identifies the XMPP server that you recently configured and started. The default setting in the script files is "localhost". If the server is not on the local computer, modify the scripts. For example, if the XMPP server is 10.155.2.219, change "localhost" in both files to "10.155.2.219".
b The -u option is the username that the proxy uses to log on to the XMPP server as an NTAF node. (This name will appear to end users on the NTAF Registry view in iTest). Set the name as needed (the default name is spirent_proxy).
c Use the -p option to specify a password. If you do not specify -p, then the script uses "password". Microsoft Windows 1 Copy the NtafProxy folder from the iTest installation folder to a local disk.
2 Edit the contents of the scripts to specify the XMPP server and login credentials:
NtafProxy.bat runs the following command:
java -jar NtafProxy.jar -s localhost -u spirent_proxy NtafProxyDebug.bat runs the following command:
java -jar NtafProxy.jar -s localhost -u spirent_proxy -debug true
a The -s option identifies the XMPP server that you recently configured and started. The default setting in the script files is "localhost". If the server is not on the local computer, modify the scripts. For example, if the XMPP server is 10.155.2.219, change "localhost" in both files to "10.155.2.219".
b The -u option is the username that the proxy uses to log on to the XMPP server as an NTAF node. (This name will appear to end users on the NTAF Registry view in iTest). Set the name as needed (the default name is spirent_proxy).
c Use the -p option to specify a password. If you do not specify -p, then the script uses "password".
75 iTest Installation Guide
Step 4 Start the NTAF proxy
Note Before using the NTAF proxy, perform these settings: If NTAF Proxy is not running on the same PC as iTest, on the PC that is used to run NTAF Proxy, set NTAF_PROXY_JAVA_HOME variable and this environment variable should point to JRE 32bit.
Example: NTAF_PROXY_JAVA_HOME=C:\Program Files (x86)\Java\jre1.8.0_181)
If NTAF Proxy is running on the same host machine as iTest, install jre32bit and configure that NTAF_PROXY_JAVA_HOME variable. Landslide TCL API (Replay Mode) requires 32-bit Java 8+ (1.8.0) and it is recommended to install Oracle Java JRE/JDK 1.8 32 bit from Oracle's Java Website http://www.java.com/.
Note To use iTest with any NTAF tool, a single instance of the NTAF proxy service must be running.
Now that you have edited the scripts, execute the script that meets your need:
The NtafProxy script launches the proxy for normal operation
The NtafProxyDebug script launches the proxy and produces debug output
Stopping the proxy service Type CTRL+C in the proxy terminal window.
Step 5 Installation and setup are now complete Now that Landslide is properly set up for NTAF, it will use the NTAF proxy to communicate with iTest. You can now use iTest to capture manual sessions with Spirent Landslide and use the captured data to create automated test cases that control Spirent Landslide sessions.
76 C H A P T E R 9
Installing Ixia Traffic Generators
Installing Ixia (formerly Agilent) QuickTest Software for Use with iTest
Note Skip this chapter if you do not use QuickTest software in test cases to control N2X devices.
This topic describes the Ixia software installation procedure. As a result of installing the software, you will be able to use Ixia QuickTest steps in iTest test cases
Important While you must install Ixia Packets and Protocols / QuickTest on the computer that will execute iTest (to install the Ixia Tcl Library), you cannot execute Ixia QuickTest locally. Typically, you’ll use remote desktop or VNC to launch the GUI on the controller.
Installing Ixia N2X on Linux
Important ixN2X Packets and Protocols (formerly Agilent N2X) has reached it’s End of Life, and is no longer supported.
Install Tcl You must install Tcl to use iTest with any traffic generation software. Tcl version requirements are described in the iTest release notes, under “Software Interoperability”.
Install Ixia software on Linux You will find the instructions for installing the Ixia libraries for Linux in the Ixia Installation Guide.
Note The library must be installed under ~/Ixia (or ~/Agilent) because that is the hard-coded location in some of the Tcl scripts provided by Ixia. If you have installed the library to a central location (for example, for multiple users), then you must add a symbolic link in each user's home folder that points to the central install location.
After you follow the Ixia instructions to install QuickTest, you set following environment variables:
N2X_AGTCLIENT: Directory that holds the AgtClient.tcl file
N2X_QUICKTEST: QuickTest installation directory
77 iTest Installation Guide
N2X_QUICKTEST_TCL: The Tcl binary with which you run the QuickTest application. (Typically of the form tclsh or tclsh8.4) Environment variable settings N2X_AGTCLIENT=/home/user1/Ixia/N2X/tcl/extras N2X_QUICKTEST=/home/user1/Ixia/N2X/QuickTest N2X_QUICKTEST_TCL=tclsh TCLLIBPATH=/home/user1/Ixia/N2X/tcl/extras Correct the QuickTest.ini.tcl file Perform the following procedure to avoid having the IxiaTraffic configuration get and configuration save commands generate errors on Linux after installing Ixia QuickTest.
1 Edit the Ixia/N2X/QuickTest/lib/AgtQtl/QuickTest.ini.tcl file. 2 At line 129, add a close square bracket (]) before the close brace. The line should look like this:
if { [file exist [file join $rootDir AgtQtlDefaults.tcl]] } {
Installing Ixia QuickTest on Microsoft Windows
Note For Ixia v6.11 (released February 2009), Ixia has started distributing a QuickTest installer for Windows (so that you do not have to install the complete N2X Packets and Protocols distribution as described here). For more information, contact Ixia.
If you plan to use Ixia N2X devices with iTest, then install the QuickTest (part of Packets and Protocols) software, as follows:
1 From Ixia’s website, download and install the N2X Packets and Protocols software (the installation utility will also install QuickTest).
2 On the Setup Type page, select Client (GUI Only).
78 Chapter 9 Installing Ixia Traffic Generators
Specify the Tcl library path:
Important iTest will auto-locate the Ixia application if it is installed in the default location. Follow the instructions in this section only if the Ixia application is not installed in the default location.
1 Once the Ixia software is installed, click Start > My Computer. Right-click in the window and select Properties. On the Advanced tab, click the Environment Variables button. The Environment Variables dialog box opens.
2 In the System Variables box, select TCLLIBPATH.
3 Specify the following paths as the first entries for the TCLLIBPATH environment variable:
"C:/Program Files/Tcl83/lib/IxiaN2X" "C:/Program Files/Ixia/N2X/QuickTest/lib" "C:/Program Files/Ixia/N2X/QuickTest”
• Use quotes " around each path • Use one space to separate the paths, not a semicolon • Use the / character to separate directory levels
79 iTest Installation Guide
Installing Aptixia IxLoad software for use with iTest
Note Skip this chapter if you do not use IxLoad software in iTest test cases with Ixia devices.
This section describes the software installation procedure. As a result of installing the Aptixia IxLoad and associated software, you will be able to use IxLoad steps in iTest test cases.
Installing supporting software on Linux
Ensure compatibility Ensure compatibility between IxOS and your IxLoad version. See the Ixia compatibility matrix at: http://www.ixiacom.com/support/product_compatibility_matrix/ iTest support for Ixia products is listed in “Spirent and Third-party Software” on page 9, , “”.
Install Ixia IxOS software Following the Ixia installation instructions, install and configure the IxOS software to home/user/ixia/IxOs. Install IxLoad client Following the Ixia installation instructions, install and configure the IxLoad client to home/user/ixia/IxOs/IxLoadTclAPI Install Tcl You must install Tcl to use iTest with any traffic generation software. Tcl version requirements are described in the iTest release notes, under “Software Interoperability”.
Configuring Ixia IxOS 9.01 GA for use with iTest Follow these additional instructions for Ixia 9.01 GA:
1 Close all instances of iTest.
2 On the computer that runs iTest, install Ixia 9.01 GA.
3 Set the TCLLIBPATH environment variable.
export TCLLIBPATH="$TCLLIBPATH $IXIA_HOME/lib"
80 Chapter 9 Installing Ixia Traffic Generators
4 Set additional path variables Add the following paths to the TCLLIBPATH variable:
home/user/ixia/IxOs/lib home/user/ixia/IxOs/lib/IxLoad Set the following paths:
export IXIA_HOME=
export IXIA_LOGS_DIR=/tmp export IXIA_RESULTS_DIR=/tmp export IXIA_SAMPLES=$IXIA_HOME/samples export IXIA_TCL_DIR=$IXIA_HOME/lib
# IXIA must be in the path export LD_LIBRARY_PATH=$IXIA_HOME/lib:$LD_LIBRARY_PATH Validate the installation Launch iTest and connect to the Ixia device. If you successfully connected to the Ixia chassis, then you should see the IxLoad> prompt.
Installing supporting software on Microsoft Windows
Ensure compatibility Ensure compatibility between IxOS and your IxLoad version. See the Ixia compatibility matrix at: http://www.ixiacom.com/support/product_compatibility/matrix iTest support for Ixia products is listed in “Spirent and Third-party Software” on page 9, , “”.
Install Ixia IxOS software 1 Close all instances of iTest.
2 On the computer that runs iTest, follow the Ixia installation instructions to install Ixia 9.01 GA to
C:\Tcl\bin;C:\Program Files\Ixia\IxOS\9.01-GA
Important iTest will auto-locate the IxOS application if it is installed in the default location. Follow Step 3 and Step 4 only if the application is not installed in the default location.
3 Modify the PATH environment variable. Place the following paths as the first paths in the list. In this example, the Tcl interpreter is installed at C:\Tcl C:\Tcl\bin;C:\Program Files\Ixia\IxOS\9.01-GA; 4 Add the TCLLIBPATH environment variable:
C:/Program Files/Ixia/IxOS/9.01-GA/TclScripts/lib (Notice the forward slashes / )
81 iTest Installation Guide
Notes If you have already installed IxOS with an unsupported version of ActiveTcl, then you must uninstall IxOS, upgrade ActiveTcl, and then reinstall IxOS. (Ixia offers no option to upgrade ActiveTcl directly.) During IxOS installation, when you are prompted for the ActiveTcl version that is installed on your computer, be sure to specify the version that is actually installed.
Install IxLoad client Following the Ixia installation instructions, install and configure the IxLoad client to C:\Program Files\Ixia\IxOS\IxLoadTclAPI Specifying the Tcl library path
Important iTest will auto-locate the Tcl application if it is installed in the default location. Follow the instructions in this section only if the application is not installed in the default location.
Specify the following paths for the TCLLIBPATH environment variable: {C:/Program Files/Ixia/TclScripts/lib} {C:/Program Files/Spirent/iTest
Validate the installation Launch iTest and connect to the Ixia device. If you successfully connected to the Ixia chassis, then you should see the IxLoad> prompt.
82 Chapter 9 Installing Ixia Traffic Generators
Installing AptIxia IxNetwork software for use with iTest
Note Skip this chapter if you do not use IxNetwork software in iTest test cases.
This section describes the software installation procedure. As a result of installing the Ixia software, you will be able to use IxNetwork steps in iTest test cases.
Important Using IxNetwork on Linux requires a Windows host running the IxNetwork TCL Server.
Installing Ixia IxOS on Linux See page 83.
Installing Ixia IxOS on Microsoft Windows See page 83.
Installing Ixia IxOS on Linux
Ensure compatibility Ensure compatibility between IxOS and your IxNetwork version. See the Ixia compatibility matrix at: http://www.ixiacom.com/support/product_compatibility_matrix/ Spirent support for Ixia products is listed in “Spirent and Third-party Software” on page 9, , “”.
Install Tcl You must install Tcl to use iTest with any traffic generation software. Tcl version requirements are described in the iTest release notes, under “Software Interoperability”.
Install Ixia software
Note Both IxOS and IxNetwork installers execute the 'du' command in the home directory to determine free space. This takes about 10 minutes, so it looks like installer hangs.
1 Following the Ixia installation instructions, download and install IxOS.
2 Following the Ixia installation instructions, download and install IxNetwork.
3 Append the IxTclNetwork directory to TCLLIBPATH. Typically it is located at: ~/Ixia/lib/IxTclNetwork
Installing Ixia IxOS on Microsoft Windows
1 Following the Ixia installation instructions, download and install IxOS.
2 Following the Ixia installation instructions, download and install IxNetwork.
3 Skip this step if you are going to use the TCL interpreter installed with Ixia (c:/Program Files/Ixia/IxNetwork/tcl8.4/bin)
Append the IxTclNetwork directory to the TCLLIBPATH environment variable. Typically it is located at:
c:/Program Files/Ixia/IxNetwork/tcl8.4/lib/IxTclNetwork).
83 iTest Installation Guide
Installing IxiaTraffic software for use with iTest
Note Skip this chapter if you do not use IxiaTraffic software in iTest to control Ixia devices.
This section describes the software installation procedure. As a result of installing the Ixia software, you will be able to use IxiaTraffic steps in iTest test cases.
Installing Ixia IxOS on Linux See page 83.
Installing Ixia IxOS on Microsoft Windows See page 85.
Installing Ixia IxOS on Linux
Ensure compatibility Ensure compatibility between IxOS and any other Ixia software. See the Ixia compatibility matrix at: http://www.ixiacom.com/support/product_compatibility_matrix/ iTest support for Ixia products is listed in “Spirent and Third-party Software” on page 9, , “”.
Install Tcl You must install Tcl to use iTest with any traffic generation software. Tcl version requirements are described in the iTest release notes, under “Software Interoperability”.
Install Ixia IxOS software Following the Ixia installation instructions, install and configure the IxOS software to home/user/ixia/IxOs. Configuring Ixia IxOS for use with iTest Follow these additional instructions:
1 Close all instances of iTest.
2 On the computer that runs iTest, install Ixia.
3 Set the TCLLIBPATH environment variable.
export TCLLIBPATH="$TCLLIBPATH $IXIA_HOME/lib" 4 Set additional path variables Add the following paths to TCLLIBPATH:
home/user/ixia/IxOs/lib home/user/ixia/IxOs/lib/IxLoad Set the following paths:
export IXIA_HOME=
export IXIA_LOGS_DIR=/tmp export IXIA_RESULTS_DIR=/tmp export IXIA_SAMPLES=$IXIA_HOME/samples export IXIA_TCL_DIR=$IXIA_HOME/lib
# IXIA must be in the path export LD_LIBRARY_PATH=$IXIA_HOME/lib:$LD_LIBRARY_PATH
84 Chapter 9 Installing Ixia Traffic Generators
Installing Ixia IxOS on Microsoft Windows If you will control Ixia devices with iTest, then install Ixia IxOS.
Ensure compatibility iTest support for Ixia products is listed in “Spirent and Third-party Software” on page 9, , “”.
Install Ixia IxOS software 1 Close all instances of iTest.
2 On the computer that runs iTest, follow the Ixia installation instructions to install IxOS to C:\Tcl\bin;C:\Program Files\Ixia\IxOS\
Important iTest will auto-locate the IxOS application if it is installed in the default location. Follow Step 3 and Step 4 only if the application is not installed in the default location.
3 Modify the PATH environment variable. Place the following paths as the first paths in the list. In this example, the Tcl interpreter is installed at C:\Tcl C:\Tcl\bin;C:\Program Files\Ixia\IxOS\
C:/Program Files/Ixia/IxOS/
Notes If you have already installed IxOS with an unsupported version of ActiveTcl, then you must uninstall IxOS, upgrade ActiveTcl, and then reinstall IxOS. (Ixia offers no option to upgrade ActiveTcl directly.) During IxOS installation, when you are prompted for the ActiveTcl version that is installed on your computer, be sure to specify the version that is actually installed.
85 iTest Installation Guide
Specifying the Tcl library path
Important iTest will auto-locate the Tcl application if it is installed in the default location. Follow the instructions in this section only if the application is not installed in the default location.
Specify the following paths for the TCLLIBPATH environment variable: {C:/Program Files/Ixia/TclScripts/lib} {C:/Program Files/Spirent/iTest
86 CHAPTER 10
Installing Quality Management Integration
Installing the iTest adapter for IBM Rational Quality Manager
Note Skip this chapter if you will not use IBM Rational Quality Manager (RQM) with iTest.
The iTest adapter for IBM Rational Quality Manager enables RQM to execute iTest test cases. RQM prerequisites and installation steps: • Make sure RQM server be started successfully before installing The adapter.
• Refer to setting Java in server.startup.bat inside RQM installation folder. See also https://jazz.net/downloads/rational-quality-manager/ Follow these instructions to install the required versions of the RQM adapter.
“Install RQM adapter for Server version 6.0.1, 6.0.2 or higher” on page 87
“Install RQM adapter for Server version prior to 6.0.1” on page 89
Install RQM adapter for Server version 6.0.1, 6.0.2 or higher
Step 1 Obtain the adapter
1 Request the adapter from Spirent Customer Support [email protected]
2 Unzip the file to a temporary location on a local disk.The components in the server folder should be deployed on the host where RQM is installed.
Step 2 Install the server components
1 Ensure that the server folder contains the following files:
spirent-update-site.zip spirent-profile.ini 2 Copy the server folder to a temporary location on the host where RQM is installed.
3 Unzip the spirent-update-site.zip file to a temporary location; this will create a folder called spirent-update-site.
4 Install the update site: Copy the spirent-update-site folder as a sub-folder to the following location.
Note Ensure that the folder is not anywhere under RQM Server install directory.
87 iTest Installation Guide
5 Update the value of the url property in the spirent-profile.ini file to point to the install location identified in Step 4. For example, if your install location is
/home/user/qm/iTest-Adapter/spirent-update-site then change the url line in the file to:
url=file:qm/iTest_Adapter/spirent-update-site 6 Copy the updated spirent-profile.ini file to:
[install_root]/server/conf/qm/provision_profiles/spirent-profile.ini
where [install_root] is the root location where RQM is installed. 7 Reset RQM to deploy the Spirent components:
a Log in to RQM as an administrator.
b Navigate to:
https://
where
d Log out of RQM.
e Stop and start RQM.
f run “repotools-qm -clean” as follows to clear and install iTest adapter.
[install_root]/server/repotools-qm
88 Chapter 10 Installing Quality Management Integration
Install RQM adapter for Server version prior to 6.0.1
Step 1 Obtain the adapter
1 Request the adapter from Spirent Customer Support [email protected]
2 Unzip the file to a temporary location on a local disk.The components in the server folder should be deployed on the host where RQM is installed.
Step 2 Install the server components
1 Ensure that the server folder contains the following files:
spirent-update-site.zip spirent-profile.ini 2 Copy the server folder to a temporary location on the host where RQM is installed.
3 Unzip the spirent-update-site.zip file to a temporary location; this will create a folder called spirent-update-site.
4 Install the update site: Copy the spirent-update-site folder as a sub-folder to the following location.
Note Ensure that the folder is not anywhere under RQM Server install directory.
Windows c:\iTest-Adapter Linux /home/user/iTest-Adapter 5 Update the value of the url property in the spirent-profile.ini file to point to the install location identified in Step 4. For example, if your install location is /home/user/iTest-Adapter/spirent-update-site then change the url line in the file to:
url=file:/home/user/iTest-Adapter/spirent-update-site 6 Copy the updated spirent-profile.ini file to:
[install_root]/server/conf/qm/provision_profiles/spirent-profile.ini
where [install_root] is the root location where RQM is installed. 7 Reset RQM to deploy the Spirent components:
a Log in to RQM as an administrator.
b Navigate to:
https://
where
d Log out of RQM.
e Stop and start RQM.
89 iTest Installation Guide
90 CHAPTER 11
Installing NTAF Server
Important The Spirent TestCenter NTAF and Spirent Avalanche NTAF sessions are obsolete and is no longer supported.
Any references is provided only to support existing implementations.
Important Skip this chapter if you will not use NTAF providers with iTest. Spirent supports the following tools: Landslide NTAF.
This chapter describes the software installation procedures. As a result of installing the software, you will be able to access sessions that use NTAF in iTest test cases. Using iTest to control Spirent applications is supported only when both iTest and the NTAF proxy service are running on Windows.
Instructions for configuring NTAF servers The Landslide installer creates a default NTAF installation directory. You also have the option to place the NTAF files in a different location. If you want to use a different path for the NTAF harness and tools, then you must identify the directory using the SPRIENT_NTAF_DIR environment variable so iTest can locate the necessary files. Follow these instructions after installing Avalanche NTAF or Landslide NTAF:
To specify the NTAF installation directory
Step 1 Add the environment variable that specifies the NTAF installation directory Linux The recommended path for the NTAF installation directory is: /opt/Spirent/NTAF
Add the new environment variable into /etc/bashrc as follows: export SPIRENT_NTAF_DIR=/
91 iTest Installation Guide
Windows a Right-click My Computer and click Properties
b Click Advanced System Settings
c In the System Properties window, on the Advanced tab, click Environment Variables
d Click New and set the following values:
Variable name: SPIRENT_NTAF_DIR
Variable value (recommended): C:/Spirent/NTAF
Note Before using the NTAF proxy, perform these settings: If NTAF Proxy is not running on the same PC as iTest, on the PC that is used to run NTAF Proxy, set NTAF_PROXY_JAVA_HOME variable and this environment variable should point to JRE 32bit.
Example: NTAF_PROXY_JAVA_HOME=C:\Program Files (x86)\Java\jre1.8.0_181)
If NTAF Proxy is running on the same host machine as iTest, install jre32bit and configure that NTAF_PROXY_JAVA_HOME variable. Landslide TCL API (Replay Mode) requires 32-bit Java 8+ (1.8.0) and it is recommended to install Oracle Java JRE/JDK 1.8 32 bit from Oracle's Java Website http://www.java.com/.
Step 2 Copy the installed NTAF files to the new NTAF directory Because the installer placed the NTAF files into the default installation directory, you now move the files to the location that you specified using the environment variable. There are two sets of files to move:
Harness:
Tool:
Step 3 Restart the host to apply the new configuration
Overview: Multiple host setup XMPP is designed for communication across hosts and even across disparate networks. It is possible and often useful to have one centralized XMPP server for all NTAF usage. For GUI capture, iTest, proxy, and Spirent applications are typically installed on one host. For execution and replay one might place iTest on one host and proxy + the Spirent application on a different host.
Multiple host architecture, Landslide The proxy also requires that a Landslide client be installed on the same host. Landslide, however, has a more complex structure than Avalanche because its GUI runs as a Web Start application — the Landslide TAS host is separate. The GUI, however, gets downloaded from
92 Chapter 11 Installing NTAF Server
the TAS to the host that the proxy is running on. Landslide replay runs locally (it is downloaded during setup). In both cases the Landslide code communicates with the TAS. iTest <====> XMPP <====> Proxy + Landslide <====> TAS
GUI capture compared with execution/replay It is possible to install iTest on a different host than the host for the proxy and Spirent applications. For example, the proxy and Spirent application could be centralized to one or a few hosts. During capture, however, the application GUI will launch on the same host with the application and the proxy. Because a user needs access to the display of the proxy and application host, capture is simpler if iTest is installed on the same host as the proxy and application. (Of course it is still possible to run iTest on a separate host during capture if the user has remote access to the proxy host through an application like VNC or remote desktop.) For replay, because the user does not need access to the application GUI, replay with iTest and proxy-application on separate hosts is much easier. When using separate hosts, users must be aware of file locations. For example, TestCenter replay requires a configuration file and will look for that file on its local host. Users must take care that a proper URI is used within iTest to refer to files on the remote host.
93 iTest Installation Guide
94 CHAPTER 12
Install iTest Test Report Database
Note The instructions on this page are intended for a system administrator who will configure a database server for use with iTest. Supported database servers are listed in the Release Notes.
You can store iTest test reports in a centralized external database (instead of the built-in database). The external database can be any JDBC-compliant database. Spirent has tested this feature only with MySQL. It should be possible, however, to use other database servers like Microsoft SQL Server, Oracle, PostGreSQL, or Derby. Perform theses steps to maintain test report consistency between older versions of iTest and iTest 7.0.1 (or later versions) It is mandatory to perform the following steps to maintain test report consistency between iTest:
Download from Spirent Customer Use this script to ... Support.
MySqlUpdate.sql Update original database schema version from iTest 7.0.1 to iTest 8.5.
Setting up a MySQL database for use with iTest
Step 1 Install MySQL server on a workstation or a server See the MySQL documentation for MySQL server installation instructions. Spirent recommends at least 4GB of memory and 500 GB of disk space for a server handling a team of 20 users. You may use less or more disk space based on the rate and size of reports.
Step 2 To support iTest, modify the /etc/my.cnf file:
Modify the /etc/my.cnf file as follows:
• Text encoding: By default, MySQL server uses the default encoding of the host computer. iTest sends data in UTF8 format, so add following lines to the [mysql] section:
default-character-set = utf8 character-set-server = utf8 collation-server=utf8_general_ci • Maximum size of a table record: The MySQL server limit on the size of a table record being transferred from an SQL client (iTest) to the server is 4 MB. Because each step in an iTest test report is a record in a table on the server, you will need to set this size based on the maximum size of a response for a step that you expect in your test cases.
95 iTest Installation Guide
We recommend setting this to 32 MB because the default of 4 MB may not be enough for general use. Add the following line to the [mysqld] section:
max_allowed_packet = 32M • Database connections: Increase the number of database connections to around 10,000. (rule of thumb: use 10 connections per instance of iTest). Add the following line to the [mysqld] section:
max_connections=10000 • Non-local users: By default, MySQL server provides access to local users only, that is, it binds itself to “localhost”. Change the bind-address parameter setting so that users from other computers can connect to the server:
bind-address =
Step 4 Create a test report database on the server
To create the database, you can use either the mysql command line application or MySQL Administrator.
The MySqlSchema.sql file mentioned in these instructions appears in the file on CSC which may be downloaded (CSC label): iTest External TestReport MySql Database Schema.
The MySqlUpdate.sql file mentioned in these instructions appears in the file on CSC which may be downloaded (CSC label): iTest External TestReport Database Update Schema. Start the program using the user ID of the administrator that you created while installing the database server. If you are using mysql command line, submit the following commands: • Commands 1 and 2 create the database:
1> create database itestreports; 2> use itestreports; • Command 3 allows you to create a login and password pair to be used by iTest to connect to this database. You may want to read about how MySQL credentials are managed in order to have a fully secure database server.
3> ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY
• Command 4 creates all tables and indices required by iTest.
4> source MySqlSchema.sql • Command 5 updates the data in a table.
MySqlUpdate.sql.
Step 5 Configure iTest to save reports to the external database
These instructions apply for MySQL only. For instructions for other database servers, see the Online Help topic on “Configuring iTest to save test reports to an external database”.
1 Install iTest on a client computer.
2 Start iTest and click Window > Preferences.
96 Chapter 12 Install iTest Test Report Database
3 On the Preferences page, in the Spirent group, navigate to General > Test Reports > Test Report Database.
4 Select Use an external database to store test reports and then specify the following settings.
Database type MySQL
Database server Specify the hostname or IP address of the database server. address / Host
Database server port Leave the port number as 0 — iTest will use the default TCP port to connect number to MySQL server. Change the port number only if you have changed the default port on the server.
Database/Catalog Type itestreports (or the name that you used in the create database name/SID command.
User ID Type the username that you specified in the grant all command.
Password Type the password that you specified in the grant all command.
JDBC connection Do not change string
Driver class Do not change
5 To save and apply the settings, click OK and then exit and restart iTest.
Step 6 Verify iTest connectivity to the server
On the Test Report Database page, click Test Connection. If you connect successfully, iTest is ready to save test reports to the database. To read more about test reports, consult the iTest Online Help. If you get a failure dialog, modify server settings based on the error message until the connection is successful. Some common errors are:
The database server is not listening on the correct IP address
The database catalog name is not correct
Credentials are not correct
Step 7 Configure how old reports are aged Irrespective of the disk capacity, you have to think about aging (deleting) test reports when they become “old”. You can set up an aging script on the server to periodically delete the records.
Spirent supplies a script called agescript.sh (included in the iTest Scripts_Test_Report_Database folder) that you can periodically run using a cron job. The script is written for Linux, but you can modify it for a Windows server. Modify the parameters in the script to age older test reports as required at your organization.
97 iTest Installation Guide
Updating the test report database for new releases of iTest To update the external database schema when upgrading iTest:
An admin user who is familiar with running SQL scripts should source the MySqlUpdate.sql script against the reporting database schema. The script appears on the Customer Support portal. You will find general instructions on running SQL scripts in the script that is used during initial database installation: MySqlSchema.sql (in the same folder).
98 CHAPTER 13
Configuration Tips
Note This chapter provides tips and suggestions to configure your environment, for example your browser settings to automate web based regression tests against each browser. iTest Selenium—IE settings to Replay Selenium Test Case
Note Selenium playback/replay is not supported on Windows IE, when Agent is installed as a service.
Follow these settings.
IE11 Set the same Protected Mode value for each zone (all ON or all OFF)
Enable embedding credentials into URL (create or modify registry key/value/data if needed): 64-bit Windows: HKLM\SOFTWARE\Microsoft\Internet Explorer\Main\FeatureControl\FEATURE_HTTP_USERNAME_ PASSWORD_DISABLE
Important Inside this key, create a DWORD value named iexplore.exe with the value of 0.
Disable Branch Cache feature (create or modify registry key/value/data if needed): 64-bit Windows: HKLM\SOFTWARE\Wow6432Node\Microsoft\InternetExplorer\Main\ FeatureControl\FEATURE_BFCACHE
Important Inside this key, create a DWORD value namediexplore.exe with the value o0f.
Windows Server Turn off IE ESC (Enhanced Security Configuration). See http://support.citrix.com/article/CTX128789
IE11 KB3025390 Should be fixed by KB3021952 update update
99 iTest Installation Guide
Security Settings for IE Follow these steps, which are required Internet Explorer (8,9,10 and 11) settings to replay Selenium Test Case.
1 Go to the Control Panel from the Start option and then open Internet Options. OR
Start the Internet Explorer browser, select Tools > Internet Options.
100 Chapter 13 Configuration Tips
2 Click Security Tab > Internet. Select Enable Protected Mode and click Custom level.
3 Scroll down the list. Select the Disable option for “Only allow approved domains to use ActiveX without prompt”, under ActiveX controls and plugins.
Note For the rest of the options, select Enable or prompt and click OK.
101 iTest Installation Guide
4 Repeat the above steps for the Local Intranet > Security tab.
5 Enable protect mode for Trusted sites and Restricted sites.
6 Restart the IE Browser and iTest.
7 Execute the Selenium test case.
102 How to Contact Us
To obtain technical support for any Spirent Communications product, please contact our Support Services department using any of the following methods:
Spirent products and services Information about Spirent Communications and its products and services appears on the company website at https://support.spirent.com/SpirentCSC/
Obtaining technical support To obtain technical support for any Spirent Communications product, please contact our Support Services department using any of the following methods:
Americas Web: https://support.spirent.com/SpirentCSC/
E-mail: [email protected] Toll Free: North America +1 800-SPIRENT (+1 800-774-7368)
Europe, Middle East, Africa Web: https://support.spirent.com/SpirentCSC/
E-mail: [email protected] EMEA: +33 (1) 6137-2270 United Kingdom: +44 1803-546333 Toll Free: +1 818-676-2616
Asia Pacific Web: https://support.spirent.com/SpirentCSC/ E-mail: [email protected] In China Mainland: 86 (400) 810-9529 (toll-free) Out of China Mainland: +86 10 8233-0033 India: 1800-419-2111 Information about Spirent Communications and its products and services can be found on the main company website at https://www.spirent.com. Information about our global office locations can be found at https://www.spirent.com/About_Us/Locations
103 104