Examples with InstructorCourseEnrollResultPageData teammates.ui.pagedata.InstructorCourseEnrollResultPageData used on opensource projects

Example 1 with InstructorCourseEnrollResultPageData

use of teammates.ui.pagedata.InstructorCourseEnrollResultPageData in project teammates by TEAMMATES.

the class InstructorCourseEnrollSaveActionTest method testExecuteAndPostProcess.

@Override
@Test
public void testExecuteAndPostProcess() throws Exception {
    String enrollString = "";
    InstructorAttributes instructor1OfCourse1 = typicalBundle.instructors.get("instructor1OfCourse1");
    String instructorId = instructor1OfCourse1.googleId;
    String courseId = instructor1OfCourse1.courseId;
    gaeSimulation.loginAsInstructor(instructorId);
    ______TS("Typical case: add and edit students for non-empty course");
    enrollString = "Section | Team | Name | Email | Comment" + System.lineSeparator() + // A new student
    "Section 3 \t Team 1\tJean Wong\tjean@email.tmt\tExchange student" + System.lineSeparator() + // A new student with extra spaces in the team and name
    "Section 3 \t Team   1\tstudent  with   extra  spaces  \t" + "studentWithExtraSpaces@gmail.tmt\t" + System.lineSeparator() + // A student to be modified
    "Section 2 \t Team 1.3\tstudent1 In Course1</td></div>'\"\tstudent1InCourse1@gmail.tmt\t" + "New comment added" + System.lineSeparator() + // An existing student with no modification
    "Section 1 \t Team 1.1</td></div>'\"\tstudent2 In Course1\tstudent2InCourse1@gmail.tmt\t" + System.lineSeparator() + // An existing student, now with extra spaces, should cause no modification
    "Section 1 \t Team   1.1</td></div>'\"\tstudent3  In   Course1  \tstudent3InCourse1@gmail.tmt\t";
    String[] submissionParams = new String[] { Const.ParamsNames.COURSE_ID, courseId, Const.ParamsNames.STUDENTS_ENROLLMENT_INFO, enrollString };
    InstructorCourseEnrollSaveAction enrollAction = getAction(submissionParams);
    ShowPageResult pageResult = getShowPageResult(enrollAction);
    assertEquals(getPageResultDestination(Const.ViewURIs.INSTRUCTOR_COURSE_ENROLL_RESULT, false, "idOfInstructor1OfCourse1"), pageResult.getDestinationWithParams());
    assertFalse(pageResult.isError);
    assertEquals("", pageResult.getStatusMessage());
    // there are 6 sessions in this course
    verifySpecifiedTasksAdded(enrollAction, Const.TaskQueue.FEEDBACK_RESPONSE_ADJUSTMENT_QUEUE_NAME, 6);
    List<TaskWrapper> tasksAdded = enrollAction.getTaskQueuer().getTasksAdded();
    for (TaskWrapper task : tasksAdded) {
        Map<String, String[]> paramMap = task.getParamMap();
        assertEquals(courseId, paramMap.get(ParamsNames.COURSE_ID)[0]);
    }
    InstructorCourseEnrollResultPageData pageData = (InstructorCourseEnrollResultPageData) pageResult.data;
    assertEquals(courseId, pageData.getCourseId());
    StudentAttributes newStudent = StudentAttributes.builder(courseId, "Jean Wong", "jean@email.tmt").withSection("Section 3").withTeam("Team 1").withComments("Exchange student").withGoogleId("jean").build();
    newStudent.updateStatus = StudentUpdateStatus.NEW;
    verifyStudentEnrollmentStatus(newStudent, pageData.getEnrollResultPanelList());
    StudentAttributes newStudentWithExtraSpaces = StudentAttributes.builder(courseId, "student with extra spaces", "studentWithExtraSpaces@gmail.tmt").withSection("Section 3").withTeam("Team 1").withComments("").withGoogleId("student").build();
    newStudentWithExtraSpaces.updateStatus = StudentUpdateStatus.NEW;
    verifyStudentEnrollmentStatus(newStudentWithExtraSpaces, pageData.getEnrollResultPanelList());
    StudentAttributes modifiedStudent = typicalBundle.students.get("student1InCourse1");
    modifiedStudent.comments = "New comment added";
    modifiedStudent.section = "Section 2";
    modifiedStudent.team = "Team 1.3";
    modifiedStudent.updateStatus = StudentUpdateStatus.MODIFIED;
    verifyStudentEnrollmentStatus(modifiedStudent, pageData.getEnrollResultPanelList());
    StudentAttributes unmodifiedStudent = typicalBundle.students.get("student2InCourse1");
    unmodifiedStudent.updateStatus = StudentUpdateStatus.UNMODIFIED;
    verifyStudentEnrollmentStatus(unmodifiedStudent, pageData.getEnrollResultPanelList());
    StudentAttributes unmodifiedStudentWithExtraSpaces = typicalBundle.students.get("student3InCourse1");
    unmodifiedStudentWithExtraSpaces.updateStatus = StudentUpdateStatus.UNMODIFIED;
    verifyStudentEnrollmentStatus(unmodifiedStudentWithExtraSpaces, pageData.getEnrollResultPanelList());
    String expectedLogSegment = "Students Enrolled in Course <span class=\"bold\">[" + courseId + "]" + ":</span><br>" + SanitizationHelper.sanitizeForHtml(enrollString).replace("\n", "<br>");
    AssertHelper.assertContains(expectedLogSegment, enrollAction.getLogMessage());
    ______TS("Masquerade mode, enrollment into empty course");
    if (CoursesLogic.inst().isCoursePresent("new-course")) {
        CoursesLogic.inst().deleteCourseCascade("new-course");
    }
    courseId = "new-course";
    CoursesLogic.inst().createCourseAndInstructor(instructorId, courseId, "New course", "UTC");
    gaeSimulation.loginAsAdmin("admin.user");
    String headerRow = "Name\tEmail\tTeam\tComment";
    String studentsInfo = "Jean Wong\tjean@email.tmt\tTeam 1\tExchange student" + System.lineSeparator() + "James Tan\tjames@email.tmt\tTeam 2\t";
    enrollString = headerRow + System.lineSeparator() + studentsInfo;
    submissionParams = new String[] { Const.ParamsNames.USER_ID, instructorId, Const.ParamsNames.COURSE_ID, courseId, Const.ParamsNames.STUDENTS_ENROLLMENT_INFO, enrollString };
    enrollAction = getAction(submissionParams);
    pageResult = getShowPageResult(enrollAction);
    assertEquals(getPageResultDestination(Const.ViewURIs.INSTRUCTOR_COURSE_ENROLL_RESULT, false, "idOfInstructor1OfCourse1"), pageResult.getDestinationWithParams());
    assertFalse(pageResult.isError);
    assertEquals("", pageResult.getStatusMessage());
    verifyNoTasksAdded(enrollAction);
    pageData = (InstructorCourseEnrollResultPageData) pageResult.data;
    assertEquals(courseId, pageData.getCourseId());
    StudentAttributes student1 = StudentAttributes.builder(courseId, "Jean Wong", "jean@email.tmt").withSection("None").withTeam("Team 1").withComments("Exchange student").withGoogleId("jean").build();
    student1.updateStatus = StudentUpdateStatus.NEW;
    verifyStudentEnrollmentStatus(student1, pageData.getEnrollResultPanelList());
    StudentAttributes student2 = StudentAttributes.builder(courseId, "James Tan", "james@email.tmt").withSection("None").withTeam("Team 2").withComments("").withGoogleId("james").build();
    student2.updateStatus = StudentUpdateStatus.NEW;
    verifyStudentEnrollmentStatus(student2, pageData.getEnrollResultPanelList());
    expectedLogSegment = "Students Enrolled in Course <span class=\"bold\">[" + courseId + "]:</span>" + "<br>" + enrollString.replace("\n", "<br>");
    AssertHelper.assertContains(expectedLogSegment, enrollAction.getLogMessage());
    ______TS("Failure case: enrollment failed due to invalid lines");
    gaeSimulation.loginAsInstructor(instructorId);
    String studentWithoutEnoughParam = "Team 1\tStudentWithNoEmailInput";
    String studentWithInvalidEmail = "Team 2\tBenjamin Tan\tinvalid.email.tmt";
    String invalidEmail = "invalid.email.tmt";
    enrollString = "Team | Name | Email" + System.lineSeparator() + studentWithoutEnoughParam + System.lineSeparator() + studentWithInvalidEmail;
    submissionParams = new String[] { Const.ParamsNames.COURSE_ID, courseId, Const.ParamsNames.STUDENTS_ENROLLMENT_INFO, enrollString };
    enrollAction = getAction(submissionParams);
    pageResult = getShowPageResult(enrollAction);
    assertEquals(Const.ViewURIs.INSTRUCTOR_COURSE_ENROLL, pageResult.destination);
    assertTrue(pageResult.isError);
    String expectedStatusMessage = "<p>" + "<span class=\"bold\">Problem in line : " + "<span class=\"invalidLine\">" + SanitizationHelper.sanitizeForHtml(studentWithoutEnoughParam) + "</span>" + "</span>" + "<br>" + "<span class=\"problemDetail\">&bull; " + StudentAttributesFactory.ERROR_ENROLL_LINE_TOOFEWPARTS + "</span>" + "</p>" + "<br>" + "<p>" + "<span class=\"bold\">Problem in line : " + "<span class=\"invalidLine\">" + SanitizationHelper.sanitizeForHtml(studentWithInvalidEmail) + "</span>" + "</span>" + "<br>" + "<span class=\"problemDetail\">&bull; " + SanitizationHelper.sanitizeForHtml(getPopulatedErrorMessage(FieldValidator.EMAIL_ERROR_MESSAGE, invalidEmail, FieldValidator.EMAIL_FIELD_NAME, FieldValidator.REASON_INCORRECT_FORMAT, FieldValidator.EMAIL_MAX_LENGTH)) + "</span>" + "</p>";
    assertEquals(expectedStatusMessage, pageResult.getStatusMessage());
    verifyNoTasksAdded(enrollAction);
    InstructorCourseEnrollPageData enrollPageData = (InstructorCourseEnrollPageData) pageResult.data;
    assertEquals(courseId, enrollPageData.getCourseId());
    assertEquals(enrollString, enrollPageData.getEnrollStudents());
    expectedLogSegment = expectedStatusMessage + "<br>Enrollment string entered by user:<br>" + enrollString.replace("\n", "<br>");
    AssertHelper.assertContains(expectedLogSegment, enrollAction.getLogMessage());
    ______TS("Boundary test for size limit per enrollment");
    // can enroll, if within the size limit
    StringBuilder enrollStringBuilder = new StringBuilder(200);
    enrollStringBuilder.append("Section\tTeam\tName\tEmail");
    for (int i = 0; i < Const.SIZE_LIMIT_PER_ENROLLMENT; i++) {
        enrollStringBuilder.append(System.lineSeparator()).append("section" + i + "\tteam" + i + "\tname" + i + "\temail" + i + "@nonexistemail.nonexist");
    }
    submissionParams = new String[] { Const.ParamsNames.COURSE_ID, courseId, Const.ParamsNames.STUDENTS_ENROLLMENT_INFO, enrollStringBuilder.toString() };
    enrollAction = getAction(submissionParams);
    pageResult = getShowPageResult(enrollAction);
    assertFalse(pageResult.isError);
    assertEquals("", pageResult.getStatusMessage());
    verifyNoTasksAdded(enrollAction);
    // fail to enroll, if exceed the range
    enrollStringBuilder.append(System.lineSeparator()).append("section" + Const.SIZE_LIMIT_PER_ENROLLMENT + "\tteam" + Const.SIZE_LIMIT_PER_ENROLLMENT + "\tname" + Const.SIZE_LIMIT_PER_ENROLLMENT + "\temail" + Const.SIZE_LIMIT_PER_ENROLLMENT + "@nonexistemail.nonexist");
    submissionParams = new String[] { Const.ParamsNames.COURSE_ID, courseId, Const.ParamsNames.STUDENTS_ENROLLMENT_INFO, enrollStringBuilder.toString() };
    enrollAction = getAction(submissionParams);
    pageResult = getShowPageResult(enrollAction);
    assertEquals(Const.ViewURIs.INSTRUCTOR_COURSE_ENROLL, pageResult.destination);
    assertTrue(pageResult.isError);
    assertEquals(Const.StatusMessages.QUOTA_PER_ENROLLMENT_EXCEED, pageResult.getStatusMessage());
    verifyNoTasksAdded(enrollAction);
    ______TS("Failure case: empty input");
    enrollString = "";
    submissionParams = new String[] { Const.ParamsNames.COURSE_ID, courseId, Const.ParamsNames.STUDENTS_ENROLLMENT_INFO, enrollString };
    enrollAction = getAction(submissionParams);
    pageResult = getShowPageResult(enrollAction);
    assertEquals(getPageResultDestination(Const.ViewURIs.INSTRUCTOR_COURSE_ENROLL, true, "idOfInstructor1OfCourse1"), pageResult.getDestinationWithParams());
    assertTrue(pageResult.isError);
    assertEquals(Const.StatusMessages.ENROLL_LINE_EMPTY, pageResult.getStatusMessage());
    verifyNoTasksAdded(enrollAction);
    enrollPageData = (InstructorCourseEnrollPageData) pageResult.data;
    assertEquals(courseId, enrollPageData.getCourseId());
    assertEquals(enrollString, enrollPageData.getEnrollStudents());
    AssertHelper.assertContains(Const.StatusMessages.ENROLL_LINE_EMPTY, enrollAction.getLogMessage());
    CoursesLogic.inst().deleteCourseCascade("new-course");
    StudentsLogic.inst().deleteStudentsForCourseWithoutDocument(instructor1OfCourse1.courseId);
}

