Welcome and Congratulations!
Welcome to the demo version of CDRouter! And congratulations on downloading the leading test tool for CPE and access routers!
This guide will help you get the CDRouter Demo installed and running in only nine simple steps. The CDRouter Demo contains 24 fundamental test cases from a suite of more than 1400 test cases available in the full version of CDRouter. It also contains the same web based interface and command-line interface available in the full product.
The CDRouter Demo is valid for 30 days. During this time, please contact firstname.lastname@example.org for additional assistance. Also, please check Additional Online Resources section of this guide for a list of additional online resources.
Please use the following steps to get started on your CDRouter evaluation.
To get started with the CDRouter Demo, you will need a dedicated PC running Linux, the CDRouter Demo software, a license file, and a typical SOHO router. The basic test setup for CDRouter is shown below.
CDRouter will install and run on most modern off-the-shelf PCs with a 32 or 64 bit Fedora, openSUSE, or Ubuntu operating system. The Linux host PC must also have Tcl installed, and a minimum of three installed and addressable network interfaces, of which two will be dedicated to CDRouter and one dedicated to your own lab or corporate network connection. For more information on CDRouter’s specific hardware and software requirements, please see this Knowledge Base article.
- For information on the network interface cards that we recommend, please refer to this Knowledge Base article.
- The network interfaces used for CDRouter should be configured with a static IP address of 0.0.0.0, as discussed in this Knowledge Base article.
- The CDRouter Demo requires that Tcl be installed on the Linux host PC. Most distributions install Tcl by default, however, some do not. Instructions for installing Tcl can be found in this Knowledge Base article.
- If the router under test is a DSL or DOCSIS based device, CDRouter can be still be used, provided a DSLAM or CMTS, respectively, is available. For more information, please refer to these Application Notes:
Using the test setup shown in Requirements section as a reference, connect eth1 on your Linux host PC to one of the LAN ports on your router. Likewise, connect eth2 to the router’s WAN port. Note that if your Linux host assigned names other than eth1 and eth2 to the available network interfaces, you will have to modify the lanInterface and wanInterface testvars in the default configuration file with the appropriate interface names. This process is discussed in detail in Create and Execute a Test Package Using BuddyWeb section.
Download the CDRouter Demo and License File
If you have not already downloaded the CDRouter Demo, please start the download process by visiting the following link:
Completion of this form will send a request to the QA Cafe Sales Team for the opportunity to download the CDRouter Demo. Please keep in mind that the website will automatically respond to all correctly entered email addresses with an acknowledgement of the request. The QA Cafe Sales Team will then try to contact you to verify your interest and your information. Please feel free to speed up the process by sending a separate email to email@example.com. Access to the CDRouter Demo software is only granted once communication has been established between you and the QA Cafe Sales Team.
Once this verification is complete, the Sales Team will send a separate email containing a link to download the CDRouter Demo installation file. You must download both the CDRouter Demo installation file and license file to complete the installation.
Install the CDRouter Demo and License File
Instructions for installing the CDRouter Demo and license file can be found here.
Note that you may need root-level access to complete installation. You can attain root-level access by logging in as root or by issuing the sudo su command.
Also note that the installer will handle installing the CDRouter Demo and all necessary files for your Linux distribution. This process will also install and start the CDRouter web interface, referred to as BuddyWeb (the command line interface is referred to as buddy).
Installation of the CDRouter Demo can be verified by running the buddy -info command as root. This should display some basic information about your system, license file, and the version of the CDRouter Demo you are using:
Copyright (c) 2001-2010 by QA Cafe (DEMO Version) Built on 2010-08-24 on fourcubed, pktsrc version 6.3 build 73 *** *** WARNING: THIS IS A QACAFE DEMO VERSION ONLY *** *** The number of network connections that can be created is limited to 6. *** This includes DHCP clients and wireless interfaces. This version also *** limits the number of packets that can be sent before exiting. *** *** For evaluation purposes only. *** INFO(setup): Starting buddy Tue Aug 24 12:34:40 EDT 2010 INFO(setup): Loaded OS version Linux-2.6.32-24-generic x86_64 INFO(setup): Loaded Tcl version 8.5.8 INFO(setup): Loaded buddy version 1.48 INFO(setup): (buildd@yellow) (gcc version 4.4.3 (Ubuntu 4.4.3-4ubuntu5) ) INFO(setup): Trying to load modules from '.' INFO(setup): Trying to load modules from '/usr/share/doc/cdrouter' INFO(setup): Trying to load modules from '/usr/share/doc/cdrouterdemo' INFO(setup): Start command: /usr/bin/buddy -info INFO(setup): Test Suite cdr-DEMO 6.3 build 73 INFO(setup): The system ID is DEMO-VERSION INFO(setup): Using license installed at: /etc/cdr-DEMO.lic INFO(setup): This demo expires in 30 days INFO(setup): Licensed to run: cdr-DEMO INFO(setup): BuddyWeb is enabled INFO(setup): IPv6 is enabled INFO(setup): IKE is disabled INFO(setup): TR69 is enabled INFO(setup): TR69-EDM is disabled INFO(setup): CPU is Intel(R) Core(TM)2 CPU 6420 @ 2.13GHz, bogomips 4256.03 INFO(setup): Loaded TclXML version 3.1 (libxml2), TclDOM 3.0, xmldefs 3.1
Run CDRouter Using BuddyWeb
After the install has finished, you can run CDRouter by connecting to BuddyWeb using a Firefox, Safari, or Chrome web browser. The default port for BuddyWeb is 8015.
For example, if your CDRouter Linux host has an IP address of 10.0.0.5, point your Firefox browser to the URL http://10.0.0.5:8015. If you are running locally, you can also use the URL http://127.0.0.1:8015, or http://localhost:8015. Once connected you should see the following BuddyWeb Home page.
Note that BuddyWeb provides several navigation “tabs” at the top of each page which can be used to navigate through the BuddyWeb interface:
Create a Configuration File Using BuddyWeb
Before a test can be executed a configuration file must first be created. A configuration file is comprised of test configuration parameters called testvars. Testvars are used to describe the configuration of the router under test and also control several aspects of CDRouter.
Configuration files can be created, edited, deleted, or imported using the BuddyWeb Configuration Manager. Using the navigation tabs at the top of the screen, click on the Configurations tab to access the BuddyWeb Configuration Manager. By default the CDRouter Demo is loaded with two configuration files named Example_config_1.conf and Example_config_2.conf as shown in the next screenshot.
To edit an existing configuration file, simply click its row or select it from the list in the Configuration Manager and click the “Edit” button in the toolbar at the top. The selected configuration file(s) will open for editing in a new window.
To create a new configuration file, simply click the “New Config” button to edit our default configuration file template, or launch our Configuration Wizard by clicking the “Wizard” button. We recommend starting with the Configuration Wizard, which is an intuitive graphical configuration file editor with inline help, as shown in the screenshot below.
When building an initial configuration file using the Configuration Wizard, it is essential that the Basic LAN and Basic WAN Configuration sections be completely filled out. The fields in these two sections specify the settings for the basic LAN-side and WAN-side connections between CDRouter and the router under test. Clicking on a field name will display help for that particular field in the lower right hand corner of the Configuration Wizard window.
Ultimately the Basic LAN and Basic WAN Configuration sections in the Configuration Wizard must match the configuration of the router under test. It is typically easiest, at least initially, to modify the settings on the router under test to match the default configuration settings in the Configuration Wizard. In cases where this is not possible, be sure to modify any fields appropriately to match the configuration on the router under test. Once you’ve built an initial configuration file, click the “Generate Config” button in the Configuration Wizard toolbar to save it.
Note that clicking the “Generate Config” button will generate the raw configuration file used by CDRouter. You can later edit this file directly or build a new configuration using the Wizard.
Create and Execute a Test Package Using BuddyWeb
You are now ready to create a new test package using the BuddyWeb Package Manager. Using the navigation tabs at the top of the screen, click on the Packages tab to access the BuddyWeb Package Manager. A package defines all of the components required to execute a group of tests, including the configuration file that should be used, the modules and individual tests that should be run, and various run-time options (run all tests once, repeat, etc.). Like the Configuration Manager, the Package Manager allows you to create, edit, and delete test packages, making it easy to compile and manage a comprehensive library of different test scenarios.
The CDRouter Demo is preloaded with the test packages Example package and Example package 2 as shown in the following screenshot.
To create a new package, simply click the “New Package” button from within the Package Manager. To view and/or edit the contents of an existing package, click anywhere in its row and then click the “Edit” button, as shown in the following screenshot.
Clicking the Edit button as shown above will open the selected package in the current window. The package name, description, associated configuration file, tags, options, and test modules can all be modified from the package edit window, as shown in the screenshot below. For more information on tags, which are user-defined labels that can be applied to configuration files, packages, and results, please see this Application Note.
Once a package has been created, it can be executed one of two possible ways:
- By navigating to the Packages page, selecting one or more test packages from the list and clicking the “Run/Queue” button. All selected packages will be added to the job queue and executed sequentially.
- By navigating to the Packages page, opening a single package and clicking the “Launch” button. Note that this will automatically redirect you to the Live page.
Note that the CDRouter Demo includes only a small subset of the total number of test cases available from QA Cafe (there are over 1400 test cases available to customers with the purchase of QA Cafe’s software modules, while there are only 24 test cases in the Demo). Please remember, the Demo is designed to give you the chance to see just how our software works. A link to the descriptions of all test cases included in the full version of CDRouter is included Additional Online Resources section of this guide.
Analyze Test Results Using BuddyWeb
Results can be viewed in real time while a test package is running by navigating to BuddyWeb’s Live tab. Once a test package finishes, the results are accessible from BuddyWeb’s Results tab.
The Results page contains a history of all test packages that have been executed. From the Results page you can view the detailed results, open the results directory, tag or star specific test runs, flag specific test case results, or export a test run as a .zip or .tgz archive. The Results page also displays the number of failures, the number of passes, the test duration, and the size of the results directory for each test package that has been executed.
The CDRouter Demo includes two sets of sample results as shown in the following screenshot:
Selecting one or more test runs and clicking the “View” button in the toolbar will open each test run in a new window and display the details for the selected test run(s) including individual test logs and capture files for each test case that was performed. The following screenshot shows the detailed test results for the included Example package which was run against a typical off-the-shelf router tested using the default values in the Example_config_1.conf configuration file:
As you can see, 14 tests were selected, ten of which passed, one which failed. The remaining three test cases were automatically skipped by CDRouter due to certain configuration options (in this case one reason that certain tests were skipped is that the WAN interface on the router under test was configured for PPPoE, therefore the DHCP tests are not applicable and were not performed).
The automatically generated log files provide additional information that can be used to debug failures. BuddyWeb also automatically captures all packets on the LAN and WAN interfaces and makes these available as capture files. Note that CDRouter includes an integrated capture file and packet viewer. To use this feature just click on the capture file links for a test result or click on a packet within a test log. Alternatively, capture files can be viewed using the Wireshark application. Also note that log and capture files can be viewed and automatically refreshed while a test case is running. The log and capture files may be accessed from BuddyWeb’s Live or Results tabs by clicking the appropriate links for each test.
That’s basically it! The router under test, if configured properly, should produce results similar to those shown above. You can examine the results in detail by reviewing the log and capture files, and even induce failures to verify that your router is functioning properly. The final step included in this guide is a brief overview of buddy, the command-line interface.
(Optional) Try the Command-Line Interface
The CDRouter command-line interface may also be used with the CDRouter Demo. The name of the command-line tool is buddy. Buddy is located in the /usr/bin/directory. All of the functionality included in BuddyWeb is also available using the various options included with buddy. Buddy is useful for generating automated test scripts and scheduling test runs (nightly regression testing for example).
To get started with buddy, create a new working directory and copy the example CDRouter configuration file.
# mkdir demo # cd demo # cp /usr/share/doc/cdrouterdemo/local.conf . # vi local.conf # buddy –trace –pt –capture –testpath /usr/share/doc/cdrouterdemo –config local.conf –logfile demo.txt
Alternatively, you can copy an existing configuration file created with BuddyWeb.
# mkdir demo # cd demo # cp /usr/buddyweb/configs/example.conf . # vi example.conf # buddy –trace –pt –capture –testpath /usr/share/doc/cdrouterdemo –config example.conf –logfile demo.txt
When running the demo for the first time from the command-line, we recommend using the following options:
- buddy -trace : Enable protocol trace messages
- buddy -pt : Enable a one line summary of sent and received packets
- buddy -capture : Create capture files for the LAN and WAN interface
- buddy -logdir : Capture all test output to a logfile
These options will turn on additional logging information to help debug any setup issues. The buddy -capture option will produce WAN and LAN capture files in the running directory that may be opened using Wireshark.
Run all tests:
# buddy -config myrouter.conf -testpath /usr/share/doc/cdrouterdemo -trace -pt -capture -logfile myrun.txt
List out the tests:
# buddy –summary
Run a specific test:
# buddy –config myrouter.conf –testpath /usr/share/doc/cdrouterdemo –execute cdrouter_nat_1
TIP: Instead of using the buddy -testpath option, you may set the environment variable BUDDY_TESTPATH:
# export BUDDY_TESTPATH=/usr/share/doc/cdrouterdemo
The following resources are available online:
Test case summaries:
- CDRouter test case summaries (add-ons listed individually below)
Customer Lounge - software downloads and updates (login required):