Skip to content
This repository has been archived by the owner on Aug 13, 2019. It is now read-only.

FAQ on task folder

jy95 edited this page Jul 30, 2019 · 1 revision

What is the common structure of a task ?

├───your_task_folder
│   ├───src
|   │    |─── StudentTestRunner.java
|   │    |─── InginiousTests.java
|   │    |─── *.java
│   │ 
│   └───templates
|       |─── *.java
│   │ 
│   ├───run
│   ├───task.yaml   

Why "common" ? Is there any other possibilities ?

For particular exercises , you need to create a feedback_setting.yaml to override the settings.

For exercise like coverage, you must have a flavour folder that contains correct and wrong implementations we will use to check if the student test suite can detect/cover specifications.

├───your_task_folder
│   ├───src
|   │    |─── StudentTestRunner.java
|   │    |─── InginiousTests.java
|   │    |─── *.java
│   │ 
│   └───templates
|       |─── *.java
│   │ 
│   └───flavour
|       |─── *.java
│   │ 
│   ├───run
│   ├───task.yaml
|   |───feedback_settings.yaml   

Explanation about the structure ?

Folder / File Description
templates Folder where you put the java files that will be filled by the student
src Folder where you put the java files you need for testing (StudentTestRunner.java, InginiousTests.java, ...)
flavour It contains files for code coverage or correct/wrong implementations (eg : tasks "BlackBox" and "Coverage")
feedback_setting.yaml Check the feedback_setting.yaml page for more information
task.yaml Check out Inginious documentation for task
run run file
StudentTestRunner.java For all types of tasks (except coverage) / For coverage
InginiousTests.java Template file

Additional guidelines:

  • Don't forget to add at the top of each java file the correct package instruction
  • The runfile code is designed to allow you to have as many packages that you want in your src/templates/flavour structure so feel free to do whatever you want