33065c16f6
For currently, the timestamp in query fields is not unified, this patch standardizes the usage of timestamp query fileds: - unify the time query filed in API to *timestamp* supported only. - unify the time related fileds of filters to start_timestamp and end_timestamp to simplify the process logic. - improve the _query_to_kwargs method to give explicit presentation if user specifies unsupported query fields. Change-Id: Ic3ade312efa89edd01d2ee5ae31d341805b11f79 Closes-bug: #1295104 Closes-bug: #1291171
410 lines
16 KiB
Python
410 lines
16 KiB
Python
# Copyright 2013 OpenStack Foundation.
|
|
# All Rights Reserved.
|
|
# Copyright 2013 IBM Corp.
|
|
#
|
|
# 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 the methods related to query."""
|
|
import datetime
|
|
|
|
import fixtures
|
|
import mock
|
|
from oslo.utils import timeutils
|
|
from oslotest import base
|
|
from oslotest import mockpatch
|
|
import wsme
|
|
|
|
from ceilometer.alarm.storage import base as alarm_storage_base
|
|
from ceilometer.api.controllers import v2 as api
|
|
from ceilometer import storage
|
|
from ceilometer.storage import base as storage_base
|
|
from ceilometer.tests import base as tests_base
|
|
|
|
|
|
class TestQuery(base.BaseTestCase):
|
|
def setUp(self):
|
|
super(TestQuery, self).setUp()
|
|
self.useFixture(fixtures.MonkeyPatch(
|
|
'pecan.response', mock.MagicMock()))
|
|
|
|
def test_get_value_as_type_with_integer(self):
|
|
query = api.Query(field='metadata.size',
|
|
op='eq',
|
|
value='123',
|
|
type='integer')
|
|
expected = 123
|
|
self.assertEqual(expected, query._get_value_as_type())
|
|
|
|
def test_get_value_as_type_with_float(self):
|
|
query = api.Query(field='metadata.size',
|
|
op='eq',
|
|
value='123.456',
|
|
type='float')
|
|
expected = 123.456
|
|
self.assertEqual(expected, query._get_value_as_type())
|
|
|
|
def test_get_value_as_type_with_boolean(self):
|
|
query = api.Query(field='metadata.is_public',
|
|
op='eq',
|
|
value='True',
|
|
type='boolean')
|
|
expected = True
|
|
self.assertEqual(expected, query._get_value_as_type())
|
|
|
|
def test_get_value_as_type_with_string(self):
|
|
query = api.Query(field='metadata.name',
|
|
op='eq',
|
|
value='linux',
|
|
type='string')
|
|
expected = 'linux'
|
|
self.assertEqual(expected, query._get_value_as_type())
|
|
|
|
def test_get_value_as_type_with_integer_without_type(self):
|
|
query = api.Query(field='metadata.size',
|
|
op='eq',
|
|
value='123')
|
|
expected = 123
|
|
self.assertEqual(expected, query._get_value_as_type())
|
|
|
|
def test_get_value_as_type_with_float_without_type(self):
|
|
query = api.Query(field='metadata.size',
|
|
op='eq',
|
|
value='123.456')
|
|
expected = 123.456
|
|
self.assertEqual(expected, query._get_value_as_type())
|
|
|
|
def test_get_value_as_type_with_boolean_without_type(self):
|
|
query = api.Query(field='metadata.is_public',
|
|
op='eq',
|
|
value='True')
|
|
expected = True
|
|
self.assertEqual(expected, query._get_value_as_type())
|
|
|
|
def test_get_value_as_type_with_string_without_type(self):
|
|
query = api.Query(field='metadata.name',
|
|
op='eq',
|
|
value='linux')
|
|
expected = 'linux'
|
|
self.assertEqual(expected, query._get_value_as_type())
|
|
|
|
def test_get_value_as_type_with_bad_type(self):
|
|
query = api.Query(field='metadata.size',
|
|
op='eq',
|
|
value='123.456',
|
|
type='blob')
|
|
self.assertRaises(wsme.exc.ClientSideError, query._get_value_as_type)
|
|
|
|
def test_get_value_as_type_with_bad_value(self):
|
|
query = api.Query(field='metadata.size',
|
|
op='eq',
|
|
value='fake',
|
|
type='integer')
|
|
self.assertRaises(wsme.exc.ClientSideError, query._get_value_as_type)
|
|
|
|
def test_get_value_as_type_integer_expression_without_type(self):
|
|
# bug 1221736
|
|
query = api.Query(field='should_be_a_string',
|
|
op='eq',
|
|
value='123-1')
|
|
expected = '123-1'
|
|
self.assertEqual(expected, query._get_value_as_type())
|
|
|
|
def test_get_value_as_type_boolean_expression_without_type(self):
|
|
# bug 1221736
|
|
query = api.Query(field='should_be_a_string',
|
|
op='eq',
|
|
value='True or False')
|
|
expected = 'True or False'
|
|
self.assertEqual(expected, query._get_value_as_type())
|
|
|
|
def test_get_value_as_type_with_syntax_error(self):
|
|
# bug 1221736
|
|
value = 'WWW-Layer-4a80714f-0232-4580-aa5e-81494d1a4147-uolhh25p5xxm'
|
|
query = api.Query(field='group_id',
|
|
op='eq',
|
|
value=value)
|
|
expected = value
|
|
self.assertEqual(expected, query._get_value_as_type())
|
|
|
|
def test_get_value_as_type_with_syntax_error_colons(self):
|
|
# bug 1221736
|
|
value = 'Ref::StackId'
|
|
query = api.Query(field='field_name',
|
|
op='eq',
|
|
value=value)
|
|
expected = value
|
|
self.assertEqual(expected, query._get_value_as_type())
|
|
|
|
|
|
class TestValidateGroupByFields(base.BaseTestCase):
|
|
|
|
def test_valid_field(self):
|
|
result = api._validate_groupby_fields(['user_id'])
|
|
self.assertEqual(['user_id'], result)
|
|
|
|
def test_valid_fields_multiple(self):
|
|
result = set(
|
|
api._validate_groupby_fields(['user_id', 'project_id', 'source'])
|
|
)
|
|
self.assertEqual(set(['user_id', 'project_id', 'source']), result)
|
|
|
|
def test_invalid_field(self):
|
|
self.assertRaises(wsme.exc.UnknownArgument,
|
|
api._validate_groupby_fields,
|
|
['wtf'])
|
|
|
|
def test_invalid_field_multiple(self):
|
|
self.assertRaises(wsme.exc.UnknownArgument,
|
|
api._validate_groupby_fields,
|
|
['user_id', 'wtf', 'project_id', 'source'])
|
|
|
|
def test_duplicate_fields(self):
|
|
result = set(
|
|
api._validate_groupby_fields(['user_id', 'source', 'user_id'])
|
|
)
|
|
self.assertEqual(set(['user_id', 'source']), result)
|
|
|
|
|
|
class TestQueryToKwArgs(tests_base.BaseTestCase):
|
|
def setUp(self):
|
|
super(TestQueryToKwArgs, self).setUp()
|
|
self.useFixture(mockpatch.PatchObject(
|
|
api, '_sanitize_query', side_effect=lambda x, y, **z: x))
|
|
self.useFixture(mockpatch.PatchObject(
|
|
api, '_verify_query_segregation', side_effect=lambda x, **z: x))
|
|
|
|
def test_sample_filter_single(self):
|
|
q = [api.Query(field='user_id',
|
|
op='eq',
|
|
value='uid')]
|
|
kwargs = api._query_to_kwargs(q, storage.SampleFilter.__init__)
|
|
self.assertIn('user', kwargs)
|
|
self.assertEqual(1, len(kwargs))
|
|
self.assertEqual('uid', kwargs['user'])
|
|
|
|
def test_sample_filter_multi(self):
|
|
q = [api.Query(field='user_id',
|
|
op='eq',
|
|
value='uid'),
|
|
api.Query(field='project_id',
|
|
op='eq',
|
|
value='pid'),
|
|
api.Query(field='resource_id',
|
|
op='eq',
|
|
value='rid'),
|
|
api.Query(field='source',
|
|
op='eq',
|
|
value='source_name'),
|
|
api.Query(field='meter',
|
|
op='eq',
|
|
value='meter_name')]
|
|
kwargs = api._query_to_kwargs(q, storage.SampleFilter.__init__)
|
|
self.assertEqual(5, len(kwargs))
|
|
self.assertEqual('uid', kwargs['user'])
|
|
self.assertEqual('pid', kwargs['project'])
|
|
self.assertEqual('rid', kwargs['resource'])
|
|
self.assertEqual('source_name', kwargs['source'])
|
|
self.assertEqual('meter_name', kwargs['meter'])
|
|
|
|
def test_sample_filter_timestamp(self):
|
|
ts_start = timeutils.utcnow()
|
|
ts_end = ts_start + datetime.timedelta(minutes=5)
|
|
q = [api.Query(field='timestamp',
|
|
op='lt',
|
|
value=str(ts_end)),
|
|
api.Query(field='timestamp',
|
|
op='gt',
|
|
value=str(ts_start))]
|
|
kwargs = api._query_to_kwargs(q, storage.SampleFilter.__init__)
|
|
self.assertEqual(4, len(kwargs))
|
|
self.assertTimestampEqual(kwargs['start_timestamp'], ts_start)
|
|
self.assertTimestampEqual(kwargs['end_timestamp'], ts_end)
|
|
self.assertEqual('gt', kwargs['start_timestamp_op'])
|
|
self.assertEqual('lt', kwargs['end_timestamp_op'])
|
|
|
|
def test_sample_filter_meta(self):
|
|
q = [api.Query(field='metadata.size',
|
|
op='eq',
|
|
value='20'),
|
|
api.Query(field='resource_metadata.id',
|
|
op='eq',
|
|
value='meta_id')]
|
|
kwargs = api._query_to_kwargs(q, storage.SampleFilter.__init__)
|
|
self.assertEqual(1, len(kwargs))
|
|
self.assertEqual(2, len(kwargs['metaquery']))
|
|
self.assertEqual(20, kwargs['metaquery']['metadata.size'])
|
|
self.assertEqual('meta_id', kwargs['metaquery']['metadata.id'])
|
|
|
|
def test_sample_filter_non_equality_on_metadata(self):
|
|
queries = [api.Query(field='resource_metadata.image_id',
|
|
op='gt',
|
|
value='image',
|
|
type='string'),
|
|
api.Query(field='metadata.ramdisk_id',
|
|
op='le',
|
|
value='ramdisk',
|
|
type='string')]
|
|
with mock.patch('pecan.request') as request:
|
|
request.headers.return_value = {'X-ProjectId': 'foobar'}
|
|
self.assertRaises(
|
|
wsme.exc.InvalidInput,
|
|
api._query_to_kwargs,
|
|
queries,
|
|
storage.SampleFilter.__init__)
|
|
|
|
def test_sample_filter_invalid_field(self):
|
|
q = [api.Query(field='invalid',
|
|
op='eq',
|
|
value='20')]
|
|
self.assertRaises(
|
|
wsme.exc.UnknownArgument,
|
|
api._query_to_kwargs, q, storage.SampleFilter.__init__)
|
|
|
|
def test_sample_filter_invalid_op(self):
|
|
q = [api.Query(field='user_id',
|
|
op='lt',
|
|
value='20')]
|
|
self.assertRaises(
|
|
wsme.exc.InvalidInput,
|
|
api._query_to_kwargs, q, storage.SampleFilter.__init__)
|
|
|
|
def test_sample_filter_timestamp_invalid_op(self):
|
|
ts_start = timeutils.utcnow()
|
|
q = [api.Query(field='timestamp',
|
|
op='eq',
|
|
value=str(ts_start))]
|
|
self.assertRaises(
|
|
wsme.exc.InvalidInput,
|
|
api._query_to_kwargs, q, storage.SampleFilter.__init__)
|
|
|
|
def test_sample_filter_exclude_internal(self):
|
|
queries = [api.Query(field=f,
|
|
op='eq',
|
|
value='fake',
|
|
type='string')
|
|
for f in ['y', 'on_behalf_of', 'x']]
|
|
with mock.patch('pecan.request') as request:
|
|
request.headers.return_value = {'X-ProjectId': 'foobar'}
|
|
self.assertRaises(wsme.exc.ClientSideError,
|
|
api._query_to_kwargs,
|
|
queries,
|
|
storage.SampleFilter.__init__,
|
|
internal_keys=['on_behalf_of'])
|
|
|
|
def test_sample_filter_self_always_excluded(self):
|
|
queries = [api.Query(field='user_id',
|
|
op='eq',
|
|
value='20')]
|
|
with mock.patch('pecan.request') as request:
|
|
request.headers.return_value = {'X-ProjectId': 'foobar'}
|
|
kwargs = api._query_to_kwargs(queries,
|
|
storage.SampleFilter.__init__)
|
|
self.assertFalse('self' in kwargs)
|
|
|
|
def test_sample_filter_translation(self):
|
|
queries = [api.Query(field=f,
|
|
op='eq',
|
|
value='fake_%s' % f,
|
|
type='string') for f in ['user_id',
|
|
'project_id',
|
|
'resource_id']]
|
|
with mock.patch('pecan.request') as request:
|
|
request.headers.return_value = {'X-ProjectId': 'foobar'}
|
|
kwargs = api._query_to_kwargs(queries,
|
|
storage.SampleFilter.__init__)
|
|
for o in ['user', 'project', 'resource']:
|
|
self.assertEqual('fake_%s_id' % o, kwargs.get(o))
|
|
|
|
def test_timestamp_validation(self):
|
|
q = [api.Query(field='timestamp',
|
|
op='le',
|
|
value='123')]
|
|
|
|
exc = self.assertRaises(
|
|
wsme.exc.InvalidInput,
|
|
api._query_to_kwargs, q, storage.SampleFilter.__init__)
|
|
expected_exc = wsme.exc.InvalidInput('timestamp', '123',
|
|
'invalid timestamp format')
|
|
self.assertEqual(str(expected_exc), str(exc))
|
|
|
|
def test_get_alarm_changes_filter_valid_fields(self):
|
|
q = [api.Query(field='abc',
|
|
op='eq',
|
|
value='abc')]
|
|
exc = self.assertRaises(
|
|
wsme.exc.UnknownArgument,
|
|
api._query_to_kwargs, q,
|
|
alarm_storage_base.Connection.get_alarm_changes)
|
|
valid_keys = ['alarm_id', 'on_behalf_of', 'project', 'search_offset',
|
|
'timestamp', 'type', 'user']
|
|
msg = ("unrecognized field in query: %s, "
|
|
"valid keys: %s") % (q, valid_keys)
|
|
expected_exc = wsme.exc.UnknownArgument('abc', msg)
|
|
self.assertEqual(str(expected_exc), str(exc))
|
|
|
|
def test_sample_filter_valid_fields(self):
|
|
q = [api.Query(field='abc',
|
|
op='eq',
|
|
value='abc')]
|
|
exc = self.assertRaises(
|
|
wsme.exc.UnknownArgument,
|
|
api._query_to_kwargs, q, storage.SampleFilter.__init__)
|
|
valid_keys = ['message_id', 'metaquery', 'meter', 'project',
|
|
'resource', 'search_offset', 'source', 'timestamp',
|
|
'user']
|
|
msg = ("unrecognized field in query: %s, "
|
|
"valid keys: %s") % (q, valid_keys)
|
|
expected_exc = wsme.exc.UnknownArgument('abc', msg)
|
|
self.assertEqual(str(expected_exc), str(exc))
|
|
|
|
def test_get_meters_filter_valid_fields(self):
|
|
q = [api.Query(field='abc',
|
|
op='eq',
|
|
value='abc')]
|
|
exc = self.assertRaises(
|
|
wsme.exc.UnknownArgument,
|
|
api._query_to_kwargs, q, storage_base.Connection.get_meters)
|
|
valid_keys = ['metaquery', 'pagination', 'project', 'resource',
|
|
'source', 'user']
|
|
msg = ("unrecognized field in query: %s, "
|
|
"valid keys: %s") % (q, valid_keys)
|
|
expected_exc = wsme.exc.UnknownArgument('abc', msg)
|
|
self.assertEqual(str(expected_exc), str(exc))
|
|
|
|
def test_get_resources_filter_valid_fields(self):
|
|
q = [api.Query(field='abc',
|
|
op='eq',
|
|
value='abc')]
|
|
exc = self.assertRaises(
|
|
wsme.exc.UnknownArgument,
|
|
api._query_to_kwargs, q, storage_base.Connection.get_resources)
|
|
valid_keys = ['metaquery', 'pagination', 'project', 'resource',
|
|
'search_offset', 'source', 'timestamp', 'user']
|
|
msg = ("unrecognized field in query: %s, "
|
|
"valid keys: %s") % (q, valid_keys)
|
|
expected_exc = wsme.exc.UnknownArgument('abc', msg)
|
|
self.assertEqual(str(expected_exc), str(exc))
|
|
|
|
def test_get_alarms_filter_valid_fields(self):
|
|
q = [api.Query(field='abc',
|
|
op='eq',
|
|
value='abc')]
|
|
exc = self.assertRaises(
|
|
wsme.exc.UnknownArgument,
|
|
api._query_to_kwargs, q, alarm_storage_base.Connection.get_alarms)
|
|
valid_keys = ['alarm_id', 'enabled', 'meter', 'name', 'pagination',
|
|
'project', 'state', 'type', 'user']
|
|
msg = ("unrecognized field in query: %s, "
|
|
"valid keys: %s") % (q, valid_keys)
|
|
expected_exc = wsme.exc.UnknownArgument('abc', msg)
|
|
self.assertEqual(str(expected_exc), str(exc))
|