How to setup and trigger your builds¶
NOTE: THE WIKI IS WORK IN PROGRESS
the information are correct but the images are for information purpose only. the images aren't related to this project but are a good example of how the system will look
- Table of contents
- How to setup and trigger your builds
- How to monitor the status of your build
- Dynamic graphs and statistics
How to setup the environment¶
To properly work on the CI system you first need to download and setup the code from the repository
NOTE: Before executing the code, move into the directory where you want to keep the code
mkdir my_ci_dir
cd my_ci_dir
git clone http://cdcvs.fnal.gov/projects/generic_ci
git clone http://cdcvs.fnal.gov/projects/art_ci
cd generic_ci
setup -. generic_ci
PATH="${PATH}:${PWD}/bin"
cd ../art_ci
setup -. -j art_ci
export ART_CI_DIR=${PWD}
The previous code let you download and setup the generic_ci and the art_ci in the my_ci_dir directory
Tips for a faster setup¶
The CI environment needs to be configured every time you log into the machine.
If you haven't deleted the folder the first time you configured the CI System, you can avoid to download again the code from the repository and use the same code that is on the machine.
If you plan to use the local build more than once, could be good to setup a function into your .bashrc file.
To do that execute the following steps:
NOTE: I'm using vim as text editor but you can open the file with your preferred text editor.
- Open the .bashrc file with a text editor
vim ~/.bashrc
- Paste the following code to the end of the file: P.S: In vim you need to press "i" to activate the insert mode
function setup_ci { my_path="${1:-${PWD}}" cd ${my_path}/generic_ci setup -. generic_ci PATH="${PATH}:${my_path}/generic_ci/bin" cd ${my_path}/art_ci setup -. -j art_ci export ART_CI_DIR=${my_path}/art_ci } - Save the changes and close the file.
NOTE: In vim you need to press Esc then type ":wq" and then press Enter to save and exit
- giving as argument to the function the full path of the my_ci_dir directory:
setup_ci <path/of/your/my_ci_dir/directory>
- Running the function without argument if you first change directory to the my_ci_dir directory
cd <path/of/your/my_ci_dir/directory>​setup_ci
Manually trigger a build¶
Once the environment is set, you can launch the build/workflow executing the trigger script with different options:- To trigger the CI build using the develop version code
trigger
- *To trigger a CI build with a specific tag *
trigger --revisions "*@ART_SUITE_v2_01_02"
where "ART_SUITE_v2_01_02" is the tag of the versions that you want to use for the build
- trigger --workflow Art_CI --revisions "*@ART_SUITE_v2_00_03"
this will trigger the build for the non nu-qualified version of the code - trigger --workflow Art_CI_nu --revisions "*@ART_SUITE_v2_00_03"
this will trigger the build for the nu-qualified version of the code - trigger --workflow Art_CI,Art_CI_nu --revisions "*@ART_SUITE_v2_00_03"
this will trigger both the nu-qualified and the non nu-qualified version of the code, separated by a time lapse of two minutes
For the online help page of trigger, use the following command:
trigger -h
How to monitor the status of your build¶
The Art_CI Web Application¶
To monitor the status of your builds into the CI system, our team created an experiment based web application to help you with your monitoring job.
The application can be found at one of the following links:
http://art-ci-history.fnal.gov:8080/ArtCI/app/view_builds/index
http://dbweb5.fnal.gov:8080/ArtCI/app/view_builds/index
This application offer to you all the necessary tools to monitor the status and the performance of your builds in a short and long term.
It offers a quick overview of the status of the last ten builds and offers also dynamic graphs to show the overtime performance of the different build phases.
The main page of the web application¶
The previous image shows the homepage of the Art CI web application.
This page is divided into three main sections:- The search and filter section ( on the left of the image )
- The legend section ( on the right of the image )
- The Show data section (in the middle of the image )
The search and filter section¶
The purpose of this section is to offer to the user a tool to filter the results shown in the web application.This panel allows you to:
- Show the builds up to a defined build number.
- Show the builds in a defined time range.
- Filter the builds for platform or for test suite used.
The legend section¶
This section show the association between the color of the different phases of the builds,and their status- [#] yellow -> The phase is running
- [#] gray -> The phase is pending
- [#] green -> The phase was successful
- [#] red -> The phase failed
- [#] olive green -> The phase have been skipped
The Show data section¶
This is the main section of the homepage and it's where the most important data is shown.
This section shows a table of the last ten builds executed and their corresponding information.
The table is divided into multiple columns.
The first three columns show some basic information about the CI build number, the time when the CI build started and the platform on which the CI build have been executed.
The next columns show the status of the different phases of the CI build.
Each phase is represented by a square with a bullet
- Checkout
Show the status of the checkout of the code from the repository. - Build
shows the status of the building process of the code into the CI System. - Unit test
Show the progress of the unit tests configured. - Install
Show the progress of the install process of the code into the CI System.
Dynamic graphs and statistics¶
Every bullet and the build number into the web application is clickable.
Performing a click on a bullet open a different web page that shows detailed information on the phase.