Dockerized Faculty Tools

.dockerignore

@@ -0,0 +1,22 @@
+.dockerignore
+__pycache__
+*.pyc
+*.pyo
+*.pyd
+.Python
+env
+venv*
+pip-log.txt
+pip-delete-this-directory.txt
+.tox
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+*.log
+.git
+*.template
+.env*
+fake-s3

.env.template

@@ -0,0 +1,16 @@
+TOOL_TITLE=Faculty Tools
+THEME_DIR=
+BASE_CANVAS_SERVER_URL=https://example.com/
+SECRET_KEY=CHANGEME
+LTI_KEY=key
+LTI_SECRET=secret
+OAUTH2_URI=http://127.0.0.1:9001/oauthlogin
+OAUTH2_ID=CHANGEME
+OAUTH2_KEY=CHANGEME
+GOOGLE_ANALYTICS=GA-000000
+CONFIG=config.DevelopmentConfig
+DATABASE_URI=mysql://root:secret@db/faculty_tools
+
+REQUIREMENTS=test_requirements.txt
+
+WHITELIST_JSON=whitelist.json

.github/workflows/ci.yml

@@ -0,0 +1,96 @@
+name: Run Python Tests and Build Image
+
+on:
+  push:
+    branches:
+      - issue/21-dockerize
+      - develop
+      - master
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+  REQUIREMENTS: requirements.txt
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Python 3
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.7
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r test_requirements.txt
+          pip install coveralls
+      - name: Setup Repo
+        run: |
+          cp whitelist.json.template whitelist.json
+          cp .env.template .env
+      - name: Run flake8
+        run: flake8
+      - name: Run black
+        run: black --check .
+      - name: Lint markdown files
+        uses: bewuethr/mdl-action@v1
+      # - name: Load dotenv
+      #   uses: falti/dotenv-action@v0.2.5
+      - name: Environment Variables from Dotenv
+        uses: c-py/action-dotenv-to-setenv@v3
+      # - name: Print Repo
+      #   run: |
+      #     env
+      - name: Run unittests
+        run: coverage run -m unittest discover
+
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Print Buildx
+        run: |
+          docker buildx ls
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: REQUIREMENTS=${{ env.REQUIREMENTS }}
+          platforms: linux/amd64
+
+      - name: Build and push ARM64 Docker image
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: REQUIREMENTS=${{ env.REQUIREMENTS }}
+          platforms: linux/arm64 
+
+      - name: Build and push ARMv7 Docker image
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: REQUIREMENTS=${{ env.REQUIREMENTS }}
+          platforms: linux/arm/v7
+

.gitignore

@@ -1,7 +1,7 @@
 # config/settings
 logs
-settings.py
 whitelist.json
+.env
 
 # local theming
 themes/*

Dockerfile

@@ -0,0 +1,9 @@
+FROM python:3.7 as base
+ARG REQUIREMENTS
+COPY requirements.txt /app/
+COPY test_requirements.txt /app/
+RUN pip install -r /app/$REQUIREMENTS
+WORKDIR /app
+COPY ./ /app/
+EXPOSE 9001
+CMD ["gunicorn", "--conf", "gunicorn_conf.py", "--bind", "0.0.0.0:9001", "lti:app"]

README.md

@@ -4,18 +4,54 @@
 
 # Documentation for Faculty Tools
 
-## Settings
+## Setting up Faculty Tools with Docker & Docker-Compose
 
-Create a new `settings.py` file from the template
+First clone and setup the repo.
 
 ```sh
-cp settings.py.template settings.py
+git clone git@github.com:ucfopen/faculty-tools.git
+cd faculty-tools
+cp whitelist.json.template whitelist.json
+cp .env.template .env
 ```
 
-Edit `settings.py` to configure the application. All fields are required,
+### Environment Variables
+
+Edit `.env` to configure the application. All fields are required,
 unless specifically noted.
 
-## Developer Key
+To create a good secure secret key, run this command:
+
+```sh
+docker-compose run --rm lti python -c "import os, binascii; print(binascii.b2a_base64(os.urandom(24)).decode('ascii'))"
+```
+
+```sh
+TOOL_TITLE=Faculty Tools # Window Title of Page
+THEME_DIR= # Keep blank unless building out your own theme directory
+BASE_CANVAS_SERVER_URL=https://example.com/ # the URL for your canvas server
+SECRET_KEY=CHANGEME # Random key used to secure portions of Flask - Follow instructions above
+LTI_KEY=key # Random key - This is public - Used to install LTI.
+LTI_SECRET=secret # Random secret key - Used to install LTI.  Do not share!
+OAUTH2_URI=http://127.0.0.1:9001/oauthlogin # URL of faculty tools oauthlogin page
+OAUTH2_ID=CHANGEME # ID given by LMS Admins / Developer Key (API Key) page in Canvas
+OAUTH2_KEY=CHANGEME # ID given by LMS Admins / Developer Key (API Key) page in Canvas
+GOOGLE_ANALYTICS=GA-000000 # Your Google Analytics id.
+DATABASE_URI=mysql://root:secret@db/faculty_tools # Your mysql connection string.
+
+# config.py configuration settings
+# config.Development for Dev, config.BaseConfig for production
+CONFIG=config.DevelopmentConfig
+
+
+# test_requirements for development / requirements.txt for production.
+REQUIREMENTS=test_requirements.txt
+
+WHITELIST_JSON=whitelist.json # See below
+
+```
+
+## Developer Key -> API Key
 
 You will need a developer key for the OAuth2 flow. Check out the [Canvas
 documentation for creating a new developer key](https://community.canvaslms.com/docs/DOC-12657-4214441833)
@@ -57,31 +93,14 @@ Add the tools you want instructors and faculty to see to `whitelist.json`.
 ]
 ```
 
-## Virtual Environment
-
-Create a new virtual environment.
-
-```sh
-virtualenv env
-```
-
-Activate the environment.
-
-```sh
-source env/bin/activate
-```
-
-Install everything:
-
-```sh
-pip install -r requirements.txt
-```
-
 ## Create DB
 
-Change directory into the project folder. Create the database in python shell:
+We need to generate the database and tables for faculty tools to run properly.
+The MySQL docker image automatically creates the user, password, and database
+name set in the `docker-compose.yml` file.
 
 ```sh
+docker-compose run --rm lti python
 from lti import db
 db.create_all()
 ```
@@ -90,34 +109,35 @@ If you want to look at your users table in the future, you can do so in the
 python shell:
 
 ```python
+docker-compose run lti python
 from lti import Users
 Users.query.all()
 ```
 
-## Environment Variables
+## Run the App
 
-Set the flask app to `lti.py` and debug to true.
+It's time to use docker-compose to bring up the application.
 
 ```sh
-export FLASK_APP=lti.py
-export FLASK_DEBUG=1
+docker-compose up -d
 ```
 
-Alternatively, you can run the setup script to simultaneously setup environment
-variables and the virtual environment.
+Go to the /xml page, <http://127.0.0.1:9001/xml> by default.
 
-```sh
-source setup.sh
-```
+Copy the xml, and install it into a course (Course->Settings->Apps).
 
-## Run the App
+## View the Logs
 
-Run the lti script while your virtual environment is active.
+To view the logs while the application is running use this docker command:
 
 ```sh
-flask run
+docker-compose logs -f
 ```
 
-Go to the /xml page, [http://0.0.0.0:5000/xml](http://0.0.0.0:5000/xml) by default
+## Stopping the App
+
+To shutdown Faculty Tools
 
-Copy the xml, install it into a course.
+```sh
+docker-compose down
+```