Merge pull request #22 from GatorEducator/feature/automated-docker-bu…

…ilds

Automated docker builds

.dockerignore

@@ -3,5 +3,115 @@ Dockerfile
 .venv/
 .git/
 .gitignore
+/tests
+/scripts
+
 # possibly need to ignore database if using remote
 # database.db
+
+# Ignore git's ignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

.travis.yml

@@ -8,13 +8,12 @@ os: linux
 # set env variables for different jobs
 env:
   global:
-    - PYENV_ROOT=$HOME/.travis-pyenv
     - PIPENV_VENV_IN_PROJECT=1
     - PIPENV_IGNORE_VIRTUALENVS=1
     - LANG=en_US.UTF-8
     - LC_ALL=en_US.UTF-8
-    - secure: aU6ToQ8/23GK6QJxRKA7xBNuV3W26YoXrFMOMIPU8om22CCSd7aiN5ls6msR+cqX2cY3ozXUh/jcQqFeYrG3026gs53OVO+NSkZXVv3o9I6WaVM4wyudMXty3wAiq+1H9DWWYLKQOVInqPUmjetA1XioV3u9D2aTH+0psZUHzRCz0DrSIE7QF06YHexP4tNJayihjo3wXfHVOB+ABKb+O9ZdfCDSeUsJjeI7N1hP7+aAsa0lcgrvWevNOwlouchGliOB4qCqxAKAPsLyg9PVE/HDgHLpsWh/HnPfdiK5U8yoSIPRRn4wlCgn0bQ/xO2eFdNImHTel+cTzo6n7GNvyZU7VvxcmRdfqQAl7ix/mU255wMAziaIrJnvjJXuLO6PPTtW83Wfh54YyAX/d4bc9AKdszJUI0wa9ir3O8tSe6sY8YXe+mE83Tgh67heBqzBclofLyKF8g6IPiOefIkRFKBkIlJiB42Xbh2Zi+39BUvi6lrViCOB8DyWSkA4gjEPAKzvZSFGim9BxGPknfRknpWELn8hQ3GC9iOZ4NrAtuDl2kQshhjTVUGcEpYKjaoNROnjBZkpPT54/OweWJYW3w6uw9K8jEF63g6pWkKi2jVwtcmUp5cRuvgSaX5+1sd6T0DMNHBXYaUqMIgwdIljoDwswktvzfKtADKmO6TzbS8=
-    - secure: dE2+Q6P1KrFHr0kVn9Nwzx4mRVdTP3397hXDCyOM21+kAS3Kq6yRN/J1ThU701T7y6baEfWe6ICjDA2P4RTsN6MXUBkRjr1Wn7fht5FILnla9r5hQ+t2g4mPh7jsaJr7e8Qa29cML2Jub91midyzG4b348+AHod1JoUr2Adttvs4mtrVRV8epIby8VMa9iyyP3jD+1hq2xxtqVeQeaRbU44Bs4jIcDWx7ihix7Ns1AjqVUQhxgEhNh1RUlcppiGWGwAp3iWkqYFxfoqxKDbcZ2jl7YFA0ygJVnuuzxkZ7mNMMu3/T1CuC+IObD0KPjuNksx22OEyy1SKkOEBDuByyJRftnMPfzLw5PfwN+dyVjBLkGNf0Z3xdxCqhimPZaqlvlhwES7sq09aJuy/MBfpBcCp9GXITybjsp5NzUnfdiBN0efIgeeYp8gYv3uu/JAMJD6l/DM2WVG3mjsEXoinzhaw2XmYdLIU1w5jGfvcUdN0JolUT4ci9x2HeBhcGYQfkFgfC8xqHRy3UObVIvXoeoG1SlBk86fLHosubp59R/zWbUPl7jDIWjNK2WluUNTkDlEg2WYNznEf3VRtMeqOMD7O5s0+AANa38mw+qBXVpJDKc4V3nphbR2NPEAFRBluC5qG+lTKHmxEnr/i4j6rOFum5ymBvoae6YriT13sMBc=
+    - secure: "P26yt3T7Jp1HgCyScJ3O82hO7Z0HM9NK1GpwFgJ+a3xEE9dc2G0EM2O/k4ye0fFSObwjTeQl8kZwfvn/D4X++nulGhPI9ImLWcNIiElANyY7Gi+r2X+t1toE2RqCQ5FqtPQvdA8+SB3h7mf/br02gOQajY6gxD0/YjVke6FQmMT4npSrLwo9FgEgT5KY5/8GrKbJUDbhGJRPk3rgXFyTXFuRDMeVAZlfuIkdGVAwM9YFCMlqhzv/D1YP/DF8ODHR8zgtE3oXLwaoXzKTjuQ/yrSzsviU6lMrLOANLLLYGsFBhBcv52wELre/QisYW8O9swLlNanxHtqapT9r8JZIGy+2+52Hs5evIFnKKUhjuE/YgGWMu+KFwn/FJiZTpbwDXl85XCufgG98Ak62ZOypxGKwDaAJVxLhgaS/s+0LOMghVA6htVnx++oTUqdCCOVI7A3rWfX3zR2/zJWM+JhBqGKMUUp2jp9JLPzaeQSTHc24SaMWMNb95aj50orL60F+7SxrKGIdLA0ejJ6/tc1RqBYAjqdN9d9Z436nt8vWoOH3WrQmvh1+np8/rDuU7TpwOfw2Zur2tEdpdv5tNJjt7OBDjUONx+iONqNyVGS/V6rO2Acg9meYz0O62UNw9YeVSzp+89ZAsGYvY+C9rZCEzt33nrbzOd83vEAb36sxAY8="
+    - secure: "o/dxLIjL50bW4Qak/zNepaRJIt1kUSVCfxQY2HQ6cmJku6NNNb+BriRuqE0ddc1l35n77vE7MHWMV264ysc2OlVIZWGFwJ82yk+yqS9RjJvwM1XwP74AiiHzxk1XQO3ylTK3P0pP+legfoDQ4AZrGJCyOZ39OtPdJXVz/5gPWPbGqzE+U43PzzdvvWqQfFBXXP2rIrOAamUdDeQlB6nLB1lUIPJ7VoxVVLfhSE0n3ku2SgW3QMkq4/ytr63mG2TD9sbGXMbz9R8Q+enothockujlx9z4nI0ew/97wDsBC9T7oqGpuZAnokDgLtsMo1y5ekP7bEELuBFsa2WchPbTw3M42beUj6MluVeI+i4G3UIvAKOA3E7EelkJ7pndnO+91KtMBda3ZvO870DZtbo+X8Sg6WZGbzdvGpB7+qQcsIm41Y8vAy3c3ryps6rRKaAiFQDK77GkvKpTrl6V7soKBA2/5O/PE9RIaqYFsjvv1vFhkp4Ib0hqoxBaGy3AMjAdPRVamW9Ocngnokmn7lDOvNkuvIarcIPMgiSSS6xMLtbKPlZ2SIyRk5cimq3PzF2yCaC8JZu6WQXkAjWPs3Vh7wNiBJf29vKkpOLdGPR0n8VN05fNJi7WnZNj+HvwnFHHPgQjWuGrO+GiTLWdHS5YlpVB9WxTFhbxpDY1b2ZAR1A="
 
 # command to install dependencies
 install:
@@ -27,9 +26,9 @@ install:
 # cache pip installations
 # cache pyenv installations
 cache:
-  - pip
-  - directories:
+  directories:
     - $HOME/.pyenv_cache
+    - $HOME/.cache/pip
 
 # perform testing:
 # --> run the test suite and generate coverage with Pipfile script

README.md

@@ -3,12 +3,9 @@
 ![logo](logo.jpg "Professor Spidey")
 
 [![Build Status](https://travis-ci.com/GatorEducator/quizagator.svg?branch=master)](https://travis-ci.com/GatorEducator/quizagator)
-[![codecov.io](http://codecov.io/github/GatorEducator/quizagator/coverage.svg?branch=master)](
-http://codecov.io/github/GatorEducator/quizagator?branch=master)
+[![codecov.io](http://codecov.io/github/GatorEducator/quizagator/coverage.svg?branch=master)](http://codecov.io/github/GatorEducator/quizagator?branch=master)
 [![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat)](#contributors)
-[![made-with-python](
-https://img.shields.io/badge/Made%20with-Python-blue.svg)](
-https://www.python.org/)
+[![made-with-python](https://img.shields.io/badge/Made%20with-Python-blue.svg)](https://www.python.org/)
 
 ## A Quiz Creation Tool for File Upload and Custom Grading
 

application/__init__.py

@@ -1,12 +1 @@
 """ Application package initializer """
-import flask
-
-# main flask instance
-app = flask.Flask(__name__)
-
-# pylint: disable=wrong-import-position
-from . import index  # noqa: E402, F401
-from . import db_connect  # noqa: E402, F401
-from . import students  # noqa: E402, F401
-from . import teachers  # noqa: E402, F401
-from . import login  # noqa: E402, F401

application/app.py

@@ -0,0 +1,15 @@
+"""AppFactory"""
+import flask
+
+
+def create_app():
+    """Create an app"""
+    app = flask.Flask(__name__)
+
+    with app.app_context():
+        # pylint: disable=unused-import
+        from . import index  # noqa: E402, F401
+        from . import students  # noqa: E402, F401
+        from . import teachers  # noqa: E402, F401
+        from . import login  # noqa: E402, F401
+    return app

application/db_connect.py

@@ -1,11 +1,10 @@
 """ Describes the database connection """
-
 import functools
 import sqlite3
 import flask
 
 # from flask import g, session, escape
-from application import app
+from flask import current_app as app
 
 
 DATABASE = "database.db"

application/index.py

@@ -1,8 +1,7 @@
 """ undocumented """
-
 import flask
 
-from application import app
+from flask import current_app as app
 
 
 @app.route("/")

application/login.py

@@ -1,8 +1,7 @@
 """ undocumented """
-
 import flask
 
-from application import app
+from flask import current_app as app
 from . import db_connect
 
 # LOGIN THE USER

application/students.py

@@ -1,7 +1,7 @@
 """ Student endpoints """
 import flask
 
-from application import app
+from flask import current_app as app
 from . import db_connect as db
 
 

application/teachers.py

@@ -1,8 +1,7 @@
 """ teacher endpoints """
-
 import flask
 
-from application import app
+from flask import current_app as app
 from . import db_connect as db
 
 

run.py

@@ -2,7 +2,9 @@
 
 import argparse
 
-from application import app
+from application import app as appfactory
+
+app = appfactory.create_app()
 
 app.secret_key = "$JLmL!eCQXyajbdu2LCJ&Vwqs2JGagg3B&FRfexCmKBV"
 

scripts/create-docker-image.sh

@@ -1,7 +1,9 @@
 #!/bin/bash
 
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
 IMAGE_NAME="gatoreducator/quizagator"
-TAG="latest"
+TAG="$(source $SCRIPT_DIR/version.sh)-dev"
 
 NAME="$IMAGE_NAME"
 if ! test -z "$TAG"; then

scripts/run-docker-image.sh

@@ -1,7 +1,11 @@
 #!/bin/bash
 
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
 NAME="quizagator"
-IMAGE="gatoreducator/quizagator:latest"
+IMAGE_NAME="gatoreducator/quizagator"
+TAG="$(source $SCRIPT_DIR/version.sh)-dev"
+IMAGE="$IMAGE_NAME:$TAG"
 INNER_PORT="5000"
 OUTER_PORT="4201"
 

scripts/version.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+function get_latest_version() {
+    local tag
+    tag="$(curl -s -X "GET" "https://api.github.com/repos/gatoreducator/quizagator/tags" | jq -r '.[0].name')"
+
+    if [[ -z "$tag" ]] || [[ "$tag" = "null" ]]; then
+        tag="v0.0.0"
+    fi
+
+    tag=${tag##v}
+    echo "$tag"
+    return 0
+}
+
+get_latest_version

tests/test_app.py

@@ -1,27 +1,33 @@
-""" basic tests """
+"""Basic Tests"""
 import pytest
 
-from application import app
-from application import login
+from application import app as appfactory
 
 
+@pytest.fixture()
+def factory():
+    """Create an app and its test client"""
+    actual_app = appfactory.create_app()
 
-def test_app_created():
-    """Start with a blank database."""
-    assert app is not None
+    # pylint: disable=too-few-public-methods
+    class Group:
+        """Group of created objects"""
 
-class FlaskrTestCase(unittest.TestCase):
+        app = actual_app
+        client = actual_app.test_client()
 
-    def setUp(self):
-        self.db_fd, flaskr.app.config['DATABASE'] = tempfile.mkstemp()
-        flaskr.app.testing = True
-        self.app = flaskr.app.test_client()
-        with flaskr.app.app_context():
-            flaskr.init_db()
+    return Group
 
 
-# def test_index(app):
-#     res = app.get("/")
-#     # print(dir(res), res.status_code)
-#     assert res.status_code == 200
-#     assert b"" in res.data
+# pylint: disable=redefined-outer-name
+def test_app_created(factory):
+    """Start with a blank database"""
+    assert factory.app is not None
+
+
+# pylint: disable=redefined-outer-name
+def test_index(factory):
+    """Test index page works -- NOT CORRECT"""
+    res = factory.client.get("/")
+    assert res.status_code == 404
+    assert b"" in res.data