Add local tests notes.

Author: guzman-raphael

.travis.yml

@@ -16,7 +16,7 @@ main: &main
       dist: xenial # precise, trusty, xenial, bionic
       language: shell
       script:
-        - docker-compose -f LNX-docker-compose.yml up --build --exit-code-from dj
+        - docker-compose -f LNX-docker-compose.yml up --build --exit-code-from app
 jobs:
   include:
     - <<: *main

LNX-docker-compose.yml

@@ -3,7 +3,7 @@ x-net: &net
   networks:
       - main
 services:
-  dj:
+  app:
     <<: *net
     image: datajoint/pydev:${PY_VER}-alpine${ALPINE_VER}
     depends_on:

README.md

@@ -98,3 +98,43 @@ A number of labs are currently adopting DataJoint and we are quickly getting the
 * https://docs.datajoint.io -- up-to-date documentation
 * https://tutorials.datajoint.io -- step-by-step tutorials
 * https://catalog.datajoint.io -- catalog of example pipelines
+
+## Running Tests Locally
+
+
+* Create an `.env` with desired development environment values e.g.
+``` sh
+PY_VER=3.7
+ALPINE_VER=3.10
+MYSQL_VER=5.7
+MINIO_VER=RELEASE.2019-09-26T19-42-35Z
+UID=1000
+GID=1000
+```
+* `cp local-docker-compose.yml docker-compose.yml`
+* `docker-compose up -d` (Note configured `JUPYTER_PASSWORD`)
+* Select a means of running Tests e.g. Docker Terminal, or Local Terminal (see bottom)
+* Run desired tests. Some examples are as follows:
+
+| Use Case                     | Shell Code                                                                    |
+| ---------------------------- | ------------------------------------------------------------------------------ |
+| Run all tests                | `nosetests -vsw tests --with-coverage --cover-package=datajoint`                                                              |
+| Run one class of tests       | `nosetests -vs --tests=tests.test_fetch:TestFetch.test_getattribute_for_fetch1`                                                           |
+| Run one specific test        | `nosetests -vs --tests=tests.test_external_class:test_insert_and_fetch`                                   |
+
+
+### Launch Docker Terminal
+* Shell into `datajoint-python_app_1` i.e. `docker exec -it datajoint-python_app_1 sh`
+
+
+### Launch Local Terminal
+* See `datajoint-python_app` environment variables in `local-docker-compose.yml`
+* Launch local terminal
+* `export` environment variables in shell
+* Add entry in `/etc/hosts` for `127.0.0.1 fakeminio.datajoint.io`
+
+
+### Launch Jupyter Notebook for Interactive Use
+* Navigate to `localhost:8888`
+* Input Jupyter password
+* Launch a notebook i.e. `New > Python 3`

local-docker-compose.yml

@@ -3,7 +3,7 @@ x-net: &net
   networks:
       - main
 services:
-  dj:
+  app:
     <<: *net
     image: datajoint/pydev:${PY_VER}-alpine${ALPINE_VER}
     depends_on:
@@ -32,7 +32,7 @@ services:
        "
         pip install --user nose nose-cov coveralls ptvsd .;
         pip freeze | grep datajoint;
-        ## You may run the below tests once sh'ed into container i.e. docker exec -it datajoint-python_dj_1 sh
+        ## You may run the below tests once sh'ed into container i.e. docker exec -it datajoint-python_app_1 sh
         # nosetests -vsw tests --with-coverage --cover-package=datajoint; #run all tests
         # nosetests -vs --tests=tests.test_external_class:test_insert_and_fetch; #run specific basic test
         # nosetests -vs --tests=tests.test_fetch:TestFetch.test_getattribute_for_fetch1; #run specific Class test
@@ -45,22 +45,22 @@ services:
         done;
        "
     ports:
-      - "8889:8888"
+      - "8888:8888"
       - "5678:5678"
     user: ${UID}:${GID}
     volumes:
       - .:/src
       - /tmp/.X11-unix:/tmp/.X11-unix:rw
       # Additional mounted notebooks may go here
-      - ./notebook:/home/dja/notebooks
-      - ../dj-python-101/ch1:/home/dja/tutorials
+      # - ./notebook:/home/dja/notebooks
+      # - ../dj-python-101/ch1:/home/dja/tutorials
   db:
     <<: *net
     image: datajoint/mysql:$MYSQL_VER
     environment:
       - MYSQL_ROOT_PASSWORD=simple
     ports:
-      - "3307:3306"
+      - "3306:3306"
     # To persist MySQL data
     # volumes:
     #   - ./mysql/data:/var/lib/mysql