User Tools

Site Tools


dev:dashboard

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Last revisionBoth sides next revision
dev:dashboard [2015/05/08 16:52] – [Statuses] oschuettdev:dashboard [2023/11/13 13:02] oschuett
Line 1: Line 1:
-====== CP2K Dashboard ====== +This page has been moved to: https://github.com/cp2k/cp2k/blob/master/tools/dashboard/README.md .
- +
-The CP2K dashboard is hosted at [[http://dashboard.cp2k.org]]. It is the central place where we collect automatic test results. +
- +
-===== Main View ===== +
- +
-===== Statuses ===== +
-^ Status                                         ^ Meaning                                              | +
-| {{ :dev:dashboard_ok.png?nolink&50 |}}         | The latest svn resivion passed the test.             | +
-| {{ :dev:dashboard_failed.png?nolink&50 |}}     | The latest svn resivion did **not** passed the test. | +
-| {{ :dev:dashboard_ok_old.png?nolink&50 |}}     | An older svn revision passed the test.               | +
-| {{ :dev:dashboard_failed_old.png?nolink&50 |}} | An older svn revision did **not** passed the test.   | +
-| {{ :dev:dashboard_unkown.png?nolink&60 |}}     | The dashboard was unable to fetch and parse the latest report.| +
-| {{ :dev:dashboard_outdated.png?nolink&60 |}}   | The results are outdated, a newer revision exists for over 24 hours and has not been tested, yet. | +
- +
- +
- +
-===== How does it work? ===== +
-The HTML pages that make up the dashboard are generated by the script [[src>cp2k/tools/dashboard/generate_dashboard.py | generate_dashboard.py]]. It is run every 5 minutes by a [[wp>Cron | cron-job]]. +
- +
-For each tester it performs the following steps: +
-  - fetch latest report from ''report_url'' +
-  - parse report according to its ''report_type'' +
-  - if fetching and parsing was successful, make a copy of the report for the archive +
-  - if the test status is FAILED and the tester has notifications enabled, send emails to responsible author(s). +
- +
-===== Adding a Tester ===== +
- +
-To add a new tester to the dashboard, simply edit the [[src>cp2k/tools/dashboard/dashboard.conf | dashboard.conf ]]. The file has the format of the python [[https://docs.python.org/2/library/configparser.html| configpraser]]. A typical entry looks like this: +
-<code> +
-[mkrack-pdbg] +
-sortkey:     100 +
-name:        Linux-x86-64-gfortran.pdbg +
-host:        PSI, merlinl03 +
-notify:      off +
-report_type: regtest +
-report_url:  http://www.cp2k.org/static/regtest/trunk/Linux-x86-64-gfortran-regtest/pdbg/regtest-0 +
-info_url:    http://www.cp2k.org/static/regtest/trunk/Linux-x86-64-gfortran-regtest/pdbg/index.html +
-</code> +
- +
-The fields have the following meaning: +
-^ Field           ^ Meaning                                                          | +
-| ''[foo_bar]''   | internal name of the tester, it shows up e.g. in the archive-url | +
-| ''sortkey''     | used to order the entries in the dashboard, low means high up    | +
-| ''name''        | displayed in the first column of the dashboard                   | +
-| ''host''        | displayed in the second column of the dashboard                  | +
-| ''info_url''    | optional, if provided it is shows up as the "more information"-link on the archive-page | +
-| ''notify''      | on/off switch, determines if email notifications are send upon test failure |  +
-| ''report_url''  | points to the location of the latest report | +
-| ''report_type'' | can be either of ''regtest'' or ''generic''+
- +
-=== Reports Types === +
-Currently the dashboard supports two test-types. +
- +
-  * A report of type ''regtest'' is simply the output of a [[dev:regtesting | regtest run]]. +
-  * A report of type ''generic'' is a text file that has to contain the following three lines: +
- +
-<code> +
-Revision: <svn-revision> +
-... +
-more test output +
-this is ignored by the dashboard +
-... +
-Summary: <text> +
-Status: <OK/FAILED/UNKOWN> +
-</code> +
- +
-===== Bulk-Download of Archived Reports ===== +
-Over time the dashboard archive has become quite a ressource on its own. To allow for bulk-downloads of the reports two url-lists are provided: +
- +
-  * A full list containing all reports in the archive: http://dashboard.cp2k.org/archive/list_full.txt +
-  * A recent list containing only reports from the last 100 commits: http://dashboard.cp2k.org/archive/list_recent.txt +
- +
-You can conveniently download all reports in a list with [[https://www.gnu.org/software/wget/ | wget]]: +
-<code> +
-$ wget -nH -Nxi http://dashboard.cp2k.org/archive/list_recent.txt +
-</code> +
-Added bonus: If you run the wget-command repeatedly, it'll only download the new reports. +
dev/dashboard.txt · Last modified: 2023/11/13 13:04 by oschuett