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 JsonResultTest #13274

Merged
merged 7 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
8 changes: 4 additions & 4 deletions src/main/java/teammates/ui/webapi/JsonResult.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,18 @@ public class JsonResult extends ActionResult {
private final ApiOutput output;
private List<Cookie> cookies;

JsonResult(ApiOutput output) {
public JsonResult(ApiOutput output) {
super(HttpStatus.SC_OK);
this.output = output;
this.cookies = new ArrayList<>();
}

JsonResult(ApiOutput output, List<Cookie> cookies) {
public JsonResult(ApiOutput output, List<Cookie> cookies) {
this(output);
this.cookies = cookies;
}

JsonResult(String message) {
public JsonResult(String message) {
this(message, HttpStatus.SC_OK);
}

Expand All @@ -64,7 +64,7 @@ public void send(HttpServletResponse resp) throws IOException {
JsonUtils.toCompactJson(output, pw);
}

List<Cookie> getCookies() {
public List<Cookie> getCookies() {
return cookies;
}

Expand Down
84 changes: 84 additions & 0 deletions src/test/java/teammates/sqlui/webapi/JsonResultTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
package teammates.sqlui.webapi;

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

import jakarta.servlet.http.Cookie;

import org.testng.annotations.Test;

import teammates.test.BaseTestCase;
import teammates.test.MockHttpServletResponse;
import teammates.ui.output.MessageOutput;
import teammates.ui.webapi.JsonResult;

/**
* SUT: {@link JsonResult}.
*/
public class JsonResultTest extends BaseTestCase {
private static final String MESSAGE = "output message";
private static final String EMPTY_MESSAGE = "";
private final MessageOutput messageOutput = new MessageOutput(MESSAGE);
private final MessageOutput emptyMessageOutput = new MessageOutput(EMPTY_MESSAGE);
private final List<Cookie> cookies = new ArrayList<>();
private final List<Cookie> emptyCookies = new ArrayList<>();
private final Cookie testCookie = new Cookie("cookieName", "cookieValue");

@Test
public void testConstructor_sendStringMessageReceivesMessage_shouldSucceed() throws Exception {
JsonResult result = new JsonResult(MESSAGE);
verifyJsonResult(result, MESSAGE, 0, 0);
}

@Test
public void testConstructor_sendMessageOutputReceivesMessage_shouldSucceed() throws Exception {
JsonResult result = new JsonResult(messageOutput);
verifyJsonResult(result, MESSAGE, 0, 0);
}

@Test
public void testConstructor_sendMessageOutputCookieReceiveMessageAndCookies_shouldSucceed() throws Exception {
cookies.add(testCookie);
JsonResult result = new JsonResult(messageOutput, cookies);
verifyJsonResult(result, MESSAGE, 1, 1);
}

@Test
public void testConstructor_emptyMessageAndCookie_shouldSucceed() throws Exception {
JsonResult result = new JsonResult(emptyMessageOutput, emptyCookies);
verifyJsonResult(result, EMPTY_MESSAGE, 0, 0);
}

@Test
public void testConstructor_sendNullMessage_shouldGetNullAndFailResponse() {
JsonResult result = new JsonResult((String) null);
MessageOutput output = (MessageOutput) result.getOutput();
assertEquals(null, output.getMessage());

result = new JsonResult((MessageOutput) null);
output = (MessageOutput) result.getOutput();
assertEquals(null, output);

JsonResult nullTestJsonResult = new JsonResult((MessageOutput) null, (List<Cookie>) null);
output = (MessageOutput) nullTestJsonResult.getOutput();
assertEquals(null, output);
assertEquals(null, nullTestJsonResult.getCookies());

MockHttpServletResponse resp = new MockHttpServletResponse();
assertThrows(NullPointerException.class, () -> nullTestJsonResult.send(resp));
}

private void verifyJsonResult(
JsonResult result,
String expectedMessage,
int expectedMessageCookieSize,
int expectedResponseCookieSize) throws Exception {
MessageOutput output = (MessageOutput) result.getOutput();
assertEquals(expectedMessage, output.getMessage());
assertEquals(expectedMessageCookieSize, result.getCookies().size());

MockHttpServletResponse resp = new MockHttpServletResponse();
result.send(resp);
assertEquals(expectedResponseCookieSize, resp.getCookies().size());
}
}
Loading