Control Code Coverage & Performance measurement

Report flags/Manager options for the CTRL Coverage

The following table contains the report flags and manager options for CTRL coverage:

The following table shows how to use the debug flags and manager options:

• To output the coverage data for panels, use the report flag -report CTRL_COVERAGE.

• Coverage information of a panel will be saved correctly in an XML file. The script editor, however, cannot read a panel code coverage report. The script editor can only read code coverage reports for libraries and scripts but not for panels.

The code coverage information is written to a manager log file: WCCOActrl2.log for the Control manager with the number 2. The report is also output in the log viewer:

Performance Measurement

The performance measurement allows you to output performance data. The calculation and storage of performance data takes considerable use of resources, influencing runtime performance. As a consequence, the output performance data is only calculated if the debug flag "CTRL_PERF" is used.

The following table contains the possible report and debug flags:

The following table shows how to use the report and debug flags:

CTRL Coverage Output

When one of the report or debug flags -dbg CTRL_COVERAGE or -dbg CTRL_PERF is active on manager start, an output file is created and will continuously be filled when data needs to be written (e.g. a thread ends or a script is stopped or when the manager finishes).

The xml filename can be defined in the following ways:

• Default: <manager><num>_cov.xml

• Commandline: -coveragereportfile <filename>

• Environment Variable: CTRL_COV_REPORT_STREAM

• Config Entry: [allSections] coverageReportFile

<project path>/log

-coveragereportfile subdir/coverage/fileName.xml

The content of the report file will be deleted before a new code coverage report is written. In order to avoid this, use place holders (see the description of the place holders in the tables above).

Code Coverage via the CTRL manager after starting

When -dbg CTRL_PERF or -dbg CTRL_COVERAGE was active on manager start, the reporting and thus writing to the file is done continuously. Contrary to this, when they were not active at start (to only count a part of the execution), using -report CTRL_COVERAGE while the manager is running will create the report file at that point in time. However, the file will only contain data which is available at that point in time. That means that scripts already removed (e.g. from an already closed panel) will not be known.

The xml content will no longer be written to the manager log file/stderr or the file given with -reportfile <fileName>

The following steps produce a coverage report after starting a CTRL Manager:

1. In the WinCC OA console add a new CTRL manager, which loads a script (manager option: <nameOfTheScript>.ctl) to your project.

2. Start the CTRL manager.

3. Press the key combination Ctrl+D in order to set the report flag:

   -report CTRL_COVERAGE -coveragereportfile coverage_$DATE$_$TIME$_$MAN$.xml

   for the CTRL manager.

1. The report file is located in the log directory of the project and shows how often a statement was executed.

Control Coverage Report in the Script Editor

The Coverage Report can be displayed in the script editor alongside the code that was analyzed.

The following steps describe this process:

1. Open the script, which runs in the CTRL manager, in the script editor.

2. Load the code coverage report (Coverage file coverage_[date]_[time]_WinCC OActrl2.xml) via the Load Code Coverage Report option in the File menu of the script editor. The report is by default located in the log directory of the project.

1. The script is automatically shown with the corresponding marks in the script editor. The executed parts are marked green, the not executed parts red. You can delete the markers by using the option Remove Coverage Markers in the View menu .

Control Coverage report in the CTRL Script Performance Analysis Panel

The Control Script Performance Analysis Panel (also called PerfVisu panel in the GEDI)

1. Go to the Tools- section in the GEDI and open CTRL Script Performance Analysis

2. Click the Load button and select the script you want to display.

1. The Coverage or Performance Report is opened in the PerfVisu panel. The display can be filtered with the option- check boxes at the top.

XML Cobertura File Format

You can convert a WinCC OA XML coverage file to an XML in Cobertura file format.

shared_ptr<ICtrlCoverageConverter> converter = new CtrlCoverageToCoberturaConverter();
converter.convert(inputFileName, outputFileName);

EXAMPLE:

string inputFileName = getPath(LOG_REL_PATH) + "WCCOActrl3_cov.xml";
string outputFileName = getPath(LOG_REL_PATH) + "WCCOActrl3_cov_Cobertura.xml";

You can convert all XML files of a directory ending with _cov.xml to Cobertura format. The converted files get the file name ending with _cov_Cobertura.xml.

EXAMPLE:

// Converting all COV files in log directory
shared_ptr<ICtrlCoverageConverter> converter = new CtrlCoverageToCoberturaConverter();
converter.convertAll(LOG_REL_PATH);