EducatorGuide

Project Creation:

Creating an Project:

Creating a project and setting deadlines is a simple process. Using the UI, an educator can:
- Set start and end deadlines
- Select a language
- Upload a solution file(or files)
- Upload a Project description

An image of the project creation page can be seen bellow:

Creating test cases:

On the same page an educator can create test cases for a project. Using the UI an educator can:

- Input a descriptive test-case name
- Specify the input to pass to the solution file
    - The output is automatically generated
- Enter the description of the test case
- Identify if this is a "hidden" test case or not
    - Hidden test cases are not visible to students
- Add an additional file should the test case require it.
    - This is useful for test cases that require a file to be read in for data analysis or other purposes.
- Identify what level a test case belongs to, in general we recommend the following:
    - Level 1: Base Cases (Simple Cases)
        - Test basic functionality with simple inputs.
    - Level 2: Main Functionality Cases
        - Test core features and main tasks.
        - Use a variety of inputs, positive/negative scenarios.
    - Level 3: Edge Cases (Boundary and Extreme Cases)
        - Test less common or extreme situations.
- Test cases can be created in any order, and can be edited or removed at any time. 
- Test cases can be exported/imported using a JSON file via the following Schema:

An image of the test case creation page can be seen bellow:

Project Management:

Once a project has been created for a particular course, it is visible on course page, along with all other assignments, and a higher level view of their course.

This page enables instructors to view:

• Project Name
• Project Start date
• Project End date
• Total Unique student submissions
  • Student X submitting 3 times counts as 1 unique submission
• A project view button
  • This button enables instructors to view the project in more detail, and is described below.
• The ability to modify a project
  • Edit the project information
    • See above
  • Refresh a project, ie: delete all prior submissions while keeping test cases and the project description and dates
  • Delete a project
• This page is also the starting point for creating a new assignment.

An image of the project management page can be seen bellow:

Student List:

Should an educator click on the view button for a particular project, they will be taken to the student list page.

This page enables instructors to view:

• Student Name
• Lecture Section
• Number of total submissions for that project
• Date of most recent submission
• Number of Pylint errors on the most recent submission
• State of their last submission:
  • This is a boolean, "FAILED" if a student misses a single test case, and "PASSED" if they pass all test cases.
• A student view button
  • This button enables instructors to view a students Code Page described TODO
• The ability to run "Plagiarism Detection"
  • This submits all student files for a particular project to MOSS, and emails the instructor a link to the results.
  • TODO: Add link to MOSS
• The ability to "save" grades for a student
• The ability to export grades in a format currently used by our institution
  • D2L CSV format

An image of the student list page can be seen bellow: