Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#12048] Migrate AdminSearchPageE2ETest SQL #12811

Merged
merged 33 commits into from
Apr 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
faca72a
test e2e changes
domoberzin Feb 24, 2024
ac0edff
fix: reduce e2e test json file size
domoberzin Feb 24, 2024
b6e41bb
fix student key
domoberzin Feb 24, 2024
23b2348
fix course key
domoberzin Feb 24, 2024
c769cc3
fix instructor keys
domoberzin Feb 24, 2024
12fbea4
fix filepath
domoberzin Feb 24, 2024
83eed0d
fix e2e test
domoberzin Feb 25, 2024
7810213
remove extra data from bundle
domoberzin Feb 25, 2024
09df7f1
Add correct removal logic to avoid constraint violation
domoberzin Feb 25, 2024
3bdccdd
Fix e2e tests and lint
domoberzin Feb 25, 2024
bf8cffa
Merge branch 'master' into e2e-migrate
domoberzin Feb 25, 2024
d65ead4
fix: add null check
domoberzin Feb 25, 2024
55737b0
move admin search page e2e test to sql cases
domoberzin Feb 25, 2024
4cf5187
Rename AdminSearchPageE2ETest_SQLEntities.json to AdminSearchPageE2ET…
domoberzin Feb 25, 2024
c25196f
Merge branch 'master' into e2e-migrate
domoberzin Feb 25, 2024
38cf549
Merge branch 'master' into e2e-migrate
domoberzin Feb 29, 2024
994a399
fix failing test
domoberzin Feb 29, 2024
f1398f5
fix: remove extra null check
domoberzin Feb 29, 2024
d83d88b
fix: add test to e2e sql xml file
domoberzin Feb 29, 2024
01368ce
Merge branch 'master' into e2e-migrate
cedricongjh Mar 12, 2024
1fd2b42
Merge branch 'master' into e2e-migrate
domoberzin Mar 27, 2024
1aa7e6b
fix function call
domoberzin Mar 27, 2024
4731ec6
remove unnecessary changes
domoberzin Mar 27, 2024
0521dee
create new file for sql entities
domoberzin Mar 27, 2024
f848416
Merge branch 'master' into e2e-migrate
domoberzin Mar 27, 2024
20e3976
revert unnecessary changes
domoberzin Mar 27, 2024
a6b48b2
remove trailing whitespace
domoberzin Mar 27, 2024
833d6d7
add teardown for account requests
domoberzin Mar 27, 2024
9f1b3f2
Merge branch 'master' into e2e-migrate
cedricongjh Mar 28, 2024
9aa2b46
Merge branch 'master' into e2e-migrate
domoberzin Mar 29, 2024
995b0b9
Merge branch 'master' into e2e-migrate
domoberzin Apr 1, 2024
b365edf
Merge branch 'master' into e2e-migrate
domoberzin Apr 6, 2024
09333ef
Merge branch 'master' into e2e-migrate
cedricongjh Apr 8, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ protected void prepareTestData() {
putDocuments(testData);
sqlTestData = loadSqlDataBundle("/AdminSearchPageE2ETest_SqlEntities.json");
removeAndRestoreSqlDataBundle(sqlTestData);
doPutDocumentsSql(sqlTestData);
putSqlDocuments(sqlTestData);
}

@Test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ protected void prepareTestData() {
putDocuments(testData);
sqlTestData = loadSqlDataBundle("/AdminSearchPageE2ETest_SqlEntities.json");
removeAndRestoreSqlDataBundle(sqlTestData);
doPutDocumentsSql(sqlTestData);
putSqlDocuments(sqlTestData);
}

@Test
Expand Down
185 changes: 185 additions & 0 deletions src/e2e/java/teammates/e2e/cases/sql/AdminSearchPageE2ETest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
package teammates.e2e.cases.sql;

import java.time.Instant;

import org.testng.annotations.AfterClass;
import org.testng.annotations.Test;

import teammates.common.util.AppUrl;
import teammates.common.util.Const;
import teammates.e2e.pageobjects.AdminSearchPage;
import teammates.e2e.util.TestProperties;
import teammates.storage.sqlentity.AccountRequest;
import teammates.storage.sqlentity.Course;
import teammates.storage.sqlentity.FeedbackSession;
import teammates.storage.sqlentity.Instructor;
import teammates.storage.sqlentity.Student;

/**
* SUT: {@link Const.WebPageURIs#ADMIN_SEARCH_PAGE}.
*/
public class AdminSearchPageE2ETest extends BaseE2ETestCase {

@Override
protected void prepareTestData() {
if (!TestProperties.INCLUDE_SEARCH_TESTS) {
return;
}
testData = removeAndRestoreDataBundle(loadSqlDataBundle("/AdminSearchPageE2ESqlTest.json"));
putDocuments(testData);
}

@Test
@Override
public void testAll() {
if (!TestProperties.INCLUDE_SEARCH_TESTS) {
return;
}

AppUrl url = createFrontendUrl(Const.WebPageURIs.ADMIN_SEARCH_PAGE);
AdminSearchPage searchPage = loginAdminToPage(url, AdminSearchPage.class);

Course course = testData.courses.get("typicalCourse1");
Student student = testData.students.get("student1InCourse1");
Instructor instructor = testData.instructors.get("instructor1OfCourse1");
AccountRequest accountRequest = testData.accountRequests.get("instructor1OfCourse1");

______TS("Typical case: Search student email");
String searchContent = student.getEmail();
searchPage.inputSearchContent(searchContent);
searchPage.clickSearchButton();
String studentDetails = getExpectedStudentDetails(student);
String studentManageAccountLink = getExpectedStudentManageAccountLink(student);
String studentHomePageLink = getExpectedStudentHomePageLink(student);
int numExpandedRows = getExpectedNumExpandedRows(student);
searchPage.verifyStudentRowContent(student, course, studentDetails, studentManageAccountLink,
studentHomePageLink);
searchPage.verifyStudentExpandedLinks(student, numExpandedRows);

______TS("Typical case: Reset student google id");
searchPage.resetStudentGoogleId(student);
student.setGoogleId(null);
searchPage.verifyStudentRowContentAfterReset(student, course);

______TS("Typical case: Regenerate registration key for a course student");
searchPage.clickExpandStudentLinks();
String originalJoinLink = searchPage.getStudentJoinLink(student);
searchPage.regenerateStudentKey(student);
searchPage.verifyRegenerateStudentKey(student, originalJoinLink);
searchPage.waitForPageToLoad();

______TS("Typical case: Search for instructor email");
searchPage.clearSearchBox();
searchContent = instructor.getEmail();
searchPage.inputSearchContent(searchContent);
searchPage.clickSearchButton();
String instructorManageAccountLink = getExpectedInstructorManageAccountLink(instructor);
String instructorHomePageLink = getExpectedInstructorHomePageLink(instructor);
searchPage.verifyInstructorRowContent(instructor, course, instructorManageAccountLink,
instructorHomePageLink);
searchPage.verifyInstructorExpandedLinks(instructor);

______TS("Typical case: Reset instructor google id");
searchPage.resetInstructorGoogleId(instructor);
searchPage.verifyInstructorRowContentAfterReset(instructor, course);

______TS("Typical case: Regenerate registration key for an instructor");
searchPage.clickExpandInstructorLinks();
originalJoinLink = searchPage.getInstructorJoinLink(instructor);
searchPage.regenerateInstructorKey(instructor);
searchPage.verifyRegenerateInstructorKey(instructor, originalJoinLink);
searchPage.waitForPageToLoad();

______TS("Typical case: Search for account request by email");
searchPage.clearSearchBox();
searchContent = accountRequest.getEmail();
searchPage.inputSearchContent(searchContent);
searchPage.clickSearchButton();
searchPage.verifyAccountRequestRowContent(accountRequest);
searchPage.verifyAccountRequestExpandedLinks(accountRequest);

______TS("Typical case: Search common search key");
searchPage.clearSearchBox();
searchContent = "Course1";
searchPage.inputSearchContent(searchContent);
searchPage.clickSearchButton();
searchPage.verifyStudentRowContentAfterReset(student, course);
searchPage.verifyInstructorRowContentAfterReset(instructor, course);
searchPage.verifyAccountRequestRowContent(accountRequest);

______TS("Typical case: Expand and collapse links");
searchPage.verifyLinkExpansionButtons(student, instructor, accountRequest);

______TS("Typical case: Reset account request successful");
searchContent = "ASearch.instructor1@gmail.tmt";
searchPage.clearSearchBox();
searchPage.inputSearchContent(searchContent);
searchPage.clickSearchButton();
searchPage.clickResetAccountRequestButton(accountRequest);
assertNull(BACKDOOR.getAccountRequest(accountRequest.getEmail(), accountRequest.getInstitute()).getRegisteredAt());

______TS("Typical case: Delete account request successful");
accountRequest = testData.accountRequests.get("unregisteredInstructor1");
searchContent = accountRequest.getEmail();
searchPage.clearSearchBox();
searchPage.inputSearchContent(searchContent);
searchPage.clickSearchButton();
searchPage.clickDeleteAccountRequestButton(accountRequest);
assertNull(BACKDOOR.getAccountRequest(accountRequest.getEmail(), accountRequest.getInstitute()));
}

private String getExpectedStudentDetails(Student student) {
return String.format("%s [%s] (%s)", student.getCourse().getId(),
student.getSection() == null
? Const.DEFAULT_SECTION
: student.getSection().getName(), student.getTeam().getName());
}

private String getExpectedStudentHomePageLink(Student student) {
return student.isRegistered() ? createFrontendUrl(Const.WebPageURIs.STUDENT_HOME_PAGE)
.withUserId(student.getGoogleId())
.toAbsoluteString()
: "";
}

private String getExpectedStudentManageAccountLink(Student student) {
return student.isRegistered() ? createFrontendUrl(Const.WebPageURIs.ADMIN_ACCOUNTS_PAGE)
.withParam(Const.ParamsNames.INSTRUCTOR_ID, student.getGoogleId())
.toAbsoluteString()
: "";
}

private int getExpectedNumExpandedRows(Student student) {
int expectedNumExpandedRows = 2;
for (FeedbackSession sessions : testData.feedbackSessions.values()) {
if (sessions.getCourse().equals(student.getCourse())) {
expectedNumExpandedRows += 1;
if (sessions.getResultsVisibleFromTime().isBefore(Instant.now())) {
expectedNumExpandedRows += 1;
}
}
}
return expectedNumExpandedRows;
}

private String getExpectedInstructorHomePageLink(Instructor instructor) {
String googleId = instructor.isRegistered() ? instructor.getGoogleId() : "";
return createFrontendUrl(Const.WebPageURIs.INSTRUCTOR_HOME_PAGE)
.withUserId(googleId)
.toAbsoluteString();
}

private String getExpectedInstructorManageAccountLink(Instructor instructor) {
String googleId = instructor.isRegistered() ? instructor.getGoogleId() : "";
return createFrontendUrl(Const.WebPageURIs.ADMIN_ACCOUNTS_PAGE)
.withParam(Const.ParamsNames.INSTRUCTOR_ID, googleId)
.toAbsoluteString();
}
Copy link
Contributor

Choose a reason for hiding this comment

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

could we add a @afterclass to delete the accountRequests, similar to the original test?


@AfterClass
public void classTeardown() {
for (AccountRequest request : testData.accountRequests.values()) {
BACKDOOR.deleteAccountRequest(request.getEmail(), request.getInstitute());
}
}
}
14 changes: 14 additions & 0 deletions src/e2e/java/teammates/e2e/cases/sql/BaseE2ETestCase.java
Original file line number Diff line number Diff line change
Expand Up @@ -265,4 +265,18 @@ StudentData getStudent(String courseId, String studentEmailAddress) {
protected StudentData getStudent(Student student) {
return getStudent(student.getCourseId(), student.getEmail());
}

/**
* Puts the documents in the database using BACKDOOR.
* @param dataBundle the data to be put in the database
* @return the result of the operation
*/
protected String putDocuments(SqlDataBundle dataBundle) {
try {
return BACKDOOR.putSqlDocuments(dataBundle);
} catch (HttpRequestFailedException e) {
e.printStackTrace();
return null;
}
}
}
Loading
Loading