view README @ 21:7cd98b5c3440 draft default tip

Fixed issue with virtual methods which were included in the report (which was wrong).
author Pavel Tisnovsky <ptisnovs@redhat.com>
date Thu, 23 Aug 2012 14:06:33 +0200
parents 29318fe8d6d0
children
line wrap: on
line source

Mauve test coverage tool
========================

This tool could be used to measure test coverage of Java standard API.
It's based on Mauve tests directory structure, but the tool is able to
work with other type of tests.



How it works:
-------------
1. First of all, full names of all public class from rt.jar archive are
   exported to text file (you could use this text file as basis for
   creating list of selected API classes).

2. In the second step the test tool lists all public methods from selected API
   classes (this step is based on Reflection API functionality!).

3. In the third step tests bytecode are investigated and all API calls
   are registered (this means, that all tests should be compiled first).

4. Results from step 2 and step 3 are compared and HTML report is generated.



Building test coverage tool
---------------------------

This task is very straighforward, just type:
make build



Running test coverage tool
--------------------------

First you need to configure the tool by editing following three
text files:

path_to_rt_jar.txt: this file should contains full path to rt.jar
test_directory.txt: this file should contains path to test directory
class_list.txt:     list of classes to be tested (you usually don't want
                    to test whole API)

When these three files are configured, type:

make report

Results are stored in directory "reports", you want to open file "index.html"
in web browser.