[#9536] Instructor Feedback Sessions Page E2E Test #10521

jtankw3 · 2020-08-02T15:04:28Z

Part of #9536

Outline of Solution

Add methods to BaseE2ETestCase to verify downloaded files exist
Add methods to BaseE2ETestCase to compare emails sent
Add InstructorFeedbackSessionsPage to represent instructor sessions page
Add relevant backdoor methods to compare feedback session data in datastore
Add InstructorFeedbackSessionsPageE2ETest to test:
- verify loaded data
- verify response rate
- add new session
- add new copied session
- copy session
- publish results
- send reminder email
- resend results link
- unpublish results
- download results
- soft delete session
- restore session
- permanently delete session
- restore all session
- delete all session

…instructor-sessions-e2e # Conflicts: # src/web/app/components/session-edit-form/session-edit-form.component.html

…instructor-sessions-e2e # Conflicts: # src/web/app/components/session-edit-form/session-edit-form.component.html # src/web/app/components/sessions-recycle-bin-table/sessions-recycle-bin-table.component.html # src/web/app/pages-instructor/instructor-sessions-page/instructor-sessions-page.component.html

src/e2e/java/teammates/e2e/cases/e2e/BaseE2ETestCase.java

src/e2e/java/teammates/e2e/pageobjects/Browser.java

src/e2e/java/teammates/e2e/pageobjects/InstructorFeedbackSessionsPage.java

…instructor-sessions-e2e # Conflicts: # src/e2e/java/teammates/e2e/pageobjects/AppPage.java # src/e2e/java/teammates/e2e/util/BackDoor.java # src/e2e/resources/testng-e2e.xml # src/test/java/teammates/test/cases/BaseTestCaseWithDatastoreAccess.java # src/web/app/components/session-edit-form/session-edit-form.component.html

wkurniawan07 · 2020-08-13T12:27:32Z

src/e2e/java/teammates/e2e/cases/e2e/BaseE2ETestCase.java

+        try {
+            String expectedFilePath = getTestResultsFolder() + expectedFileName;
+            String actualFilePath = getTestDownloadsFolder() + actualFileName;
+            assertEquals(FileHelper.readFile(expectedFilePath), FileHelper.readFile(actualFilePath));


This works, but we don't really need to do a full check (otherwise we need to also maintain these test files). Just doing a quick sanity check (file name and maybe a few representative lines) is good enough.

wkurniawan07

Well done in general, some changes suggested.

wkurniawan07 · 2020-08-17T10:49:39Z

src/e2e/java/teammates/e2e/cases/e2e/BaseE2ETestCase.java

+            while (!actual && retryLimit > 0) {
+                retryLimit--;
+                ThreadHelper.waitFor(1000);
+                actual = emailAccount.isEmailWithSubjectPresent(subject);


I have seen a lot of this kind of operation, and it's not just on this PR. Is it possible to build some kind of abstraction for them? Or perhaps use the RetryManager class? But don't need to do on this PR.

wkurniawan07 · 2020-08-17T10:51:12Z

src/e2e/java/teammates/e2e/cases/e2e/InstructorFeedbackSessionsPageE2ETest.java

+
+        ______TS("download results");
+        feedbackSessionsPage.downloadResults(openSession);
+        ThreadHelper.waitFor(5000);


Maybe use retries here, where the success condition is the existence of downloaded file?

Added it to the verifyDownloadedFile method

wkurniawan07 · 2020-08-17T10:51:27Z

src/e2e/java/teammates/e2e/util/BackDoor.java

+                .stream()
+                .filter(fs -> fs.getFeedbackSessionName().equals(feedbackSessionName))
+                .findFirst()
+                .orElse(null);


Unrelated change?

I think it is because I realized it is the only method with a different indentation level. Should I not include it?

This should normally count as unrelated change, but I can close one eye.

wkurniawan07 · 2020-08-17T10:51:45Z

src/main/java/teammates/ui/webapi/action/GetFeedbackSessionAction.java


+        if (feedbackSession == null) {
+            return new JsonResult("No feedback session with name " + feedbackSessionName


wkurniawan07 · 2020-08-17T12:31:09Z

src/e2e/java/teammates/e2e/cases/e2e/BaseE2ETestCase.java

+    protected void verifyDownloadedFile(String expectedContent, String expectedFileName) {
+        try {
+            String filePath = getTestDownloadsFolder() + expectedFileName;
+            assertTrue(FileHelper.readFile(filePath).contains(expectedContent));


Also, just checking one line may not be enough. Let's make expectedContent a list.

…instructor-sessions-e2e # Conflicts: # src/web/app/components/sessions-table/__snapshots__/sessions-table.component.spec.ts.snap # src/web/app/components/sessions-table/sessions-table.component.html # src/web/app/pages-instructor/instructor-home-page/__snapshots__/instructor-home-page.component.spec.ts.snap

wkurniawan07

LGTM

wkurniawan07 · 2020-08-19T01:39:48Z

src/e2e/java/teammates/e2e/util/BackDoor.java

+                .stream()
+                .filter(fs -> fs.getFeedbackSessionName().equals(feedbackSessionName))
+                .findFirst()
+                .orElse(null);


This should normally count as unrelated change, but I can close one eye.

jtankw3 added 5 commits August 2, 2020 22:54

Add methods for downloaded file comparison

9fe54b7

Add methods for email comparison

b0366e0

Add backdoor methods

22e7521

Add InstructorFeedbackSessionsE2ETest

ed47abd

Merge branch 'master' of https://github.com/TEAMMATES/teammates into …

370c597

…instructor-sessions-e2e # Conflicts: # src/web/app/components/session-edit-form/session-edit-form.component.html

jtankw3 added the s.ToReview The PR is waiting for review(s) label Aug 2, 2020

jtankw3 added 3 commits August 3, 2020 00:04

Fix lint and snapshots

4d67016

Reduce complexity of download comparison

32d8537

Add timeout for page loads

ec18de9

jtankw3 requested review from rrtheonlyone and madanalogy August 2, 2020 17:34

rrtheonlyone self-assigned this Aug 8, 2020

wkurniawan07 reviewed Aug 12, 2020

View reviewed changes

jtankw3 force-pushed the instructor-sessions-e2e branch from 8efcef6 to c143bd6 Compare August 13, 2020 08:15

wkurniawan07 reviewed Aug 13, 2020

View reviewed changes

jtankw3 added 3 commits August 13, 2020 22:33

Change to using waitUntilAnimationFinish

2431071

Add content check for downloaded file

1eafde7

Remove mention of student in verifyEmailSent method

81e213a

jtankw3 force-pushed the instructor-sessions-e2e branch from 7e459e2 to 81e213a Compare August 13, 2020 15:33

jtankw3 requested a review from wkurniawan07 August 13, 2020 16:33

wkurniawan07 reviewed Aug 17, 2020

View reviewed changes

jtankw3 added 2 commits August 18, 2020 21:13

Improve verifyDownloadedFile method

8f81db7

jtankw3 requested a review from wkurniawan07 August 18, 2020 15:52

wkurniawan07 approved these changes Aug 19, 2020

View reviewed changes

wkurniawan07 added s.ToMerge The PR is approved by all reviewers including final reviewer; ready for merging and removed s.ToReview The PR is waiting for review(s) labels Aug 19, 2020

madanalogy removed request for rrtheonlyone and madanalogy August 19, 2020 02:42

madanalogy assigned wkurniawan07 and unassigned rrtheonlyone Aug 19, 2020

jtankw3 merged commit 1ebe7a9 into TEAMMATES:master Aug 19, 2020

jtankw3 deleted the instructor-sessions-e2e branch August 19, 2020 04:45

madanalogy added this to the v7.0.1 milestone Aug 22, 2020

madanalogy added the c.Feature User-facing feature; can be new feature or enhancement to existing feature label Aug 22, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#9536] Instructor Feedback Sessions Page E2E Test #10521

[#9536] Instructor Feedback Sessions Page E2E Test #10521

jtankw3 commented Aug 2, 2020 •

edited

Loading

wkurniawan07 Aug 13, 2020

wkurniawan07 left a comment

wkurniawan07 Aug 17, 2020

wkurniawan07 Aug 17, 2020

jtankw3 Aug 18, 2020

wkurniawan07 Aug 17, 2020

jtankw3 Aug 18, 2020

wkurniawan07 Aug 19, 2020

wkurniawan07 Aug 17, 2020

wkurniawan07 Aug 17, 2020

wkurniawan07 left a comment

wkurniawan07 Aug 19, 2020


		if (feedbackSession == null) {
		return new JsonResult("No feedback session with name " + feedbackSessionName

[#9536] Instructor Feedback Sessions Page E2E Test #10521

[#9536] Instructor Feedback Sessions Page E2E Test #10521

Conversation

jtankw3 commented Aug 2, 2020 • edited Loading

Choose a reason for hiding this comment

wkurniawan07 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wkurniawan07 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtankw3 commented Aug 2, 2020 •

edited

Loading