Rooba
/
mitogen
mirror of https://github.com/mitogen-hq/mitogen.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

README: move testing bits into tests directory.

This commit is contained in:
David Wilson 2018-03-06 17:07:14 +05:45
parent 04bb5881b6
commit 23f78ca5a2
2 changed files with 27 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,25 +1,4 @@
# Mitogen
# Running The Tests
[![Build Status](https://api.travis-ci.org/dw/mitogen.svg?branch=master)](https://travis-ci.org/dw/mitogen)
Your computer should have an Internet connection, and the ``docker`` command
line tool should be able to connect to a working Docker daemon (localhost or
elsewhere for OS X etc.) that can run new images.
The IP address of the Docker daemon must allow exposing ports from running
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``
<a href="https://mitogen.readthedocs.io/">Please see the documentation</a>.

25
tests/README.md
View File

@ -3,3 +3,28 @@
This directory is full of disorganized crap, including random hacks I checked
in that I'd like to turn into tests. The effort to write tests only really
started in September 2017. Pull requests in this area are very welcome!
## Running The Tests
[![Build Status](https://api.travis-ci.org/dw/mitogen.svg?branch=master)](https://travis-ci.org/dw/mitogen)
Your computer should have an Internet connection, and the ``docker`` command
line tool should be able to connect to a working Docker daemon (localhost or
elsewhere for OS X etc.) that can run new images.
The IP address of the Docker daemon must allow exposing ports from running
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``