Merge remote-tracking branch 'origin/master'

.github/workflows/ci.yml

@@ -2,11 +2,24 @@ name: Python application
 
 on:
   push:
-    branches: [ master ]
+    branches: 
+      - '*'
   pull_request:
     branches: [ master ]
 
 jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+    -   name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+    -
+        name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          push: false
+          tags: tbarbette/npf:latest
+
   build:
     runs-on: ubuntu-latest
     steps:

.gitignore

@@ -13,4 +13,6 @@ tests/local
 
 npf.egg-info/
 tmp/
-.vscode/
+.vscode/
+
+venv

Dockerfile

@@ -0,0 +1,5 @@
+FROM ubuntu:20.04
+RUN apt-get update && apt-get install -y python3 python3-pip git
+COPY . /npf
+RUN cd /npf && python3 -m pip install -r /npf/requirements.txt
+CMD [""]

README.md

@@ -66,6 +66,14 @@ pip3 install --user npf
 
 At run-time, NPF uses SSH and can benefit from usage of sudo and NFS, see the [run-time dependencies](https://npf.readthedocs.io/en/latest/usage.html#run-time-dependencies) in the documentation for more information.
 
+#### With docker ####
+We provide a Dockerfile to use npf.
+
+```bash
+docker build --tag npf .
+docker run -it npf npf-compare ...
+```
+
 ### Big picture ###
 Your *.npf* test file is composed of a serie of sections, as in the example given above. The sections describe the scripts to run, where to run them, what variables should be tested, what are their ranges, configuration parameters such as timeout or graph colors, etc. Each section is described in more details in [the "writing test script" documentation](https://npf.readthedocs.io/en/latest/tests.html).
 

doc/build_graphs.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -e
+
+python3 ./npf-run.py --test integration/filter.npf --graph-size 4 2.5 --graph-filename doc/filter.png
+python3 ./npf-run.py 'local:Default' --test doc/example_multiple_result.npf --graph-size 3 2.5 --graph-filename doc/example_multiple_result_default.png --force-retest
+python3 ./npf-run.py 'local:Add' --test doc/example_multiple_result.npf --graph-size 3 2.5 --graph-filename doc/example_multiple_result_add.png --config 'result_add={THROUGHPUT}' --force-retest
+python3 ./npf-run.py 'local:Append' --test doc/example_multiple_result.npf --graph-size 3 2.5 --graph-filename doc/example_multiple_result_append.png --config 'result_append={THROUGHPUT}' --force-retest
+python3 ./npf-run.py local:Namespace --test doc/example_namespaces.npf --graph-size 4 2.5 --graph-filename doc/example_namespaces.svg
+python3 ./npf-run.py 'local:Namespace (synced)' --test doc/example_namespaces.npf --graph-size 4 2.5 --graph-filename doc/example_namespaces_synced.svg --config 'var_sync={TIME}'

doc/example_multiple_result.npf

@@ -0,0 +1,4 @@
+%script
+echo "RESULT-THROUGHPUT 6"
+echo "RESULT-THROUGHPUT 10"
+echo "RESULT-THROUGHPUT 26"