Skip to content

test: fix assertion order in session tests #602

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

Merged
merged 1 commit into from
Sep 11, 2024
Merged

test: fix assertion order in session tests #602

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion modules/common/src/test/java/com/ibm/cloud/cloudant/internal/TestCloudantService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
package com.ibm.cloud.cloudant.internal;

import com.ibm.cloud.cloudant.common.SdkCommon;
import com.ibm.cloud.cloudant.internal.CloudantBaseService;
import com.ibm.cloud.sdk.core.http.RequestBuilder;
import com.ibm.cloud.sdk.core.http.ResponseConverter;
import com.ibm.cloud.sdk.core.http.ServiceCall;
Expand Down
58 changes: 22 additions & 36 deletions ...common/src/test/java/com/ibm/cloud/cloudant/security/CouchDbSessionAuthenticatorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ void validateEmptyPass() {

@Test
void authenticationType() {
assertEquals("COUCHDB_SESSION", testAuthenticator.authenticationType(), "Authentication " +
assertEquals(testAuthenticator.authenticationType(), "COUCHDB_SESSION", "Authentication " +
"type should be COUCHDB_SESSION");
}

Expand Down Expand Up @@ -253,14 +253,11 @@ void setHeaders() {
TestCloudantService testCloudantService = new TestCloudantService("test", a);
testCloudantService.setDefaultHeaders(customHeaders);

// Verify the setter was called
Mockito.verify(a).setHeaders(customHeaders);

// Assert that the headers are the custom header + the SDK defaults
Map<String, String> expectedHeaders = new HashMap<>();
expectedHeaders.putAll(customHeaders);
expectedHeaders.putAll(SdkCommon.getSdkHeaders("authenticatorPostSession"));
assertEquals(expectedHeaders, a.getHeaders(), "The expected headers should match.");
assertEquals(a.getHeaders(), expectedHeaders, "The expected headers should match.");
}

/**
Expand All @@ -270,7 +267,6 @@ void setHeaders() {
*/
@Test
void requestToken() throws Exception {
MockWebServer server = new MockWebServer();

String mockSession = "AuthSession=ABC123456DE";
String mockSetCookieValue = String.format("%s; Version=1; Expires=Thu, 09-Apr-2020 " +
Expand All @@ -285,8 +281,8 @@ void requestToken() throws Exception {
.setBody(mockSessionPostResponseBody);
MockResponse sessionGetResponse = new MockResponse()
.setBody(mockSessionGetResponseBody);
server.start();
try {
try(MockWebServer server = new MockWebServer();) {
server.start();
server.getPort();
server.enqueue(sessionPostResponse);
server.enqueue(sessionGetResponse);
Expand All @@ -299,23 +295,23 @@ void requestToken() throws Exception {
// Assert on the mock server
// First request
RecordedRequest sessionPostRequest = server.takeRequest();
assertEquals("POST", sessionPostRequest.getMethod(), "Should have been a POST request" +
assertEquals(sessionPostRequest.getMethod(), "POST", "Should have been a POST request" +
".");
assertEquals("/_session", sessionPostRequest.getPath(), "Should have been a _session " +
assertEquals(sessionPostRequest.getPath(), "/_session", "Should have been a _session " +
"request.");
String expectedBody = String.format("{\"username\":\"%s\",\"password\":\"%s\"}",
CouchDbSessionAuthenticatorTest.USERNAME,
String.valueOf(CouchDbSessionAuthenticatorTest.PASSWORD));
assertEquals(expectedBody, sessionPostRequest.getBody().readUtf8(), "The body should " +
assertEquals(sessionPostRequest.getBody().readUtf8(), expectedBody, "The body should " +
"be as expected.");
assertEquals("TESTVALUE", sessionPostRequest.getHeader("X-CDT-SDK-TEST"), "The custom" +
assertEquals(sessionPostRequest.getHeader("X-CDT-SDK-TEST"), "TESTVALUE", "The custom" +
" header should have been on the request.");
// Second request
RecordedRequest sessionGetRequest = server.takeRequest();
assertEquals("GET", sessionGetRequest.getMethod(), "Should have been a GET request.");
assertEquals("/_session", sessionGetRequest.getPath(), "Should have been a _session " +
assertEquals(sessionGetRequest.getMethod(), "GET", "Should have been a GET request.");
assertEquals(sessionGetRequest.getPath(), "/_session", "Should have been a _session " +
"request.");
assertEquals(mockSession, sessionGetRequest.getHeader("Cookie"), "The cookie on the " +
assertEquals(sessionGetRequest.getHeader("Cookie"), mockSession, "The cookie on the " +
"request should be correct.");

// Additional assertions on the response
Expand All @@ -325,13 +321,11 @@ void requestToken() throws Exception {
assertTrue((Boolean) information.get("ok"), "The response should be OK.");
Map<String, Object> userCtx = (Map<String, Object>) information.get("userCtx");
assertNotNull(information.get("userCtx"), "There should be a user context.");
assertEquals("testuser", userCtx.get("name"), "The user should be " +
assertEquals(userCtx.get("name"), "testuser", "The user should be " +
"testuser.");
List<String> roles = (List<String>) userCtx.get("roles");
assertEquals("_admin", roles.get(0), "The role should be " +
assertEquals(roles.get(0), "_admin", "The role should be " +
"_admin");
} finally {
server.shutdown();
}
}

Expand All @@ -342,14 +336,12 @@ void requestToken() throws Exception {
*/
@Test
void requestTokenUnauthorized() throws Exception {
MockWebServer server = new MockWebServer();

MockResponse sessionPostErrorResponse = new MockResponse()
.setStatus("HTTP/1.1 401 UNAUTHORIZED")
.setBody("{\"error\":\"unauthorized\",\"reason\":\"Name or password is incorrect" +
".\"}");
server.start();
try {
try(MockWebServer server = new MockWebServer()) {
server.start();
server.getPort();
server.enqueue(sessionPostErrorResponse);

Expand All @@ -360,14 +352,12 @@ void requestTokenUnauthorized() throws Exception {
testCloudantService.getSessionInformation().execute().getResult();
fail("A ServiceResponseException should be thrown.");
} catch (ServiceResponseException e) {
assertEquals(401, e.getStatusCode(), "The status code should be 401.");
assertEquals("unauthorized", e.getMessage(), "The error should be " +
assertEquals(e.getStatusCode(), 401, "The status code should be 401.");
assertEquals(e.getMessage(), "unauthorized", "The error should be " +
"unauthorized.");
assertEquals("Name or password is incorrect.", e.getDebuggingInfo().get(
"reason"), "The reason should be as expected.");
assertEquals(e.getDebuggingInfo().get(
"reason"), "Name or password is incorrect.", "The reason should be as expected.");
}
} finally {
server.shutdown();
}
}

Expand All @@ -378,12 +368,10 @@ void requestTokenUnauthorized() throws Exception {
*/
@Test
void requestTokenNoCookie() throws Exception {
MockWebServer server = new MockWebServer();

MockResponse sessionPostErrorResponse = new MockResponse()
.setBody("{\"ok\": true}");
server.start();
try {
try(MockWebServer server = new MockWebServer();) {
server.start();
server.getPort();
server.enqueue(sessionPostErrorResponse);

Expand All @@ -393,10 +381,8 @@ void requestTokenNoCookie() throws Exception {
testCloudantService.getSessionInformation().execute().getResult();
fail("A ServiceResponseException should be thrown.");
} catch (ServiceResponseException e) {
assertEquals(200, e.getStatusCode(), "The status code should be 200.");
assertEquals(e.getStatusCode(), 200, "The status code should be 200.");
}
} finally {
server.shutdown();
}
}
}