https://github.com/mitodl/openedx-course-test

Script for validating/testing Open Learning XML courses for the edx-platform using a docker container
https://github.com/mitodl/openedx-course-test

Last synced: 6 days ago
JSON representation

Script for validating/testing Open Learning XML courses for the edx-platform using a docker container

• Host: GitHub
• URL: https://github.com/mitodl/openedx-course-test
• Owner: mitodl
• License: bsd-2-clause
• Created: 2015-01-28T20:55:38.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2023-10-20T13:38:12.000Z (about 1 year ago)
• Last Synced: 2024-04-14T05:23:50.537Z (8 months ago)
• Language: Python
• Size: 32.2 KB
• Stars: 3
• Watchers: 11
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Course Tester

---

Syntax checker and validator for edX Courses.

---

This repo builds a docker image of a minimal edx-platform install

capable of doing several

[Open Learning XML (OLX)](http://engineering.edx.org/2014/10/open-learning-xml-olx-format/)

(a.k.a. [Open edX course exports](https://code.edx.org)) content checks and validations.

This is extremely useful for raw XML authored (or

[latex2edx](https://github.com/mitocw/latex2edx)) courses, but it also

has a lot of benefits for validating regular Studio edited courses as

well.  Notably link checking and some basic accessibility checks

## Quick Start

If you have docker installed and a course to test, you don't even need

to grab this repository, just run: `docker run -i -t -v

"/path/to/course_dir":"/course" -w /test_course

mitodl/openedx-course-test bash -e test_course` replacing

`path/to/course_dir` with the file path to a folder above where you

have your course.

## Current Tests

- XML syntax validation

- JSON policy file syntax validation

- Static asset file names are in the simple URL set of `^[a-zA-Z0-9_\./-]+$`

- Course imports successfully into `XMLModuleStore`

- Course image validation

  - It exists

  - It is an image

  - It is the correct image type (PNG or JPG)

  - It warns if the aspect ratio isn't correct (1.75)

- All image tags in content have `alt` attributes for accessibility

- All video units have `show_captions` set to true (warns only)

- Link checking

  - `/static/` magic links point at assets that exist in the course

  - `/jump_to/` links point at internally valid courseware

  - `/jump_to_id/` point at valid urls within the course

  - `http[s]` links are tested with HEAD and validated to return 200 status code

## Full Usage

Simply run `course_test /path/to/course/folder` where the course

folder has exactly one course in it.  This will need to be run on

a system that has docker installed and enough ram to run the

import (probably about 2GiB).

By default this will get the latest public docker image.  If you want

to build your own locally instead, you can run `course_test -l

/path/to/course/folder` and it will build it if you don't already have

the image.  You can also manually build just the image with `docker

build -t=mitodl/openedx-course-test .` and build from scratch

(no-cache) with `docker build --no-cache -t=mitodl/openedx-course-test

.`

## Known Issues

Due to somewhat ridiculous requirements needed to import ORA problems,

they will just show up as failed in the "Possible issues in course"

section as `Error loading from xml. No module named require`.