From 5083b1984471961f61d68c35d84acf90e33d3423 Mon Sep 17 00:00:00 2001
From: Marco Malavolti <marco.malavolti@gmail.com>
Date: Tue, 10 Aug 2021 18:48:42 +0200
Subject: [PATCH] Update requirements.txt
---
README.md | 42 ++++++++++++++++++++++++++++++++++++++----
requirements.txt | 4 ++--
2 files changed, 40 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 0630b12..6fcefba 100644
--- a/README.md
+++ b/README.md
@@ -104,7 +104,7 @@ The tool uses following status for IdPs:
## Download ECCS2 Repository
-* `cd $HOME ; git clone https://github.com/malavolti/eccs2.git`
+* `cd $HOME ; git clone https://gitlab.geant.org/marco.malavolti/eccs2.git`
## Install Python 3.9.x
@@ -159,10 +159,12 @@ The tool uses following status for IdPs:
# Install Google Chrome needed by Selenium
* Debian (64 bit):
+ * `cd $HOME/eccs2`
* `sudo wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb`
* `sudo apt install ./google-chrome-stable_current_amd64.deb`
* CentOS (64 bit):
+ * `cd $HOME/eccs2`
* `sudo wget https://dl.google.com/linux/direct/google-chrome-stable_current_x86_64.rpm`
* `sudo yum install ./google-chrome-stable_current_x86_64.rpm`
@@ -181,10 +183,10 @@ The tool uses following status for IdPs:
4. Use the version number retrieved from the previous step to construct the URL to download ChromeDriver. With version `72.0.3626.69`, the URL would be "https://chromedriver.storage.googleapis.com/index.html?path=73.0.3683.68/"
5. Download the Chromedriver and extract it with:
- * `wget https://chromedriver.storage.googleapis.com/73.0.3683.75/chromedriver_linux64.zip -O $HOME/eccs2/chromedriver_linux64.zip`
* `cd $HOME/eccs2`
+ * `wget https://chromedriver.storage.googleapis.com/73.0.3683.75/chromedriver_linux64.zip`
* `unzip chromedriver_linux64.zip`
- * `rm chromedriver_linux64.zip`
+ * `rm chromedriver_linux64.zip google-chrome-stable_current_amd64.deb`
**Note:**
After the initial download, it is recommended that you occasionally go through the above process again to see if there are any bug fix releases.
@@ -196,6 +198,7 @@ After the initial download, it is recommended that you occasionally go through t
* `cd $HOME/eccs2`
* `./python/bin/python3.9 -m pip install virtualenv`
* `$HOME/eccs2/python/bin/virtualenv --python=$HOME/eccs2/python/bin/python3.9 eccs2venv`
+* `$HOME/eccs2/eccs2venv/bin/python -m pip install --upgrade pip`
* `source eccs2venv/bin/activate` (`deactivate` to exit Virtualenv)
* `python -m pip install -r requirements.txt`
@@ -216,8 +219,10 @@ After the initial download, it is recommended that you occasionally go through t
fi
```
+ * `source $HOME/.bash_profile`
+
* Debian:
- * `vim $HOME/.profile`
+ * `vim $HOME/.bash_profile`
* Add the following lines at the tail:
```bash
@@ -227,6 +232,8 @@ After the initial download, it is recommended that you occasionally go through t
fi
```
+ * `source $HOME/.bash_profile`
+
3. Configure ECCS2 cron job for the local user:
* `crontab -e`
@@ -313,6 +320,14 @@ To perform a restart after an API change use the following command:
* 'OK'
* 'ERROR'
* 'DISABLED'
+ * `check_result=`
+ * `OK`
+ * `Timeout`
+ * `Invalid-Form`
+ * `Connection-Error`
+ * `No-eduGAIN-Metadata`
+ * `SSL-Error`
+ * `DISABLED`
* `reg_auth=https://reg.auth.example.org` (select a specific Registration Authority)
* `format=simple` (retrieve results in a simple format)
* `/api/fedstats`
@@ -322,6 +337,8 @@ To perform a restart after an API change use the following command:
The available dates are provided by the first and the last file created into the `output/` directory
+## Clean old results
+
To clean the ECCS2 results from files older than last 7 days use (modify it on your needs):
* `crontab -e`
@@ -332,6 +349,23 @@ To clean the ECCS2 results from files older than last 7 days use (modify it on y
0 10 * * * /bin/bash $HOME/eccs2/clean7daysOldFiles.sh > $HOME/eccs2/logs/clean7daysOldFiles.log 2>&1
```
+## User interface
+The eduGAIN Connectivity Check 2 test web page is available at https://technical-test.edugain.org/eccs2
+
+## User interface parameters
+
+| Parameter name | Example |
+| -------------- | -------------------------------------------- |
+| `date` | `date=2020-02-20` |
+| `reg_auth` | `reg_auth=https://reg.auth.example.org` |
+| `idp` | `idp=https://idp.example.org/idp/shibboleth` |
+| `status` | `status=ERROR` |
+| `check_result` | `check_result=Timeout` |
+
+**Example:**
+
+`https://technical-test.edugain.org/eccs2?reg_auth=http://www.idem.garr.it/&check_result=SSL-Error`
+
# Utility for developers
## ECCS2 API Development Server
diff --git a/requirements.txt b/requirements.txt
index 8c7fe6c..4422f09 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,7 +1,7 @@
-urllib3==1.26.6
+click==7.1.2
Flask==1.1.2
Flask-RESTful==0.3.9
requests==2.25.1
selenium==3.141.0
uWSGI==2.0.19.1
-Click==7.1.2
+urllib3==1.26.6
--
GitLab