Skip to content

FAQ on feedback_settings.yaml

Jacques Yakoub edited this page Oct 10, 2020 · 7 revisions

What is feedback_settings.yaml ?

That is a optional yaml configuration used for generating feedback(s) and determine sucess/failure of the task.

What does it contain ?

Key Default value Description
quorum 1.0 float between 0.0 (0%) and 1.0 (100%) that the user should reach in order to success the task
has_feedback false true If we expected something on stdout (generated by the Runner). Else it is a pass/fail task
feedback_kind None any of these string values ("JavaGrading", "JaCoCo"). Useful only when you have has_feedback=True
coverage_stats None Sequences of string. Possible values are "INSTRUCTION", "BRANCH", "LINE", "METHOD", "CLASS" ) (check out more in https://www.eclemma.org/jacoco/trunk/doc/counters.html )
prohibited {} Map that has "problem id" as key and sequences of strings as values
required {} Map like "prohibited" but this time, we want to force the student to use some code
usernames_for_full_log [] Sequences of string. Each one are a valid username provided by INGInious (See the PR for an example)
plagiarism false true if we want to detect plagiarism on submission ( with JPlag ). Else we don't care
external_libraries None Sequences of subpath string to a library in the task folder. See the PR for more information
custom_feedback_script None Subpath string to a python file for custom feedback. See the PR for more information
status_message See config.py contents Map that has "exit_code" as key (number) and string as value

Warning: IF feedback_kind == "JaCoCo" THEN YOU MUST HAVE A FLAVOUR FOLDER.

Example ?

coverage_stats: 
  - INSTRUCTION
  - BRANCH
external_libraries: 
  - mySuperJavaLibrary1.jar
  - mySuperJavaLibrary2.jar
feedback_kind: JaCoCo
has_feedback: true
prohibited: 
  other_problem_id: 
    - System.arraycopy
  some_problem_id: 
    - System.arraycopy
quorum: 0.7
status_message: 
  2: "Cheating is not a solution in your problem in life"
usernames_for_full_log: 
  - aldubray
  - xgillard
Clone this wiki locally