Nested Data Reporting Plugin

Jenkins plugin to report data from nested data as pie-charts, trend-charts and data tables.
Explore the docs »

Report Bug · Request Feature

Introduction

This plugin reports data from a nested data file as pie-charts, trend-charts and data tables. If an item has items, the result will be computed automatically for this parent item. Please make sure you use a unique identifier for the id!

An example json file looks like this:

{
  "id": "my-json-report"
  "name": "My JSON report"
  "items": [
    {
      "id": "stocks",
      "name": "Stocks",
      "items": [
        {
          "id": "alphabet",
          "name": "Google",
          "result": {
            "incorrect": 1,
            "manually": 1,
            "accurate": 4
          }
        },
        {
          "id": "microsoft",
          "name": "Microsoft",
          "result": {
            "incorrect": 2,
            "manually": 1,
            "accurate": 5
          }
        }
      ]
    },
    {
      "id": "derivates",
      "name": "Derivates",
      "result": {
        "incorrect": 2,
        "manually": 3,
        "accurate": 10
      }
    },
    {
      "id": "fonds",
      "name": "Fonds",
      "result": {
        "incorrect": 6,
        "manually": 7,
        "accurate": 20
      }
    },
    {
      "id": "warrants",
      "name": "Warrants",
      "result": {
        "incorrect": 6,
        "manually": 4,
        "accurate": 15
      }
    }
  ],
  "colors": {
    "incorrect": "#EF9A9A",
    "manually": "#FFF59D",
    "accurate": "#A5D6A7"
  }
}

To check your json you can use the json schema to validate it.

⚠️ Color Mapping:

The attribute "colors" needs exactly the same attributes as the result of the items and assigns a color to each attribute, which is used for the graphical representation. Otherwise a default color #E9E9E9 is used for the missing property!

If your items only have one result, the visualization is different from the default one, because the representation then makes no sense. Instead of the attributes of the result object, the keys of the individual items are used as the basis for distribution. For example:

{
  "id": "my-second-json-report"
  "name": "My second JSON report"
  "items": [
    {
      "id": "Aktie",
      "name": "Aktie",
      "items": [
        {
          "id": "Aktie_1",
          "name": "Aktie 1",
          "result": {
            "incorrect": 3541
          }
        },
        {
          "id": "Aktie_2",
          "name": "Aktie 2",
          "result": {
            "incorrect": 4488
          }
        },
        {
          "id": "Aktie_3",
          "name": "Aktie 3",
          "result": {
            "incorrect": 2973
          }
        }
      ]
    },
    {
      "id": "Not_Found",
      "name": "Not_Found",
      "result": {
        "incorrect": 8701
      }
    },  
    {
      "id": "Renten",
      "name": "Renten",
      "items": [
        {
          "id": "Rente_1",
          "name": "Rente1",
          "result": {
            "incorrect": 5762
          }
        },
        {
          "id": "Rente_2",
          "name": "Rente2",
          "result": {
            "incorrect": 2271
          }
        }
      ]
    },
    {
      "id": "Derivat",
      "name": "Derivat",
      "result": {
        "incorrect": 2271
      }
    }
  ],
  "colors": {
    "Aktie": "#EF9A9A",
    "Aktie_1": "#FFF59D",
    "Aktie_2": "#A5D6A7",
    "Aktie_3": "#FFCE30",
    "Not_Found": "#E83845",
    "Renten": "#E389B9",
    "Rente_1": "#746AB0",
    "Rente_2": "#288BA8",
    "Derivat": "#0088FF"
  }
}

Then your dashboard looks like this:

Supported file formats

• JSON
• YAML/YML

Visualization

At job level, a trend chart is generated showing the development of the items included in the json over all builds.

Since version 2.4.0, the view is dynamically built and always contains a pie chart, a history and a table.

The pie chart and the hsitory show the aggregated results of the underlying items.

The table then shows the individual underlying items and visualizes the distribution of the properties in the table.

By clicking on a corresponding row, the view is filtered according to the selection. However, the structure remains the same. This can be continued until no more subitems are available in the json model. On the lowest level only the pie chart and the history will be displayed.

Getting started

Pipeline Step

publishReport reportFile: "etc/result.json", displayType: "absolute"

Parameter:

reportFile:

The path to the report file. At the moment yaml/yml or json files are supported.

displayType (optional, default = absolute):

This can be used to determine the representation of the values within the table. Choose between absolute, relative or dual.

Issues

Report issues and enhancements in the GitHub Issue Tracker

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

LICENSE

Licensed under MIT, see LICENSE