Autograder improvements
Description
This resolves #2198.
1. UI now indicates whether an autograder tar and makefile exists
2. UI now provides an option to download the existing autograder tar and makefile
3. Disable network access is now shifted from advanced settings to autograde settings.
Note that this does not appear when there is no file being selected, and the buttons to download should not appear as well.
Motivation and Context
This consolidates all autograder settings into a single place. This also minimizes confusion that a person has when uploading autograder tar and makefiles. This provides a fast and easy way for an instructor to check if they have uploaded a makefile or tar file and to also check the contents of the tar and makefile. Instructors will also no longer have to navigate out of autograder settings to disable or enable network access which is an autograder setting.
How Has This Been Tested?
- Check that when there is no autograder uploaded, there is no buttons to download files and no help text
- Check that when an autograder is uploaded, there are buttons to download the files and also the help text appears even when you refresh the page
- Check that the buttons download the file as desired and that the buttons and help text work if only makefile is added or only tar file is added
- Check that the check box for disable network access persists after refresh
- Check that the checkbox for disable network access actually enables/disables network access as desired
Types of changes
- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
Checklist:
- [x] I have run rubocop and erblint for style check. If you haven't, run
overcommit --install && overcommit --signto use pre-commit hook for linting - [ ] My change requires a change to the documentation, which is located at Autolab Docs
- [ ] I have updated the documentation accordingly, included in this PR
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
Walkthrough
The changes involve enhancements to the AutogradersController, including the addition of file handling capabilities, updates to the assessment alongside the autograder, and a new method for downloading files. The user interface for uploading autograder files has been improved with conditional help text and download links for existing files. Additionally, the :disable_network checkbox has been modified to be included directly in the autograder settings form. A new route for downloading files has also been introduced, streamlining user interactions with the autograder feature.
Changes
| Files | Change Summary |
|---|---|
| app/assets/stylesheets/style.css.scss | Modifications to styles for input fields, time picker components, error messages, and labels. |
| app/controllers/autograders_controller.rb | Added file existence checks, updated update method for assessments, added download_file method, and introduced assessment_params. |
| app/form_builders/form_builder_with_date_time_input.rb | Updated methods for handling file fields and score adjustments, including conditional logic for file display. |
| app/views/autograders/_form.html.erb | Enhanced file upload UI with conditional help text, added download links for existing files, and included a checkbox for :disable_network. |
Assessment against linked issues
| Objective | Addressed | Explanation |
|---|---|---|
| UI indication for uploaded autograder files (#2198) | ✅ | |
| Ability to download existing autograder files through the UI (#2198) | ✅ | |
Consolidation of disable_network option into "Autograder Settings" (#2198) |
❌ | The checkbox was modified but not consolidated into a single settings area. |
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>, please review it.Generate unit testing code for this file.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai generate unit testing code for this file.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@coderabbitai read src/utils.ts and generate unit testing code.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (Invoked using PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
Would it be possible to reduce the spacing and align the new text more?