Skip to content

Commit

Permalink
autotest: add info about updating/testing/resetting the autotester ur…
Browse files Browse the repository at this point in the history
…l in the UI and API (#157)
  • Loading branch information
mishaschwartz authored Nov 1, 2022
1 parent e3688dd commit c6ba617
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 0 deletions.
10 changes: 10 additions & 0 deletions Admin-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ This will redirect you to a page where you can specify the following course prop

- **Name**: The name or course code for this course. Please ensure this is correct before creating the course as this cannot be edited later.
- **Display Name**: A longer course name or title for users to see.
- **Autotester URL**: A URL that points to the API of a running [Automated Tester](https://github.com/MarkUsProject/markus-autotesting) instance. Setting this will enable automated testing for this course. To disable automated testing, set this to the empty string.
- **Maximum File Size (bytes)**: The maximum file size (in bytes) that users are allowed to upload to MarkUs.
- **Course Visibility**: Selecting "hidden" will hide the course from students in a course. Graders and instructors for the course can still see and manage the course as usual.

Expand All @@ -87,6 +88,15 @@ From the edit page of a course you can modify the "Display Name" and "Course Vis

![Markus Course Edit Page](images/markus-admin-course-edit.png)

#### Managing the connection to the automated tester

If an Autotester URL has been set for this course, two additional buttons will be available:

- **Test Connection**: Clicking this button will check if the current course can connect to the automated tester at the given URL. The result will be reported as a flash message at the top of the page.
- **Refresh Settings**: Clicking this button will resend all automated test settings (for each assignment) to the autotester and get an updated schema (contains information about which testers are available and the options for each one). This is useful if the automated tester has been reset or updated but the url has not changed.

![Manage Connection To Automated Tester](images/manage-connection-to-automated-tester.png)

## Managing Users

As with courses, to manage users, navigate to the "Users" sub tab on the MarkUs Administration Page.
Expand Down
12 changes: 12 additions & 0 deletions RESTful-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,18 @@ NOTE: this method is only available to AdminUser users

NOTE: this method is only available to AdminUser users

### GET /api/courses/:id/test_autotest_connection

- description: Test whether MarkUs can connect to the server running the [automated test software](https://github.com/MarkUsProject/markus-autotesting) for this course.

NOTE: this method is only available to AdminUser users

### PUT /api/courses/:id/reset_autotest_connection

- description: Resend all automated test settings (for each assignment) to the [automated test software](https://github.com/MarkUsProject/markus-autotesting) for this course and get an updated schema.

NOTE: this method is only available to AdminUser users

### GET /api/courses/:course_id/roles

- description: Display all role information for the given course
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/markus-admin-course-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/markus-admin-course-new.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c6ba617

Please sign in to comment.