From 810b17ae06c88ef0fd289687de178d747153d0dd Mon Sep 17 00:00:00 2001 From: Spencer Gibb Date: Thu, 3 Dec 2015 11:00:11 -0700 Subject: [PATCH] Guard for null entity. redefine isSuccess to 2xx status code series. fixes gh-687 --- .../apache/RibbonApacheHttpResponse.java | 11 ++- .../apache/RibbonApacheHttpResponseTests.java | 72 +++++++++++++++++++ 2 files changed, 82 insertions(+), 1 deletion(-) create mode 100644 spring-cloud-netflix-core/src/test/java/org/springframework/cloud/netflix/ribbon/apache/RibbonApacheHttpResponseTests.java diff --git a/spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/ribbon/apache/RibbonApacheHttpResponse.java b/spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/ribbon/apache/RibbonApacheHttpResponse.java index 3cd0c037..a6367c91 100644 --- a/spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/ribbon/apache/RibbonApacheHttpResponse.java +++ b/spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/ribbon/apache/RibbonApacheHttpResponse.java @@ -28,6 +28,8 @@ import java.util.Map; import org.apache.http.Header; import org.apache.http.HttpResponse; +import org.springframework.http.HttpStatus; +import org.springframework.util.Assert; import com.google.common.reflect.TypeToken; import com.netflix.client.ClientException; @@ -43,6 +45,7 @@ public class RibbonApacheHttpResponse implements com.netflix.client.http.HttpRes private URI uri; public RibbonApacheHttpResponse(final HttpResponse httpResponse, final URI uri) { + Assert.notNull(httpResponse, "httpResponse can not be null"); this.httpResponse = httpResponse; this.uri = uri; } @@ -50,6 +53,9 @@ public class RibbonApacheHttpResponse implements com.netflix.client.http.HttpRes @Override public Object getPayload() throws ClientException { try { + if (!hasPayload()) { + return null; + } return this.httpResponse.getEntity().getContent(); } catch (final IOException e) { @@ -64,7 +70,7 @@ public class RibbonApacheHttpResponse implements com.netflix.client.http.HttpRes @Override public boolean isSuccess() { - return this.httpResponse.getStatusLine().getStatusCode() == 200; + return HttpStatus.valueOf(this.httpResponse.getStatusLine().getStatusCode()).is2xxSuccessful(); } @Override @@ -123,6 +129,9 @@ public class RibbonApacheHttpResponse implements com.netflix.client.http.HttpRes @Override public InputStream getInputStream() { try { + if (!hasPayload()) { + return null; + } return this.httpResponse.getEntity().getContent(); } catch (final IOException e) { diff --git a/spring-cloud-netflix-core/src/test/java/org/springframework/cloud/netflix/ribbon/apache/RibbonApacheHttpResponseTests.java b/spring-cloud-netflix-core/src/test/java/org/springframework/cloud/netflix/ribbon/apache/RibbonApacheHttpResponseTests.java new file mode 100644 index 00000000..58a8c57d --- /dev/null +++ b/spring-cloud-netflix-core/src/test/java/org/springframework/cloud/netflix/ribbon/apache/RibbonApacheHttpResponseTests.java @@ -0,0 +1,72 @@ +/* + * Copyright 2013-2015 the original author or authors. + * + * Licensed 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.springframework.cloud.netflix.ribbon.apache; + +import java.io.ByteArrayInputStream; +import java.net.URI; + +import org.apache.http.HttpResponse; +import org.apache.http.StatusLine; +import org.apache.http.entity.BasicHttpEntity; +import org.junit.Test; + +import static org.hamcrest.Matchers.is; +import static org.hamcrest.Matchers.notNullValue; +import static org.hamcrest.Matchers.nullValue; +import static org.junit.Assert.assertThat; +import static org.mockito.BDDMockito.given; +import static org.mockito.BDDMockito.mock; + +/** + * @author Spencer Gibb + */ +public class RibbonApacheHttpResponseTests { + + @Test + public void testNullEntity() throws Exception { + StatusLine statusLine = mock(StatusLine.class); + given(statusLine.getStatusCode()).willReturn(204); + HttpResponse response = mock(HttpResponse.class); + given(response.getStatusLine()).willReturn(statusLine); + + RibbonApacheHttpResponse httpResponse = new RibbonApacheHttpResponse(response, URI.create("http://example.com")); + + assertThat(httpResponse.isSuccess(), is(true)); + assertThat(httpResponse.hasPayload(), is(false)); + assertThat(httpResponse.getPayload(), is(nullValue())); + assertThat(httpResponse.getInputStream(), is(nullValue())); + } + + + @Test + public void testNotNullEntity() throws Exception { + StatusLine statusLine = mock(StatusLine.class); + given(statusLine.getStatusCode()).willReturn(204); + HttpResponse response = mock(HttpResponse.class); + given(response.getStatusLine()).willReturn(statusLine); + BasicHttpEntity entity = new BasicHttpEntity(); + entity.setContent(new ByteArrayInputStream(new byte[0])); + given(response.getEntity()).willReturn(entity); + + RibbonApacheHttpResponse httpResponse = new RibbonApacheHttpResponse(response, URI.create("http://example.com")); + + assertThat(httpResponse.isSuccess(), is(true)); + assertThat(httpResponse.hasPayload(), is(true)); + assertThat(httpResponse.getPayload(), is(notNullValue())); + assertThat(httpResponse.getInputStream(), is(notNullValue())); + } +}