Skip to content

Add test case for graph controller - #1801

Merged
david-yz-liu merged 5 commits into
Courseography:masterfrom
PeanutPiglet:add-saveGraph-coverage
Sep 21, 2026
Merged

david-yz-liu merged 5 commits into
Courseography:masterfrom
PeanutPiglet:add-saveGraph-coverage

Conversation

@PeanutPiglet

@PeanutPiglet PeanutPiglet commented Sep 17, 2026 •

Copy link
Copy Markdown
Contributor

Proposed Changes

This pull request adds a test case for the saveGraphJSON function in the graph controller.

Previously, the function was not tested on invalid inputs. See Coveralls report.
https://coveralls.io/builds/81681939/source?filename=app%2FControllers%2FGraph.hs
The new test case covers this.

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)
🐛 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) X
📦 Dependency update (change that updates a dependency)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

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.
  • I have updated the project Changelog (this is required for all changes).

After opening your pull request:

  • I have verified that the CI checks have passed.
  • I have reviewed the test coverage changes reported by Coveralls.
  • I have requested a review from a project maintainer.

Questions and Comments

(Include any questions or comments you have regarding your changes.)

@coveralls

coveralls commented Sep 18, 2026 •

Copy link
Copy Markdown

Coverage Report for CI Build 35521578849

Coverage increased (+0.02%) to 59.839%

Details

  • Coverage increased (+0.02%) from the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 4340
Covered Lines: 2647
Line Coverage: 60.99%
Relevant Branches: 991
Covered Branches: 543
Branch Coverage: 54.79%
Branches in Coverage %: Yes
Coverage Strength: 153.68 hits per line

💛 - Coveralls

retrievedResult <- liftIO $ Models.Graph.getGraph graphName
let expectedValue = fmap addDefaults (decode payload :: Maybe Value)
assertEqual ("Unexpected response for " ++ label) expectedValue retrievedResult
when (isNothing expectedValue) $

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.

You have the right idea for this test case, but it's a little awkward to add this case to the existing function runSaveGraphJSONTest because the test behaviour is quite different (which is why you used when).

Instead, you can define a new test runSaveGraphJSONInvalidJSONTest :: TestTree which hard-codes the specific invalid JSON input; then add this new test case to the full list of test cases defined at the bottom of this file.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks! I see how it is quite awkward. I have refactored the new test as prescribed.

Comment thread CHANGELOG.md Outdated
- Switched CI provider from CircleCI to GitHub Actions
- Cleared up documentation for various graph-related front-end functions
- Adopted TypeScript v7 into build and CI pipelines and converted `js/components/graph/Button.js` to `Button.tsx` as a proof of concept
- Added test case coverage for `app/Controllers/Graph.hs`

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.

be more specific about what case is being covered here

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes. I have updated it with more details.

@david-yz-liu david-yz-liu 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.

Nice work, @PeanutPiglet!

@david-yz-liu
david-yz-liu merged commit 2452a76 into Courseography:master Sep 21, 2026
3 checks passed
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.

3 participants