Draft - LTI 1.3 and Dockerize

.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/*

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 ### General
 
+- Implement LTI 1.3 standard for tool launch
+- Move refresh and access tokens from session storage to db storage
+- add Makefile for easier docker and utility commands
+
 ## [1.2.0] - 2019-09-10
 
 ### General
@@ -18,8 +22,7 @@
 
 ### Bugfixes
 
-- Fixed an issue where switching browsers would cause Faculty Tools to ask the
-    user to reauthorize with Canvas, leading to multiple access tokens.
+- Fixed an issue where switching browsers would cause Faculty Tools to ask the user to reauthorize with Canvas, leading to multiple access tokens.
 
 ## [1.0.0] - 2018-08-29
 

Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.12 as base
+ARG REQUIREMENTS
+COPY requirements.txt /app/
+COPY test_requirements.txt /app/
+# RUN pip install --upgrade pip
+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"]

Makefile

@@ -0,0 +1,83 @@
+COMPOSE_FILE=docker-compose.yml
+DOCKER_COMPOSE=docker compose -f $(COMPOSE_FILE)
+
+BLACK        := $(shell tput -Txterm setaf 0)
+RED          := $(shell tput -Txterm setaf 1)
+GREEN        := $(shell tput -Txterm setaf 2)
+YELLOW       := $(shell tput -Txterm setaf 3)
+LIGHTPURPLE  := $(shell tput -Txterm setaf 4)
+PURPLE       := $(shell tput -Txterm setaf 5)
+BLUE         := $(shell tput -Txterm setaf 6)
+WHITE        := $(shell tput -Txterm setaf 7)
+RESET := $(shell tput -Txterm sgr0)
+
+default: build
+
+#==============================================
+# Building and cleaning the Docker environment
+#==============================================
+build: ## Build all Docker images
+	@echo "Building Faculty Tools' Docker images"
+	@$(DOCKER_COMPOSE) build
+
+build-no-cache: ## Build all Docker images
+	@echo "Building Faculty Tools' Docker images"
+	@$(DOCKER_COMPOSE) build --no-cache
+
+clean: stop-lti remove-lti-volumes build-no-cache ## Stops and removes existing existing containers before rebuilding images
+
+nuke:  ## Stops and removes existing existing containers and volumes, including the database
+	@echo "${YELLOW}Stopping running containers and purging existing volumes${RESET}"
+	$(DOCKER_COMPOSE) down -v
+
+#================================================================================
+# Managing the Docker environment (e.g. starting, stopping, deleting containers)
+#================================================================================
+start: start-daemon ## Start Faculty Tools (default: daemon mode)
+
+start-attached: ## Start Faculty Tools in attached mode
+	@echo "${GREEN}Starting Faculty Tools in attached mode${RESET}"
+	$(DOCKER_COMPOSE) up
+
+start-daemon: ## Start Faculty Tools in daemon mode
+	@echo "${GREEN}Starting Faculty Tools in daemon mode${RESET}"
+	@echo "Run \`make start-attached\` to run in attached mode, or view container logs with \`make logs\`"
+	$(DOCKER_COMPOSE) up -d
+
+stop: ## Stop Faculty Tools
+	@echo "${YELLOW}Stopping Faculty Tools${RESET}"
+	$(DOCKER_COMPOSE) down
+
+logs: ## View container logs (optionally specifying a service name, like `lti`)
+	$(DOCKER_COMPOSE) logs -f
+
+#=================================
+# Application management commands
+#=================================
+
+# TODO ensure the new way using `db-init` covers same actions
+# create-db:
+# 	@echo "Initializing the database"
+# 	docker-compose up -d lti
+# 	docker-compose exec lti python -c "from lti import app, db; app.app_context().push(); db.create_all()"
+
+db-init: ## Initialize the database
+  ${DOCKER_COMPOSE} run --rm -e FLASK_APP=lti.py lti flask db init
+
+makemigrations: ## Create a new DB migration
+	${DOCKER_COMPOSE} run --rm -e FLASK_APP=lti.py lti flask db migrate
+
+migrate-run: ## Run an existing DB migration
+	${DOCKER_COMPOSE} run --rm -e FLASK_APP=lti.py lti flask db upgrade
+
+downgrade: ## Downgrade the database
+	${DOCKER_COMPOSE} run --rm -e FLASK_APP=lti.py lti flask db downgrade
+
+generate-keys: ## Create new public and private keys and assign them to a keyset
+	${DOCKER_COMPOSE} run --rm -e FLASK_APP=lti.py lti flask  generate_keys
+
+register: ## Add a new registration for Zapt in a platform
+	${DOCKER_COMPOSE} run --rm -e FLASK_APP=lti.py lti flask register
+
+deploy: ## Add a new deployment for Zapt to an existing registration
+	${DOCKER_COMPOSE} run --rm -e FLASK_APP=lti.py lti flask deploy