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 for GetNotificationsActionTest #13219

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

[#12048] Migrate tests for GetNotificationsActionTest #13219

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
18b6c13
Add GetNotificationsActionTest for migration
InfinityTwo Feb 8, 2025
65dc6fe
Remove typical bundle usage
InfinityTwo Feb 15, 2025
a5b2d79
Merge branch 'master' into db-migration-d
InfinityTwo Feb 15, 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
310 changes: 310 additions & 0 deletions src/test/java/teammates/sqlui/webapi/GetNotificationsActionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,310 @@
package teammates.sqlui.webapi;

import static org.mockito.Mockito.when;

import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;

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

import teammates.common.datatransfer.NotificationTargetUser;
import teammates.common.util.Const;
import teammates.storage.sqlentity.Notification;
import teammates.ui.output.NotificationData;
import teammates.ui.output.NotificationsData;
import teammates.ui.webapi.GetNotificationsAction;
import teammates.ui.webapi.JsonResult;

/**
* SUT: {@link GetNotificationsAction}.
*/
public class GetNotificationsActionTest extends BaseActionTest<GetNotificationsAction> {
private static final String GOOGLE_ID = "user-googleId";
private static final int READ_NOTIFICATION_COUNT = 5;
private static final int UNREAD_NOTIFICATION_COUNT = 10;

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

@Override
String getRequestMethod() {
return GET;
}

@BeforeMethod
public void baseClassSetup() {
loginAsAdmin();
}

@Test
protected void testAccessControl_instructorAccessStudentNotification_shouldFail() {
loginAsInstructor(GOOGLE_ID);
String[] requestParams = new String[] {
Const.ParamsNames.NOTIFICATION_TARGET_USER, NotificationTargetUser.STUDENT.toString(),
Const.ParamsNames.NOTIFICATION_IS_FETCHING_ALL, String.valueOf(true),
};
verifyCannotAccess(requestParams);
}

@Test
protected void testAccessControl_instructorAccessInstructorNotification_shouldSucceed() {
loginAsInstructor(GOOGLE_ID);
String[] requestParams = new String[] {
Const.ParamsNames.NOTIFICATION_TARGET_USER, NotificationTargetUser.INSTRUCTOR.toString(),
Const.ParamsNames.NOTIFICATION_IS_FETCHING_ALL, String.valueOf(true),
};
verifyCanAccess(requestParams);
}

@Test
protected void testAccessControl_studentAccessInstructorNotification_shouldFail() {
loginAsStudent(GOOGLE_ID);
String[] requestParams = new String[] {
Const.ParamsNames.NOTIFICATION_TARGET_USER, NotificationTargetUser.INSTRUCTOR.toString(),
Const.ParamsNames.NOTIFICATION_IS_FETCHING_ALL, String.valueOf(true),
};
verifyCannotAccess(requestParams);
}

@Test
protected void testAccessControl_studentAccessStudentNotification_shouldSucceed() {
loginAsStudent(GOOGLE_ID);
String[] requestParams = new String[] {
Const.ParamsNames.NOTIFICATION_TARGET_USER, NotificationTargetUser.STUDENT.toString(),
Const.ParamsNames.NOTIFICATION_IS_FETCHING_ALL, String.valueOf(true),
};
verifyCanAccess(requestParams);
}

@Test
protected void testAccessControl_unknownTargetUser_shouldFail() {
loginAsInstructor(GOOGLE_ID);
String[] requestParams = new String[] {
Const.ParamsNames.NOTIFICATION_TARGET_USER, "unknown",
Const.ParamsNames.NOTIFICATION_IS_FETCHING_ALL, String.valueOf(true),
};
verifyHttpParameterFailureAcl(requestParams);
}

@Test
protected void testAccessControl_adminAccessAllNotification_shouldSucceed() {
loginAsAdmin();
String[] requestParams = new String[] {
Const.ParamsNames.NOTIFICATION_TARGET_USER, null,
Const.ParamsNames.NOTIFICATION_IS_FETCHING_ALL, String.valueOf(true),
};
verifyCanAccess(requestParams);
}

@Test
protected void testExecute_withValidUserTypeForNonAdmin_shouldReturnData() {
List<Notification> testNotifications = new ArrayList<>();

loginAsInstructor(GOOGLE_ID);

int expectedNumberOfNotifications = UNREAD_NOTIFICATION_COUNT + READ_NOTIFICATION_COUNT;

for (int i = 0; i < expectedNumberOfNotifications; i++) {
testNotifications.add(getTypicalNotificationWithId());
}

when(mockLogic.getActiveNotificationsByTargetUser(NotificationTargetUser.INSTRUCTOR))
.thenReturn(testNotifications);

String[] requestParams = new String[] {
Const.ParamsNames.NOTIFICATION_TARGET_USER, NotificationTargetUser.INSTRUCTOR.toString(),
Const.ParamsNames.NOTIFICATION_IS_FETCHING_ALL, String.valueOf(true),
};

GetNotificationsAction action = getAction(requestParams);
JsonResult jsonResult = getJsonResult(action);

NotificationsData output = (NotificationsData) jsonResult.getOutput();
List<NotificationData> notifications = output.getNotifications();

// should fetch correct number of notifications
assertEquals(expectedNumberOfNotifications, notifications.size());
}

@Test
public void testExecute_withoutUserTypeForAdmin_shouldReturnAllNotifications() {
final int expectedNumberOfNotifications = 5;
Notification testNotification = getTypicalNotificationWithId();

loginAsAdmin();

List<Notification> testNotifications = new ArrayList<>();
for (int i = 0; i < expectedNumberOfNotifications; i++) {
testNotifications.add(getTypicalNotificationWithId());
}

when(mockLogic.getAllNotifications()).thenReturn(testNotifications);

String[] requestParams = new String[] {
Const.ParamsNames.NOTIFICATION_TARGET_USER, null,
Const.ParamsNames.NOTIFICATION_IS_FETCHING_ALL, String.valueOf(true),
};

GetNotificationsAction action = getAction(requestParams);
JsonResult jsonResult = getJsonResult(action);

NotificationsData output = (NotificationsData) jsonResult.getOutput();
List<NotificationData> notifications = output.getNotifications();

assertEquals(expectedNumberOfNotifications, mockLogic.getAllNotifications().size());
assertEquals(expectedNumberOfNotifications, notifications.size());

NotificationData expected = new NotificationData(testNotifications.get(0));
NotificationData firstNotification = notifications.get(0);
verifyNotificationEquals(expected, firstNotification);

// notification's shown attribute should not be updated
List<Notification> notificationToCheck =
mockLogic.getActiveNotificationsByTargetUser(testNotification.getTargetUser());
notificationToCheck.forEach(n -> assertFalse(n.isShown()));
}

@Test
public void testExecute_withoutUserTypeForNonAdmin_shouldFail() {
loginAsInstructor(GOOGLE_ID);

String[] requestParams = new String[] {
Const.ParamsNames.NOTIFICATION_IS_FETCHING_ALL, String.valueOf(true),
};

GetNotificationsAction action = getAction(requestParams);
assertThrows(AssertionError.class, action::execute);
}

@Test
public void testExecute_invalidUserType_shouldFail() {
loginAsInstructor(GOOGLE_ID);

// when usertype is GENERAL
verifyHttpParameterFailure(Const.ParamsNames.NOTIFICATION_TARGET_USER,
NotificationTargetUser.GENERAL.toString(),
Const.ParamsNames.NOTIFICATION_IS_FETCHING_ALL,
String.valueOf(true));

// when usertype is a random string
verifyHttpParameterFailure(Const.ParamsNames.NOTIFICATION_TARGET_USER,
"invalid string",
Const.ParamsNames.NOTIFICATION_IS_FETCHING_ALL,
String.valueOf(true));
}

@Test
public void testExecute_withFalseIsFetchingAll_shouldUpdateShownAndReturnUnreadNotifications() {
loginAsInstructor(GOOGLE_ID);

List<Notification> testAllNotifications = new ArrayList<>();
List<Notification> testUnreadNotifications = new ArrayList<>();
Set<String> readNotificationsId;

for (int i = 0; i < UNREAD_NOTIFICATION_COUNT; i++) {
testUnreadNotifications.add(getTypicalNotificationWithId());
}

for (int i = 0; i < READ_NOTIFICATION_COUNT; i++) {
Notification readNotification = getTypicalNotificationWithId();
readNotification.setShown();
testAllNotifications.add(readNotification);
}

readNotificationsId = testAllNotifications.stream()
.map(n -> n.getId().toString())
.collect(Collectors.toSet());

testAllNotifications.addAll(testUnreadNotifications);

when(mockLogic.getAllNotifications()).thenReturn(testAllNotifications);
when(mockLogic.getActiveNotificationsByTargetUser(NotificationTargetUser.INSTRUCTOR))
.thenReturn(testUnreadNotifications);

String[] requestParams = new String[] {
Const.ParamsNames.NOTIFICATION_TARGET_USER, NotificationTargetUser.INSTRUCTOR.toString(),
Const.ParamsNames.NOTIFICATION_IS_FETCHING_ALL, String.valueOf(false),
};

GetNotificationsAction action = getAction(requestParams);
JsonResult jsonResult = getJsonResult(action);

NotificationsData output = (NotificationsData) jsonResult.getOutput();
List<NotificationData> notifications = output.getNotifications();
verifyDoesNotContainNotifications(notifications, readNotificationsId);

// should update notification has shown attribute
List<Notification> notificationAttributes =
mockLogic.getActiveNotificationsByTargetUser(NotificationTargetUser.INSTRUCTOR);
notificationAttributes = notificationAttributes.stream()
.filter(n -> !readNotificationsId.contains(n.getId().toString()))
.collect(Collectors.toList());
notificationAttributes.forEach(n -> assertTrue(n.isShown()));
}

@Test
public void testExecute_withoutIsFetchingAll_shouldUpdateShownAndReturnUnreadNotifications() {
List<Notification> testAllNotifications = new ArrayList<>();
List<Notification> testUnreadNotifications = new ArrayList<>();
Set<String> readNotificationsId;

loginAsInstructor(GOOGLE_ID);

for (int i = 0; i < READ_NOTIFICATION_COUNT; i++) {
Notification readNotification = getTypicalNotificationWithId();
readNotification.setShown();
testAllNotifications.add(readNotification);
}

readNotificationsId = testAllNotifications.stream()
.map(n -> n.getId().toString())
.collect(Collectors.toSet());

when(mockLogic.getActiveNotificationsByTargetUser(NotificationTargetUser.INSTRUCTOR))
.thenReturn(testUnreadNotifications);

String[] requestParams = new String[] {
Const.ParamsNames.NOTIFICATION_TARGET_USER, NotificationTargetUser.INSTRUCTOR.toString(),
};

GetNotificationsAction action = getAction(requestParams);
JsonResult jsonResult = getJsonResult(action);

NotificationsData output = (NotificationsData) jsonResult.getOutput();
List<NotificationData> notifications = output.getNotifications();
verifyDoesNotContainNotifications(notifications, readNotificationsId);
}

@Test
public void testExecute_withInvalidIsFetchingAll_shouldFail() {
loginAsInstructor(GOOGLE_ID);

String[] requestParams = new String[] {
Const.ParamsNames.NOTIFICATION_TARGET_USER, NotificationTargetUser.INSTRUCTOR.toString(),
Const.ParamsNames.NOTIFICATION_IS_FETCHING_ALL, "random-value",
};

verifyHttpParameterFailure(requestParams);
}

private void verifyNotificationEquals(NotificationData expected, NotificationData actual) {
assertEquals(expected.getNotificationId(), actual.getNotificationId());
assertEquals(expected.getStyle(), actual.getStyle());
assertEquals(expected.getTargetUser(), actual.getTargetUser());
assertEquals(expected.getTitle(), actual.getTitle());
assertEquals(expected.getMessage(), actual.getMessage());
assertEquals(expected.getStartTimestamp(), actual.getStartTimestamp());
assertEquals(expected.getEndTimestamp(), actual.getEndTimestamp());
}

private void verifyDoesNotContainNotifications(List<NotificationData> notifications, Set<String> readIds) {
for (NotificationData n : notifications) {
assertFalse(readIds.contains(n.getNotificationId()));
}
}
}
Loading