tbarbette / npf

Network Performance Framework: easy-to-use experiment manager with automated testing, result collection, and graphing
GNU General Public License v3.0
40 stars 15 forks source link

Add interactive graphs generation to npf-run (npf-web-extension) #38

Closed dpcodebiz closed 1 year ago

dpcodebiz commented 1 year ago

Description

This PR adds a new argument to npf-run (--web [export_path]). This new argument allows users to export data to html format via npf-web-extension (https://github.com/dpcodebiz/npf-web-extension). This parameter is optional and can be used along with all other parameters (--single-output, etc.)

Motivation

Npf-run is only able to generate static graphs and this extension goes further by allowing the user to export an instance-based interface that runs in any browser and provides data visualization capabilities.

Relevant changes

Tests

tbarbette commented 1 year ago

@dpcodebiz any new on this?

dpcodebiz commented 1 year ago

I don't think a unit test is necessary as the small portion of code I added to npf is already being asserted inside the integration test. In other words, https://github.com/dpcodebiz/npf/blob/36ccb1fe9c79f1b0a58c730bb099e08b9a131f12/npf/types/web/web.py#L5-L29 this is the only relevant part worth testing and checking that a .html file is being generated asserts that the method is working properly. What do you think?

tbarbette commented 1 year ago

Ok for the tests :) For the variable names I guess it's easy enough.