Add CI Testing for Image Annotation

Open
#13,155 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
cypress
Domain
testing-qa

Research direction

Start by locating the existing Cypress e2e specs and the image-annotation entry points for grader and student views. Add coverage for unsaved, saved, cleared, downloaded, and student-visible annotations, including the grading-state and green View Grade behavior; done means the listed workflows pass after reloads where specified.

Written by the indexing model from the issue text.

Description

Awaiting Triage enhancement / feature request Image/PDF Annotation TA Grading / TA UI Testing / Continuous Integration (CI)

What problem are you trying to solve with Submitty
There are currently no tests for image annotation.

Describe the way you'd like to solve this problem
There should be Cypress e2e specs that test at least the following:

  • Images can only be annotated if they are in submissions_processed (bulk upload) and if the grader isn't a peer, otherwise the annotation toolbar doesn't appear and annotations aren't attempted to be loaded
  • Adding an annotation without saving doesn't save the annotation (test by reloading the page at least)
  • Adding an annotation and then saving saves the annotation (test by reloading at least, can maybe also check that a file was made? might be complicated because parts of the file path/name are hashed for anonymization)
  • Clearing an annotation removes all marks and deletes the annotation file
  • Downloading an annotation downloads the original image + the annotations on top (this might not be trivial)
  • A student can only see an annotation made on their submission if all components of their grade have been fully graded
  • A student can successfully view and download any annotations made on their submission
  • Changes to annotations (being added/edited/removed) can be seen from the student's point of view once the annotation is saved by the grader
  • Every time an annotation is changed, the grade is considered a new grade, and the student's View Grade button becomes green (see #13106)

This could probably be split into 2 PRs, one focusing on the grader's view and other focusing on the student's (although they should probably be tested in the same spec because testing student's view requires actions in the grading interface anyways).

Dominant language
PHP
Stars
793
Forks
1.1k
Avg merge
2d 16h
Merged PRs (30d)
78

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Submitty/Submitty

All issues in Submitty/Submitty

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.