2like-server-demo

Deploy

docker-compose up --build -d

Relevant/Interesting files:

compose.yaml

Configuration for docker compose, change Ports, etc here.

Dockerfile

Tells docker how to build the container.

execution_script.sh

Use analyze.sh instead (I do not know, why this is still here).

generate_test_keys.sh

Generates the keys for https, change this to use lets encrypt if valid certificates are required.

vpl_evaluate.sh

Tells vpl how to start our program and sets required environment variables.

app/StatisticsReceiver.sh

Script needed to receive the statistics from the vpl analyses, simply stores them in a file.

app/analyze.sh

Used by vpl to start our program. Konfiguration for whole deployement (changes require rebuilding the docker container), in the line before the last line, change command line parameters for the call of our program. You can use the following arguments:

• --codePath <path to the code> (required)\n"
• --configPath <path to the config> (required)\n"
• --userID <ID of the moodle user> (required)\n"
• --taskID <ID of the task> (required)\n"
• --statisticsServerPort <port> (optional), the port of the server collecting the statistics (if not given, no statistics are collected)\n"
• --feedbackLevel <level> (optional, default is advanced), the specified feedback level (beginner, intermediate or advanced) will be considered when generating descriptions for the findings\n"
• --ignoreLinter <linterName> (optional), the specified linter will not be used for the analysis\n"
• --ignoreFinding <findingName> (optional), the specified finding (by type or abbreviation) will be ignored in the analysis, may also be a comma separated list of several findings (no spaces!)\n"
• -n <number of findings to maximally print> (optional, default is max integer)\n"
• --ignore-infilesettings (optional), this results in settings in the file being ignored\n"
• --debug (optional), to enable debug mode\n"

app/install_vpl.sh

Install script for vpl, used by docker during the build process.

app/install_2like.sh

Creates directories needed by our program as soon as the vpl jail server is up and running.

app/supervisord.conf

Configuration for supervisord. supervisord is used to start everything that is required to run in the docker container, since docker does not use systemd.

app/vpl_jail_system.conf

Configuration for the vpl jail system.

app/findings.csv

This file is used to configure the findings our system finds. It can be used to customize the names, messages, priority and category of each finding. It also supports applying regexes to the outputs of the individual linters to use the captured groups in the messages for the findings. It also supports three levels of messages: beginner, intermediate and advanced.

app/linters.json

Configuration for the linters used by our program. This file mostly configures, how each linter is executed and how the xml file it returns is parsed (using xpath expressions). Besides that it also contains the priority of each linter and the index of its individual information in the findings.csv file.

app/linters/cq-checkers

This folder contains the linters themselves.