Add HttpRange tests, set Accept-Range header, polish

Issue: SPR-10805

Author: rstoyanchev

spring-web/src/main/java/org/springframework/http/HttpRange.java

@@ -27,7 +27,7 @@
 import org.springframework.util.StringUtils;
 
 /**
- * Represents an HTTP (byte) range, as used in the {@code Range} header.
+ * Represents an HTTP (byte) range for use with the HTTP {@code "Range"} header.
  *
  * @author Arjen Poutsma
  * @see <a href="http://tools.ietf.org/html/rfc7233">HTTP/1.1: Range Requests</a>
@@ -41,57 +41,51 @@ public abstract class HttpRange {
 
 
 	/**
-	 * Creates a {@code HttpRange} that ranges from the given position to the end of the
-	 * representation.
+	 * Return the start of the range given the total length of a representation.
+	 * @param length the length of the representation
+	 * @return the start of this range for the representation
+	 */
+	public abstract long getRangeStart(long length);
+
+	/**
+	 * Return the end of the range (inclusive) given the total length of a representation.
+	 * @param length the length of the representation
+	 * @return the end of the range for the representation
+	 */
+	public abstract long getRangeEnd(long length);
+
+
+	/**
+	 * Create an {@code HttpRange} from the given position to the end.
 	 * @param firstBytePos the first byte position
-	 * @return a byte range that ranges from {@code firstBytePos} till the end
+	 * @return a byte range that ranges from {@code firstPos} till the end
 	 * @see <a href="http://tools.ietf.org/html/rfc7233#section-2.1">Byte Ranges</a>
 	 */
 	public static HttpRange createByteRange(long firstBytePos) {
 		return new ByteRange(firstBytePos, null);
 	}
 
 	/**
-	 * Creates a {@code HttpRange} that ranges from the given fist position to the given
-	 * last position.
+	 * Create a {@code HttpRange} from the given fist to last position.
 	 * @param firstBytePos the first byte position
 	 * @param lastBytePos the last byte position
-	 * @return a byte range that ranges from {@code firstBytePos} till {@code lastBytePos}
+	 * @return a byte range that ranges from {@code firstPos} till {@code lastPos}
 	 * @see <a href="http://tools.ietf.org/html/rfc7233#section-2.1">Byte Ranges</a>
 	 */
 	public static HttpRange createByteRange(long firstBytePos, long lastBytePos) {
-		Assert.isTrue(firstBytePos <= lastBytePos,
-				"\"firstBytePost\" should be " + "less then or equal to \"lastBytePos\"");
 		return new ByteRange(firstBytePos, lastBytePos);
 	}
 
 	/**
-	 * Creates a {@code HttpRange} that ranges over the last given number of bytes.
-	 * @param suffixLength the number of bytes
+	 * Create an {@code HttpRange} that ranges over the last given number of bytes.
+	 * @param suffixLength the number of bytes for the range
 	 * @return a byte range that ranges over the last {@code suffixLength} number of bytes
 	 * @see <a href="http://tools.ietf.org/html/rfc7233#section-2.1">Byte Ranges</a>
 	 */
 	public static HttpRange createSuffixRange(long suffixLength) {
 		return new SuffixByteRange(suffixLength);
 	}
 
