Code Coverage Receiver

C o d e C ov e r a g e R e c eiv e r
R20
Amendment History:
Revisio
Date Amended Name Description
n
1 June 23rd 2016 T. Aubert Initial version
2 Sept. 12th 2016 T. Aubert Add the xml files description
3 March 22nd 2019 S. Sakthi R19 AMR Review
3 March 25th 2020 S. Sakthi R20 AMR Review
Page 2
C o pyri g h t
Copyright © Temenos Headquarters SA 2009-2020.
All rights reserved.
This document contains proprietary information that is protected by copyright. No part of this document may
be reproduced, transmitted, or made available directly or indirectly to a third party without the express
written agreement of TEMENOS UK Limited. Receipt of this material directly TEMENOS UK Limited
constitutes its express permission to copy. Permission to use or copy this document expressly excludes
modifying it for any purpose, or using it to create a derivative therefrom.
Err a t a a n d C o m m e n t s
If you have any comments regarding this manual or wish to report any errors in the
documentation, please document them and send them to the address below:
Technology Department
Temenos Headquarters SA
2 Rue de l’Ecole-de-Chimie,
CH - 1205 Geneva,
Switzerland
Tel SB: +41 (0) 22 708 1150

Fax: +41 (0) 22 708 1160
Please include your name, company, address, and telephone and fax numbers, and email
address if applicable. TAFJdev@temenos.com
Page 3
Table of Contents
Copyright................................................................................................................................................ 3
Errata and Comments............................................................................................................................ 3
Quick start (command line).................................................................................................. 5
To start the server............................................................................................................ 5
To stop the server............................................................................................................ 5
To create an instance....................................................................................................... 5
To start an instance.......................................................................................................... 5
To stop an instance.......................................................................................................... 5
To delete an instance....................................................................................................... 5
To have a full status of your server.................................................................................. 6
To have a status of one single instance........................................................................... 6
To reset an instance......................................................................................................... 6
To create a report............................................................................................................. 6
Very Quick start (command line).......................................................................................... 6
The code coverage configuration file................................................................................... 7
Using the UI.......................................................................................................................... 8
The inconsistencies............................................................................................................ 10
Remote management by command line............................................................................. 10
The report........................................................................................................................... 12
The welcome page........................................................................................................ 13
The inconsistencies view............................................................................................... 13
The report details........................................................................................................... 14
XML files........................................................................................................................ 19
Intro d u c ti o n
Page 4
The Code Coverage Receiver (ccr) is a standalone program which will receive informations
via TCP from different running JBC code. This program is able to generate full html report. It
can be managed via a web interface as well as via command lines. The ccr can be
configured to receive informations from different versions on the JBC.
Qui c k s t art ( c o m m a n d lin e )

The Code Coverage Receiver (ccr) has only one binary (ccr / ccr.bat). It is located in the
<home_of_ccr>/bin directory. Before anything, make sure you environment variable
JAVA_HOME points to a jre 1.7.x. From this binary, you can do all the necessary.
To s t a r t t h e s e r v e r
ccr (.bat) start
This will start the server in background.
To s t o p t h e s e r v e r
ccr (.bat) shutdown
Once the server is started, you need to create a new instance (this is effectively what will
receive informations from your JBC programs.
To c r e a t e a n i n s t a n c e
ccr (.bat) create <instance_name> <tcp port> [“start”]
example : ccr create Test 12345 start
If you ommit the start at the end, the instance is created but not started. You can start / stop
and instance like this :
To s t a r t a n i n s t a n c e
ccr (.bat) start <instance name)
example : ccr start Test
To s t o p a n i n s t a n c e
ccr (.bat) stop <instance name>
example : ccr stop Test
To d e l e t e a n i n s t a n c e
ccr (.bat) delete <instance name>
example : ccr delete Test
Page 5
To h a v e a f u l l s t a t u s o f y o u r s e r v e r
ccr (.bat) status
To h a v e a s t a t u s o f o n e s i n g l e i n s t a n c e
ccr (.bat) status <instance_name>
To r e s e t a n i n s t a n c e
ccr (.bat) reset <instance_name>
Resetting an instance means clearing all data received so far (starting fresh).
To c r e a t e a r e p o r t
ccr (.bat) make <instance name> [-p <path of precompile>] [-s <path of sources>] [-d <report
destination path>]
The path of precompile is the path containing all the precompile jars. If it is omitted, the Code
Coverage Receiver will obviously know nothing about the subroutines not having been
executed, and the subroutine coverage ration will always be 100%. However, the line
coverage will be correct.
If the <path of sources> is omitted, the report won't be able to drill down until the sources (not
a big deal for management reporting)
If the <report destination path> is omitted, the report will be created in the default location :
<home_of_ccr>/data/<instance name>/report
Note : Creating a report is time consuming, and it can easily take up to 1-5 minutes
depending your machine. Be patient !
Very Q u i c k s t a r t ( c o m m a n d l i n e )
Here is in few lines how to start from scratch, up to a report.

$ c cr start
$ c cr cr e a t e m yIn s t a n c e 1 2 3 4 5 s t art
Edit your tafj.properties like this :

temn.tafj.runtime.enable.coverage = true
temn.tafj.runtime.coverage.host = localhost (or the ip address of ccr machine)
temn.tafj.runtime.coverage.port = 12345
Run your program (eg EX). One done,
$ c cr m a k e myInsta n c e
Page 6
Done !
T h e c o d e c o v e r a g e c o n f i g u r a t i o n fil e .
At the root of your Code Coverage Receiver, you will find a file “CCReceiver.properties”.
This file contains few informations to make the server running :
vm_options=-Xms256M -Xmx2048M -XX:MaxPermSize=256M
http_port = 7470
instances = Test;running
vm_options is the java VM options used when starting the receiver.

Please consult the internet for more options.
http_port is the main port for all the Receiver. You can change it without any problem, but
make sure your server is stopped otherwise you won't have any other choice to “kill” it.
instances is a coma-separated list if names of instances.
each instance is supposed to have its corresponding <instance> directory in which you will
find <instance>.property file as well as other resources.
Their is no need to configure anything. The default values are all right for a normal activity.
Page 7
U si n g t h e UI
This is possible to manage your receiver via a web interface. For that, open a browser a
browse : http://<ip_of_ccr>:<http_port>/CoverageReceiver
At that stage, you can only Shutdown the receiver or create a new instance.
Let's click on “New Instance ...”
A very simple wizard will guide you through the instance creation. Small note : press <tab>
after having typed something for activating the navigations buttons.
Page 8
Once you clicked finished, your main screen will look like this :
If you read the “Quick start (command line)” chapter, you will recognize all the
options on your screen. No need to comment them again here.
Click on “Start” and … … you are ready to go !
Everything is persisted, so if you shut down the Receiver and restart if afterwards, it will
remain in the exact same status as when you stopped it.
Page 9
The incon sist e n ci e s
As you can see on the previous screen-shots, an instance can be either “running” or
“stopped”, but the side-icons are showing three states.
The second state indicates that there are some inconsistencies in the data received
(or loaded).
This is the “warning” state :
To understand what it means, you need to understand how it is all working.

At the runtime side (when you run your jBC code), there is a special process which collects
the line executed and send them in regular basis to the Code Coverage Receiver. Alongside
with the line numbers, there are 3 other informations sent :
1) The Subroutine name.
2) The total number of lines in this subroutines
3) The $PACKAGE information.
The first one is obvious. The second one is here to be able to generate a report even if you
are not specifying a precompile directory. However, imagine that you run a first time you
program, the Receiver receives a certain total number of lines, then you modify the program
and re-run it without resetting the instance.
In that case, we have an inconsistency. The report will certainly be wrong. Fortunately, we
can see these inconsistencies (see the “report” chapter later in this document).
The situation is the same with the $PACKAGE information. You will see that in the report, the
data are organized by “module” / “component”. If, in the same instance, we receive 2 times
the same routine with a different package, this create an “inconsistency”.
R e m o t e m a n a g e m e n t by c o m m a n d lin e
Since this is possible to manage a Code Coverage Receiver remotely with the UI, this is also
possible to do it command line.
All the commands (exept start) can have the “host:port” information as a prefix.
Example : to add an instance on a remote machine (running ccr !), you can type :
ccr remote_ip:remote_port create instance_name port
Example :
$ c cr 1 0 . 4 1 . 5. 5 1: 7 4 7 0 cr e a t e m y N e wI n s t a n c e 1 2 1 2
Page 10
The only command which cannot have a remote ip address is “start”. This seems obvious.
However, we can do something like this :
$ c c r l o c a l h o s t: 7 4 8 0 s t a r t
This will start the Code Coverage Receiver on the port 7480.
In other words, for the start command, the host “localhost” is forced.
Here is the full syntaxes of all the available commands
[…] means “optional”
<...> means “any” value
“...” means a “strict” value
Start the receiver :

c c r [“loc al h o s t”: ] s t a r t
Shutdown the receiver :
ccr [ < host >: <ip >] sh utdow n
Return the status of all (or a single) instance :
ccr [ < host >: <ip >] stat us [ <insta nce n a m e >]
List all the instances names :
c c r [ < h o s t > : ] in s t a n c e s
Create a new Instance :
c c r [ < h o s t > : ] c r e a t e [“s t a r t ”]
Delete an instance :
c c r [ < h o s t > : ] d el e t e 
Reset an instance (clear the collected data) :
ccr [ < host >: <ip >] res et 
Start an instance :
ccr [ < host >: <ip >] sta rt 
Stop an instance :
ccr [ < host >: <ip >] stop 
Generate a report (can take few minutes) :
c c r [ < h o s t > : ] m a k e [-p ] [-s < s o u r c e di r > ] [-d
< d e s ti n a tio n di r > ]
Page 11
Th e rep ort
Once the report is generated (either by command line with the “make” option or from the UI,
you will have a “report” directory containing “static” html pages.
This report is completely detached of anything and can be moved to a new machine.
Also, a zip file of the “report” directory is generated at the same time to make a download
easier.
From the UI (Browser) perspective, the links to the report (for immediate consultation) and to
the zip (for download) appears as shown here :
The zip file can be downloaded from command line with the wget program. The url is
http://<host>:<port>/CoverageReceiver/download/<instance name>/report.zip
eg :
http://localhost:7470/CoverageReceiver/download/myInstance/report.zip
The report url (if generated in default location) is :
http://<host>:<port>/report/<instance name>/report/index.html
Page 12
The w elc o m e pa g e
The welcome page will give an instant view on the coverage as follows :
Note : For the purpose of the documentation, the report has been based on a full component
build of T24 (running all the unitTests). Then, the report has been generated passing AN
OLDER version of the precompiled jars to force some inconsistencies.
You can see that this report has some inconsistencies. By clicking on the “<click for full list>,
you will see all the inconsistencies. Please read the “inconsistencies” chapter for more
details.
T h e i n c o n s i s t e n c i e s vi e w
Here is a view of the inconsistencies :
Page 13
Th e r e p ort d e t ail s
The report is organized by module / component / subroutines.
Here are the different view you will have :
The “full” initial view :
Page 14
One module view
All the components
Page 15
Page 16
You can sort the column by clicking on them :
One component :
Page 17
Page 18
One routine :
X ML fil e s
In addition to the static html files composing the report, you can find a subdirectory called
“xml”. This directory contains xml files representing the coverage information by module /
component.
Here is an example of the “module” files :
Page 19
and here an example of the “component” files :
Page 20

Code Coverage Receiver

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Code Coverage Receiver

Uploaded by

Copyright:

Available Formats

C o d e C ov e r a g e R e c eiv e r

3 March 25th 2020 S. Sakthi R20 AMR Review

Tel SB: +41 (0) 22 708 1150

To start the server............................................................................................................ 5

To stop the server............................................................................................................ 5

To have a full status of your server.................................................................................. 6

To have a status of one single instance........................................................................... 6

Very Quick start (command line).......................................................................................... 6

The code coverage configuration file................................................................................... 7

Using the UI.......................................................................................................................... 8

Remote management by command line............................................................................. 10

The welcome page........................................................................................................ 13

The inconsistencies view............................................................................................... 13

The report details........................................................................................................... 14

Qui c k s t art ( c o m m a n d lin e )

This will start the server in background.

example : ccr create Test 12345 start

example : ccr start Test

example : ccr stop Test

example : ccr delete Test

Here is in few lines how to start from scratch, up to a report.

Edit your tafj.properties like this :

Run your program (eg EX). One done,

vm_options=-Xms256M -Xmx2048M -XX:MaxPermSize=256M

vm_options is the java VM options used when starting the receiver.

instances is a coma-separated list if names of instances.

Click on “Start” and … … you are ready to go !

The incon sist e n ci e s

To understand what it means, you need to understand how it is all working.

Here is the full syntaxes of all the available commands

[…] means “optional”

<...> means “any” value

“...” means a “strict” value

Start the receiver :

The report url (if generated in default location) is :

Here are the different view you will have :

The “full” initial view :

One module view

All the components

You can sort the column by clicking on them :

Here is an example of the “module” files :

and here an example of the “component” files :

You might also like