Skip to content

Commit

Permalink
Abstract the code and add instructorInDifferentCourse test
Browse files Browse the repository at this point in the history
  • Loading branch information
@DhiraPT
DhiraPT committed Jan 30, 2025
1 parent 9bf5470 commit 7dba50d
Showing 1 changed file with 69 additions and 49 deletions.
118 changes: 69 additions & 49 deletions src/test/java/teammates/sqlui/webapi/DeleteStudentActionTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

import static org.mockito.Mockito.when;

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

import teammates.common.datatransfer.InstructorPrivileges;
import teammates.common.util.Const;
import teammates.storage.sqlentity.Account;
import teammates.storage.sqlentity.Course;
import teammates.storage.sqlentity.Instructor;
import teammates.storage.sqlentity.Student;
Expand All @@ -17,7 +19,9 @@
*/
public class DeleteStudentActionTest extends BaseActionTest<DeleteStudentAction> {

String googleId = "user-googleId";
private Course course;
private Student student;
private Instructor instructor;

@Override
protected String getActionUri() {
Expand All @@ -29,13 +33,42 @@ protected String getRequestMethod() {
return DELETE;
}

@Test
void testExecute_deleteStudentByEmail_success() {
Course course = new Course("course-id", "name", Const.DEFAULT_TIME_ZONE, "institute");
Student student = new Student(course, "Student Name", "[email protected]", "Some comments");
@BeforeMethod
void setUp() {
course = new Course("course-id", "Course Name", Const.DEFAULT_TIME_ZONE, "institute");
student = setupStudent("student-googleId", "Student Name", "[email protected]", "Some comments");
instructor = setupInstructor("instructor-googleId", "Instructor Name", "[email protected]");

setupMockLogic();
}

private Student setupStudent(String googleId, String name, String email, String comments) {
Account account = new Account(googleId, name, email);
Student student = new Student(course, name, email, comments);
student.setAccount(account);
return student;
}

private Instructor setupInstructor(String googleId, String name, String email) {
Account account = new Account(googleId, name, email);
InstructorPrivileges instructorPrivileges = new InstructorPrivileges();
instructorPrivileges.updatePrivilege(Const.InstructorPermissions.CAN_MODIFY_STUDENT, true);

Instructor instructor = new Instructor(course, name, email,
false, "", null, instructorPrivileges);
instructor.setAccount(account);
return instructor;
}

private void setupMockLogic() {
when(mockLogic.getCourse(course.getId())).thenReturn(course);
when(mockLogic.getStudentByGoogleId(course.getId(), student.getGoogleId())).thenReturn(student);
when(mockLogic.getStudentForEmail(course.getId(), student.getEmail())).thenReturn(student);
when(mockLogic.getInstructorByGoogleId(course.getId(), instructor.getGoogleId())).thenReturn(instructor);
}

@Test
void testExecute_deleteStudentByEmail_success() {
String[] params = {
Const.ParamsNames.COURSE_ID, course.getId(),
Const.ParamsNames.STUDENT_EMAIL, student.getEmail(),
Expand All @@ -49,14 +82,9 @@ void testExecute_deleteStudentByEmail_success() {

@Test
void testExecute_deleteStudentById_success() {
Course course = new Course("course-id", "name", Const.DEFAULT_TIME_ZONE, "institute");
Student student = new Student(course, "Student Name", "[email protected]", "Some comments");

when(mockLogic.getStudentByGoogleId(course.getId(), googleId)).thenReturn(student);

String[] params = {
Const.ParamsNames.COURSE_ID, course.getId(),
Const.ParamsNames.STUDENT_ID, googleId,
Const.ParamsNames.STUDENT_ID, student.getGoogleId(),
};

DeleteStudentAction action = getAction(params);
Expand All @@ -67,11 +95,11 @@ void testExecute_deleteStudentById_success() {

@Test
void testExecute_courseDoesNotExist_failSilently() {
when(mockLogic.getStudentByGoogleId("RANDOM_COURSE", googleId)).thenReturn(null);
when(mockLogic.getCourse("RANDOM_COURSE")).thenReturn(null);

String[] params = {
Const.ParamsNames.COURSE_ID, "RANDOM_COURSE",
Const.ParamsNames.STUDENT_ID, googleId,
Const.ParamsNames.STUDENT_ID, student.getGoogleId(),
};

DeleteStudentAction action = getAction(params);
Expand All @@ -82,12 +110,10 @@ void testExecute_courseDoesNotExist_failSilently() {

@Test
void testExecute_studentDoesNotExist_failSilently() {
String courseId = "course-id";

when(mockLogic.getStudentByGoogleId(courseId, "RANDOM_STUDENT")).thenReturn(null);
when(mockLogic.getStudentByGoogleId(course.getId(), "RANDOM_STUDENT")).thenReturn(null);

String[] params = {
Const.ParamsNames.COURSE_ID, courseId,
Const.ParamsNames.COURSE_ID, course.getId(),
Const.ParamsNames.STUDENT_ID, "RANDOM_STUDENT",
};

Expand All @@ -105,7 +131,7 @@ void testExecute_noParameters_throwsInvalidParametersException() {
@Test
void testExecute_missingStudentIdOrEmail_throwsInvalidHttpParameterException() {
String[] params = {
Const.ParamsNames.COURSE_ID, "course-id",
Const.ParamsNames.COURSE_ID, course.getId(),
};

verifyHttpParameterFailure(params);
Expand All @@ -114,7 +140,7 @@ void testExecute_missingStudentIdOrEmail_throwsInvalidHttpParameterException() {
@Test
void testExecute_missingCourseIdWithStudentId_throwsInvalidHttpParameterException() {
String[] params = {
Const.ParamsNames.STUDENT_ID, "student-id",
Const.ParamsNames.STUDENT_ID, student.getGoogleId(),
};

verifyHttpParameterFailure(params);
Expand All @@ -123,20 +149,18 @@ void testExecute_missingCourseIdWithStudentId_throwsInvalidHttpParameterExceptio
@Test
void testExecute_missingCourseIdWithStudentEmail_throwsInvalidHttpParameterException() {
String[] params = {
Const.ParamsNames.STUDENT_EMAIL, "[email protected]",
Const.ParamsNames.STUDENT_EMAIL, student.getEmail(),
};

verifyHttpParameterFailure(params);
}

@Test
void testExecute_randomEmail_failSilently() {
String courseId = "course-id";

when(mockLogic.getStudentForEmail(courseId, "RANDOM_EMAIL")).thenReturn(null);
when(mockLogic.getStudentForEmail(course.getId(), "RANDOM_EMAIL")).thenReturn(null);

String[] params = {
Const.ParamsNames.COURSE_ID, courseId,
Const.ParamsNames.COURSE_ID, course.getId(),
Const.ParamsNames.STUDENT_EMAIL, "RANDOM_EMAIL",
};

Expand All @@ -148,55 +172,51 @@ void testExecute_randomEmail_failSilently() {

@Test
void testSpecificAccessControl_admin_canAccess() {
Course course = new Course("course-id", "Course Name", Const.DEFAULT_TIME_ZONE, "institute");
Student student = new Student(course, "Student Name", "[email protected]", "Some comments");

loginAsAdmin();
when(mockLogic.getCourse(course.getId())).thenReturn(course);
when(mockLogic.getStudentByGoogleId(course.getId(), googleId)).thenReturn(student);

String[] params = {
Const.ParamsNames.COURSE_ID, course.getId(),
Const.ParamsNames.STUDENT_ID, googleId,
Const.ParamsNames.STUDENT_ID, student.getGoogleId(),
};

verifyCanAccess(params);
}

@Test
void testSpecificAccessControl_instructorWithPermission_canAccess() {
Course course = new Course("course-id", "name", Const.DEFAULT_TIME_ZONE, "institute");
InstructorPrivileges instructorPrivileges = new InstructorPrivileges();
instructorPrivileges.updatePrivilege(Const.InstructorPermissions.CAN_MODIFY_STUDENT, true);
Instructor instructor = new Instructor(course, "name", "[email protected]",
false, "", null, instructorPrivileges);

loginAsInstructor(googleId);
when(mockLogic.getCourse(course.getId())).thenReturn(course);
when(mockLogic.getInstructorByGoogleId(course.getId(), googleId)).thenReturn(instructor);
loginAsInstructor(instructor.getGoogleId());

String[] params = {
Const.ParamsNames.COURSE_ID, course.getId(),
Const.ParamsNames.STUDENT_ID, "student-id",
Const.ParamsNames.STUDENT_ID, student.getGoogleId(),
};

verifyCanAccess(params);
}

@Test
void testSpecificAccessControl_instructorWithInvalidPermission_cannotAccess() {
Course course = new Course("course-id", "Course Name", Const.DEFAULT_TIME_ZONE, "institute");
InstructorPrivileges instructorPrivileges = new InstructorPrivileges();
instructorPrivileges.updatePrivilege(Const.InstructorPermissions.CAN_MODIFY_STUDENT, false);
Instructor instructor = new Instructor(course, "name", "[email protected]",
false, "", null, instructorPrivileges);
instructor.setPrivileges(instructorPrivileges);

loginAsInstructor(googleId);
when(mockLogic.getInstructorByGoogleId(course.getId(), googleId)).thenReturn(instructor);
loginAsInstructor(instructor.getGoogleId());

String[] params = {
Const.ParamsNames.COURSE_ID, course.getId(),
Const.ParamsNames.STUDENT_ID, "student-id",
Const.ParamsNames.STUDENT_ID, student.getGoogleId(),
};

verifyCannotAccess(params);
}

@Test
void testSpecificAccessControl_instructorInDifferentCourse_cannotAccess() {
loginAsInstructor("instructor2-googleId");

String[] params = {
Const.ParamsNames.COURSE_ID, course.getId(),
Const.ParamsNames.STUDENT_ID, student.getGoogleId(),
};

verifyCannotAccess(params);
Expand All @@ -205,11 +225,11 @@ void testSpecificAccessControl_instructorWithInvalidPermission_cannotAccess() {
@Test
void testSpecificAccessControl_student_cannotAccess() {
String[] params = {
Const.ParamsNames.COURSE_ID, "course-id",
Const.ParamsNames.STUDENT_ID, "student-id",
Const.ParamsNames.COURSE_ID, course.getId(),
Const.ParamsNames.STUDENT_ID, student.getGoogleId(),
};

loginAsStudent(googleId);
loginAsStudent(student.getGoogleId());
verifyCannotAccess(params);

logoutUser();
Expand Down

0 comments on commit 7dba50d

Please sign in to comment.