From 00219e7e9b24ee2298a7d0d977afdf123a6de88b Mon Sep 17 00:00:00 2001 From: Julien Date: Wed, 19 Jul 2017 21:40:40 +0800 Subject: rename all READM.rst to README.md Change-Id: I95930de9fefd0897bd0b75d2aeb5a1d731332dad Signed-off-by: Julien --- verigraph/tester/README.md | 38 ++++++++++++++++++++++++++++++++++++++ verigraph/tester/README.rst | 38 -------------------------------------- 2 files changed, 38 insertions(+), 38 deletions(-) create mode 100644 verigraph/tester/README.md delete mode 100644 verigraph/tester/README.rst (limited to 'verigraph/tester') diff --git a/verigraph/tester/README.md b/verigraph/tester/README.md new file mode 100644 index 0000000..35396a3 --- /dev/null +++ b/verigraph/tester/README.md @@ -0,0 +1,38 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +In order to run the automatic testing script test.py, you need the +following dependencies installed on your python distribution: + +- "requests" python package -> + http://docs.python-requests.org/en/master/ +- "jsonschema" python package -> + https://pypi.python.org/pypi/jsonschema + +IMPORTANT - If you have multiple versions of Python installed on your +machine, check carefully that the version you are actually using when +running the script, has the required packages installed. Requested +version is Python 3+ + +| HINT - to install a package you can raise the following command (Bash + on Linux or DOS shell on Windows): +| python -m pip install jsonschema +| python -m pip install requests + +Tested on PYTHON 3.4.3 + +To add a new test, just put a new .json file inside the testcases +folder. The corresponding JSON schema is in the testcase\_schema.json +file and some examples are already available. Each json file should +specify: + +- id, an integer for the testcase; +- name, the name for the testcase; +- description, an optional description; +- policy\_url\_parameters, the parameters to be appended after the + verification URL (including the '?' character); +- result, the expected verification result; +- graph, the graph to be tested (the same object that you usually POST + to VeriGraph to create a new graph). + The test.py script will test each .json file contained into the + testcases folder and will provide a complete output. diff --git a/verigraph/tester/README.rst b/verigraph/tester/README.rst deleted file mode 100644 index 35396a3..0000000 --- a/verigraph/tester/README.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -In order to run the automatic testing script test.py, you need the -following dependencies installed on your python distribution: - -- "requests" python package -> - http://docs.python-requests.org/en/master/ -- "jsonschema" python package -> - https://pypi.python.org/pypi/jsonschema - -IMPORTANT - If you have multiple versions of Python installed on your -machine, check carefully that the version you are actually using when -running the script, has the required packages installed. Requested -version is Python 3+ - -| HINT - to install a package you can raise the following command (Bash - on Linux or DOS shell on Windows): -| python -m pip install jsonschema -| python -m pip install requests - -Tested on PYTHON 3.4.3 - -To add a new test, just put a new .json file inside the testcases -folder. The corresponding JSON schema is in the testcase\_schema.json -file and some examples are already available. Each json file should -specify: - -- id, an integer for the testcase; -- name, the name for the testcase; -- description, an optional description; -- policy\_url\_parameters, the parameters to be appended after the - verification URL (including the '?' character); -- result, the expected verification result; -- graph, the graph to be tested (the same object that you usually POST - to VeriGraph to create a new graph). - The test.py script will test each .json file contained into the - testcases folder and will provide a complete output. -- cgit 1.2.3-korg