Public project release.

.gitignore

@@ -0,0 +1,20 @@
+__pycache__/
+*.py[cod]
+*$py.class
+
+gitpull.log
+
+db.sqlite3
+uploads/
+settings_local.py
+scripts/chroot_execvp
+
+.idea
+.settings
+.project
+.pydevproject
+*.sublime-project
+*.sublime-workspace
+
+.DS_Store
+*~

README.md

@@ -0,0 +1,124 @@
+This grading service accepts anonymous submissions for grading via HTTP. The
+grading can be done synchronously or asynchronously using a submission queue.
+The results are delivered to the calling system and the grader does not keep
+any record other than service logs. The grader is designed to serve exercises
+for the A+ learning system. A farm of individual grading servers can be setup
+to handle large amount of submissions.
+
+The grader is implemented on Django 1.7 (`grader/settings.py`)
+and grading queue on Celery 3.1 (`grader/tasks.py`). Actual grading is
+typically executed via shell scripts in a Linux chroot sandbox.
+On an Ubuntu system the sandbox can be created with the
+`manage_sandbox.sh` script.
+
+The grader is designed to be extended for different courses and exercise types.
+Course and exercise configuration is in `exercises` directory where
+exercise documentation and examples are available.
+
+Installing the grader stack
+===========================
+
+> 6/2014 - Ubuntu 12.04.4
+
+1. ### Ubuntu package requirements
+
+	Installs and starts the daemons.
+
+		sudo apt-get install rabbitmq-server python-pip python-dev
+		sudo apt-get install libxml2-dev libxslt-dev unzip
+		# For running in Apache web server
+		sudo apt-get install apache2 libapache2-mod-wsgi
+
+2. ### Python requirements
+
+	Installs the Python libraries. Setting up an virtualenv is possible.
+	At Aug 13th librabbitmq did not have Python 3 support so Python 2 is
+	required.
+
+		sudo pip install -r requirements.txt
+
+3. ### Grader application
+
+	Clones the Git repository.
+
+		sudo git clone https://github.com/Aalto-LeTech/mooc-grader.git
+		sudo mkdir mooc-grader/uploads
+		sudo chown -R www-data:www-data mooc-grader/uploads
+
+	If required, edit `grader/settings.py`
+	* `CELERY_BROKER`: the queue URL (RabbitMQ service)
+	* `CELERY_TASK_LIMIT_SEC`: the timeout for grading a task
+	* `QUEUE_ALERT_LENGTH`: the error log threshold
+	* `SUBMISSION_PATH`: the file submission directory
+	* `SANDBOX_LIMITS`: the default time/memory limits for sandbox
+
+	#### Testing grader application
+
+	Django and Celery can run in test mode from command line.
+
+			python manage.py runserver
+			celery -A grader.tasks worker
+
+	In addition, the exercise configuration and grading of individual
+	exercises can be tested from command line.
+
+			python manage.py exercises
+			python manage.py grade
+
+	#### For configuring courses and exercises, see
+
+	`exercises/README.md`
+
+4. ### Chroot sandbox creation
+
+	Creates a chroot environment to `/var/sandbox/` where tests
+	can not escape the enclosing directory. The script can be run
+	again to update the sandbox with changes.
+
+		sudo mooc-grader/manage_sandbox.sh create all
+
+	Changing the sandbox location requires changing path in
+	`scripts/chroot_execvp.c` and using an argument with the
+	management script.
+
+5. ### X virtual frame buffer
+
+	For tests requiring X display server xvfb can be used. These
+	tests include in browser tests. Installs the xvfb and copies
+	the daemon script. Finally starts X daemon in DISPLAY=:0
+
+		sudo apt-get install xvfb
+		sudo cp doc/etc-init.d-xvfb /etc/init.d/xvfb
+		sudo chmod a+x /etc/init.d/xvfb
+		sudo update-rc.d xvfb defaults
+		sudo /etc/init.d/xvfb start
+
+6. ### Celeryd installation
+
+	Copies daemon configuration and script (configuration
+	depends on the grader directory). Registers daemon
+	for default run levels and starts it up. The **mooc-grader
+	directory must** be set in the `/etc/default/celeryd`.
+	If using virtualenv pay attention to celery path as well.
+
+		sudo cp doc/etc-default-celeryd /etc/default/celeryd
+		sudo cp doc/etc-init.d-celeryd /etc/init.d/celeryd
+		sudo chmod a+x /etc/init.d/celeryd
+		sudo update-rc.d celeryd defaults
+		sudo /etc/init.d/celeryd start
+
+7. ### Web server configuration
+
+	__Apache__: Edit your `/etc/apache2/sites-available/sitename`.
+	This is an example configuration without virtualenv or case
+	optimized parameters.
+
+		WSGIDaemonProcess grader user=www-data group=www-data
+		WSGIProcessGroup grader
+		WSGIScriptAlias / /var/mooc-grader/grader/wsgi.py
+		Alias /static/ /var/mooc-grader/static/
+		Alias /robots.txt /var/mooc-grader/static/robots.txt
+		<Directory /var/mooc-grader/static/>
+			Order allow,deny
+			allow from all
+		</Directory>