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.

Sign up for GitHub

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 tests #13206

Merged
merged 8 commits into from
Feb 18, 2025
Merged

[#12048] Migrate tests #13206

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7f0321d
Migrate tests and improve code coverage
mingyang143 Jan 29, 2025
b9ae573
Update tests based on PR feedback
mingyang143 Feb 10, 2025
abc2ff6
Merge branch 'master' into branch-migrate-tests-week3
mingyang143 Feb 10, 2025
7b8d3d0
Update tests based on PR feedback
mingyang143 Feb 15, 2025
cbaad42
Merge branch 'master' into branch-migrate-tests-week3
mingyang143 Feb 15, 2025
b3f9bac
Update tests based on PR feedback
mingyang143 Feb 15, 2025
645e6ac
Merge branch 'master' into branch-migrate-tests-week3
mingyang143 Feb 17, 2025
b09a53e
Merge branch 'master' into branch-migrate-tests-week3
yuanxi1 Feb 18, 2025
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
164 changes: 164 additions & 0 deletions src/test/java/teammates/sqlui/webapi/DeleteFeedbackSessionActionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
package teammates.sqlui.webapi;

import static org.mockito.Mockito.when;

import java.time.Instant;

import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;

import teammates.common.datatransfer.InstructorPrivileges;
import teammates.common.util.Const;
import teammates.storage.sqlentity.Course;
import teammates.storage.sqlentity.FeedbackSession;
import teammates.storage.sqlentity.Instructor;
import teammates.ui.output.MessageOutput;
import teammates.ui.webapi.DeleteFeedbackSessionAction;

/**
* SUT: {@link DeleteFeedbackSessionAction}.
*/
public class DeleteFeedbackSessionActionTest extends BaseActionTest<DeleteFeedbackSessionAction> {
String googleId = "user-googleId";
private Course course;
private FeedbackSession session;

@Override
protected String getActionUri() {
return Const.ResourceURIs.SESSION;
}

@Override
protected String getRequestMethod() {
return DELETE;
}

@BeforeMethod
void setUp() {
course = new Course("course-id", "name", Const.DEFAULT_TIME_ZONE, "institute");
session = new FeedbackSession(
"session-name",
course,
"[email protected]",
null,
Instant.parse("2020-01-01T00:00:00.000Z"),
Instant.parse("2020-10-01T00:00:00.000Z"),
Instant.parse("2020-01-01T00:00:00.000Z"),
Instant.parse("2020-11-01T00:00:00.000Z"),
null,
false,
false,
false);
loginAsInstructor(googleId);
}

@Test
public void testExecute_sessionDoesNotExist_failSilently() {
when(mockLogic.getFeedbackSession("incorrect-name", course.getId())).thenReturn(null);
String[] params = {
Const.ParamsNames.FEEDBACK_SESSION_NAME, "incorrect-name",
Const.ParamsNames.COURSE_ID, course.getId(),
};

DeleteFeedbackSessionAction action = getAction(params);
MessageOutput actionOutput = (MessageOutput) getJsonResult(action).getOutput();
assertEquals("The feedback session is deleted.", actionOutput.getMessage());
}

@Test
public void testExecute_sessionExists_success() {
when(mockLogic.getFeedbackSession(session.getId())).thenReturn(session);

String[] params = {
Const.ParamsNames.FEEDBACK_SESSION_NAME, session.getName(),
Const.ParamsNames.COURSE_ID, session.getCourseId(),
};

DeleteFeedbackSessionAction action = getAction(params);
MessageOutput actionOutput = (MessageOutput) getJsonResult(action).getOutput();
assertEquals("The feedback session is deleted.", actionOutput.getMessage());
}

@Test
public void testExecute_missingParameters_throwsInvalidHttpParameterException() {
String[] params = {
Const.ParamsNames.FEEDBACK_SESSION_NAME, "session-name",
};

verifyHttpParameterFailure(params);

String[] params2 = {
Const.ParamsNames.COURSE_ID, "course-id",
};

verifyHttpParameterFailure(params2);

String[] params3 = {
Const.ParamsNames.FEEDBACK_SESSION_NAME, null,
Const.ParamsNames.COURSE_ID, course.getId(),
};

verifyHttpParameterFailure(params3);

String[] params4 = {
Const.ParamsNames.FEEDBACK_SESSION_NAME, session.getName(),
Const.ParamsNames.COURSE_ID, null,
};

verifyHttpParameterFailure(params4);

String[] params5 = {
Const.ParamsNames.FEEDBACK_SESSION_NAME, null,
Const.ParamsNames.COURSE_ID, null,
};

verifyHttpParameterFailure(params5);
}

@Test
public void testSpecificAccessControl_notInstructor_cannotAccess() {
String[] params = {
Const.ParamsNames.FEEDBACK_SESSION_NAME, session.getName(),
Const.ParamsNames.COURSE_ID, session.getCourseId(),
};
loginAsStudent(googleId);
verifyCannotAccess(params);
logoutUser();
verifyCannotAccess(params);
}

@Test
public void testSpecificAccessControl_instructorWithPermission_canAccess() {
InstructorPrivileges instructorPrivileges = new InstructorPrivileges();
instructorPrivileges.updatePrivilege(Const.InstructorPermissions.CAN_MODIFY_SESSION, true);
Instructor instructor = new Instructor(course, "name", "[email protected]",
false, "", null, instructorPrivileges);
loginAsInstructor(googleId);
when(mockLogic.getInstructorByGoogleId(course.getId(), googleId)).thenReturn(instructor);
when(mockLogic.getFeedbackSessionFromRecycleBin(session.getName(), course.getId())).thenReturn(session);

String[] params = {
Const.ParamsNames.FEEDBACK_SESSION_NAME, session.getName(),
Const.ParamsNames.COURSE_ID, session.getCourseId(),
};
verifyCanAccess(params);

}

@Test
public void testSpecificAccessControl_instructorWithoutPermission_cannotAccess() {
InstructorPrivileges instructorPrivileges = new InstructorPrivileges();
Instructor instructor = new Instructor(course, "name", "[email protected]",
false, "", null, instructorPrivileges);
loginAsInstructor(googleId);
when(mockLogic.getInstructorByGoogleId(course.getId(), googleId)).thenReturn(instructor);
when(mockLogic.getFeedbackSessionFromRecycleBin(session.getName(), course.getId())).thenReturn(session);

String[] params = {
Const.ParamsNames.FEEDBACK_SESSION_NAME, session.getName(),
Const.ParamsNames.COURSE_ID, session.getCourseId(),
};
verifyCannotAccess(params);
}

}
215 changes: 215 additions & 0 deletions src/test/java/teammates/sqlui/webapi/EnrollStudentsActionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,215 @@
package teammates.sqlui.webapi;

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.when;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;

import teammates.common.datatransfer.InstructorPrivileges;
import teammates.common.exception.EntityAlreadyExistsException;
import teammates.common.exception.EntityDoesNotExistException;
import teammates.common.exception.InvalidParametersException;
import teammates.common.util.Const;
import teammates.storage.sqlentity.Course;
import teammates.storage.sqlentity.Instructor;
import teammates.storage.sqlentity.Section;
import teammates.storage.sqlentity.Student;
import teammates.storage.sqlentity.Team;
import teammates.ui.output.EnrollStudentsData;
import teammates.ui.output.StudentData;
import teammates.ui.request.StudentsEnrollRequest;
import teammates.ui.webapi.EnrollStudentsAction;
import teammates.ui.webapi.JsonResult;

/**
* Test cases for the {@link EnrollStudentsAction} class.
*/
public class EnrollStudentsActionTest extends BaseActionTest<EnrollStudentsAction> {
Course course;
Team team;
Section section;
Copy link
Contributor

Choose a reason for hiding this comment

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

small nit lets private these for consistency too


@Override
protected String getActionUri() {
return Const.ResourceURIs.STUDENTS;
}

@Override
protected String getRequestMethod() {
return PUT;
}

@BeforeMethod
void setUp() {
course = new Course("course-id", "name", Const.DEFAULT_TIME_ZONE, "institute");
section = new Section(course, "section");
team = new Team(section, course.getId());
}

@Test
public void testExecute_withNewStudent_shouldBeAdded() throws Exception {
Instructor instructor = getTypicalInstructor();
loginAsInstructor(instructor.getGoogleId());
Student newStudent = new Student(course, "name", "email.com", "", team);
when(mockLogic.getCourse(course.getId())).thenReturn(course);
when(mockLogic.createStudent(any(Student.class))).thenReturn(newStudent);
when(mockLogic.getTeamOrCreate(section, "team")).thenReturn(team);
when(mockLogic.getSectionOrCreate(course.getId(), "section")).thenReturn(section);

StudentsEnrollRequest req = prepareRequest(newStudent);
String[] params = new String[] {
Const.ParamsNames.COURSE_ID, course.getId(),
};
EnrollStudentsAction action = getAction(req, params);
JsonResult result = getJsonResult(action);

List<StudentData> enrolledStudents = ((EnrollStudentsData) result.getOutput()).getStudentsData().getStudents();
assertEquals(enrolledStudents.size(), 1);
assertEquals(enrolledStudents.get(0).getEmail(), newStudent.getEmail());
verifySpecifiedTasksAdded(Const.TaskQueue.SEARCH_INDEXING_QUEUE_NAME, 1);
}

@Test
public void testExecute_studentAlreadyEnrolled_updateStudent() throws Exception {
Instructor instructor = getTypicalInstructor();
loginAsInstructor(instructor.getGoogleId());
Student newStudent = new Student(course, "name", "email.com", "", team);
when(mockLogic.getStudentsForCourse(course.getId())).thenReturn(new ArrayList<>(List.of(newStudent)));
when(mockLogic.getCourse(course.getId())).thenReturn(course);
when(mockLogic.getStudentForEmail(course.getId(), newStudent.getEmail())).thenReturn(newStudent);
when(mockLogic.getTeamOrCreate(section, "team")).thenReturn(team);
when(mockLogic.getSectionOrCreate(course.getId(), "section")).thenReturn(section);
when(mockLogic.updateStudentCascade(any(Student.class))).thenReturn(newStudent);

StudentsEnrollRequest req = prepareRequest(newStudent);
String[] params = new String[] {
Const.ParamsNames.COURSE_ID, course.getId(),
};
EnrollStudentsAction action = getAction(req, params);
JsonResult result = getJsonResult(action);

List<StudentData> enrolledStudents = ((EnrollStudentsData) result.getOutput()).getStudentsData().getStudents();
assertEquals(enrolledStudents.size(), 1);
assertEquals(enrolledStudents.get(0).getEmail(), newStudent.getEmail());
verifySpecifiedTasksAdded(Const.TaskQueue.SEARCH_INDEXING_QUEUE_NAME, 1);
}

@Test
public void testExecute_invalidParamsAndNotAlreadyEnrolled_studentAddedToErrorList() throws
EntityAlreadyExistsException, InvalidParametersException {
doThrow(new InvalidParametersException("")).when(mockLogic).createStudent(any(Student.class));

Instructor instructor = getTypicalInstructor();
loginAsInstructor(instructor.getGoogleId());
Student newStudent = new Student(course, "name", "email.com", "", team);
when(mockLogic.getStudentsForCourse(course.getId())).thenReturn(new ArrayList<>());
when(mockLogic.getCourse(course.getId())).thenReturn(course);
when(mockLogic.getTeamOrCreate(section, "team")).thenReturn(team);
when(mockLogic.getSectionOrCreate(course.getId(), "section")).thenReturn(section);

StudentsEnrollRequest req = prepareRequest(newStudent);
String[] params = new String[] {
Const.ParamsNames.COURSE_ID, course.getId(),
};
EnrollStudentsAction action = getAction(req, params);
JsonResult result = getJsonResult(action);
List<StudentData> enrolledStudents = ((EnrollStudentsData) result.getOutput()).getStudentsData().getStudents();
List<EnrollStudentsData.EnrollErrorResults> errors =
((EnrollStudentsData) result.getOutput()).getUnsuccessfulEnrolls();
assertEquals(errors.size(), 1);
assertEquals(enrolledStudents.size(), 0);
}

@Test
public void testExecute_invalidParamsAndAlreadyEnrolled_studentAddedToErrorList()
throws InvalidParametersException, EntityDoesNotExistException, EntityAlreadyExistsException {
Instructor instructor = getTypicalInstructor();
loginAsInstructor(instructor.getGoogleId());

doThrow(new InvalidParametersException("")).when(mockLogic).updateStudentCascade(any(Student.class));

Student newStudent = new Student(course, "name", "email.com", "", team);
when(mockLogic.getCourse(course.getId())).thenReturn(course);
when(mockLogic.getStudentsForCourse(course.getId())).thenReturn(new ArrayList<>(List.of(newStudent)));
when(mockLogic.getStudentForEmail(course.getId(), newStudent.getEmail())).thenReturn(newStudent);
when(mockLogic.getTeamOrCreate(section, "team")).thenReturn(team);
when(mockLogic.getSectionOrCreate(course.getId(), "section")).thenReturn(section);

StudentsEnrollRequest req = prepareRequest(newStudent);
String[] params = new String[] {
Const.ParamsNames.COURSE_ID, course.getId(),
};
EnrollStudentsAction action = getAction(req, params);
JsonResult result = getJsonResult(action);
List<StudentData> enrolledStudents = ((EnrollStudentsData) result.getOutput()).getStudentsData().getStudents();
List<EnrollStudentsData.EnrollErrorResults> errors =
((EnrollStudentsData) result.getOutput()).getUnsuccessfulEnrolls();
assertEquals(errors.size(), 1);
assertEquals(enrolledStudents.size(), 0);
}

@Test
public void testExecute_invalidCourseId_invalidHttpRequestBodyException() {
Instructor instructor = getTypicalInstructor();
loginAsInstructor(instructor.getGoogleId());
String[] params = new String[] {
Const.ParamsNames.COURSE_ID, null,
};

verifyHttpParameterFailure(params);
}

@Test
public void testSpecificAccessControl_instructorWithInvalidPermission_cannotAccess() {
Instructor instructor = new Instructor(course, "name", "[email protected]",
false, "", null, new InstructorPrivileges());
loginAsInstructor(instructor.getGoogleId());
String[] params = new String[] {
Const.ParamsNames.COURSE_ID, course.getId(),
};

verifyCannotAccess(params);
}

@Test
public void testSpecificAccessControl_instructorWithValidPermission_canAccess() {
InstructorPrivileges instructorPrivileges = new InstructorPrivileges();
instructorPrivileges.updatePrivilege(Const.InstructorPermissions.CAN_MODIFY_STUDENT, true);
Instructor instructor = new Instructor(course, "name", "[email protected]",
false, "", null, instructorPrivileges);
loginAsInstructor(instructor.getGoogleId());
when(mockLogic.getInstructorByGoogleId(course.getId(), instructor.getGoogleId())).thenReturn(instructor);
when(mockLogic.getCourse(course.getId())).thenReturn(course);
String[] params = new String[] {
Const.ParamsNames.COURSE_ID, course.getId(),
};
verifyCanAccess(params);
}

@Test
public void testSpecificAccessControl_notInstructor_cannotAccess() {
String[] params = {
Const.ParamsNames.COURSE_ID, course.getId(),
};
loginAsStudent("random-id");
verifyCannotAccess(params);

logoutUser();
verifyCannotAccess(params);
}

private StudentsEnrollRequest prepareRequest(Student... studentsToEnroll) {
List<StudentsEnrollRequest.StudentEnrollRequest> requestList = new ArrayList<>();
Arrays.stream(studentsToEnroll).forEach(student -> requestList.add(
new StudentsEnrollRequest.StudentEnrollRequest(student.getName(), student.getEmail(),
"team", "section", student.getComments())));
return new StudentsEnrollRequest(requestList);
}

}
Loading