432 lines
20 KiB
Python
432 lines
20 KiB
Python
#
|
|
# Copyright 2012 eNovance <licensing@enovance.com>
|
|
#
|
|
# 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.
|
|
import mock
|
|
from oslo_config import cfg
|
|
import six
|
|
|
|
from ceilometermiddleware import swift
|
|
from ceilometermiddleware.tests import base as tests_base
|
|
from threading import Event
|
|
|
|
|
|
class FakeApp(object):
|
|
def __init__(self, body=None):
|
|
self.body = body or ['This string is 28 bytes long']
|
|
|
|
def __call__(self, env, start_response):
|
|
yield
|
|
start_response('200 OK', [
|
|
('Content-Type', 'text/plain'),
|
|
('Content-Length', str(sum(map(len, self.body))))
|
|
])
|
|
while env['wsgi.input'].read(5):
|
|
pass
|
|
for line in self.body:
|
|
yield line
|
|
|
|
|
|
class FakeRequest(object):
|
|
"""A bare bones request object
|
|
|
|
The middleware will inspect this for request method,
|
|
wsgi.input and headers.
|
|
"""
|
|
|
|
def __init__(self, path, environ=None, headers=None):
|
|
environ = environ or {}
|
|
headers = headers or {}
|
|
|
|
environ['PATH_INFO'] = path
|
|
|
|
if 'wsgi.input' not in environ:
|
|
environ['wsgi.input'] = six.moves.cStringIO('')
|
|
|
|
for header, value in six.iteritems(headers):
|
|
environ['HTTP_%s' % header.upper()] = value
|
|
self.environ = environ
|
|
|
|
|
|
@mock.patch('oslo_messaging.get_transport', mock.MagicMock())
|
|
class TestSwift(tests_base.TestCase):
|
|
|
|
def setUp(self):
|
|
super(TestSwift, self).setUp()
|
|
cfg.CONF([], project='ceilometermiddleware')
|
|
self.addCleanup(cfg.CONF.reset)
|
|
|
|
@staticmethod
|
|
def start_response(*args):
|
|
pass
|
|
|
|
def test_get(self):
|
|
app = swift.Swift(FakeApp(), {})
|
|
req = FakeRequest('/1.0/account/container/obj',
|
|
environ={'REQUEST_METHOD': 'GET'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
resp = app(req.environ, self.start_response)
|
|
self.assertEqual(["This string is 28 bytes long"], list(resp))
|
|
self.assertEqual(1, len(notify.call_args_list))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertEqual('objectstore.http.request', data[1])
|
|
self.assertEqual(28, data[2]['measurements'][0]['result'])
|
|
self.assertEqual('storage.objects.outgoing.bytes',
|
|
data[2]['measurements'][0]['metric']['name'])
|
|
metadata = data[2]['target']['metadata']
|
|
self.assertEqual('1.0', metadata['version'])
|
|
self.assertEqual('container', metadata['container'])
|
|
self.assertEqual('obj', metadata['object'])
|
|
self.assertEqual('get', data[2]['target']['action'])
|
|
|
|
def test_get_background(self):
|
|
notified = Event()
|
|
app = swift.Swift(FakeApp(),
|
|
{"nonblocking_notify": "True",
|
|
"send_queue_size": "1"})
|
|
req = FakeRequest('/1.0/account/container/obj',
|
|
environ={'REQUEST_METHOD': 'GET'})
|
|
with mock.patch('oslo_messaging.Notifier.info',
|
|
side_effect=lambda *args, **kwargs: notified.set()
|
|
) as notify:
|
|
resp = app(req.environ, self.start_response)
|
|
self.assertEqual(["This string is 28 bytes long"], list(resp))
|
|
notified.wait()
|
|
self.assertEqual(1, len(notify.call_args_list))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertEqual('objectstore.http.request', data[1])
|
|
self.assertEqual(28, data[2]['measurements'][0]['result'])
|
|
self.assertEqual('storage.objects.outgoing.bytes',
|
|
data[2]['measurements'][0]['metric']['name'])
|
|
metadata = data[2]['target']['metadata']
|
|
self.assertEqual('1.0', metadata['version'])
|
|
self.assertEqual('container', metadata['container'])
|
|
self.assertEqual('obj', metadata['object'])
|
|
self.assertEqual('get', data[2]['target']['action'])
|
|
|
|
def test_put(self):
|
|
app = swift.Swift(FakeApp(body=['']), {})
|
|
req = FakeRequest(
|
|
'/1.0/account/container/obj',
|
|
environ={'REQUEST_METHOD': 'PUT',
|
|
'wsgi.input':
|
|
six.moves.cStringIO('some stuff')})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(1, len(notify.call_args_list))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertEqual('objectstore.http.request', data[1])
|
|
self.assertEqual(10, data[2]['measurements'][0]['result'])
|
|
self.assertEqual('storage.objects.incoming.bytes',
|
|
data[2]['measurements'][0]['metric']['name'])
|
|
metadata = data[2]['target']['metadata']
|
|
self.assertEqual('1.0', metadata['version'])
|
|
self.assertEqual('container', metadata['container'])
|
|
self.assertEqual('obj', metadata['object'])
|
|
self.assertEqual('put', data[2]['target']['action'])
|
|
|
|
def test_post(self):
|
|
app = swift.Swift(FakeApp(body=['']), {})
|
|
req = FakeRequest(
|
|
'/1.0/account/container/obj',
|
|
environ={'REQUEST_METHOD': 'POST',
|
|
'wsgi.input': six.moves.cStringIO('some other stuff')})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(1, len(notify.call_args_list))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertEqual('objectstore.http.request', data[1])
|
|
self.assertEqual(16, data[2]['measurements'][0]['result'])
|
|
self.assertEqual('storage.objects.incoming.bytes',
|
|
data[2]['measurements'][0]['metric']['name'])
|
|
metadata = data[2]['target']['metadata']
|
|
self.assertEqual('1.0', metadata['version'])
|
|
self.assertEqual('container', metadata['container'])
|
|
self.assertEqual('obj', metadata['object'])
|
|
self.assertEqual('post', data[2]['target']['action'])
|
|
|
|
def test_head(self):
|
|
app = swift.Swift(FakeApp(body=['']), {})
|
|
req = FakeRequest('/1.0/account/container/obj',
|
|
environ={'REQUEST_METHOD': 'HEAD'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(1, len(notify.call_args_list))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertEqual('objectstore.http.request', data[1])
|
|
self.assertIsNone(data[2].get('measurements'))
|
|
metadata = data[2]['target']['metadata']
|
|
self.assertEqual('1.0', metadata['version'])
|
|
self.assertEqual('container', metadata['container'])
|
|
self.assertEqual('obj', metadata['object'])
|
|
self.assertEqual('head', data[2]['target']['action'])
|
|
|
|
def test_bogus_request(self):
|
|
"""Test even for arbitrary request method, this will still work."""
|
|
app = swift.Swift(FakeApp(body=['']), {})
|
|
req = FakeRequest('/1.0/account/container/obj',
|
|
environ={'REQUEST_METHOD': 'BOGUS'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(1, len(notify.call_args_list))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertEqual('objectstore.http.request', data[1])
|
|
self.assertIsNone(data[2].get('measurements'))
|
|
metadata = data[2]['target']['metadata']
|
|
self.assertEqual('1.0', metadata['version'])
|
|
self.assertEqual('container', metadata['container'])
|
|
self.assertEqual('obj', metadata['object'])
|
|
self.assertEqual('bogus', data[2]['target']['action'])
|
|
|
|
def test_get_container(self):
|
|
app = swift.Swift(FakeApp(), {})
|
|
req = FakeRequest('/1.0/account/container',
|
|
environ={'REQUEST_METHOD': 'GET'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(1, len(notify.call_args_list))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertEqual('objectstore.http.request', data[1])
|
|
self.assertEqual(28, data[2]['measurements'][0]['result'])
|
|
self.assertEqual('storage.objects.outgoing.bytes',
|
|
data[2]['measurements'][0]['metric']['name'])
|
|
metadata = data[2]['target']['metadata']
|
|
self.assertEqual('1.0', metadata['version'])
|
|
self.assertEqual('container', metadata['container'])
|
|
self.assertIsNone(metadata['object'])
|
|
self.assertEqual('get', data[2]['target']['action'])
|
|
|
|
def test_no_metadata_headers(self):
|
|
app = swift.Swift(FakeApp(), {})
|
|
req = FakeRequest('/1.0/account/container',
|
|
environ={'REQUEST_METHOD': 'GET'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(1, len(notify.call_args_list))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertEqual('objectstore.http.request', data[1])
|
|
metadata = data[2]['target']['metadata']
|
|
self.assertEqual('1.0', metadata['version'])
|
|
self.assertEqual('container', metadata['container'])
|
|
self.assertIsNone(metadata['object'])
|
|
self.assertEqual('get', data[2]['target']['action'])
|
|
http_headers = [k for k in metadata.keys()
|
|
if k.startswith('http_header_')]
|
|
self.assertEqual(0, len(http_headers))
|
|
|
|
def test_metadata_headers(self):
|
|
app = swift.Swift(FakeApp(), {
|
|
'metadata_headers': 'X_VAR1, x-var2, x-var3, token'
|
|
})
|
|
req = FakeRequest('/1.0/account/container',
|
|
environ={'REQUEST_METHOD': 'GET'},
|
|
headers={'X_VAR1': 'value1',
|
|
'X_VAR2': 'value2',
|
|
'TOKEN': 'token'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(1, len(notify.call_args_list))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertEqual('objectstore.http.request', data[1])
|
|
metadata = data[2]['target']['metadata']
|
|
self.assertEqual('1.0', metadata['version'])
|
|
self.assertEqual('container', metadata['container'])
|
|
self.assertIsNone(metadata['object'])
|
|
self.assertEqual('get', data[2]['target']['action'])
|
|
http_headers = [k for k in metadata.keys()
|
|
if k.startswith('http_header_')]
|
|
self.assertEqual(3, len(http_headers))
|
|
self.assertEqual('value1', metadata['http_header_x_var1'])
|
|
self.assertEqual('value2', metadata['http_header_x_var2'])
|
|
self.assertEqual('token', metadata['http_header_token'])
|
|
self.assertFalse('http_header_x_var3' in metadata)
|
|
|
|
def test_metadata_headers_unicode(self):
|
|
app = swift.Swift(FakeApp(), {
|
|
'metadata_headers': 'unicode'
|
|
})
|
|
uni = u'\xef\xbd\xa1\xef\xbd\xa5'
|
|
req = FakeRequest('/1.0/account/container',
|
|
environ={'REQUEST_METHOD': 'GET'},
|
|
headers={'UNICODE': uni})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(1, len(notify.call_args_list))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertEqual('objectstore.http.request', data[1])
|
|
metadata = data[2]['target']['metadata']
|
|
self.assertEqual('1.0', metadata['version'])
|
|
self.assertEqual('container', metadata['container'])
|
|
self.assertIsNone(metadata['object'])
|
|
self.assertEqual('get', data[2]['target']['action'])
|
|
http_headers = [k for k in metadata.keys()
|
|
if k.startswith('http_header_')]
|
|
self.assertEqual(1, len(http_headers))
|
|
self.assertEqual(six.text_type(uni),
|
|
metadata['http_header_unicode'])
|
|
|
|
def test_metadata_headers_on_not_existing_header(self):
|
|
app = swift.Swift(FakeApp(), {
|
|
'metadata_headers': 'x-var3'
|
|
})
|
|
req = FakeRequest('/1.0/account/container',
|
|
environ={'REQUEST_METHOD': 'GET'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(1, len(notify.call_args_list))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertEqual('objectstore.http.request', data[1])
|
|
metadata = data[2]['target']['metadata']
|
|
self.assertEqual('1.0', metadata['version'])
|
|
self.assertEqual('container', metadata['container'])
|
|
self.assertIsNone(metadata['object'])
|
|
self.assertEqual('get', data[2]['target']['action'])
|
|
http_headers = [k for k in metadata.keys()
|
|
if k.startswith('http_header_')]
|
|
self.assertEqual(0, len(http_headers))
|
|
|
|
def test_bogus_path(self):
|
|
app = swift.Swift(FakeApp(), {})
|
|
req = FakeRequest('/5.0//',
|
|
environ={'REQUEST_METHOD': 'GET'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(0, len(notify.call_args_list))
|
|
|
|
def test_missing_resource_id(self):
|
|
app = swift.Swift(FakeApp(), {})
|
|
req = FakeRequest('/v1/', environ={'REQUEST_METHOD': 'GET'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(0, len(notify.call_args_list))
|
|
|
|
@mock.patch('six.moves.urllib.parse.quote')
|
|
def test_emit_event_fail(self, mocked_func):
|
|
mocked_func.side_effect = Exception("a exception")
|
|
app = swift.Swift(FakeApp(body=["test"]), {})
|
|
req = FakeRequest('/1.0/account/container',
|
|
environ={'REQUEST_METHOD': 'GET'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
resp = list(app(req.environ, self.start_response))
|
|
self.assertEqual(0, len(notify.call_args_list))
|
|
self.assertEqual(["test"], resp)
|
|
|
|
def test_reseller_prefix(self):
|
|
app = swift.Swift(FakeApp(), {})
|
|
req = FakeRequest('/1.0/AUTH_account/container/obj',
|
|
environ={'REQUEST_METHOD': 'GET'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(1, len(notify.call_args_list))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertEqual("account", data[2]['target']['id'])
|
|
|
|
def test_custom_prefix(self):
|
|
app = swift.Swift(FakeApp(), {'reseller_prefix': 'CUSTOM_'})
|
|
req = FakeRequest('/1.0/CUSTOM_account/container/obj',
|
|
environ={'REQUEST_METHOD': 'GET'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(1, len(notify.call_args_list))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertEqual("account", data[2]['target']['id'])
|
|
|
|
def test_incomplete_reseller_prefix(self):
|
|
# Custom reseller prefix set, but without trailing underscore
|
|
app = swift.Swift(
|
|
FakeApp(), {'reseller_prefix': 'CUSTOM'})
|
|
req = FakeRequest('/1.0/CUSTOM_account/container/obj',
|
|
environ={'REQUEST_METHOD': 'GET'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(1, len(notify.call_args_list))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertEqual("account", data[2]['target']['id'])
|
|
|
|
def test_invalid_reseller_prefix(self):
|
|
app = swift.Swift(
|
|
FakeApp(), {'reseller_prefix': 'AUTH_'})
|
|
req = FakeRequest('/1.0/admin/bucket',
|
|
environ={'REQUEST_METHOD': 'GET'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(1, len(notify.call_args_list))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertEqual("1.0/admin/bucket", data[2]['target']['id'])
|
|
|
|
def test_ignore_requests_from_project(self):
|
|
app = swift.Swift(FakeApp(), {'ignore_projects': 'skip_proj'})
|
|
|
|
for proj_attr in ['HTTP_X_SERVICE_PROJECT_ID', 'HTTP_X_PROJECT_ID',
|
|
'HTTP_X_TENANT_ID']:
|
|
for proj, calls in [('good', 1), ('skip_proj', 0)]:
|
|
req = FakeRequest('/1.0/CUSTOM_account/container/obj',
|
|
environ={'REQUEST_METHOD': 'GET',
|
|
proj_attr: proj})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(calls, len(notify.call_args_list))
|
|
|
|
def test_ignore_requests_from_multiple_projects(self):
|
|
app = swift.Swift(FakeApp(), {'ignore_projects': 'skip_proj, ignore'})
|
|
|
|
for proj_attr in ['HTTP_X_SERVICE_PROJECT_ID', 'HTTP_X_PROJECT_ID',
|
|
'HTTP_X_TENANT_ID']:
|
|
for proj, calls in [('good', 1), ('skip_proj', 0),
|
|
('also_good', 1), ('ignore', 0)]:
|
|
req = FakeRequest('/1.0/CUSTOM_account/container/obj',
|
|
environ={'REQUEST_METHOD': 'GET',
|
|
proj_attr: proj})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(calls, len(notify.call_args_list))
|
|
|
|
def test_empty_reseller_prefix(self):
|
|
app = swift.Swift(
|
|
FakeApp(), {'reseller_prefix': 'CUSTOM'})
|
|
req = FakeRequest('/1.0/CUSTOM/container/obj',
|
|
environ={'REQUEST_METHOD': 'GET'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertIsNot(0, len(data[2]['target']['id']))
|
|
|
|
def test_head_account(self):
|
|
app = swift.Swift(FakeApp(body=['']), {})
|
|
req = FakeRequest('/1.0/account',
|
|
environ={'REQUEST_METHOD': 'HEAD'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertEqual(1, len(notify.call_args_list))
|
|
data = notify.call_args_list[0][0]
|
|
self.assertEqual('objectstore.http.request', data[1])
|
|
self.assertIsNone(data[2].get('measurements'))
|
|
metadata = data[2]['target']['metadata']
|
|
self.assertEqual('1.0', metadata['version'])
|
|
self.assertIsNone(metadata['container'])
|
|
self.assertIsNone(metadata['object'])
|
|
self.assertEqual('head', data[2]['target']['action'])
|
|
|
|
def test_put_with_swift_source(self):
|
|
app = swift.Swift(FakeApp(), {})
|
|
|
|
req = FakeRequest(
|
|
'/1.0/account/container/obj',
|
|
environ={'REQUEST_METHOD': 'PUT',
|
|
'wsgi.input':
|
|
six.moves.cStringIO('some stuff'),
|
|
'swift.source': 'RL'})
|
|
with mock.patch('oslo_messaging.Notifier.info') as notify:
|
|
list(app(req.environ, self.start_response))
|
|
self.assertFalse(notify.called)
|