Skip to content

Implement GET test_runs API route#8055

Merged
david-yz-liu merged 4 commits into
masterfrom
feature-api-test-runs
Jul 14, 2026
Merged

Implement GET test_runs API route#8055
david-yz-liu merged 4 commits into
masterfrom
feature-api-test-runs

Conversation

@sophia-huynh

@sophia-huynh sophia-huynh commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Proposed Changes

Implements GET for test_runs, allowing for API retrieval of information about the test runs for a group.

  • GET /api/courses/:course_id/assignments/:assignment_id/groups/:id/test_runs returns the test runs for the given group for the given assignment. Returns all test runs and the associated test group result IDs.

Both JSON and XML can be returned depending on the Accept header.

Screenshots of your changes (if applicable) n/a
Associated documentation repository pull request (if applicable) https://github.com/MarkUsProject/Wiki/pull/271

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change that adds functionality) X
🐛 Bug fix (non-breaking change that fixes an issue)
🎨 User interface change (change to user interface; provide screenshots)
♻️ Refactoring (internal change to codebase, without changing functionality)
🚦 Test update (change that only adds or modifies tests)
📦 Dependency update (change that updates a dependency)
📖 Documentation update (change that updates documentation)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

  • I have performed a self-review of my changes.
    • Check that all changed files included in this pull request are intentional changes.
    • Check that all changes are relevant to the purpose of this pull request, as described above.
  • I have added tests for my changes, if applicable.
    • This is required for all bug fixes and new features.
  • I have updated the project documentation, if applicable.
    • This is required for new features.
  • If this is my first contribution, I have added myself to the list of contributors.

After opening your pull request:

  • I have updated the project Changelog (this is required for all changes).
  • I have verified that the pre-commit.ci checks have passed.
  • I have verified that the CI tests have passed.
  • I have reviewed the test coverage changes reported by Coveralls.
  • I have requested a review from a project maintainer.

Questions and Comments

N/A

@coveralls

coveralls commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

Coverage Report for CI Build 29352539665

Coverage increased (+1.4%) to 91.681%

Details

  • Coverage increased (+1.4%) from the base build.
  • Patch coverage: 99 of 99 lines across 3 files are fully covered (100%).
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 25110
Covered Lines: 23296
Line Coverage: 92.78%
Relevant Branches: 758
Covered Branches: 420
Branch Coverage: 55.41%
Branches in Coverage %: Yes
Coverage Strength: 260.95 hits per line

💛 - Coveralls

@Naragod Naragod left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Naragod
Naragod requested a review from david-yz-liu July 13, 2026 17:55
Comment thread app/controllers/api/groups_controller.rb Outdated
Comment thread app/controllers/api/groups_controller.rb
Comment thread app/controllers/api/groups_controller.rb Outdated
@sophia-huynh

Copy link
Copy Markdown
Contributor Author

The aforementioned changes have been made (reverting formatting changes, changing to grouping.test_runs, returning the entire test group results rather than just the IDs), and moved the documentation changes into docs/docs/technical-guides/restful-api.md

@david-yz-liu david-yz-liu left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @sophia-huynh!

@david-yz-liu
david-yz-liu merged commit d582f87 into master Jul 14, 2026
11 checks passed
@david-yz-liu
david-yz-liu deleted the feature-api-test-runs branch July 14, 2026 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants