docker: add Dockerfile, docker-compose.yml and how to use it

Author: stoivo

Dockerfile

@@ -0,0 +1,18 @@
+FROM python:2.7
+
+MAINTAINER Simon Toivo Telhaug <[email protected]>
+
+RUN apt-get update
+RUN apt-get install man-db -y
+
+ADD ./requirements.txt /tmp/requirements.txt
+
+RUN pip install --upgrade pip
+RUN python --version
+RUN pip install -r /tmp/requirements.txt
+
+ADD ./ /opt/webapp/
+WORKDIR /opt/webapp
+EXPOSE 5000
+
+CMD ["make", "serve"]

README.md

@@ -74,3 +74,28 @@ Use the manager to parse and save a gzipped man page in raw format:
     python runserver.py
      * Running on http://127.0.0.1:5000/
      * Restarting with reloader
+
+### Start up a local web server with docker
+
+    Build docker web and db containers
+    $ docker-compose build
+    $ docker-compose up
+
+    Copy dump over to container for than to import it.
+    $ docker cp dump/ explainshell_db_1:/tmp/dump
+
+    Import classifiers
+    $ docker exec explainshell_db_1 mongorestore /tmp/dump
+
+    Import a man page
+    $ docker exec explainshell_web_1 PYTHONPATH=. python explainshell/manager.py --log info /usr/share/man/man1/rsync.1.gz
+
+    Open browser at port 5000
+    $ open http://localhost:5000
+
+    ## Run tests
+    Restore test db to run tests
+    $ docker exec explainshell_db_1 mongorestore -d explainshell_tests /tmp/dump/explainshell
+
+    Run test
+    $ docker exec explainshell_web_1 make tests

docker-compose.yml

@@ -0,0 +1,16 @@
+version: '2'
+services:
+  db:
+    image: mongo
+  web:
+    build: .
+    command: make serve
+    environment:
+      - MONGO_URI=mongodb://db
+      - HOST_IP=0.0.0.0
+    volumes:
+      - .:/opt/webapp
+    ports:
+      - "5000:5000"
+    depends_on:
+      - db

explainshell/config.py

@@ -8,7 +8,9 @@
 
 MAN2HTML = os.path.join(TOOLSDIR, 'w3mman2html.cgi')
 
-MONGO_URI = 'mongodb://localhost'
+# host to pass into Flask's app.run.
+HOST_IP = os.getenv('HOST_IP', False)
+MONGO_URI = os.getenv('MONGO_URI', 'mongodb://localhost')
 DEBUG = True
 
 LOGGING_DICT = {

explainshell/store.py

@@ -1,7 +1,7 @@
 '''data objects to save processed man pages to mongodb'''
 import pymongo, collections, re, logging
 
-from explainshell import errors, util, helpconstants
+from explainshell import errors, util, helpconstants, config
 
 logger = logging.getLogger(__name__)
 
@@ -215,7 +215,7 @@ class store(object):
     2) manpage - contains a processed man page
     3) mapping - contains (name, manpageid, score) tuples
     '''
-    def __init__(self, db='explainshell', host='localhost'):
+    def __init__(self, db='explainshell', host=config.MONGO_URI):
         logger.info('creating store, db = %r, host = %r', db, host)
         self.connection = pymongo.MongoClient(host)
         self.db = self.connection[db]

runserver.py

@@ -5,4 +5,7 @@
 logging.config.dictConfig(config.LOGGING_DICT)
 
 if __name__ == '__main__':
-    app.run(debug=config.DEBUG)
+    if config.HOST_IP:
+        app.run(debug=config.DEBUG, host=config.HOST_IP)
+    else:
+        app.run(debug=config.DEBUG)

tests/test-integration.py

@@ -1,10 +1,10 @@
 import unittest, subprocess, pymongo, os
 
-from explainshell import manager, matcher
+from explainshell import manager, config, matcher
 
 class test_integration(unittest.TestCase):
     def test(self):
-        mngr = manager.manager('localhost', 'explainshell_tests', [os.path.join(os.path.dirname(__file__), 'echo.1.gz')], drop=True)
+        mngr = manager.manager(config.MONGO_URI, 'explainshell_tests', [os.path.join(os.path.dirname(__file__), 'echo.1.gz')], drop=True)
         mngr.run()
 
         cmd = 'echo -en foobar --version'

tests/test-manager.py

@@ -11,7 +11,7 @@ def _getmanager(self, names, **kwargs):
         for n in names:
             l.append(os.path.join(config.MANPAGEDIR, '1', n))
 
-        m = manager.manager('localhost', 'explainshell_tests', l, **kwargs)
+        m = manager.manager(config.MONGO_URI, 'explainshell_tests', l, **kwargs)
         return m
 
     def test(self):
@@ -87,7 +87,7 @@ def test_overwrite(self):
         self.assertEquals(m.store.mapping.count(), 1)
         self.assertEquals(len(list(m.store)), 1)
 
-        m = manager.manager('localhost', 'explainshell_tests', [os.path.join(config.MANPAGEDIR, '1', 'tar.1.gz')], overwrite=True)
+        m = manager.manager(config.MONGO_URI, 'explainshell_tests', [os.path.join(config.MANPAGEDIR, '1', 'tar.1.gz')], overwrite=True)
         a, e = m.run()
         self.assertTrue(a)
         self.assertFalse(e)
@@ -125,7 +125,7 @@ def test_edit(self):
 
     def test_samename(self):
         pages = [os.path.join(config.MANPAGEDIR, '1', 'node.1.gz'), os.path.join(config.MANPAGEDIR, '8', 'node.8.gz')]
-        m = manager.manager('localhost', 'explainshell_tests', pages)
+        m = manager.manager(config.MONGO_URI, 'explainshell_tests', pages)
         a, e = m.run()
         self.assertEquals(len(a), 2)
         self.assertEquals(len(m.store.findmanpage('node')), 2)