Merge pull request #13051 from TEAMMATES/account-request-form

[#11878] Account request form

solr/solr.sh

@@ -17,3 +17,5 @@ bin/solr create -c accountrequests -s 2 -rf 2
 bin/solr config -c accountrequests -p 8983 -action set-user-property -property update.autoCreateFields -value false
 curl -X POST -H 'Content-type: application/json' --data-binary '{"add-field": {"name": "email", "type": "string"}}' localhost:8983/solr/accountrequests/schema
 curl -X POST -H 'Content-type: application/json' --data-binary '{"add-field": {"name": "institute", "type": "string"}}' localhost:8983/solr/accountrequests/schema
+curl -X POST -H 'Content-type: application/json' --data-binary '{"add-field": {"name": "comments", "type": "string"}}' localhost:8983/solr/accountrequests/schema
+curl -X POST -H 'Content-type: application/json' --data-binary '{"add-field": {"name": "status", "type": "string"}}' localhost:8983/solr/accountrequests/schema

src/client/java/teammates/client/scripts/sql/DataMigrationForAccountRequestSql.java

@@ -3,6 +3,7 @@
 // CHECKSTYLE.OFF:ImportOrder
 import com.googlecode.objectify.cmd.Query;
 
+import teammates.common.datatransfer.AccountRequestStatus;
 import jakarta.persistence.criteria.CriteriaDelete;
 
 import teammates.common.util.HibernateUtil;
@@ -57,7 +58,9 @@ protected void migrateEntity(teammates.storage.entity.AccountRequest oldEntity)
         AccountRequest newEntity = new AccountRequest(
                 oldEntity.getEmail(),
                 oldEntity.getName(),
-                oldEntity.getInstitute());
+                oldEntity.getInstitute(),
+                AccountRequestStatus.APPROVED,
+                null);
 
         // set registration key to the old value if exists
         if (oldEntity.getRegistrationKey() != null) {

src/client/java/teammates/client/scripts/sql/VerifyDataMigrationConnection.java

@@ -7,6 +7,7 @@
 
 import teammates.client.connector.DatastoreClient;
 import teammates.client.util.ClientProperties;
+import teammates.common.datatransfer.AccountRequestStatus;
 import teammates.common.util.HibernateUtil;
 import teammates.storage.entity.UsageStatistics;
 import teammates.storage.sqlentity.Notification;
@@ -43,7 +44,9 @@ protected void verifySqlConnection() {
         teammates.storage.sqlentity.AccountRequest newEntity = new teammates.storage.sqlentity.AccountRequest(
                 "dummy-teammates-account-request-email@gmail.com",
                 "dummy-teammates-account-request",
-                "dummy-teammates-institute");
+                "dummy-teammates-institute",
+                AccountRequestStatus.PENDING,
+                "dummy-comments");
         HibernateUtil.beginTransaction();
         HibernateUtil.persist(newEntity);
         HibernateUtil.commitTransaction();

src/client/java/teammates/client/scripts/testdataconversion/DataStoreToSqlConverter.java

@@ -7,6 +7,7 @@
 import java.util.Map;
 import java.util.UUID;
 
+import teammates.common.datatransfer.AccountRequestStatus;
 import teammates.common.datatransfer.InstructorPermissionRole;
 import teammates.common.datatransfer.attributes.AccountAttributes;
 import teammates.common.datatransfer.attributes.AccountRequestAttributes;
@@ -128,7 +129,11 @@ protected Account convert(AccountAttributes accAttr) {
     protected AccountRequest convert(AccountRequestAttributes accReqAttr) {
         AccountRequest sqlAccountRequest = new AccountRequest(accReqAttr.getEmail(),
                 accReqAttr.getName(),
-                accReqAttr.getInstitute());
+                accReqAttr.getInstitute(), AccountRequestStatus.APPROVED, null);
+
+        if (accReqAttr.getRegisteredAt() != null) {
+            sqlAccountRequest.setStatus(AccountRequestStatus.REGISTERED);
+        }
 
         sqlAccountRequest.setCreatedAt(accReqAttr.getCreatedAt());
         sqlAccountRequest.setRegisteredAt(accReqAttr.getRegisteredAt());

src/e2e/java/teammates/e2e/cases/AdminHomePageE2ETest.java

@@ -5,7 +5,6 @@
 import teammates.common.util.AppUrl;
 import teammates.common.util.Const;
 import teammates.e2e.pageobjects.AdminHomePage;
-import teammates.storage.sqlentity.AccountRequest;
 
 /**
  * SUT: {@link Const.WebPageURIs#ADMIN_HOME_PAGE}.
@@ -47,31 +46,6 @@ public void testAll() {
         String failureMessage = homePage.getMessageForInstructor(1);
         assertTrue(failureMessage.contains(
                 "\"invalidemail\" is not acceptable to TEAMMATES as a/an email because it is not in the correct format."));
-
-        assertNotNull(BACKDOOR.getAccountRequest(email, institute));
-        BACKDOOR.deleteAccountRequest(email, institute);
-
-        ______TS("Failure case: Instructor is already registered");
-        AccountRequest registeredAccountRequest = sqlTestData.accountRequests.get("AHome.instructor1OfCourse1");
-        homePage.queueInstructorForAdding(registeredAccountRequest.getName(),
-                registeredAccountRequest.getEmail(), registeredAccountRequest.getInstitute());
-
-        homePage.addAllInstructors();
-
-        failureMessage = homePage.getMessageForInstructor(2);
-        assertTrue(failureMessage.contains("Cannot create account request as instructor has already registered."));
-
-        ______TS("Success case: Reset account request");
-
-        homePage.clickMoreInfoButtonForRegisteredInstructor(2);
-        homePage.clickResetAccountRequestLink();
-
-        successMessage = homePage.getMessageForInstructor(2);
-        assertTrue(successMessage.contains(
-                "Instructor \"" + registeredAccountRequest.getName() + "\" has been successfully created"));
-
-        assertNull(BACKDOOR.getAccountRequest(
-                registeredAccountRequest.getEmail(), registeredAccountRequest.getInstitute()).getRegisteredAt());
     }
 
 }

src/e2e/java/teammates/e2e/cases/AdminSearchPageE2ETest.java

@@ -132,7 +132,7 @@ public void testAll() {
         searchPage.inputSearchContent(searchContent);
         searchPage.clickSearchButton();
         searchPage.clickResetAccountRequestButton(accountRequest);
-        assertNull(BACKDOOR.getAccountRequest(accountRequest.getEmail(), accountRequest.getInstitute()).getRegisteredAt());
+        assertNull(BACKDOOR.getAccountRequest(accountRequest.getId()).getRegisteredAt());
 
         ______TS("Typical case: Delete account request successful");
         accountRequest = sqlTestData.accountRequests.get("unregisteredInstructor1");
@@ -141,7 +141,7 @@ public void testAll() {
         searchPage.inputSearchContent(searchContent);
         searchPage.clickSearchButton();
         searchPage.clickDeleteAccountRequestButton(accountRequest);
-        assertNull(BACKDOOR.getAccountRequest(accountRequest.getEmail(), accountRequest.getInstitute()));
+        assertNull(BACKDOOR.getAccountRequest(accountRequest.getId()));
     }
 
     private String getExpectedStudentDetails(StudentAttributes student) {
@@ -193,7 +193,7 @@ private String getExpectedInstructorManageAccountLink(InstructorAttributes instr
     @AfterClass
     public void classTeardown() {
         for (AccountRequest request : sqlTestData.accountRequests.values()) {
-            BACKDOOR.deleteAccountRequest(request.getEmail(), request.getInstitute());
+            BACKDOOR.deleteAccountRequest(request.getId());
         }
     }
 

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

@@ -4,6 +4,7 @@
 import java.nio.file.Files;
 import java.nio.file.Paths;
 import java.util.List;
+import java.util.UUID;
 
 import org.testng.ITestContext;
 import org.testng.annotations.AfterClass;
@@ -329,7 +330,7 @@ protected String getKeyForStudent(StudentAttributes student) {
 
     @Override
     protected AccountRequestAttributes getAccountRequest(AccountRequestAttributes accountRequest) {
-        return BACKDOOR.getAccountRequest(accountRequest.getEmail(), accountRequest.getInstitute());
+        return BACKDOOR.getAccountRequest(UUID.fromString(accountRequest.getId()));
     }
 
     NotificationAttributes getNotification(String notificationId) {

src/e2e/java/teammates/e2e/cases/InstructorCourseJoinConfirmationPageE2ETest.java

@@ -68,7 +68,7 @@ public void testAll() {
         ______TS("Click join link: valid account request key");
 
         String regKey = BACKDOOR
-                .getRegKeyForAccountRequest("ICJoinConf.newinstr@gmail.tmt", "TEAMMATES Test Institute 1");
+                .getRegKeyForAccountRequest(sqlTestData.accountRequests.get("ICJoinConf.newinstr").getId());
 
         joinLink = createFrontendUrl(Const.WebPageURIs.JOIN_PAGE)
                 .withIsCreatingAccount("true")

src/e2e/java/teammates/e2e/cases/sql/AdminHomePageE2ETest.java

@@ -0,0 +1,55 @@
+package teammates.e2e.cases.sql;
+
+import org.testng.annotations.Test;
+
+import teammates.common.util.AppUrl;
+import teammates.common.util.Const;
+import teammates.e2e.pageobjects.AdminHomePage;
+
+/**
+ * SUT: {@link Const.WebPageURIs#ADMIN_HOME_PAGE}.
+ */
+public class AdminHomePageE2ETest extends BaseE2ETestCase {
+
+    @Override
+    protected void prepareTestData() {
+        // not needed
+    }
+
+    @Test
+    @Override
+    public void testAll() {
+        AppUrl url = createFrontendUrl(Const.WebPageURIs.ADMIN_HOME_PAGE);
+        AdminHomePage homePage = loginAdminToPage(url, AdminHomePage.class);
+
+        ______TS("Test adding instructors with both valid and invalid details");
+
+        String name = "AHPUiT Instrúctör WithPlusInEmail";
+        String email = "AHPUiT+++_.instr1!@gmail.tmt";
+        String institute = "TEAMMATES Test Institute 1";
+
+        homePage.queueInstructorForAdding(name, email, institute);
+
+        String singleLineDetails = "Instructor With Invalid Email | invalidemail | TEAMMATES Test Institute 1";
+
+        homePage.queueInstructorForAdding(singleLineDetails);
+
+        homePage.addAllInstructors();
+
+        String successMessage = homePage.getMessageForInstructor(0);
+        assertTrue(successMessage.contains(
+                "Instructor \"AHPUiT Instrúctör WithPlusInEmail\" has been successfully created"));
+
+        String failureMessage = homePage.getMessageForInstructor(1);
+        assertTrue(failureMessage.contains(
+                "\"invalidemail\" is not acceptable to TEAMMATES as a/an email because it is not in the correct format."));
+
+        homePage.reloadPage();
+
+        ______TS("Verify that newly added instructor appears in account request table");
+
+        homePage.verifyInstructorInAccountRequestTable(name, email, institute);
+
+    }
+
+}

src/e2e/java/teammates/e2e/cases/sql/AdminSearchPageE2ETest.java

@@ -5,8 +5,11 @@
 import org.testng.annotations.AfterClass;
 import org.testng.annotations.Test;
 
+import teammates.common.datatransfer.AccountRequestStatus;
 import teammates.common.util.AppUrl;
 import teammates.common.util.Const;
+import teammates.common.util.FieldValidator;
+import teammates.common.util.StringHelperExtension;
 import teammates.e2e.pageobjects.AdminSearchPage;
 import teammates.e2e.util.TestProperties;
 import teammates.storage.sqlentity.AccountRequest;
@@ -116,7 +119,7 @@ public void testAll() {
         searchPage.inputSearchContent(searchContent);
         searchPage.clickSearchButton();
         searchPage.clickResetAccountRequestButton(accountRequest);
-        assertNull(BACKDOOR.getAccountRequest(accountRequest.getEmail(), accountRequest.getInstitute()).getRegisteredAt());
+        assertNull(BACKDOOR.getAccountRequest(accountRequest.getId()).getRegisteredAt());
 
         ______TS("Typical case: Delete account request successful");
         accountRequest = testData.accountRequests.get("unregisteredInstructor1");
@@ -125,14 +128,108 @@ public void testAll() {
         searchPage.inputSearchContent(searchContent);
         searchPage.clickSearchButton();
         searchPage.clickDeleteAccountRequestButton(accountRequest);
-        assertNull(BACKDOOR.getAccountRequest(accountRequest.getEmail(), accountRequest.getInstitute()));
+        assertNull(BACKDOOR.getAccountRequest(accountRequest.getId()));
+
+        ______TS("Typical case: Edit account request successful");
+        accountRequest = testData.accountRequests.get("unregisteredInstructor2");
+        searchContent = accountRequest.getEmail();
+        searchPage.clearSearchBox();
+        searchPage.inputSearchContent(searchContent);
+        searchPage.clickSearchButton();
+        searchPage.clickEditAccountRequestButton(accountRequest);
+        searchPage.fillInEditModalFields("Different name", accountRequest.getEmail(),
+                accountRequest.getInstitute(), "New comment");
+        searchPage.clickSaveEditAccountRequestButton();
+        accountRequest.setName("Different name");
+        accountRequest.setComments("New comment");
+        searchPage.verifyAccountRequestRowContent(accountRequest);
+
+        ______TS("Typical case: View comment of account request");
+        accountRequest = testData.accountRequests.get("unregisteredInstructor2");
+        searchContent = accountRequest.getEmail();
+        searchPage.clearSearchBox();
+        searchPage.inputSearchContent(searchContent);
+        searchPage.clickSearchButton();
+        searchPage.clickViewAccountRequestAndVerifyCommentsButton(accountRequest, "New comment");
+
+        ______TS("Edit account request with invalid details");
+        accountRequest = testData.accountRequests.get("unregisteredInstructor2");
+        searchContent = accountRequest.getEmail();
+        searchPage.clearSearchBox();
+        searchPage.inputSearchContent(searchContent);
+        searchPage.clickSearchButton();
+        searchPage.clickEditAccountRequestButton(accountRequest);
+        searchPage.fillInEditModalFields(accountRequest.getName(), "invalid",
+                accountRequest.getInstitute(), "New comment");
+        searchPage.clickSaveEditAccountRequestButton();
+        String formattedErrorMessage = String.format("\"%s\" is not acceptable to TEAMMATES as a/an %s because it %s. "
+                + "An email address contains some text followed by one '@' sign followed by some more text, "
+                + "and should end with a top level domain address like .com. It cannot be longer than %d characters, "
+                + "cannot be empty and cannot contain spaces.",
+                "invalid", FieldValidator.EMAIL_FIELD_NAME, FieldValidator.REASON_INCORRECT_FORMAT,
+                FieldValidator.EMAIL_MAX_LENGTH);
+        searchPage.verifyStatusMessage(formattedErrorMessage);
+
+        String name = StringHelperExtension.generateStringOfLength(FieldValidator.PERSON_NAME_MAX_LENGTH + 1);
+
+        searchPage.clickEditAccountRequestButton(accountRequest);
+        searchPage.fillInEditModalFields(name, accountRequest.getEmail(), accountRequest.getInstitute(), "New comment");
+        searchPage.clickSaveEditAccountRequestButton();
+        formattedErrorMessage = String.format("\"%s\" is not acceptable to TEAMMATES as a/an %s because it %s. "
+                + "The value of a/an %s should be no longer than %d characters. It should not be empty.",
+                name, FieldValidator.PERSON_NAME_FIELD_NAME, FieldValidator.REASON_TOO_LONG,
+                FieldValidator.PERSON_NAME_FIELD_NAME, FieldValidator.PERSON_NAME_MAX_LENGTH);
+        searchPage.verifyStatusMessage(formattedErrorMessage);
+
+        ______TS("Typical case: Approve account request successful");
+        accountRequest = testData.accountRequests.get("unregisteredInstructor2");
+        searchContent = accountRequest.getEmail();
+        searchPage.clearSearchBox();
+        searchPage.inputSearchContent(searchContent);
+        searchPage.clickSearchButton();
+        searchPage.clickApproveAccountRequestButton(accountRequest);
+        accountRequest.setStatus(AccountRequestStatus.APPROVED);
+        searchPage.verifyAccountRequestRowContent(accountRequest);
+
+        ______TS("Typical case: Reject account request successfully");
+        accountRequest = testData.accountRequests.get("unregisteredInstructor3");
+        searchContent = accountRequest.getEmail();
+        searchPage.clearSearchBox();
+        searchPage.inputSearchContent(searchContent);
+        searchPage.clickSearchButton();
+        searchPage.clickRejectAccountRequestButton(accountRequest);
+        accountRequest.setStatus(AccountRequestStatus.REJECTED);
+        searchPage.verifyAccountRequestRowContent(accountRequest);
+
+        ______TS("Reject account request with empty body");
+        accountRequest = testData.accountRequests.get("unregisteredInstructor5");
+        searchContent = accountRequest.getEmail();
+        searchPage.clearSearchBox();
+        searchPage.inputSearchContent(searchContent);
+        searchPage.clickSearchButton();
+        searchPage.clickRejectAccountRequestWithReasonButton(accountRequest);
+        searchPage.fillInRejectionModalBody("");
+        searchPage.clickConfirmRejectAccountRequest();
+        searchPage.verifyStatusMessage("Please provide an email body for the rejection email.");
+        searchPage.closeRejectionModal();
+
+        ______TS("Typical case: Reject account request with reason successfully");
+        accountRequest = testData.accountRequests.get("unregisteredInstructor4");
+        searchContent = accountRequest.getEmail();
+        searchPage.clearSearchBox();
+        searchPage.inputSearchContent(searchContent);
+        searchPage.clickSearchButton();
+        searchPage.clickRejectAccountRequestWithReasonButton(accountRequest);
+        accountRequest.setStatus(AccountRequestStatus.REJECTED);
+        searchPage.verifyAccountRequestRowContent(accountRequest);
     }
 
     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());
+                        ? Const.DEFAULT_SECTION
+                        : student.getSection().getName(),
+                student.getTeam().getName());
     }
 
     private String getExpectedStudentHomePageLink(Student student) {
@@ -179,7 +276,7 @@ private String getExpectedInstructorManageAccountLink(Instructor instructor) {
     @AfterClass
     public void classTeardown() {
         for (AccountRequest request : testData.accountRequests.values()) {
-            BACKDOOR.deleteAccountRequest(request.getEmail(), request.getInstitute());
+            BACKDOOR.deleteAccountRequest(request.getId());
         }
     }
 }