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 tests for GetDeadlineExtensionActionTest #13266

Merged
merged 6 commits into from
Mar 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 @@ -9,6 +9,7 @@
import teammates.common.util.FieldValidator;
import teammates.common.util.SanitizationHelper;
import teammates.storage.entity.DeadlineExtension;
import teammates.storage.sqlentity.Instructor;

/**
* The data transfer object for {@link DeadlineExtension} entities.
Expand Down Expand Up @@ -54,6 +55,25 @@ public static DeadlineExtensionAttributes valueOf(DeadlineExtension deadlineExte
return deadlineExtensionAttributes;
}

/**
* Gets the {@link DeadlineExtensionAttributes} instance
* of the given {@link teammates.storage.sqlentity.DeadlineExtension}.
*/
public static DeadlineExtensionAttributes valueOf(teammates.storage.sqlentity.DeadlineExtension deadlineExtension) {
DeadlineExtensionAttributes deadlineExtensionAttributes = new DeadlineExtensionAttributes(
deadlineExtension.getId().toString(),
deadlineExtension.getFeedbackSession().getName(),
deadlineExtension.getUser().getEmail(),
deadlineExtension.getUser() instanceof Instructor);

deadlineExtensionAttributes.sentClosingSoonEmail = deadlineExtension.isClosingSoonEmailSent();
deadlineExtensionAttributes.endTime = deadlineExtension.getEndTime();
deadlineExtensionAttributes.createdAt = deadlineExtension.getCreatedAt();
deadlineExtensionAttributes.updatedAt = deadlineExtension.getUpdatedAt();

return deadlineExtensionAttributes;
}

/**
* Returns a builder for {@link DeadlineExtensionAttributes}.
*/
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
package teammates.sqlui.webapi;

import static org.mockito.ArgumentMatchers.isA;
import static org.mockito.Mockito.when;

import java.time.Instant;
import java.util.ArrayList;
import java.util.Arrays;

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

import teammates.common.datatransfer.attributes.DeadlineExtensionAttributes;
import teammates.common.util.Const;
import teammates.storage.sqlentity.FeedbackSession;
import teammates.storage.sqlentity.User;
import teammates.ui.output.DeadlineExtensionData;
import teammates.ui.webapi.EntityNotFoundException;
import teammates.ui.webapi.GetDeadlineExtensionAction;
import teammates.ui.webapi.JsonResult;

