Running Regression Test Reports

Introduction

This page describes how to generate the Regression Test Reports. It is of interest primarily to the person designated by the release managers to run the reports.

Prerequisites

• A public ssh key.
• Linux. In theory it should be possible to run the run the reports on most modern operating system, including OS X and Windows (under bash), but all testing and current use has been on Linux. Works fine in a Linux VirtualBox virtual machine running on a Windows host.
• Git installed.
• A C++ compiler installed.

Initial setup

Send your public ssh key to Rene Rivera.

Run once only:

cd ~                   # or some other directory of your choice
mkdir boost-reports    # or some other name of your choice
cd boost-reports
mkdir trunk            
git clone --recursive git@github.com:boostorg/boost.git boost
cd boost
./bootstrap.sh
git checkout develop   # we use the branch develop tools/regression
git pull
# Only tools/regression need to be on develop, so no submodule checkout here

Build report generation program boost_report

This only has to be done when there is a change to the report generation program.

pushd ~/boost-reports/boost
git pull
pushd tools/regression/build
../../../b2 boost_report
# find location of exectuable, then:
mv bin/gcc-4.8/release/boost_report ~/boost/boost-reports # see todo below

Run reports

This step performs the following actions:

• Updates its internal procedures from the git public repository.
• Downloads current result zip files from an ftp server.
• Generates the HTML reports. (Now using a C++ program that is much faster than the old XSLT process.)
• Uploads a zip file containing the reports to a web server.

To run:

cd ~/boost/boost-reports/boost
git pull
cd ..
boost/tools/regression/xsl_reports/build_results.sh trunk

To Do

• Change build_results.sh from trunk, etc, to git names.
• build_results.sh should take care of updating boost_report if needed.
• Avoid the clone --recursive; just install the core libraries (for some definition of core libraries).
• Add install options to tools/regression/build/Jamroot.jam? Or at least boost_report
• Is it OK to run several reports (i.e. master and develop) in the same directory? Document answer.

Acknowledgements

Thanks to Tom Kent, Steven Watanabe, and Rene Rivera for illuminating various dark corners of how reporting works.

Revised 09 January 2014

Copyright Beman Dawes 2014.

Distributed under the Boost Software License, Version 1.0.