Merge pull request #62 from tai271828/pr-sprint-doc

[PyCon UK 2017 Sprint] Describe the installation and test process

.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

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``

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