search

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

Missing config in example scripts and documentation #28

Closed kesnar closed 2 years ago

kesnar commented 2 years ago

Hello, I was reading the docs and I couldn't run any of the provided simple scripts. I then tried to dig into the repository and found that neither the following test could run tests/examples/tests-readme.npf Giving me the following error, as in the scripts of the documentation: This npf script has no default repository

I found that the tests/examples/math.npf has this particular line of code that actually solves the above error.

%config
default_repo=local //No program under test

I would propose to include this line to the broken tests and provide some paragraph in the documentation about the local repo.

Thank you.

(I know it is a minor thing, but as someone coming in first contact with your (really interesting) tool, I find the ability to run simple scripts and build knowledge to be useful).

tbarbette commented 2 years ago

Hi!

No worries, making the on-boarding as easy as possible is very important !

The examples should give local in the command line or reference only tests with default_repo=local.

Where is there one of them missing?

Thanks! Tom

kesnar commented 2 years ago

Well I followed the readthedocs. There wasn't a section regarding running tests, only writing them (https://npf.readthedocs.io/en/latest/tests.html). So I assumed I should follow the format described in the main README.md file, when describing npf-run.

Can you elaborate on giving local in the command line? I think an example of how to run the simple scripts in readthedocs would be adequate and could also be inserted in the docs.