#acl Known:write,read,delete,admin,revert All:read 
###  acl Known:read,write,admin,delete,revert

= Gitlab to Canvas syncing =
For a working example check out the [[https://gitlab.control.lth.se/regler/FRTF10|FRTF10-repo]] where as soon as any changes are pushed to the `to_canvas` folder on the master branch it is uploaded to the `from_gitlab` folder on the [[https://canvas.education.lu.se/courses/1342/files/folder/from_gitlab|canvas page]].

== Gitlab CI ==
Gitlab CI is run through a file called `.gitlab-ci.yml` in the root folder of the repository. This file can setup the environment we need to run certain scripts, define how and what scripts should be run and define in what cases it should be run. For our example we use this file
{{{#!highlight yaml
image: "python:3.7"

before_script:
  - python3 -m pip install canvasapi

canvas_push:
  script:
    - python3 to_canvas/canvas_sync.py
  stage: deploy
  only:
    refs:
      - master
    changes:
      - to_canvas/**/*.{pdf}
}}}
where `image` tells the runner to use a python3 docker image, `before_script` runs a command in the container created from the image that installs the package canvasapi and `canvas_push` runs a script if any of the specified files has changed for the specified branch.

== Runners ==
See https://gitlab.control.lth.se/regler/<REPO>/-/settings/ci_cd, where <REPO> should be replaced with the repository name, for instructions about runners. Hopefully we will soon have some shared runners for the department, but for the moment they have to be set up for each project specifically.

== Python script ==
The current script just takes all pdf files in one folder and pushed them to a folder on canvas. The script needs the names of the folders, the course code in canvas
{{{#!highlight python
import os
from canvasapi import Canvas

# Set these three values
canvas_course_code = 1342
canvas_pdf_path = "from_gitlab"
source_path = "to_canvas"

canvas_base_path = "course files"
API_URL = "https://canvas.education.lu.se/"
API_TOKEN = os.environ["CANVAS_TOKEN".format(canvas_course_code)]

canvas = Canvas(API_URL, API_TOKEN)
course = canvas.get_course(canvas_course_code)

# Check if folder exists, otherwise create it
base_folder = None
pdf_folder = None
for folder in course.get_folders():
    if folder.full_name == "{}/{}".format(canvas_base_path, canvas_pdf_path):
        pdf_folder = folder
    if folder.full_name == canvas_base_path:
        base_folder = folder
if pdf_folder is None:
    pdf_folder = base_folder.create_folder(canvas_pdf_path)

# Find all pdf files in to_canvas and upload to canvas folder from_gitlab
for f in os.listdir(source_path):
    if f.endswith(".pdf"):
        pdf_folder.upload(os.path.join(source_path, f))
}}}

== Canvas API Token ==
The script assumes there exists a variable for the Canvas API token in the repository. This variable is added to the gitlab runner as an environment variable and can then be used without us having it hardcoded anywhere. A token can be added by navigating to https://gitlab.control.lth.se/regler/<REPO>/-/settings/ci_cd, where you replace <REPO> with the repository name, and looking under Variables. There you add a token with name `CANVAS_TOKEN` and value `13596~t2TYuTRlaJnfvyTznfvhDOqq7B85o2wD2jU8NBCsixzLirB8nceTFIvUzbldIa1K`.
The API token can also be generated in a canvas profile but this is a token generated from a department account.