|
INSTALLATION README © Copyright 1999-2006 by Software Research, Inc. |
|
|
INSTALLATION README © Copyright 1999-2006 by Software Research, Inc. |
The following information is available in this README file:
The fully working examples are provided in the Examples subdirectory:
Before starting, you will need to have installed Java 2 SDK, v1.3. This can be freely downloaded here.
eValid, V6 is required if you want to instrument and gather Coverage data from Java Applets.
DEMO versions of TCAT/Java contains a temporary access license file located at TCAT/Java's Program directory. EVAL versions will require a license key to operate properly.
DEMO versions are restricted to writing at most 5 modules into the MDF file. To request a FULL evaluation license key, please contact Software Research by using the Information Request Form.
NOTE: Please read details attached with each emailed license key.
The default installation directory for TCAT/Java v3.2 is C:\Program Files\Software Research\Coverage\TCAT-Java
The path needs to be appended to your path in autoexec.bat and/or the path environment variable. If you are using NT, you can change the environment variable by opening the environment window from the System Properties window. For Windows NT 4.0 users, you can invoke System Properties window from the Start button by selecting Start->Settings->Control Panel->System
TCAT also needs the COMSPEC variable to be set in order to spawn the compiler on the instrumented code. Please set it in your startup files to an appropriate value (usually for Windows 3.1x and 95 - the path of command.com, for example, COMSPEC=C:\COMMAND.COM and for NT - cmd.exe, for example, COMSPEC=C:\WINNT\SYSTEM32\CMD.EXE
TCAT may create temporary files of the form _sbxxxx.tmp in your temp directory. These can be removed after the current instrumentation is done.
The Runtime classes of the instrumentor (which writes the trace file) are installed in TCAT/Java's Program directory under the java package testworks.runtime. You can either append the TCAT/Java Program directory to your java CLASSPATH or copy the testworks package to one of your CLASSPATH entries. There is no need to do this manually if you are using WinIJava to instrument and execute your instrumented Java applications as long as the classpath is set accordingly in your project Java Compiler Settings.
The module is provided in seven flavors for different buffering sizes. The choice of which one depends upon the application's target. Replace jrun.class by any of jrunXXX.class allow you to use different sizes. The instrumented Java code may run faster with a bigger buffer, but you may lose some trace records up to one buffering size if the application terminates abnormally. The default installation does not flush the records until the application terminates.
There is the Metalworks sample provided in the ...\Examples\Uninstrumented Examples\Metalworks 1.3 directory. The files in these directories are exactly the same as those provided in the JDK 1.3 demo directory.
An example is demonstrated here to help you getting started. The example is created using the Metalworks example from JDK 1.3, and the directory is located at $SR\Examples\Instrumented Examples\Metalworks 1.3 where $SR is your TCAT directory, for example, C:\Program Files\Software Research\Coverage\TCAT-Java The Metalworks.java file is instrumented by using WinIJava. Digraph is used to view the control structure associated with the source code. The trace file Trace.trc is created after running the instrumented code and the coverage report can be viewed by using Cover.
A step by step instruction is given below.
a) Creating a new Workspace and Project in WinIJava
Start up WinIJava.
Select File > New workspace...
A "New Workspace" window should appear.
Now create a new Project Name called Coverage by
selecting Project > Create and entering Coverage
as the name of the Project.
The Project Settings window for this Project should appear
with default values provided. These should suffice. Click
on the Close button.
b) Selecting Files to Instrument and Compile in WinIJava
At this time, no project is selected for you to work on.
Right-click on item Coverage under the Project pane and select Select.
Select Project > Add Files To Project ... to select
Java source files which you would like to instrument
and source files which you only would like to compile.
These files will appear in the other window once you have
selected them.
Alternatively you can right-click on the source tree
folders to insert/remove files.
For this example, selectc) Instrumenting and Compiling in WinIJava
Select Build > Build All to instrument and compile the
selected source files.
d) Executing the Instrumented Java code
Select Build > Execute to run a Java application provided
you specified the path to the Java instrumentor in your
Project Settings.
If no Java class file was specified in the Project Settings,
you will be prompted to select one to execute.
Select Metalworks.class.
The Java application will run and coverage report will be created
under the project directory you created.
Start up Cover.
From the File menu, select Open.
In the Open dialogue, click on the filename Trace.trc
created during instrumentation. If you followed through the steps
to instrument Metalworks above, the trace file should be found
in the TCAT\tcat_db\Coverage under the Metalworks 1.3 example
directory.
The dialog box then asks for an archive file; ignore this request
by clicking the Cancel button.
A coverage report of the test of Scribble appears.
Start up DigGraph.
Select File | Open.
You are prompted for the name of the directed graph to view.
Find the UISwitchListener.dg file under TCAT\tcat_db\Coverage\d_graph
of the Metalworks 1.3 directory.
A windows pops up listing the available functions. Select
one of the functions to view.
A directed graph depicting possible program flows of the function appears.
By clicking near the number associated with an edge
and selecting the View Source button, you can call up
and view the associated source code.
Note: You may unable to view any digraphs from this class under a DEMO license.
If you are having any problems either setting up or working with this version of TCAT/Java, please report them to Software Research and every effort will be made to get them resolved and included in the next release.
We would also appreciate feedback regarding the usability (the project workflow), how it can be improved, etc. Any other comments are also welcome.
You can contact Software Research through any of these ways:
Incident Report Form
Phone: +1 (415) 861-2800 or +1 (800) 942-SOFT
FAX: +1 (415) 861-9801