2428d78a15
The Glance API supports a sort direction which we can use to paginate back The Prev href tag contains a marker id of the first item in the table. When clicked, a GET API call is made, passing in this marker and the sort_dir='asc' This will return the previous page's data. Then we have to re-sort the data because it is ordered backwards. We use the default sort_key='created_by' for this. Once the patch #1252649 is restored, we can add the same behavior to Project > Images. If we are able to get the consistency across the APIs to include the sort_dir, then we can bring Prev to the other project tables as well. There are some blueprints to enhance API capabilities in this area. Change-Id: I3e7c6a2db595838dbdff595dc8f0fdda288b6bcf Partial-Bug: #1263142 Partial-Bug: #1282987 Partially-implements: blueprint pagination-add-prev-link
250 lines
10 KiB
Python
250 lines
10 KiB
Python
# Copyright 2012 United States Government as represented by the
|
|
# Administrator of the National Aeronautics and Space Administration.
|
|
# All Rights Reserved.
|
|
#
|
|
# Copyright 2012 Nebula, Inc.
|
|
#
|
|
# 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.
|
|
|
|
from django.conf import settings
|
|
from django.test.utils import override_settings
|
|
|
|
from openstack_dashboard import api
|
|
from openstack_dashboard.test import helpers as test
|
|
|
|
|
|
class GlanceApiTests(test.APITestCase):
|
|
@override_settings(API_RESULT_PAGE_SIZE=2)
|
|
def test_image_list_detailed_no_pagination(self):
|
|
# Verify that all images are returned even with a small page size
|
|
api_images = self.images.list()
|
|
filters = {}
|
|
limit = getattr(settings, 'API_RESULT_LIMIT', 1000)
|
|
|
|
glanceclient = self.stub_glanceclient()
|
|
glanceclient.images = self.mox.CreateMockAnything()
|
|
glanceclient.images.list(page_size=limit,
|
|
limit=limit,
|
|
filters=filters,
|
|
sort_dir='desc',
|
|
sort_key='created_at',) \
|
|
.AndReturn(iter(api_images))
|
|
self.mox.ReplayAll()
|
|
|
|
images, has_more, has_prev = api.glance.image_list_detailed(
|
|
self.request)
|
|
self.assertItemsEqual(images, api_images)
|
|
self.assertFalse(has_more)
|
|
self.assertFalse(has_prev)
|
|
|
|
@override_settings(API_RESULT_PAGE_SIZE=2)
|
|
def test_image_list_detailed_sort_options(self):
|
|
# Verify that sort_dir and sort_key work
|
|
api_images = self.images.list()
|
|
filters = {}
|
|
limit = getattr(settings, 'API_RESULT_LIMIT', 1000)
|
|
sort_dir = 'asc'
|
|
sort_key = 'min_disk'
|
|
|
|
glanceclient = self.stub_glanceclient()
|
|
glanceclient.images = self.mox.CreateMockAnything()
|
|
glanceclient.images.list(page_size=limit,
|
|
limit=limit,
|
|
filters=filters,
|
|
sort_dir=sort_dir,
|
|
sort_key=sort_key) \
|
|
.AndReturn(iter(api_images))
|
|
self.mox.ReplayAll()
|
|
|
|
images, has_more, has_prev = api.glance.image_list_detailed(
|
|
self.request,
|
|
sort_dir=sort_dir,
|
|
sort_key=sort_key)
|
|
self.assertItemsEqual(images, api_images)
|
|
self.assertFalse(has_more)
|
|
self.assertFalse(has_prev)
|
|
|
|
@override_settings(API_RESULT_PAGE_SIZE=2)
|
|
def test_image_list_detailed_pagination_more_page_size(self):
|
|
# The total snapshot count is over page size, should return
|
|
# page_size images.
|
|
filters = {}
|
|
page_size = settings.API_RESULT_PAGE_SIZE
|
|
limit = getattr(settings, 'API_RESULT_LIMIT', 1000)
|
|
|
|
api_images = self.images.list()
|
|
images_iter = iter(api_images)
|
|
|
|
glanceclient = self.stub_glanceclient()
|
|
glanceclient.images = self.mox.CreateMockAnything()
|
|
# Pass back all images, ignoring filters
|
|
glanceclient.images.list(limit=limit,
|
|
page_size=page_size + 1,
|
|
filters=filters,
|
|
sort_dir='desc',
|
|
sort_key='created_at',).AndReturn(images_iter)
|
|
self.mox.ReplayAll()
|
|
|
|
images, has_more, has_prev = api.glance.image_list_detailed(
|
|
self.request,
|
|
marker=None,
|
|
filters=filters,
|
|
paginate=True)
|
|
expected_images = api_images[:page_size]
|
|
self.assertItemsEqual(images, expected_images)
|
|
self.assertTrue(has_more)
|
|
self.assertFalse(has_prev)
|
|
# Ensure that only the needed number of images are consumed
|
|
# from the iterator (page_size + 1).
|
|
self.assertEqual(len(list(images_iter)),
|
|
len(api_images) - len(expected_images) - 1)
|
|
|
|
@override_settings(API_RESULT_PAGE_SIZE=20)
|
|
def test_image_list_detailed_pagination_less_page_size(self):
|
|
# The total image count is less than page size, should return images
|
|
# more, prev should return False.
|
|
filters = {}
|
|
page_size = settings.API_RESULT_PAGE_SIZE
|
|
limit = getattr(settings, 'API_RESULT_LIMIT', 1000)
|
|
|
|
api_images = self.images.list()
|
|
images_iter = iter(api_images)
|
|
|
|
glanceclient = self.stub_glanceclient()
|
|
glanceclient.images = self.mox.CreateMockAnything()
|
|
# Pass back all images, ignoring filters
|
|
glanceclient.images.list(limit=limit,
|
|
page_size=page_size + 1,
|
|
filters=filters,
|
|
sort_dir='desc',
|
|
sort_key='created_at',).AndReturn(images_iter)
|
|
self.mox.ReplayAll()
|
|
|
|
images, has_more, has_prev = api.glance.image_list_detailed(
|
|
self.request,
|
|
filters=filters,
|
|
paginate=True)
|
|
expected_images = api_images[:page_size]
|
|
self.assertItemsEqual(images, expected_images)
|
|
self.assertFalse(has_more)
|
|
self.assertFalse(has_prev)
|
|
|
|
@override_settings(API_RESULT_PAGE_SIZE=9)
|
|
def test_image_list_detailed_pagination_equal_page_size(self):
|
|
# The total image count equals page size, should return
|
|
# page_size images. more, prev should return False
|
|
filters = {}
|
|
page_size = settings.API_RESULT_PAGE_SIZE
|
|
limit = getattr(settings, 'API_RESULT_LIMIT', 1000)
|
|
|
|
api_images = self.images.list()
|
|
images_iter = iter(api_images)
|
|
|
|
glanceclient = self.stub_glanceclient()
|
|
glanceclient.images = self.mox.CreateMockAnything()
|
|
glanceclient.images.list(limit=limit,
|
|
page_size=page_size + 1,
|
|
filters=filters,
|
|
sort_dir='desc',
|
|
sort_key='created_at',).AndReturn(images_iter)
|
|
self.mox.ReplayAll()
|
|
|
|
images, has_more, has_prev = api.glance.image_list_detailed(
|
|
self.request,
|
|
filters=filters,
|
|
paginate=True)
|
|
expected_images = api_images[:page_size]
|
|
self.assertItemsEqual(images, expected_images)
|
|
self.assertFalse(has_more)
|
|
self.assertFalse(has_prev)
|
|
self.assertEqual(len(expected_images), len(images))
|
|
|
|
@override_settings(API_RESULT_PAGE_SIZE=2)
|
|
def test_image_list_detailed_pagination_marker(self):
|
|
# Tests getting a second page with a marker.
|
|
filters = {}
|
|
page_size = settings.API_RESULT_PAGE_SIZE
|
|
limit = getattr(settings, 'API_RESULT_LIMIT', 1000)
|
|
marker = 'nonsense'
|
|
|
|
api_images = self.images.list()[page_size:]
|
|
images_iter = iter(api_images)
|
|
|
|
glanceclient = self.stub_glanceclient()
|
|
glanceclient.images = self.mox.CreateMockAnything()
|
|
# Pass back all images, ignoring filters
|
|
glanceclient.images.list(limit=limit,
|
|
page_size=page_size + 1,
|
|
filters=filters,
|
|
marker=marker,
|
|
sort_dir='desc',
|
|
sort_key='created_at',) \
|
|
.AndReturn(images_iter)
|
|
self.mox.ReplayAll()
|
|
|
|
images, has_more, has_prev = api.glance.image_list_detailed(
|
|
self.request,
|
|
marker=marker,
|
|
filters=filters,
|
|
paginate=True)
|
|
expected_images = api_images[:page_size]
|
|
self.assertItemsEqual(images, expected_images)
|
|
self.assertTrue(has_more)
|
|
self.assertTrue(has_prev)
|
|
self.assertEqual(len(list(images_iter)),
|
|
len(api_images) - len(expected_images) - 1)
|
|
|
|
@override_settings(API_RESULT_PAGE_SIZE=2)
|
|
def test_image_list_detailed_pagination_marker_prev(self):
|
|
# Tests getting previous page with a marker.
|
|
filters = {}
|
|
page_size = settings.API_RESULT_PAGE_SIZE
|
|
limit = getattr(settings, 'API_RESULT_LIMIT', 1000)
|
|
marker = 'nonsense'
|
|
|
|
api_images = self.images.list()[page_size:]
|
|
images_iter = iter(api_images)
|
|
|
|
glanceclient = self.stub_glanceclient()
|
|
glanceclient.images = self.mox.CreateMockAnything()
|
|
# Pass back all images, ignoring filters
|
|
glanceclient.images.list(limit=limit,
|
|
page_size=page_size + 1,
|
|
marker=marker,
|
|
filters=filters,
|
|
sort_dir='asc',
|
|
sort_key='created_at',) \
|
|
.AndReturn(images_iter)
|
|
self.mox.ReplayAll()
|
|
|
|
images, has_more, has_prev = api.glance.image_list_detailed(
|
|
self.request,
|
|
marker=marker,
|
|
filters=filters,
|
|
sort_dir='asc',
|
|
paginate=True)
|
|
expected_images = api_images[:page_size]
|
|
self.assertItemsEqual(images, expected_images)
|
|
self.assertTrue(has_more)
|
|
self.assertTrue(has_prev)
|
|
self.assertEqual(len(list(images_iter)),
|
|
len(api_images) - len(expected_images) - 1)
|
|
|
|
def test_get_image_empty_name(self):
|
|
glanceclient = self.stub_glanceclient()
|
|
glanceclient.images = self.mox.CreateMockAnything()
|
|
glanceclient.images.get('empty').AndReturn(self.empty_name_image)
|
|
self.mox.ReplayAll()
|
|
image = api.glance.image_get(self.request, 'empty')
|
|
self.assertIsNone(image.name)
|