Example 2 with InstructorCourseEnrollResultPageData

use of teammates.ui.pagedata.InstructorCourseEnrollResultPageData in project teammates by TEAMMATES.

the class InstructorCourseEnrollSaveAction method execute.

@Override
public ActionResult execute() throws EntityDoesNotExistException {
    String courseId = getRequestParamValue(Const.ParamsNames.COURSE_ID);
    Assumption.assertPostParamNotNull(Const.ParamsNames.COURSE_ID, courseId);
    String studentsInfo = getRequestParamValue(Const.ParamsNames.STUDENTS_ENROLLMENT_INFO);
    String sanitizedStudentsInfo = SanitizationHelper.sanitizeForHtml(studentsInfo);
    Assumption.assertPostParamNotNull(Const.ParamsNames.STUDENTS_ENROLLMENT_INFO, studentsInfo);
    InstructorAttributes instructor = logic.getInstructorForGoogleId(courseId, account.googleId);
    gateKeeper.verifyAccessible(instructor, logic.getCourse(courseId), Const.ParamsNames.INSTRUCTOR_PERMISSION_MODIFY_STUDENT);
    /* Process enrollment list and setup data for page result */
    try {
        List<StudentAttributes>[] students = enrollAndProcessResultForDisplay(studentsInfo, courseId);
        boolean hasSection = hasSections(students);
        InstructorCourseEnrollResultPageData pageData = new InstructorCourseEnrollResultPageData(account, sessionToken, courseId, students, hasSection, studentsInfo);
        statusToAdmin = "Students Enrolled in Course <span class=\"bold\">[" + courseId + "]:</span><br>" + sanitizedStudentsInfo.replace("\n", "<br>");
        return createShowPageResult(Const.ViewURIs.INSTRUCTOR_COURSE_ENROLL_RESULT, pageData);
    } catch (EnrollException | InvalidParametersException e) {
        setStatusForException(e);
        statusToAdmin += "<br>Enrollment string entered by user:<br>" + sanitizedStudentsInfo.replace("\n", "<br>");
        InstructorCourseEnrollPageData pageData = new InstructorCourseEnrollPageData(account, sessionToken, courseId, studentsInfo);
        return createShowPageResult(Const.ViewURIs.INSTRUCTOR_COURSE_ENROLL, pageData);
    } catch (EntityAlreadyExistsException e) {
        setStatusForException(e);
        statusToUser.add(new StatusMessage("The enrollment failed, possibly because some students were re-enrolled before " + "the previous enrollment action was still being processed by TEAMMATES database " + "servers. Please try again after about 10 minutes. If the problem persists, " + "please contact TEAMMATES support", StatusMessageColor.DANGER));
        InstructorCourseEnrollPageData pageData = new InstructorCourseEnrollPageData(account, sessionToken, courseId, studentsInfo);
        log.severe("Entity already exists exception occurred when updating student: " + e.getMessage());
        return createShowPageResult(Const.ViewURIs.INSTRUCTOR_COURSE_ENROLL, pageData);
    }
}

