# vim: tabstop=4 shiftwidth=4 softtabstop=4

# Copyright 2010 OpenStack LLC.
# All Rights Reserved.
#
#    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.

"""
Test suites for 'common' code used throughout the OpenStack HTTP API.
"""

import unittest

from webob import Request

from nova.api.openstack.common import limited


class LimiterTest(unittest.TestCase):
    """
    Unit tests for the `nova.api.openstack.common.limited` method which takes
    in a list of items and, depending on the 'offset' and 'limit' GET params,
    returns a subset or complete set of the given items.
    """

    def setUp(self):
        """
        Run before each test.
        """
        self.tiny = range(1)
        self.small = range(10)
        self.medium = range(1000)
        self.large = range(10000)

    def test_limiter_offset_zero(self):
        """
        Test offset key works with 0.
        """
        req = Request.blank('/?offset=0')
        self.assertEqual(limited(self.tiny, req), self.tiny)
        self.assertEqual(limited(self.small, req), self.small)
        self.assertEqual(limited(self.medium, req), self.medium)
        self.assertEqual(limited(self.large, req), self.large[:1000])

    def test_limiter_offset_medium(self):
        """
        Test offset key works with a medium sized number.
        """
        req = Request.blank('/?offset=10')
        self.assertEqual(limited(self.tiny, req), [])
        self.assertEqual(limited(self.small, req), self.small[10:])
        self.assertEqual(limited(self.medium, req), self.medium[10:])
        self.assertEqual(limited(self.large, req), self.large[10:1010])

    def test_limiter_offset_over_max(self):
        """
        Test offset key works with a number over 1000 (max_limit).
        """
        req = Request.blank('/?offset=1001')
        self.assertEqual(limited(self.tiny, req), [])
        self.assertEqual(limited(self.small, req), [])
        self.assertEqual(limited(self.medium, req), [])
        self.assertEqual(limited(self.large, req), self.large[1001:2001])

    def test_limiter_offset_blank(self):
        """
        Test offset key works with a blank offset.
        """
        req = Request.blank('/?offset=')
        self.assertEqual(limited(self.tiny, req), self.tiny)
        self.assertEqual(limited(self.small, req), self.small)
        self.assertEqual(limited(self.medium, req), self.medium)
        self.assertEqual(limited(self.large, req), self.large[:1000])

    def test_limiter_offset_bad(self):
        """
        Test offset key works with a BAD offset.
        """
        req = Request.blank(u'/?offset=\u0020aa')
        self.assertEqual(limited(self.tiny, req), self.tiny)
        self.assertEqual(limited(self.small, req), self.small)
        self.assertEqual(limited(self.medium, req), self.medium)
        self.assertEqual(limited(self.large, req), self.large[:1000])

    def test_limiter_nothing(self):
        """
        Test request with no offset or limit
        """
        req = Request.blank('/')
        self.assertEqual(limited(self.tiny, req), self.tiny)
        self.assertEqual(limited(self.small, req), self.small)
        self.assertEqual(limited(self.medium, req), self.medium)
        self.assertEqual(limited(self.large, req), self.large[:1000])

    def test_limiter_limit_zero(self):
        """
        Test limit of zero.
        """
        req = Request.blank('/?limit=0')
        self.assertEqual(limited(self.tiny, req), self.tiny)
        self.assertEqual(limited(self.small, req), self.small)
        self.assertEqual(limited(self.medium, req), self.medium)
        self.assertEqual(limited(self.large, req), self.large[:1000])

    def test_limiter_limit_medium(self):
        """
        Test limit of 10.
        """
        req = Request.blank('/?limit=10')
        self.assertEqual(limited(self.tiny, req), self.tiny)
        self.assertEqual(limited(self.small, req), self.small)
        self.assertEqual(limited(self.medium, req), self.medium[:10])
        self.assertEqual(limited(self.large, req), self.large[:10])

    def test_limiter_limit_over_max(self):
        """
        Test limit of 3000.
        """
        req = Request.blank('/?limit=3000')
        self.assertEqual(limited(self.tiny, req), self.tiny)
        self.assertEqual(limited(self.small, req), self.small)
        self.assertEqual(limited(self.medium, req), self.medium)
        self.assertEqual(limited(self.large, req), self.large[:1000])

    def test_limiter_limit_and_offset(self):
        """
        Test request with both limit and offset.
        """
        items = range(2000)
        req = Request.blank('/?offset=1&limit=3')
        self.assertEqual(limited(items, req), items[1:4])
        req = Request.blank('/?offset=3&limit=0')
        self.assertEqual(limited(items, req), items[3:1003])
        req = Request.blank('/?offset=3&limit=1500')
        self.assertEqual(limited(items, req), items[3:1003])
        req = Request.blank('/?offset=3000&limit=10')
        self.assertEqual(limited(items, req), [])

    def test_limiter_custom_max_limit(self):
        """
        Test a max_limit other than 1000.
        """
        items = range(2000)
        req = Request.blank('/?offset=1&limit=3')
        self.assertEqual(limited(items, req, max_limit=2000), items[1:4])
        req = Request.blank('/?offset=3&limit=0')
        self.assertEqual(limited(items, req, max_limit=2000), items[3:])
        req = Request.blank('/?offset=3&limit=2500')
        self.assertEqual(limited(items, req, max_limit=2000), items[3:])
        req = Request.blank('/?offset=3000&limit=10')
        self.assertEqual(limited(items, req, max_limit=2000), [])
