#
# Copyright 2012 New Dream Network, LLC (DreamHost)
#
# 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 listing resources.
"""
import datetime
import json
import six
import webtest.app
from ceilometer.publisher import utils
from ceilometer import sample
from ceilometer.tests.functional.api import v2
[docs]class TestListResources(v2.FunctionalTest):
[docs] def test_empty(self):
data = self.get_json('/resources')
self.assertEqual([], data)
def _verify_resource_timestamps(self, res, first, last):
# Bounds need not be tight (see ceilometer bug #1288372)
self.assertIn('first_sample_timestamp', res)
self.assertTrue(first.isoformat() >= res['first_sample_timestamp'])
self.assertIn('last_sample_timestamp', res)
self.assertTrue(last.isoformat() <= res['last_sample_timestamp'])
[docs] def test_instances(self):
timestamps = {
'resource-id': datetime.datetime(2012, 7, 2, 10, 40),
'resource-id-alternate': datetime.datetime(2012, 7, 2, 10, 41),
}
sample1 = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id',
'project-id',
'resource-id',
timestamp=timestamps['resource-id'],
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample',
},
source='test',
)
msg = utils.meter_message_from_counter(
sample1, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg)
sample2 = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id',
'project-id',
'resource-id-alternate',
timestamp=timestamps['resource-id-alternate'],
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample2',
},
source='test',
)
msg2 = utils.meter_message_from_counter(
sample2, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg2)
data = self.get_json('/resources')
self.assertEqual(2, len(data))
for res in data:
timestamp = timestamps.get(res['resource_id'])
self._verify_resource_timestamps(res, timestamp, timestamp)
[docs] def test_instance_multiple_samples(self):
timestamps = [
datetime.datetime(2012, 7, 2, 10, 41),
datetime.datetime(2012, 7, 2, 10, 42),
datetime.datetime(2012, 7, 2, 10, 40),
]
for timestamp in timestamps:
datapoint = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id',
'project-id',
'resource-id',
timestamp=timestamp,
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample-%s' % timestamp,
},
source='test',
)
msg = utils.meter_message_from_counter(
datapoint,
self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg)
data = self.get_json('/resources')
self.assertEqual(1, len(data))
self._verify_resource_timestamps(data[0],
timestamps[-1], timestamps[1])
[docs] def test_instances_one(self):
sample1 = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id',
'project-id',
'resource-id',
timestamp=datetime.datetime(2012, 7, 2, 10, 40),
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample',
},
source='test',
)
msg = utils.meter_message_from_counter(
sample1, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg)
sample2 = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id',
'project-id',
'resource-id-alternate',
timestamp=datetime.datetime(2012, 7, 2, 10, 41),
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample2',
},
source='test',
)
msg2 = utils.meter_message_from_counter(
sample2, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg2)
data = self.get_json('/resources/resource-id')
self.assertEqual('resource-id', data['resource_id'])
[docs] def test_with_source(self):
sample1 = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id',
'project-id',
'resource-id',
timestamp=datetime.datetime(2012, 7, 2, 10, 40),
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample',
},
source='test_list_resources',
)
msg = utils.meter_message_from_counter(
sample1, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg)
sample2 = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id2',
'project-id',
'resource-id-alternate',
timestamp=datetime.datetime(2012, 7, 2, 10, 41),
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample2',
},
source='not-test',
)
msg2 = utils.meter_message_from_counter(
sample2, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg2)
data = self.get_json('/resources', q=[{'field': 'source',
'value': 'test_list_resources',
}])
ids = [r['resource_id'] for r in data]
self.assertEqual(['resource-id'], ids)
sources = [r['source'] for r in data]
self.assertEqual(['test_list_resources'], sources)
[docs] def test_resource_id_with_slash(self):
s = sample.Sample(
'storage.containers.objects',
'gauge',
'',
1,
'19fbed01c21f4912901057021b9e7111',
'45acc90399134206b3b41f3d3a0a06d6',
'29f809d9-88bb-4c40-b1ba-a77a1fcf8ceb/glance',
timestamp=datetime.datetime(2012, 7, 2, 10, 40).isoformat(),
resource_metadata={},
source='test_show_special_resource',
)
msg = utils.meter_message_from_counter(
s, self.CONF.publisher.telemetry_secret,
)
msg['timestamp'] = datetime.datetime(2012, 7, 2, 10, 40)
self.conn.record_metering_data(msg)
rid_encoded = '29f809d9-88bb-4c40-b1ba-a77a1fcf8ceb%252Fglance'
resp = self.get_json('/resources/%s' % rid_encoded)
self.assertEqual("19fbed01c21f4912901057021b9e7111", resp["user_id"])
self.assertEqual('29f809d9-88bb-4c40-b1ba-a77a1fcf8ceb/glance',
resp["resource_id"])
[docs] def test_with_invalid_resource_id(self):
sample1 = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id',
'project-id',
'resource-id-1',
timestamp=datetime.datetime(2012, 7, 2, 10, 40),
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample',
},
source='test_list_resources',
)
msg = utils.meter_message_from_counter(
sample1, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg)
sample2 = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id2',
'project-id',
'resource-id-2',
timestamp=datetime.datetime(2012, 7, 2, 10, 41),
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample2',
},
source='test_list_resources',
)
msg2 = utils.meter_message_from_counter(
sample2, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg2)
resp1 = self.get_json('/resources/resource-id-1')
self.assertEqual("resource-id-1", resp1["resource_id"])
resp2 = self.get_json('/resources/resource-id-2')
self.assertEqual("resource-id-2", resp2["resource_id"])
resp3 = self.get_json('/resources/resource-id-3', expect_errors=True)
self.assertEqual(404, resp3.status_code)
json_data = resp3.body
if six.PY3:
json_data = json_data.decode('utf-8')
self.assertEqual("Resource resource-id-3 Not Found",
json.loads(json_data)['error_message']
['faultstring'])
[docs] def test_with_user(self):
sample1 = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id',
'project-id',
'resource-id',
timestamp=datetime.datetime(2012, 7, 2, 10, 40),
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample',
},
source='test_list_resources',
)
msg = utils.meter_message_from_counter(
sample1, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg)
sample2 = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id2',
'project-id',
'resource-id-alternate',
timestamp=datetime.datetime(2012, 7, 2, 10, 41),
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample2',
},
source='not-test',
)
msg2 = utils.meter_message_from_counter(
sample2, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg2)
data = self.get_json('/resources', q=[{'field': 'user_id',
'value': 'user-id',
}])
ids = [r['resource_id'] for r in data]
self.assertEqual(['resource-id'], ids)
[docs] def test_with_project(self):
sample1 = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id',
'project-id',
'resource-id',
timestamp=datetime.datetime(2012, 7, 2, 10, 40),
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample',
},
source='test_list_resources',
)
msg = utils.meter_message_from_counter(
sample1, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg)
sample2 = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id2',
'project-id2',
'resource-id-alternate',
timestamp=datetime.datetime(2012, 7, 2, 10, 41),
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample2',
},
source='not-test',
)
msg2 = utils.meter_message_from_counter(
sample2, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg2)
data = self.get_json('/resources', q=[{'field': 'project_id',
'value': 'project-id',
}])
ids = [r['resource_id'] for r in data]
self.assertEqual(['resource-id'], ids)
[docs] def test_with_user_non_admin(self):
sample1 = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id2',
'project-id2',
'resource-id-alternate',
timestamp=datetime.datetime(2012, 7, 2, 10, 41),
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample1',
},
source='not-test',
)
msg2 = utils.meter_message_from_counter(
sample1, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg2)
data = self.get_json('/resources',
headers={"X-Roles": "Member",
"X-Project-Id": "project-id2"})
ids = set(r['resource_id'] for r in data)
self.assertEqual(set(['resource-id-alternate']), ids)
[docs] def test_with_user_wrong_tenant(self):
sample1 = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id2',
'project-id2',
'resource-id-alternate',
timestamp=datetime.datetime(2012, 7, 2, 10, 41),
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample1',
},
source='not-test',
)
msg2 = utils.meter_message_from_counter(
sample1, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg2)
data = self.get_json('/resources',
headers={"X-Roles": "Member",
"X-Project-Id": "project-wrong"})
ids = set(r['resource_id'] for r in data)
self.assertEqual(set(), ids)
[docs] def test_resource_meter_links(self):
sample1 = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id',
'project-id',
'resource-id',
timestamp=datetime.datetime(2012, 7, 2, 10, 40),
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample',
},
source='test_list_resources',
)
msg = utils.meter_message_from_counter(
sample1, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg)
data = self.get_json('/resources')
links = data[0]['links']
self.assertEqual(2, len(links))
self.assertEqual('self', links[0]['rel'])
self.assertTrue((self.PATH_PREFIX + '/resources/resource-id')
in links[0]['href'])
self.assertEqual('instance', links[1]['rel'])
self.assertTrue((self.PATH_PREFIX + '/meters/instance?'
'q.field=resource_id&q.value=resource-id')
in links[1]['href'])
[docs] def test_resource_skip_meter_links(self):
sample1 = sample.Sample(
'instance',
'cumulative',
'',
1,
'user-id',
'project-id',
'resource-id',
timestamp=datetime.datetime(2012, 7, 2, 10, 40),
resource_metadata={'display_name': 'test-server',
'tag': 'self.sample',
},
source='test_list_resources',
)
msg = utils.meter_message_from_counter(
sample1, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg)
data = self.get_json('/resources?meter_links=0')
links = data[0]['links']
self.assertEqual(len(links), 1)
self.assertEqual(links[0]['rel'], 'self')
self.assertTrue((self.PATH_PREFIX + '/resources/resource-id')
in links[0]['href'])
[docs]class TestListResourcesRestriction(v2.FunctionalTest):
[docs] def setUp(self):
super(TestListResourcesRestriction, self).setUp()
self.CONF.set_override('default_api_return_limit', 10, group='api')
for i in range(20):
s = sample.Sample(
'volume.size',
'gauge',
'GiB',
5 + i,
'user-id',
'project1',
'resource-id%s' % i,
timestamp=(datetime.datetime(2012, 9, 25, 10, 30) +
datetime.timedelta(seconds=i)),
resource_metadata={'display_name': 'test-volume',
'tag': 'self.sample',
},
source='source1',
)
msg = utils.meter_message_from_counter(
s, self.CONF.publisher.telemetry_secret,
)
self.conn.record_metering_data(msg)
[docs] def test_resource_limit(self):
data = self.get_json('/resources?limit=1')
self.assertEqual(1, len(data))
[docs] def test_resource_limit_negative(self):
self.assertRaises(webtest.app.AppError, self.get_json,
'/resources?limit=-2')
[docs] def test_resource_limit_bigger(self):
data = self.get_json('/resources?limit=42')
self.assertEqual(20, len(data))
[docs] def test_resource_default_limit(self):
data = self.get_json('/resources')
self.assertEqual(10, len(data))