Skip to content

Batch report tool #1224

@mattias-p

Description

@mattias-p

Create a CLI tool for creating reports on batches.

Activities

  1. UI Requirements

    • What selection criteria should be offered
      • Batch ID
    • What data should be included in the report? Should this be customizable?
      • Start date, end date, runtime, number of domains tested
  2. UI Design

    • What parameters should be provided to satisfy the above requirements?
    • What syntax should be used for the arguments to the parameters?
    • How should the report be formatted?
      • Table (for humans), JSON (for machines)
  3. Design Backend Perl API

    • What method signatures should be added (and where) below the Zonemaster::Backend namespace.
    • Keep in mind that the same API will be used for the RPCAPI method. The inputs and outputs of this interface should be general and idiomatic for Perl. It should not try to be helpful to any particular entry-point.
    • Keep in mind that the API should not be tightly coupled to the database schema. Rather the Perl API should be general and idiomatic for Perl for this reason too.
  4. Implement Backend Perl API

  5. Implement the CLI tool

End Goal

The following steps are out of scope for this issue, but the design and implementation of this issue should be done with an eye towards this end goal.

  • Design and implement one or more RPCAPI methods to expose the Backend Perl API.
  • Design and implement GUI UI for using the batch report feature.

References

We should talk to @matsstralbergiis about creating batch reports. He probably has something smart to say about creating such reports. Maybe he could even provide some SQL or something that we could reuse.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions