update readme + add TestCase refinement + add better output managmeent

ElNiak · Nov 15, 2024 · 27331e3 · 27331e3
1 parent e7997c1
commit 27331e3
Show file tree

Hide file tree

Showing 16 changed files with 645 additions and 389 deletions.
diff --git a/.gitignore b/.gitignore
@@ -27,4 +27,5 @@ panther/outputs/qlogs/*/*.log
 panther/outputs/qlogs/*
 panther/outputs/*/*
 panther/config/certs
-panther/config/tls_keys
+panther/config/tls_keys
+venv/
diff --git a/INSTALL.md b/INSTALL.md
@@ -2,56 +2,67 @@
 
 Note, before implementation were added as submodule. Now we only consider Docker containers installation. (To be updated)
 
+```bash
+git clone [email protected]:ElNiak/PANTHER.git;
+cd PANTHER; 
+git submodule update --init --recursive
+```
 
-## :gear: Pre-commit and Black
+## :wrench: Requirements
 
-```
-python3.10 -m pip install pre-commit black
-pre-commit installed at .git/hooks/pre-commit
-```
+Tested on:
 
+* Python 3.10
+* Docker version 27.2.1, build 9e34c9b
+* Ubuntu 20.04.3 LTS
 
-## :computer: Local Installation (Not Recommended)
+```bash
+sudo apt install libgraphviz-dev python3.10-venv python3.10-dev
+```
 
+## :hammer: Plugins
 
+```bash
 
-See Dockerfile for dependencies and commands
+```
 
+## :gear: Pre-commit and Black
 
+```bash
+cd PANTHER;
+python3.10 -m venv venv
+venv/bin/pip install pre-commit black
+venv/bin/pre-commit install
+```
 
-## :whale: Single implementation
+## :computer: Local Installation (Not Recommended)
 
+See Dockerfile for dependencies and commands.
 
+## :whale: Docker Installation
+
+The docker image will be automatically built and run when defined in the experiment configuration file. 
 
 ```bash
-# For a full installation including all dependencies and configurations:
-IMPLEM="picoquic" make build-docker
+cd PANTHER;
+python3.10 -m venv venv
+venv/bin/pip install .
+source venv/bin/activate
+cd panther;
 ```
 
-
-## :whale: WebApp (Recommended)
+## :whale: Pypi Installation
 
 ```bash
-# For first installation
-make install
-
-# For modification:
-# For major update in ivy:
-make build-docker-compose-full
-# For a minor update in some implementation:
-make build-docker-compose
+
 ```
 
 ## :warning: Clean Up
 
 
-
 ```bash
 # To clean Docker images and system:
 make clean-docker-full
 ```
 
-
-
-
 ---
diff --git a/panther/config/experiment_config.yaml b/panther/config/experiment_config.yaml
@@ -12,9 +12,9 @@ generate_new_certificates: True
 tests:
   - name: "QUIC Client-Server Communication Test I"
     description: "Verify that the Picoquic client can communicate with the Picoquic server over Docker Compose network."
-    protocol: "quic"  # Protocol name should match the folder name in plugins/
+    protocol: ["quic"]  # Protocol name should match the folder name in plugins/
     network_environment: "docker_compose"  # Environment plugin name
-    execution_environment: None 
+    execution_environment: [] 
     services:
       picoquic_server:
         name: "picoquic_server"  # Added 'name' key
@@ -52,9 +52,9 @@ tests:
 
   - name: "QUIC Client-Server Communication Test II"
     description: "Verify that the Picoquic client can communicate with the Picoquic server over Docker Compose network."
-    protocol: "quic"  # Protocol name should match the folder name in plugins/
+    protocol: ["quic"]  # Protocol name should match the folder name in plugins/
     network_environment: "docker_compose"  # Environment plugin name
-    execution_environment: None 
+    execution_environment: [] 
     services:
       picoquic_server:
         name: "picoquic_server"  # Added 'name' key