From 2ec4189e374d1f94009fc61c1b17d00d12f7e99b Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 19 Sep 2016 17:37:47 -0700
Subject: [PATCH] Fix when we set state in Spliterator

Also clean up a comment and some exception text

Change-Id: I1e7755cc0468f9a3ba96a0dd24868f09a10c3df0
Related-Change: I24716e3271cf3370642e3755447e717fd7d9957c
---
 swift/common/swob.py           |  2 ++
 swift/common/utils.py          | 13 ++++++++-----
 test/unit/common/test_utils.py | 30 ++++++++++++++++++++++++++++++
 3 files changed, 40 insertions(+), 5 deletions(-)

diff --git a/swift/common/swob.py b/swift/common/swob.py
index df66664a9d..cff5ff60bb 100644
--- a/swift/common/swob.py
+++ b/swift/common/swob.py
@@ -1246,6 +1246,8 @@ class Response(object):
             if ranges == []:
                 self.status = 416
                 close_if_possible(app_iter)
+                # Setting body + app_iter to None makes us emit the default
+                # body text from RESPONSE_REASONS.
                 body = None
                 app_iter = None
             elif ranges:
diff --git a/swift/common/utils.py b/swift/common/utils.py
index 24ec0f5faa..f931257788 100644
--- a/swift/common/utils.py
+++ b/swift/common/utils.py
@@ -3319,8 +3319,9 @@ class Spliterator(object):
 
     def take(self, n):
         if self._iterator_in_progress:
-            raise ValueError("cannot call take() again until the first"
-                             " iterator is exhausted")
+            raise ValueError(
+                "cannot call take() again until the first iterator is"
+                " exhausted (has raised StopIteration)")
         self._iterator_in_progress = True
 
         try:
@@ -3342,14 +3343,16 @@ class Spliterator(object):
                 llen = len(self.leftovers) - self.leftovers_index
                 if llen <= n:
                     n -= llen
-                    yield self.leftovers[self.leftovers_index:]
+                    to_yield = self.leftovers[self.leftovers_index:]
                     self.leftovers = None
                     self.leftovers_index = 0
+                    yield to_yield
                 else:
-                    yield self.leftovers[
+                    to_yield = self.leftovers[
                         self.leftovers_index:(self.leftovers_index + n)]
                     self.leftovers_index += n
                     n = 0
+                    yield to_yield
 
             while n > 0:
                 chunk = next(self.input_iterator)
@@ -3358,9 +3361,9 @@ class Spliterator(object):
                     n -= cl
                     yield chunk
                 else:
-                    yield chunk[:n]
                     self.leftovers = chunk
                     self.leftovers_index = n
+                    yield chunk[:n]
                     n = 0
         finally:
             self._iterator_in_progress = False
diff --git a/test/unit/common/test_utils.py b/test/unit/common/test_utils.py
index 85c3e2ed50..1f8dc73714 100644
--- a/test/unit/common/test_utils.py
+++ b/test/unit/common/test_utils.py
@@ -5396,6 +5396,36 @@ class TestSpliterator(unittest.TestCase):
         t2 = si.take(20)
         self.assertRaises(ValueError, next, t2)
 
+    def test_closing(self):
+        input_chunks = ["abcd", "efg", "hij"]
+
+        si = utils.Spliterator(input_chunks)
+        it = si.take(3)  # shorter than first chunk
+        self.assertEqual(next(it), 'abc')
+        it.close()
+        self.assertEqual(list(si.take(20)), ['d', 'efg', 'hij'])
+
+        si = utils.Spliterator(input_chunks)
+        self.assertEqual(list(si.take(1)), ['a'])
+        it = si.take(1)  # still shorter than first chunk
+        self.assertEqual(next(it), 'b')
+        it.close()
+        self.assertEqual(list(si.take(20)), ['cd', 'efg', 'hij'])
+
+        si = utils.Spliterator(input_chunks)
+        it = si.take(6)  # longer than first chunk, shorter than first + second
+        self.assertEqual(next(it), 'abcd')
+        self.assertEqual(next(it), 'ef')
+        it.close()
+        self.assertEqual(list(si.take(20)), ['g', 'hij'])
+
+        si = utils.Spliterator(input_chunks)
+        self.assertEqual(list(si.take(2)), ['ab'])
+        it = si.take(3)  # longer than rest of chunk
+        self.assertEqual(next(it), 'cd')
+        it.close()
+        self.assertEqual(list(si.take(20)), ['efg', 'hij'])
+
 
 class TestParseContentRange(unittest.TestCase):
     def test_good(self):