[Testing:InstructorUI] Add Cypress for Manage Teams by roye2 · Pull Request #13043 · Submitty/Submitty

roye2 · 2026-07-15T14:53:28Z

Why is this Change Important & Necessary?

In #12909 I added some features for instructors to manage teams for their class. These features include: creating teams from subsections, creating single-student teams, and deleting all teams (without submissions). However, I did not add Cypress e2e testing for these features.

What is the New Behavior?

Cypress e2e testing has been added for the manage teams features. Creating teams from subsections and single student teams are tested for the instructor. It will also test that these teams have actually been created for their users. Then, it will test deleting these teams.

What steps should a reviewer take to reproduce or test the bug or new feature?

run the spec locally and ensure it passes (both in headless and headful mode)
observe the spec passing on CI
Verify that the spec is written with Cypress best practices as this is the first time I've ever written a cypress test.
Submitty guidelines I followed here:
https://submitty.org/developer/testing/cypress

Automated Testing & Documentation

It sure is :)

Other information

This is not a breaking change.
Luckily, this gradeable (grading team homework pdf) only starts off with teams with submissions, so the test is free to make and delete teams without disturbing the initial state of the gradeable (as long as it makes it to cleanup.)

codecov · 2026-07-15T14:55:54Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 21.16%. Comparing base (db53b65) to head (ce0de11).

Additional details and impacted files

@@            Coverage Diff            @@
##               main   #13043   +/-   ##
=========================================
  Coverage     21.16%   21.16%           
  Complexity    10103    10103           
=========================================
  Files           285      285           
  Lines         38773    38773           
  Branches        596      596           
=========================================
  Hits           8205     8205           
  Misses        29986    29986           
  Partials        582      582