Example 3 with InstructorCourseEnrollResultPageData

use of teammates.ui.pagedata.InstructorCourseEnrollResultPageData in project teammates by TEAMMATES.

the class InstructorCourseEnrollResultPageDataTest method testAll.

@Test
public void testAll() {
    ______TS("test typical case");
    AccountAttributes account = dataBundle.accounts.get("instructor1OfCourse1");
    String courseId = "idOfTypicalCourse1";
    @SuppressWarnings("unchecked") List<StudentAttributes>[] students = new ArrayList[StudentUpdateStatus.STATUS_COUNT];
    for (int i = 0; i < StudentUpdateStatus.STATUS_COUNT; i++) {
        students[i] = new ArrayList<>();
    }
    students[StudentUpdateStatus.NEW.numericRepresentation].add(dataBundle.students.get("student1InCourse1"));
    students[StudentUpdateStatus.NEW.numericRepresentation].add(dataBundle.students.get("student2InCourse1"));
    students[StudentUpdateStatus.MODIFIED.numericRepresentation].add(dataBundle.students.get("student3InCourse1"));
    students[StudentUpdateStatus.UNMODIFIED.numericRepresentation].add(dataBundle.students.get("student4InCourse1"));
    students[StudentUpdateStatus.ERROR.numericRepresentation].add(dataBundle.students.get("student5InCourse1"));
    boolean hasSection = true;
    String enrollStudents = "enrollString";
    InstructorCourseEnrollResultPageData pageData = new InstructorCourseEnrollResultPageData(account, dummySessionToken, courseId, students, hasSection, enrollStudents);
    assertNotNull(pageData.getCourseId());
    assertEquals(courseId, pageData.getCourseId());
    assertNotNull(pageData.account);
    assertEquals(account.googleId, pageData.account.googleId);
    assertNotNull(pageData.getEnrollResultPanelList());
    assertEquals(students.length, pageData.getEnrollResultPanelList().size());
    assertEquals(students[StudentUpdateStatus.NEW.numericRepresentation].size(), pageData.getEnrollResultPanelList().get(StudentUpdateStatus.NEW.numericRepresentation).getStudentList().size());
    assertEquals(students[StudentUpdateStatus.ERROR.numericRepresentation].size(), pageData.getEnrollResultPanelList().get(StudentUpdateStatus.ERROR.numericRepresentation).getStudentList().size());
    assertEquals(students[StudentUpdateStatus.MODIFIED.numericRepresentation].size(), pageData.getEnrollResultPanelList().get(StudentUpdateStatus.MODIFIED.numericRepresentation).getStudentList().size());
    assertEquals(students[StudentUpdateStatus.NOT_IN_ENROLL_LIST.numericRepresentation].size(), pageData.getEnrollResultPanelList().get(StudentUpdateStatus.NOT_IN_ENROLL_LIST.numericRepresentation).getStudentList().size());
    assertEquals(students[StudentUpdateStatus.UNKNOWN.numericRepresentation].size(), pageData.getEnrollResultPanelList().get(StudentUpdateStatus.UNKNOWN.numericRepresentation).getStudentList().size());
    assertEquals(students[StudentUpdateStatus.UNMODIFIED.numericRepresentation].size(), pageData.getEnrollResultPanelList().get(StudentUpdateStatus.UNMODIFIED.numericRepresentation).getStudentList().size());
    assertTrue(pageData.isHasSection());
    assertEquals(enrollStudents, pageData.getEnrollStudents());
}