Skip to main content

Test statistics plugin for InvenTree

Project description

License: MIT PyPI PEP

InvenTree Test Statistics Plugin

An InvenTree plugin for generating and viewing statistical test data.

Description

The Test Statistics plugin provides a panel for viewing statistical test data aggregated by test template. It displays pass/fail counts and percentages, supports date range filtering, and shows month-by-month breakdowns as bar charts.

Test statistics can be generated for a particular part, or for a selected build order.

Context Screenshot
Test for a part (including variants) Part Test Statistics

Features

Panel Interface

The statistics panel provides:

  • Date range selector — Filter results by month using start and end date pickers. Defaults to the past year.
  • Include Variants toggle — Optionally include test results from variant parts in the statistics.
  • Results table — Each row represents a single (enabled) test template and shows:
    • Test name and description
    • Total pass and fail counts, each with percentage of total runs
    • Total number of test executions
  • Monthly breakdown — Click to expand any row and view a stacked bar chart of pass/fail counts broken down month by month across the selected date range.

API

The plugin exposes a REST endpoint at plugin/test_statistics/statistics/ that accepts the following query parameters:

Parameter Type Description
part integer Filter by Part (primary key)
include_variants boolean Include variant parts in results (default: false)
build integer Filter by Build Order (primary key)
stock_item integer Filter by Stock Item (primary key)
date_after date Include results on or after this date
date_before date Include results on or before this date
started_after datetime Include results where test started on or after this datetime
started_before datetime Include results where test started on or before this datetime
finished_after datetime Include results where test finished on or after this datetime
finished_before datetime Include results where test finished on or before this datetime

Only test templates with enabled=True are included in the response.

Response Format

The endpoint returns a list of objects, one per test template:

[
  {
    "template": 1,
    "template_detail": {
      "test_name": "Voltage Test",
      "description": "..."
    },
    "pass_count": 42,
    "fail_count": 3,
    "monthly": [
      { "month": "2024-01-01", "pass_count": 10, "fail_count": 1 },
      { "month": "2024-02-01", "pass_count": 32, "fail_count": 2 }
    ]
  }
]

Installation

Via User Interface

The simplest way to install this plugin is from the InvenTree plugin interface. Enter the plugin name (inventree-test-statistics) and click the Install button:

Install Plugin

Via Pip

Alternatively, the plugin can be installed manually from the command line via pip:

pip install -U inventree-test-statistics

Note: After the plugin is installed, it must be activated via the InvenTree plugin interface.

Contributing

Backend

Backend code is written in Python, and is located in the test_statistics directory.

Frontend

Frontend code is written in TypeScript, and is located in the frontend directory. Read the frontend README for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

inventree_test_statistics-0.3.0.tar.gz (442.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

inventree_test_statistics-0.3.0-py3-none-any.whl (447.2 kB view details)

Uploaded Python 3

File details

Details for the file inventree_test_statistics-0.3.0.tar.gz.

File metadata

File hashes

Hashes for inventree_test_statistics-0.3.0.tar.gz
Algorithm Hash digest
SHA256 51a5f821c0d2a8ab01cce35b5efaa23338aa1370ba224c6e30cb6de68e0ef870
MD5 d4b039c3b0af716dcb23f5e22f92c659
BLAKE2b-256 4f78e497006f645bf4eedf58746678f639d43907a5c859b9f88226aef69355c7

See more details on using hashes here.

File details

Details for the file inventree_test_statistics-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for inventree_test_statistics-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a8e2b2eb5f8e68260664cef1837e2f7e6c748b0d2ec3633f6b09d684ce92f5b4
MD5 e978578cbb41a7666085d8144076bd62
BLAKE2b-256 df16d9c0b0901b11c6899efada37d47cc01790af43722cc27e98127afb4b7025

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page