/**
* SUT: {@link GetDeadlineExtensionAction}.
*/
public class GetDeadlineExtensionActionTest extends BaseActionTest<GetDeadlineExtensionAction> {
private DeadlineExtensionAttributes deadlineExtension;

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

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

@BeforeMethod
public void setUp() {
logoutUser();
deadlineExtension = getTypicalDeadlineExtensionAttributesStudent();
}

@Test
void testAccessControl_admin_cannotAccess() {
loginAsAdmin();
verifyCannotAccess();
}

@Test
void testAccessControl_maintainers_cannotAccess() {
loginAsMaintainer();
verifyCannotAccess();
}

@Test
void testAccessControl_instructor_cannotAccess() {
loginAsInstructor(Const.ParamsNames.INSTRUCTOR_ID);
verifyCannotAccess();
}

@Test
void testAccessControl_student_cannotAccess() {
loginAsStudent(Const.ParamsNames.STUDENT_ID);
verifyCannotAccess();
}

@Test
void testAccessControl_loggedOut_cannotAccess() {
verifyCannotAccess();
}

@Test
void testAccessControl_unregistered_cannotAccess() {
loginAsUnregistered(Const.ParamsNames.USER_ID);
verifyCannotAccess();
}

@Test
void testExecute_noParameters_shouldFail() {
verifyHttpParameterFailure();
}

@Test
void testExecute_missingParameter_shouldFail() {
/* Loops through each parameter pairs and removes each parameter pair to test for that
* missing parameter pair case.
*/
for (int i = 0; i < getNormalParams().length / 2; i++) {
ArrayList<String> params = new ArrayList<>(Arrays.asList(getNormalParams()));
params.remove(i * 2);
params.remove(i * 2);
String[] paramsArray = params.toArray(new String[0]);
verifyHttpParameterFailure(paramsArray);
Copy link
Contributor

Choose a reason for hiding this comment

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

nice!

}
}

@Test
void testExecute_deadlineExtensionMissing_shouldFail() {
String[] params = getNormalParams();

when(mockLogic.getFeedbackSession(deadlineExtension.getFeedbackSessionName(), deadlineExtension.getCourseId()))
.thenReturn(getTypicalDeadlineExtensionStudent().getFeedbackSession());
when(mockLogic.getExtendedDeadlineForUser(isA(FeedbackSession.class), isA(User.class)))
.thenReturn(null);

EntityNotFoundException enfe = verifyEntityNotFound(params);
assertEquals("Deadline extension for course id: " + deadlineExtension.getCourseId() + " and "
+ "feedback session name: " + deadlineExtension.getFeedbackSessionName() + " and student "
+ "email: " + deadlineExtension.getUserEmail() + " not found.",
enfe.getMessage());
}

@Test
void testExecute_typicalCaseStudent_shouldSucceed() {
String[] params = getNormalParams();

when(mockLogic.getFeedbackSession(deadlineExtension.getFeedbackSessionName(), deadlineExtension.getCourseId()))
.thenReturn(getTypicalDeadlineExtensionStudent().getFeedbackSession());
when(mockLogic.getStudentForEmail(deadlineExtension.getCourseId(), deadlineExtension.getUserEmail()))
.thenReturn(getTypicalStudent());
when(mockLogic.getExtendedDeadlineForUser(isA(FeedbackSession.class), isA(User.class)))
.thenReturn(deadlineExtension.getEndTime());

GetDeadlineExtensionAction a = getAction(params);
JsonResult r = getJsonResult(a);

DeadlineExtensionData response = (DeadlineExtensionData) r.getOutput();
compareOutput(response);
}

@Test
void testExecute_typicalCaseInstructor_shouldSucceed() {
deadlineExtension = getTypicalDeadlineExtensionAttributesInstructor();
String[] params = getNormalParams();

when(mockLogic.getFeedbackSession(deadlineExtension.getFeedbackSessionName(), deadlineExtension.getCourseId()))
.thenReturn(getTypicalDeadlineExtensionInstructor().getFeedbackSession());
when(mockLogic.getInstructorForEmail(deadlineExtension.getCourseId(), deadlineExtension.getUserEmail()))
.thenReturn(getTypicalInstructor());
when(mockLogic.getExtendedDeadlineForUser(isA(FeedbackSession.class), isA(User.class)))
.thenReturn(deadlineExtension.getEndTime());

GetDeadlineExtensionAction a = getAction(params);
JsonResult r = getJsonResult(a);

DeadlineExtensionData response = (DeadlineExtensionData) r.getOutput();

compareOutput(response);
}

private String[] getNormalParams() {
return new String[] {
Const.ParamsNames.COURSE_ID, deadlineExtension.getCourseId(),
Const.ParamsNames.FEEDBACK_SESSION_NAME, deadlineExtension.getFeedbackSessionName(),
Const.ParamsNames.USER_EMAIL, deadlineExtension.getUserEmail(),
Const.ParamsNames.IS_INSTRUCTOR, Boolean.toString(deadlineExtension.getIsInstructor()),
};
}

private void compareOutput(DeadlineExtensionData response) {
assertEquals(deadlineExtension.getCourseId(), response.getCourseId());
assertEquals(deadlineExtension.getFeedbackSessionName(), response.getFeedbackSessionName());
assertEquals(deadlineExtension.getUserEmail(), response.getUserEmail());
assertEquals(deadlineExtension.getIsInstructor(), response.getIsInstructor());
assertEquals(deadlineExtension.getEndTime().toEpochMilli(),
Instant.ofEpochMilli(response.getEndTime()).toEpochMilli());
assertEquals(deadlineExtension.getSentClosingSoonEmail(), response.getSentClosingSoonEmail());
}

}
24 changes: 24 additions & 0 deletions src/test/java/teammates/test/BaseTestCase.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import teammates.common.datatransfer.NotificationStyle;
import teammates.common.datatransfer.NotificationTargetUser;
import teammates.common.datatransfer.SqlDataBundle;
import teammates.common.datatransfer.attributes.DeadlineExtensionAttributes;
import teammates.common.datatransfer.attributes.UsageStatisticsAttributes;
import teammates.common.datatransfer.questions.FeedbackResponseDetails;
import teammates.common.datatransfer.questions.FeedbackTextQuestionDetails;
Expand All @@ -34,6 +35,7 @@
import teammates.storage.sqlentity.Account;
import teammates.storage.sqlentity.AccountRequest;
import teammates.storage.sqlentity.Course;
import teammates.storage.sqlentity.DeadlineExtension;
import teammates.storage.sqlentity.FeedbackQuestion;
import teammates.storage.sqlentity.FeedbackResponse;
import teammates.storage.sqlentity.FeedbackResponseComment;
Expand Down Expand Up @@ -239,6 +241,28 @@ protected UsageStatistics getTypicalUsageStatistics(Instant startTime) {
return UsageStatistics.valueOf(getTypicalUsageStatisticsAttributes(startTime));
}

protected DeadlineExtension getTypicalDeadlineExtensionStudent() {
return new DeadlineExtension(
getTypicalStudent(),
getTypicalFeedbackSessionForCourse(getTypicalCourse()),
Instant.now());
}

protected DeadlineExtension getTypicalDeadlineExtensionInstructor() {
return new DeadlineExtension(
getTypicalInstructor(),
getTypicalFeedbackSessionForCourse(getTypicalCourse()),
Instant.now());
}

protected DeadlineExtensionAttributes getTypicalDeadlineExtensionAttributesStudent() {
return DeadlineExtensionAttributes.valueOf(getTypicalDeadlineExtensionStudent());
}

protected DeadlineExtensionAttributes getTypicalDeadlineExtensionAttributesInstructor() {
return DeadlineExtensionAttributes.valueOf(getTypicalDeadlineExtensionInstructor());
}

/**
* Populates the feedback question and response IDs within the data bundle.
*
Expand Down
Loading