Second Batch of Submissions Tests

[20wildmanj]

Description

• Fix some variable naming and remove misleading comment in submissions_controller#missing
• add create_course_no_submissions_hash to have a test course with no submissions
• add the tests in the second batch of [Test] submissions #1803

How Has This Been Tested?

Run the tests, see that they pass

Types of changes

• 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:

• I have run rubocop and erblint for style check. If you haven't, run overcommit --install && overcommit --sign to 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

[coderabbitai]

Walkthrough

Walkthrough

This update enhances submission handling in the application by improving clarity in the codebase, particularly concerning student submissions. It introduces clearer naming conventions, expands testing coverage for various submission-related actions across different user roles, and implements functionality for downloading and managing submissions. These changes streamline workflows and ensure comprehensive testing scenarios.

Changes

File Path	Change Summary
app/controllers/submissions_controller.rb	Updated missing method to use missing_submission_students for improved clarity.
spec/contexts_helper.rb	Added method to create a course without submissions hash.
spec/controllers/.../submissions_controller_spec.rb	Introduced shared examples for #downloadAll, #download, #missing, #destroyConfirm, and #destroy actions, covering success/failure cases and rendering behaviors.

Possibly related issues

• [Test] submissions #1803: The changes in this PR, especially around the enhanced testing for submission-related actions and the update in naming for clarity in the missing method, align with the objectives of adding functionality and render tests for various submission actions outlined in Sprint 2 of the issue.
• Creating submissions rapidly causes duplicate version numbers #1954: While the direct issue of duplicate version numbers in submissions isn't explicitly mentioned in the PR summary, the focus on improving submission handling and testing could indirectly contribute to identifying and resolving underlying causes of such issues.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e7fea87 and a61aa52.

Files selected for processing (1)

• spec/controllers/submissions_controller_spec.rb (2 hunks)

Additional comments not posted (4)

spec/controllers/submissions_controller_spec.rb (4)

113-121: LGTM!

The shared example destroyConfirm_failure is correctly labeled and implemented.

The code changes are approved.

---

123-131: LGTM!

The shared example destroyConfirm_success is correctly labeled and implemented.

The code changes are approved.

---

133-143: LGTM!

The shared example destroy_success is correctly labeled and implemented.

The code changes are approved.

---

146-157: LGTM!

The shared example destroy_failure is correctly labeled and implemented.

The code changes are approved.

---

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 @coderabbitai in 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 @coderabbitai in 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file 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.

[jlge]

lgtm! left some nits about test naming

[coderabbitai]

Actionable comments posted: 2

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (2)

spec/controllers/submissions_controller_spec.rb (2)

259-275: Improve test efficiency.

Avoid writing and deleting a file in the tmp directory. Instead, validate the response content directly.

Apply this diff to improve the test efficiency:

-        File.binwrite("tmp/test2.zip", response.parsed_body)
-        Zip::File.open("tmp/test2.zip") do |zip_file|
+        Zip::File.open_buffer(response.parsed_body) do |zip_file|
           zip_file.each do |entry|
             if entry.file?
               content = entry.get_input_stream.read
               expect(content).to match(/Hello Dave/m)
             end
           end
         end
-        File.delete("tmp/test2.zip")

---

279-301: Improve test efficiency.

Avoid writing and deleting a file in the tmp directory. Instead, validate the response content directly.

Apply this diff to improve the test efficiency:

-        File.binwrite("tmp/test.c", response.parsed_body)
-        File.open("tmp/test.c") do |file|
-          file_data = file.read
+        file_data = response.parsed_body
           expect(file_data).to match(/Hello Dave/m)
-        end