Notice: We have migrated to GitLab launching 2024-05-01 see here: https://gitlab.rtems.org/

#4880 assigned project

Build List Visualization

Reported by: Chris Johns Owned by: Chris Johns
Priority: normal Milestone: Indefinite
Component: tool Version:
Severity: normal Keywords: SoC, medium, tools, RSB, python, retired
Cc: Chris Johns Blocked By:
Blocking:

Description

Build List Visualization

Students: Past, Present, and Potential Students

Status: Some work

Introduction

The project creates a visualization tool for the Build Mailing List archives.

The Build List Archives is a public list RTEMS user can post the test results from the RTEMS Test or RTEMS Source Builder (RSB) ecosystem tools.

The data in the build list archives provides a historical overview of the stability of the tools and BSP test results. The email reports sent to the list are not easy to review by hand and it is complication to inspect the archives and form a view. A visualization can provide reports and views we can all understand.

The test data forms the basis for the RTEMS Tier list. An architecture or BSP can only enter tier 1 if it has published test results from the BSP hardware.

The project has three main parts:

  1. Parsing of the email archives into a data format reports can be generated from
  1. Determining the types of reports the RTEMS Project requires
  1. Creating a visualization tool with a suitable UI

The tools created by this project will be server side generating the data need for web browser to present.

The Builds Mailing List is separate from any Continuous Integration (CI) systems the RTEMS Project provides. An RTEMS Project CI system can not provide the coverage user testing provides. We should not confuse the roles each plays.

Tools build results need to consider hosts and architectures failures to see if we can determine an architecture is not building on all hosts, a host for an architecture is not building, or all architectures are not building for a host.

Requirements

The following are the project requirements.

Software

  1. The user shall visualize the data in a web browser
  1. The browser scripting language shall be Typescript
  1. The server language shall be Python
  1. Process only the current month when parsing the mailing list data and generating the static data
  1. Investigate the generation of static data in a suitable format, eg JSON the browser can load and display. Avoiding the complexity of a database and REST will help
  1. Provide separate data tables for tool builds, BSP builds and test results.

Reports

  1. Provide a year summary page with a table of monthly high level results such as a tools passes and failures
  1. Provide a monthly build page with the pass and fails for architectures and BSP builds and various hosts
  1. Provide a monthly test page for the BSP test results
  1. Provide a BSP score table for the BSP with test results and number of passes and failures
  1. Provide a architecture/BSP tier score card providing an easy and simple way for a user to check and see the state of a BSP
  1. Provide a build failure timeline that shows when tools on a host and architecture first fail and then when it stops failing.
  1. It would be nice to able to click on a link to archived post

User Interface

Help is needed here from the community

Attachments (1)

builds.py (10.3 KB) - added by Chris Johns on 03/20/23 at 00:40:09.
First pass at a mailing list downloader and email parsing

Download all attachments as: .zip

Change History (8)

Changed on 03/20/23 at 00:40:09 by Chris Johns

Attachment: builds.py added

First pass at a mailing list downloader and email parsing

comment:1 Changed on 03/20/23 at 00:40:46 by Chris Johns

Please find attached a first pass at part 1 of the 3 main parts listed.

comment:2 Changed on 03/20/23 at 00:42:32 by Chris Johns

Keywords: medium added

comment:3 Changed on 03/20/23 at 13:23:06 by Gedare Bloom

Keywords: ecosystem added

comment:4 Changed on 05/29/23 at 18:15:54 by Abhimanyu Raghuvanshi

Owner: set to Abhimanyu Raghuvanshi
Status: newaccepted

comment:5 Changed on 06/05/23 at 06:36:45 by Chris Johns

I have copied https://git.rtems.org/chrisj/rtems-admin.git to https://github.com/kiwichris/rtems-admin so we can use GitHub? pull requests for changes for this GSoC project.

comment:6 Changed on 02/16/24 at 01:00:19 by Gedare Bloom

Keywords: retired added; ecosystem BSP testing removed

comment:7 Changed on 02/16/24 at 01:00:39 by Gedare Bloom

Owner: changed from Abhimanyu Raghuvanshi to Chris Johns
Status: acceptedassigned
Note: See TracTickets for help on using tickets.