Skip to content

Latest commit

 

History

History
103 lines (65 loc) · 3.59 KB

USAGE.md

File metadata and controls

103 lines (65 loc) · 3.59 KB
Raw

How to use the tool

Prepare the configuration

First of all, design a few exercises and put them in the exercises dir. In the case of Java sources, the exercises can be organized in packages, the package line will be removed before compiling (Java compilation and execution by the related tools assumes that everything is in the default package).

Then choose a name for your exam (the name must contain just alphanumeric and underscore characters), say myexam, and add

./confs/myexam.txt
./confs/myexam.tsv

  • the first file must contain, on the first line, a secret followed by a list of exercise names (one exercise per line), that is, names of directories in the exercises folder; if the secret starts with !! the viewer will consider this configuration private (meaning that summaries will not be visible without the suitable authentication token);

  • the second file must contain a tab-separated list of unique ids, and last and first name (exactly one tab per line, after the ids).

Give a look to the example unpacked during the installation in case of doubt.

To prepare the configuration file, just run

source ./setenv.sh
scythe prepare myexam

that will generate ./confs/myexam-st.py and ./confs/myexam-tm.py: the configuration files required for all the next steps.

The "base bundle"

The confs/basebunlde directory contains a set of file that will be included in all the exam configurations (alongside the exercises and test cases); for example it can contain a README (in .txt or .md format) to help students during the exam and a set of simplified commands to test and upload their solutions.

The confs.tgz contains a basic bundle for Java (and Shell) programming exams with an Italian README (named LEGGIMI.md) and a few support commands that can be a reasonable starting point for your own basic bundle.

Markdown files will be converted to HTML before shipping. Other support files may be included provided they are in .txt or .md format and their name is made of alphanumeric characters.

What is included by prepare

The scythe prepare creates two tar files to be, respectively, distributed to the student and used by sim-fun-i to test the students solution.

The tar are created by tristo-mietitore with the mkconf subcommand, having filter

^(bin/.*|\w+\.html|\w+\.txt)|([0-9]+-.+/(\w+\.(html|txt)|TestRunner\.java|((input|expected|args)-[0-9]+)\.txt))$

for the student's tar, and filter

^[0-9]+-.+/(.+\.md|TestRunner\.java|((input|expected|args)-[0-9]+(t|))\.txt)$

for the testing tar.

Run the exam

Now you can push the configuration to the remote server and start it with

scythe start myexam

At the end of the allowed time,

scythe stop myexam

will stop the server (so that no student will be able to upload his solution after the exam deadline).

During the exam you can run

scythe logtail myexam

to peek at server logs.

Collect the student's work for backup purposes

During the exam, or at the end of it, run

scythe backup myexam

to copy the students uploads locally (under a suitable subdirectory of the backups dir).

View the results

When you push your configurations, you'll be given a dashboard URL where you can watch the real-time evaluations (with no restrictions); omitting the token (the last part of the URL) will give you a private dashboard (where no details are shown, not even the uid infos); on the other hand, with

scythe auth myexam REALMS...

you'll get a token for the specified realms.