Flag	Coverage Δ
autograder	`21.16% <ø> (ø)`
js	`1.73% <ø> (ø)`
migrator	`100.00% <ø> (ø)`
php	`20.19% <ø> (ø)`
python_submitty_utils	`79.83% <ø> (ø)`
submitty_daemon_jobs	`55.91% <ø> (ø)`
vue	`100.00% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

NicholasCiuica

I have done a code review, and have tested the new spec headfully (npx cypress open), and everything looks good. I've added some suggestions for things I noticed in the code. Also, I was unable to run the spec headlessly because of an npm issue that will require me to rebuild my VM, but I will test it tomorrow.

roye2 · 2026-07-17T14:30:06Z

I have done a code review, and have tested the new spec headfully (npx cypress open), and everything looks good. I've added some suggestions for things I noticed in the code. Also, I was unable to run the spec headlessly because of an npm issue that will require me to rebuild my VM, but I will test it tomorrow.

@NicholasCiuica I've updated the spec to assert the states of the section + subsection for the students at appropriate times.

NicholasCiuica

I did a code review and all of the requests have been addressed. I tested locally with cypress run and open and all tests are passing and behaving as expected. Good work!

IDzyre

A couple comments about test structuring, but the code in the test themselves looks good. After the restructuring, I will re-review and approve if it's better.

IDzyre · 2026-07-20T23:33:17Z

+        cyAssertRegistration(STUDENT_3, '1');
+    });
+
+    context('Test Instructor team management', () => {


All the "it" blocks in this PR should be combined. It is better to have one larger one, than a bunch of smaller ones. And since they are on the same page, just testing different items on that page, this is significantly better and faster, especially on windows machines.

Alright, I combined it for the latest commit and did notice a speed increase. One downside I observed with combining them was that it was now harder to debug certain steps using the Cypress GUI, since I couldn't run each individual it block. But hopefully that is only an issue during debugging.

IDzyre · 2026-07-20T23:34:13Z

+    context('Test Student team access', () => {
+        it('Should test student access to their new teams created in this test', () => {
+            [STUDENT_1, STUDENT_2, STUDENT_3].forEach((user) => {
+                cy.login(user);
+                cy.visit(['sample', 'gradeable', GRADEABLE, 'team']);
+                cy.get('[data-testid="your-team-header"]').should('exist');
+            });
+        });
+    });
+
+    context('Test Instructor team management, delete teams', () => {
+        it('Should successfully test the deletion of teams', () => {
+            cy.login('instructor');
+            cy.visit(['sample', 'gradeable', GRADEABLE, 'team']);
+            cy.on('window:confirm', () => true);
+
+            cy.get('[data-testid="delete-all-teams"]').click();
+
+            cy.get('[data-testid="popup-message"]')
+                .invoke('text')
+                .should('equal', 'Successfully deleted 2 teams. Skipped 36 teams with submissions. Skipped 0 teams with instructor-level users.');
+
+            cy.get('[data-testid="manage-teams-message"]', { timeout: 5000 })
+                .should('have.text', 'There are currently 36 existing teams for this gradeable. There are currently 3 students not yet on a team and 101 students on existing teams for this gradeable.');
+        });
+    });


Instead of different "context", these could be different "it" in the same "context" as the first set.

I ended up just making one it and putting them in there, and then we also don't need a context any more. Hopefully that is okay.

roye2 · 2026-07-21T15:17:47Z

@IDzyre Thank you for the review. I have pushed a commit to address your requested changes, hopefully the structure of the test looks good now.

IDzyre · 2026-07-21T18:22:03Z

+
+        // Verify the buttons for management of teams exist
+        cy.get('[data-testid="create-teams-from-registration-subsections"]')
+            .should('be.visible')


While not strictly necessary here, since if the element isn't visible, it shouldn't be able to be retreived by cy.get, I think this is fine since it is an assertion.

IDzyre

Tests look better to me,

IDzyre · 2026-07-21T18:25:46Z

+        cyAssertRegistration(STUDENT_1, 'NULL');
+        cyAssertRegistration(STUDENT_2, 'NULL');
+        cyAssertRegistration(STUDENT_3, 'NULL');


I don't think you should assert anything in the before, since it is the setup. If you run half of the test, then stop and rerun it because you fixed something, this will fail. The before should be to set the state that the tests expect, even if they were in an unexpected state before .

Alright, that makes sense. I've just pushed a commit to remove the assertions both from the before() and from the after().

IDzyre · 2026-07-22T20:45:53Z

+        // ==========================================
+        // Test Instructor creation of teams
+        // ==========================================
+        cy.login('instructor');


Since the instructor is already logged in, this isn't really necessary.

Thanks for pointing that out, I've just updated with a commit to remove it!

IDzyre

Tests look better. There are a couple of things that are redundant, but won't hurt anything or cause significant delay in test time (maybe + seconds at the most).

…/Submitty into manage-teams-ui-cypress

bmcutler · 2026-07-23T04:29:44Z

@roye2 @IDzyre @williamjallen

There are errors about excessive/duplicate queries so we cannot merge this PR without either addressing that or making an exception.

roye2 · 2026-07-23T13:48:34Z

@roye2 @IDzyre @williamjallen

There are errors about excessive/duplicate queries so we cannot merge this PR without either addressing that or making an exception.

@bmcutler thank you for pointing that out, I updated the PR to ignore the warnings on the 3 functions being tested since I believe we had previously discussed that in this case it was okay to ignore the warnings. Hopefully once tests pass it should be ready to go now.

initial commit

e79a815

github-project-automation Bot added this to Submitty Development Jul 15, 2026

github-project-automation Bot moved this to Seeking Reviewer in Submitty Development Jul 15, 2026

automateprojectmangement Bot moved this from Seeking Reviewer to Work in Progress in Submitty Development Jul 15, 2026

roye2 added 2 commits July 15, 2026 11:17

test student access

145d954

fix context

23ae15d

roye2 marked this pull request as ready for review July 15, 2026 15:28

automateprojectmangement Bot moved this from Work in Progress to Seeking Reviewer in Submitty Development Jul 15, 2026

roye2 added 2 commits July 15, 2026 16:58

use students in null section to allow for preserved testing state

6d6cb31

Merge branch 'main' into manage-teams-ui-cypress

9616b5c

NicholasCiuica requested changes Jul 16, 2026

View reviewed changes

Comment thread site/cypress/e2e/Cypress-Feature/manage_teams.spec.js Outdated

Comment thread site/cypress/e2e/Cypress-Feature/manage_teams.spec.js Outdated

Comment thread site/cypress/e2e/Cypress-Feature/manage_teams.spec.js Outdated

github-project-automation Bot moved this from Seeking Reviewer to Work in Progress in Submitty Development Jul 16, 2026

assert proper states of student sections / subsections

e2bdd00

roye2 added 2 commits July 17, 2026 10:31

fix js lint

70ed6ac

Merge branch 'main' into manage-teams-ui-cypress

504127a

roye2 requested a review from NicholasCiuica July 17, 2026 14:37

automateprojectmangement Bot moved this from Work in Progress to In Review in Submitty Development Jul 17, 2026

IDzyre requested changes Jul 17, 2026

View reviewed changes

Comment thread site/cypress/e2e/Cypress-Feature/manage_teams.spec.js Outdated

github-project-automation Bot moved this from In Review to Work in Progress in Submitty Development Jul 17, 2026

roye2 added 2 commits July 20, 2026 11:00

make selectors used in test data-testid

f73fe54

Merge branch 'main' into manage-teams-ui-cypress

ec52efe

NicholasCiuica approved these changes Jul 20, 2026

View reviewed changes

Merge branch 'main' into manage-teams-ui-cypress

69a1338

IDzyre requested changes Jul 20, 2026

View reviewed changes

refactor to use a single it

a6071c3

fix linting

b405008

roye2 requested a review from IDzyre July 21, 2026 15:20

automateprojectmangement Bot moved this from Work in Progress to In Review in Submitty Development Jul 21, 2026

Merge branch 'main' into manage-teams-ui-cypress

e665a52

IDzyre reviewed Jul 21, 2026

View reviewed changes

IDzyre requested changes Jul 21, 2026

View reviewed changes

github-project-automation Bot moved this from In Review to Work in Progress in Submitty Development Jul 21, 2026

don't assert anything in the before() or after()

2bafe39

roye2 requested a review from IDzyre July 22, 2026 20:42

automateprojectmangement Bot moved this from Work in Progress to In Review in Submitty Development Jul 22, 2026

Merge branch 'main' into manage-teams-ui-cypress

1f2e53a

IDzyre reviewed Jul 22, 2026

View reviewed changes

IDzyre approved these changes Jul 22, 2026

View reviewed changes

github-project-automation Bot moved this from In Review to Awaiting Maintainer Review in Submitty Development Jul 22, 2026

roye2 added 2 commits July 22, 2026 16:51

remove unecessary login

491cd4a

Merge branch 'manage-teams-ui-cypress' of https://github.com/Submitty…

78228f5

…/Submitty into manage-teams-ui-cypress

roye2 added 2 commits July 23, 2026 09:44

ignore excessive queries warnings

13bdbf2

Merge branch 'main' into manage-teams-ui-cypress

ce0de11

bmcutler merged commit 703786a into main Jul 23, 2026
27 of 28 checks passed

bmcutler deleted the manage-teams-ui-cypress branch July 23, 2026 20:18

github-project-automation Bot moved this from Awaiting Maintainer Review to Done in Submitty Development Jul 23, 2026

Uh oh!

Conversation

roye2 commented Jul 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why is this Change Important & Necessary?

What is the New Behavior?

What steps should a reviewer take to reproduce or test the bug or new feature?

Automated Testing & Documentation

Other information

Uh oh!

codecov Bot commented Jul 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

NicholasCiuica left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

roye2 commented Jul 17, 2026

Uh oh!

Uh oh!

NicholasCiuica left a comment

Choose a reason for hiding this comment

Uh oh!

IDzyre left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

roye2 commented Jul 21, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

IDzyre left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

IDzyre left a comment

Choose a reason for hiding this comment

Uh oh!

bmcutler commented Jul 23, 2026

Uh oh!

roye2 commented Jul 23, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

roye2 commented Jul 15, 2026 •

edited

Loading

codecov Bot commented Jul 15, 2026 •

edited

Loading