dsmiley commented on code in PR #4183: URL: https://github.com/apache/solr/pull/4183#discussion_r2906094675
########## solr/solrj/src/test/org/apache/solr/client/solrj/response/json/JacksonDataBindResponseParserTest.java: ########## @@ -0,0 +1,133 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.solr.client.solrj.response.json; + +import static org.hamcrest.Matchers.instanceOf; + +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.Map; +import org.apache.solr.SolrTestCase; +import org.apache.solr.client.api.model.SolrJerseyResponse; +import org.apache.solr.common.util.NamedList; +import org.junit.Test; + +/** Unit tests for {@link JacksonDataBindResponseParser} */ +public class JacksonDataBindResponseParserTest extends SolrTestCase { + + @Test + public void testSuccessfulResponseHasNoErrorKey() throws IOException { + final var parser = new JacksonDataBindResponseParser<>(SolrJerseyResponse.class); + final var json = "{\"responseHeader\":{\"status\":0,\"QTime\":5}}"; + + final NamedList<Object> result = parser.processResponse(toStream(json), null); + + assertNotNull(result.get("response")); + assertThat(result.get("response"), instanceOf(SolrJerseyResponse.class)); + assertNull("No 'error' key expected on success", result.get("error")); + } + + @Test + public void testErrorResponseSurfacesErrorAtTopLevel() throws IOException { + final var parser = new JacksonDataBindResponseParser<>(SolrJerseyResponse.class); + final var json = + "{" + + "\"responseHeader\":{\"status\":400,\"QTime\":3}," + + "\"error\":{" + + " \"code\":400," + + " \"errorClass\":\"org.apache.solr.common.SolrException\"," + + " \"msg\":\"Bad collection name\"" + + "}" + + "}"; + + final NamedList<Object> result = parser.processResponse(toStream(json), null); + + // The deserialized POJO is present under "response" + assertNotNull(result.get("response")); + assertThat(result.get("response"), instanceOf(SolrJerseyResponse.class)); + final var responsePojo = (SolrJerseyResponse) result.get("response"); + + // Error is present in the deserialized POJO + assertNotNull("Error should be populated in the POJO", responsePojo.error); + + // Error is also present on NL for clients to detect + assertNotNull(result.get("error")); + assertThat(result.get("error"), instanceOf(Map.class)); + @SuppressWarnings("unchecked") + final var topLevelError = (Map<String, Object>) result.get("error"); + assertEquals(400, topLevelError.get("code")); + assertEquals("org.apache.solr.common.SolrException", topLevelError.get("errorClass")); + assertEquals("Bad collection name", topLevelError.get("msg")); + } + + @Test + public void testErrorResponseIncludesMetadataAtTopLevel() throws IOException { + final var parser = new JacksonDataBindResponseParser<>(SolrJerseyResponse.class); + final var json = + """ + { + "responseHeader":{ + "status":500, + "QTime":1 + }, + "error": { + "code":500, + "errorClass": "org.apache.solr.common.SolrException", + "msg": "Internal error", + "metadata":{ + "error-class": "org.apache.solr.common.SolrException", + "root-error-class": "java.lang.IllegalStateException" + } + } + }"""; + + final NamedList<Object> result = parser.processResponse(toStream(json), null); + + @SuppressWarnings("unchecked") + final var topLevelError = (Map<String, Object>) result.get("error"); + assertNotNull(topLevelError); + + @SuppressWarnings("unchecked") + final var metadata = (Map<String, Object>) topLevelError.get("metadata"); + assertNotNull("Metadata must be present for RemoteSolrException to extract it", metadata); + assertEquals("org.apache.solr.common.SolrException", metadata.get("error-class")); + assertEquals("java.lang.IllegalStateException", metadata.get("root-error-class")); + } + + @Test + public void testNonJerseyResponseTypeIsUnaffected() throws IOException { Review Comment: I'm unsure what the practical impact of this is, or if its even worth testing what was out of scope. ########## solr/solrj/src/test/org/apache/solr/client/solrj/response/json/JacksonDataBindResponseParserTest.java: ########## @@ -0,0 +1,127 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.solr.client.solrj.response.json; + +import static org.hamcrest.Matchers.instanceOf; + +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.Map; +import org.apache.solr.SolrTestCase; +import org.apache.solr.client.api.model.SolrJerseyResponse; +import org.apache.solr.common.util.NamedList; +import org.junit.Test; + +/** Unit tests for {@link JacksonDataBindResponseParser} */ +public class JacksonDataBindResponseParserTest extends SolrTestCase { + + @Test + public void testSuccessfulResponseHasNoErrorKey() throws IOException { + final var parser = new JacksonDataBindResponseParser<>(SolrJerseyResponse.class); + final var json = "{\"responseHeader\":{\"status\":0,\"QTime\":5}}"; + + final NamedList<Object> result = parser.processResponse(toStream(json), null); + + assertNotNull(result.get("response")); + assertThat(result.get("response"), instanceOf(SolrJerseyResponse.class)); + assertNull("No 'error' key expected on success", result.get("error")); + } + + @Test + public void testErrorResponseSurfacesErrorAtTopLevel() throws IOException { + final var parser = new JacksonDataBindResponseParser<>(SolrJerseyResponse.class); + final var json = + "{" Review Comment: It's called multi-line strings. Not sure why this test isn't using them. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
