From 4e4c9894cf92bffd8dddf723246879198d616f67 Mon Sep 17 00:00:00 2001 From: "Taihsiang Ho (tai271828)" Date: Mon, 30 Oct 2017 18:38:50 +0800 Subject: [PATCH] Describe the installation and test process We use test.sh to consolidate test cases in one file so the README would not be outdated easier rather than the hard-coded test commands in a code block. --- .travis.yml | 15 +-------------- README.md | 10 ++++++++++ test.sh | 15 +++++++++++++++ 3 files changed, 26 insertions(+), 14 deletions(-) create mode 100755 test.sh diff --git a/.travis.yml b/.travis.yml index 5b49369e..ded4ee47 100644 --- a/.travis.yml +++ b/.travis.yml @@ -12,20 +12,7 @@ install: - pip install -r dev_requirements.txt script: -- PYTHONPATH=. timeout 05.0 python tests/call_function_test.py -- PYTHONPATH=. timeout 05.0 python tests/channel_test.py -- PYTHONPATH=. timeout 05.0 python tests/first_stage_test.py -- PYTHONPATH=. timeout 05.0 python tests/id_allocation_test.py -- PYTHONPATH=. timeout 05.0 python tests/importer_test.py -- PYTHONPATH=. timeout 05.0 python tests/local_test.py -- PYTHONPATH=. timeout 05.0 python tests/master_test.py -- PYTHONPATH=. timeout 05.0 python tests/module_finder_test.py -- PYTHONPATH=. timeout 05.0 python tests/nested_test.py -- PYTHONPATH=. timeout 05.0 python tests/responder_test.py -- PYTHONPATH=. timeout 05.0 python tests/utils_test.py -- PYTHONPATH=. timeout 20.0 python tests/select_test.py -- PYTHONPATH=. timeout 20.0 python tests/ssh_test.py -- PYTHONPATH=. timeout 30.0 python tests/fakessh_test.py +- PYTHONPATH=. timeout 05.0 ${TRAVIS_BUILD_DIR}/test.sh services: - docker diff --git a/README.md b/README.md index d1461ed2..65aad13e 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,13 @@ containers, e.g. it should not be firewalled or port forwarded. If in doubt, just install Docker on a Linux box in the default configuration and run the tests there. + +## Steps To Prepare Development Environment + +1. Get the code ``git clone https://github.com/dw/mitogen.git`` +1. Go into the working directory ``cd mitogen`` +1. Establish the docker image ``./tests/build_docker_image.py`` +1. Build the virtual environment ``virtualenv ../venv`` +1. Enable the virtual environment we just built ``source ../venv/bin/activate`` +1. Install Mitogen in pip editable mode ``pip install -e .`` +1. Run ``test.sh`` diff --git a/test.sh b/test.sh new file mode 100755 index 00000000..721b2025 --- /dev/null +++ b/test.sh @@ -0,0 +1,15 @@ +#!/bin/bash +timeout 05.0 python tests/call_function_test.py +timeout 05.0 python tests/channel_test.py +timeout 05.0 python tests/first_stage_test.py +timeout 05.0 python tests/id_allocation_test.py +timeout 05.0 python tests/importer_test.py +timeout 05.0 python tests/local_test.py +timeout 05.0 python tests/master_test.py +timeout 05.0 python tests/module_finder_test.py +timeout 05.0 python tests/nested_test.py +timeout 05.0 python tests/responder_test.py +timeout 05.0 python tests/utils_test.py +timeout 20.0 python tests/select_test.py +timeout 20.0 python tests/ssh_test.py +timeout 30.0 python tests/fakessh_test.py