-
-	/**
-	 * Return the start of this range, given the total length of the representation.
-	 * @param length the length of the representation.
-	 * @return the start of this range
-	 */
-	public abstract long getRangeStart(long length);
-
-	/**
-	 * Return the end of this range (inclusive), given the total length of the
-	 * representation.
-	 * @param length the length of the representation.
-	 * @return the end of this range
-	 */
-	public abstract long getRangeEnd(long length);
-
-
 	/**
 	 * Parse the given, comma-separated string into a list of {@code HttpRange} objects.
 	 * <p>This method can be used to parse an {@code Range} header.
@@ -104,8 +98,7 @@ public static List<HttpRange> parseRanges(String ranges) {
 			return Collections.emptyList();
 		}
 		if (!ranges.startsWith(BYTE_RANGE_PREFIX)) {
-			throw new IllegalArgumentException("Range \"" + ranges + "\" does not " +
-					"start with \"" + BYTE_RANGE_PREFIX + "\"");
+			throw new IllegalArgumentException("Range '" + ranges + "' does not start with 'bytes='");
 		}
 		ranges = ranges.substring(BYTE_RANGE_PREFIX.length());
 
@@ -118,36 +111,25 @@ public static List<HttpRange> parseRanges(String ranges) {
 	}
 
 	private static HttpRange parseRange(String range) {
-		if (range == null) {
-			return null;
-		}
+		Assert.notNull(range);
 		int dashIdx = range.indexOf('-');
-		if (dashIdx < 0) {
-			throw new IllegalArgumentException("Range '\"" + range + "\" does not" +
-					"contain \"-\"");
-		}
-		else if (dashIdx > 0) {
-			// standard byte range, i.e. "bytes=0-500"
+		if (dashIdx > 0) {
 			long firstPos = Long.parseLong(range.substring(0, dashIdx));
-			ByteRange byteRange;
 			if (dashIdx < range.length() - 1) {
-				long lastPos =
-						Long.parseLong(range.substring(dashIdx + 1, range.length()));
-				byteRange = new ByteRange(firstPos, lastPos);
+				Long lastPos = Long.parseLong(range.substring(dashIdx + 1, range.length()));
+				return new ByteRange(firstPos, lastPos);
 			}
 			else {
-				byteRange = new ByteRange(firstPos, null);
+				return new ByteRange(firstPos, null);
 			}
-			if (!byteRange.validate()) {
-				throw new IllegalArgumentException("Invalid Range \"" + range + "\"");
-			}
-			return byteRange;
 		}
-		else { // dashIdx == 0
-			// suffix byte range, i.e. "bytes=-500"
+		else if (dashIdx == 0) {
 			long suffixLength = Long.parseLong(range.substring(1));
 			return new SuffixByteRange(suffixLength);
 		}
+		else {
+			throw new IllegalArgumentException("Range '" + range + "' does not contain \"-\"");
+		}
 	}
 
 	/**
@@ -157,6 +139,7 @@ else if (dashIdx > 0) {
 	 * @return the string representation
 	 */
 	public static String toString(Collection<HttpRange> ranges) {
+		Assert.notNull(ranges);
 		StringBuilder builder = new StringBuilder(BYTE_RANGE_PREFIX);
 		for (Iterator<HttpRange> iterator = ranges.iterator(); iterator.hasNext(); ) {
 			HttpRange range = iterator.next();
@@ -177,6 +160,7 @@ public String toString() {
 
 	abstract void appendTo(StringBuilder builder);
 
+
 	/**
 	 * Represents an HTTP/1.1 byte range, with a first and optional last position.
 	 * @see <a href="http://tools.ietf.org/html/rfc7233#section-2.1">Byte Ranges</a>
@@ -189,11 +173,23 @@ private static class ByteRange extends HttpRange {
 
 		private final Long lastPos;
 
+
 		private ByteRange(long firstPos, Long lastPos) {
+			assertPositions(firstPos, lastPos);
 			this.firstPos = firstPos;
 			this.lastPos = lastPos;
 		}
 
+		private void assertPositions(long firstBytePos, Long lastBytePos) {
+			if (firstBytePos < 0) {
+				throw new IllegalArgumentException("Invalid firstPos=" + firstBytePos);
+			}
+			if (lastBytePos != null && lastBytePos < firstBytePos) {
+				throw new IllegalArgumentException("firstPost= " + firstBytePos +
+						" should be less then or equal to lastBytePosition=" + lastBytePos);
+			}
+		}
+
 		@Override
 		public long getRangeStart(long length) {
 			return this.firstPos;
@@ -206,7 +202,6 @@ public long getRangeEnd(long length) {
 			}
 			else {
 				return length - 1;
-
 			}
 		}
 
@@ -219,18 +214,6 @@ void appendTo(StringBuilder builder) {
 			}
 		}
 
-		boolean validate() {
-			if (this.firstPos < 0) {
-				return false;
-			}
-			if (this.lastPos == null) {
-				return true;
-			}
-			else {
-				return this.firstPos <= this.lastPos;
-			}
-		}
-
 		@Override
 		public boolean equals(Object o) {
 			if (this == o) {
@@ -239,11 +222,8 @@ public boolean equals(Object o) {
 			if (!(o instanceof ByteRange)) {
 				return false;
 			}
-
 			ByteRange other = (ByteRange) o;
-
-			return this.firstPos == other.firstPos &&
-					ObjectUtils.nullSafeEquals(this.lastPos, other.lastPos);
+			return this.firstPos == other.firstPos && ObjectUtils.nullSafeEquals(this.lastPos, other.lastPos);
 		}
 
 		@Override
@@ -252,7 +232,6 @@ public int hashCode() {
 			hashCode = 31 * hashCode + ObjectUtils.nullSafeHashCode(this.lastPos);
 			return hashCode;
 		}
-
 	}
 
 	/**
@@ -264,15 +243,14 @@ private static class SuffixByteRange extends HttpRange {
 
 		private final long suffixLength;
 
+
 		private SuffixByteRange(long suffixLength) {
+			if (suffixLength < 0) {
+				throw new IllegalArgumentException("Invalid suffixLength=" + suffixLength);
+			}
 			this.suffixLength = suffixLength;
 		}
 
-		@Override
-		void appendTo(StringBuilder builder) {
-			builder.append('-');
-			builder.append(this.suffixLength);
-		}
 
 		@Override
 		public long getRangeStart(long length) {
@@ -289,6 +267,12 @@ public long getRangeEnd(long length) {
 			return length - 1;
 		}
 
+		@Override
+		void appendTo(StringBuilder builder) {
+			builder.append('-');
+			builder.append(this.suffixLength);
+		}
+
 		@Override
 		public boolean equals(Object o) {
 			if (this == o) {

spring-web/src/test/java/org/springframework/http/HttpHeadersTests.java

@@ -36,6 +36,7 @@
 import org.junit.Test;
 
 /**
+ * Unit tests for {@link org.springframework.http.HttpHeaders}.
  * @author Arjen Poutsma
  */
 public class HttpHeadersTests {
@@ -266,16 +267,4 @@ public void getAllowEmptySet() {
 		assertThat(headers.getAllow(), Matchers.emptyCollectionOf(HttpMethod.class));
 	}
 
-	@Test
-	public void range() {
-		List<HttpRange> ranges = new ArrayList<>();
-		ranges.add(HttpRange.createByteRange(0, 499));
-		ranges.add(HttpRange.createByteRange(9500));
-		ranges.add(HttpRange.createSuffixRange(500));
-
-		headers.setRange(ranges);
-		assertEquals("Invalid Range header", ranges, headers.getRange());
-		assertEquals("Invalid Range header", "bytes=0-499, 9500-, -500", headers.getFirst("Range"));
-	}
-
 }

spring-web/src/test/java/org/springframework/http/HttpRangeTests.java

@@ -0,0 +1,103 @@
+/*
+ * Copyright 2002-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.http;
+
+import static org.junit.Assert.*;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.junit.Test;
+
+/**
+ * Unit tests for {@link org.springframework.http.HttpRange}.
+ * @author Rossen Stoyanchev
+ */
+public class HttpRangeTests {
+
+
+	@Test(expected = IllegalArgumentException.class)
+	public void invalidFirstPosition() throws Exception {
+		HttpRange.createByteRange(-1);
+	}
+
+	@Test(expected = IllegalArgumentException.class)
+	public void invalidLastLessThanFirst() throws Exception {
+		HttpRange.createByteRange(10, 9);
+	}
+
+	@Test(expected = IllegalArgumentException.class)
+	public void invalidSuffixLength() throws Exception {
+		HttpRange.createSuffixRange(-1);
+	}
+
+	@Test
+	public void byteRange() throws Exception {
+		HttpRange range = HttpRange.createByteRange(0, 499);
+		assertEquals(0, range.getRangeStart(1000));
+		assertEquals(499, range.getRangeEnd(1000));
+	}
+
+	@Test
+	public void byteRangeWithoutLastPosition() throws Exception {
+		HttpRange range = HttpRange.createByteRange(9500);
+		assertEquals(9500, range.getRangeStart(10000));
+		assertEquals(9999, range.getRangeEnd(10000));
+	}
+
+	@Test
+	public void byteRangeOfZeroLength() throws Exception {
+		HttpRange range = HttpRange.createByteRange(9500, 9500);
+		assertEquals(9500, range.getRangeStart(10000));
+		assertEquals(9500, range.getRangeEnd(10000));
+	}
+
+	@Test
+	public void suffixRange() throws Exception {
+		HttpRange range = HttpRange.createSuffixRange(500);
+		assertEquals(500, range.getRangeStart(1000));
+		assertEquals(999, range.getRangeEnd(1000));
+	}
+
+	@Test
+	public void suffixRangeShorterThanRepresentation() throws Exception {
+		HttpRange range = HttpRange.createSuffixRange(500);
+		assertEquals(0, range.getRangeStart(350));
+		assertEquals(349, range.getRangeEnd(350));
+	}
+
+	@Test
+	public void parseRanges() throws Exception {
+		List<HttpRange> ranges = HttpRange.parseRanges("bytes=0-0,500-,-1");
+		assertEquals(3, ranges.size());
+		assertEquals(0, ranges.get(0).getRangeStart(1000));
+		assertEquals(0, ranges.get(0).getRangeEnd(1000));
+		assertEquals(500, ranges.get(1).getRangeStart(1000));
+		assertEquals(999, ranges.get(1).getRangeEnd(1000));
+		assertEquals(999, ranges.get(2).getRangeStart(1000));
+		assertEquals(999, ranges.get(2).getRangeEnd(1000));
+	}
+
+	@Test
+	public void rangeToString() {
+		List<HttpRange> ranges = new ArrayList<>();
+		ranges.add(HttpRange.createByteRange(0, 499));
+		ranges.add(HttpRange.createByteRange(9500));
+		ranges.add(HttpRange.createSuffixRange(500));
+		assertEquals("Invalid Range header", "bytes=0-499, 9500-, -500", HttpRange.toString(ranges));
+	}
+
+}