CDash:Documentation

< CDash Main Page

This page is the official CDash documentation.

CDash definitions

• Build: Single submission to the dashboard for a specific project, environment and build type.
• Build type: reference by CTest as Nightly, Experimental or Continuous. (see CMake documentation for more information).
• Site: Computer contributing builds to the dashboard. A site might belong to several projects and submit different build.
• Coverage: Number of lines of code actually tested. CDash/CTest currently supports gcov and bulleyes tools.
• Dynamic Analysis: reports the memory allocation/deallocations analysis for test, examples and executable for the project. Valgrind is currently supported by CTest/CDash.
• Nightly start time: starting time of the 24h window of the daily dashboard.
• Ajax: Asynchronous JavaScript and XML, is a group of web development techniques used for creating interactive web applications.
• PHP: Hypertext Preprocessor, is a computer scripting language, designed for producing dynamic web pages.
• SQL: Structured Query Language, is a database computer language designed for the retrieval and management of data in relational database management systems.

Login to CDash

CDash uses secure login for users and adminsitrators. CDash does not store any plain text passwords in the database, therefore passwords cannot be recovered, even by system administrators.

Note: LDAP is not currently supported.

• To login, click on the 'Login' link at the top of the main CDash page or directly go to the user.php page http://myserver/CDash/user.php.
• If you don't have a login, click on the 'register' link on the top menu. In order to register, CDash requires a valid email address, your first name, last name and password. The institution is optional. CDash implements some security features to avoid robots to register.
• Once registered you are ready to type your email and password provided in the login screen.

My CDash

MyCDash page

Each user has its own personal section in CDash, where they can keep track of recent builds, submissions, claim sites and more.

My Profile

User can change their profile: First/Last name, email, institution and password from the the "My Profile" menu at the top of the "My CDash" page.

My Projects

If a user has subscribe to at least a project (see Subscribe to project), the list of subscribed projects is shown under "My Projects". There several links related to the subscriptions.

Edit Subscription

Users can edit their subscription for a given project.

1. From MyCdash page, under My Projects, click on [Edit subscription]
2. Change the role if necessary. Downgrading from project administrator to Site maintainer or normal user cannot be reverted unless by another project administrator.
3. Change or add CVS/SVN login
4. Change the email preferences if necessary
5. Click on "Update Subscription" to validate the modifications

Users can unsubscribe from a project by clicking on the "Unsubscribe" button. Users will be able to subscribe later on.

Claim sites

See Claim a site section.

Edit project

See Editing a project section.

Manage project groups

See Build groups section.

Manage project roles

See Project roles section.

My Sites

My sites

As a site maintainer, it is useful to know if submissions have been missing for quite sometime, or if the current builds on a specific sites are not reporting errors due to misconfiguration.

• The first column show the list of currently claimed sites.
• The first row shows the current projects that are submitting builds for the given site
• For each pair (site/project) a summary of the current status of the dashboard is displayed

Public projects

List of all the public projects stored in CDash. By definition, users registered in CDash can subscribe to any public projects.

Subscribe to project

Subscribing to public projects

If the project is public then users can subscribe to the project themselves, otherwise see section Project Roles.

1. Log into CDash (see Login to CDash
2. Under "Public projects" section click on [Subscribe to this project]
3. Select your role for the project: Normal user or Site maintainer if you are responsible for a machine sending periodic builds to the dashboard/
4. Add your CVS/SVN login for the project if you have any
5. Select your email preference
6. Click on subscribe

Claim a site

Claiming a site

CDash allows Site maintainers (see Subscribe to Project) to claim a site they are managing. This allows users to have personal reports regarding a specific machine and get informed if the machine has not been submitting from quite some time or has unexpected high number of failures (probably due to misconfiguration).

In order to claim a site:

1. Login to CDash to acces "My CDash"
2. Under "My Projects" select [Claim sites]. If the project is not listed, refers to Subscribe to Project for more information.
3. The Claim sites page show the list of current sites for the project. Check the site(s) of interest.
4. Click on "Update claimed sites"

In order to unclaim a site:

1. Login to CDash to acces "My CDash"
2. Under "My Projects" select [Claim sites].
3. Uncheck the site(s) no longer of interest.
4. Click on "Update claimed sites"

See the section Describe a site for information about the given sites.

Describe a site

Describing a site