3eb9b422f4
This adds usage of the flake8-import-order extension to our flake8 checks to enforce consistency on our import ordering to follow the overall OpenStack code guidelines. Since we have now dropped Python 2, this also cleans up a few cases for things that were third party libs but became part of the standard library such as mock, which is now a standard part of unittest. Some questions, in order of importance: Q: Are you insane? A: Potentially. Q: Why should we touch all of these files? A: This adds consistency to our imports. The extension makes sure that all imports follow our published guidelines of having imports ordered by standard lib, third party, and local. This will be a one time churn, then we can ensure consistency over time. Q: Why bother. this doesn't really matter? A: I agree - but... We have the issue that we have less people actively involved and less time to perform thorough code reviews. This will make it objective and automated to catch these kinds of issues. But part of this, even though it maybe seems a little annoying, is for making it easier for contributors. Right now, we may or may not notice if something is following the guidelines or not. And we may or may not comment in a review to ask for a contributor to make adjustments to follow the guidelines. But then further along into the review process, someone decides to be thorough, and after the contributor feels like they've had to deal with other change requests and things are in really good shape, they get a -1 on something mostly meaningless as far as the functionality of their code. It can be a frustrating and disheartening thing. I believe this actually helps avoid that by making it an objective thing that they find out right away up front - either the code is following the guidelines and everything is happy, or it's not and running local jobs or the pep8 CI job will let them know right away and they can fix it. No guessing on whether or not someone is going to take a stand on following the guidelines or not. This will also make it easier on the code reviewers. The more we can automate, the more time we can spend in code reviews making sure the logic of the change is correct and less time looking at trivial coding and style things. Q: Should we use our hacking extensions for this? A: Hacking has had to keep back linter requirements for a long time now. Current versions of the linters actually don't work with the way we've been hooking into them for our hacking checks. We will likely need to do away with those at some point so we can move on to the current linter releases. This will help ensure we have something in place when that time comes to make sure some checks are automated. Q: Didn't you spend more time on this than the benefit we'll get from it? A: Yeah, probably. Change-Id: Ic13ba238a4a45c6219f4de131cfe0366219d722f Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
225 lines
9.8 KiB
Python
225 lines
9.8 KiB
Python
# Copyright 2017 Intel Corporation
|
|
# 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.
|
|
|
|
from unittest import mock
|
|
|
|
import webob
|
|
|
|
from cinder.api import microversions as mv
|
|
from cinder.api.v3 import group_specs as v3_group_specs
|
|
from cinder import context
|
|
from cinder import db
|
|
from cinder import exception
|
|
from cinder import rpc
|
|
from cinder import test
|
|
from cinder.tests.unit.api import fakes
|
|
from cinder.tests.unit import fake_constants as fake
|
|
|
|
fake_group_specs = {
|
|
'key1': 'value1',
|
|
'key2': 'value2'
|
|
}
|
|
|
|
create_fake_group_specs = {
|
|
'group_specs': {
|
|
'key1': 'value1',
|
|
'key2': 'value2'
|
|
}
|
|
}
|
|
|
|
update_fake_group_specs = {
|
|
'id': 'any_string'
|
|
}
|
|
|
|
incorrect_fake_group_specs = {
|
|
'group_specs': {
|
|
'key#': 'value1',
|
|
'key2': 'value2'
|
|
}
|
|
}
|
|
|
|
|
|
class GroupSpecsTestCase(test.TestCase):
|
|
"""test cases for the group specs API"""
|
|
|
|
def setUp(self):
|
|
super(GroupSpecsTestCase, self).setUp()
|
|
self.controller = v3_group_specs.GroupTypeSpecsController()
|
|
self.ctxt = context.RequestContext(
|
|
user_id=fake.USER_ID,
|
|
project_id=fake.PROJECT_ID,
|
|
is_admin=True)
|
|
|
|
@mock.patch.object(db, 'group_type_get', return_value={})
|
|
@mock.patch.object(db, 'group_type_specs_get',
|
|
return_value=fake_group_specs)
|
|
def test_group_types_index(self,
|
|
mock_group_type_specs_get,
|
|
mock_group_type_get):
|
|
req = fakes.HTTPRequest.blank('v3/%s/group_specs' %
|
|
fake.PROJECT_ID,
|
|
use_admin_context=True,
|
|
version=mv.GROUP_TYPE)
|
|
req.environ['cinder.context'] = self.ctxt
|
|
res_dict = self.controller.index(req, fake.GROUP_ID)
|
|
group_specs_dict = res_dict['group_specs']
|
|
mock_group_type_specs_get.assert_called()
|
|
self.assertEqual('value1', group_specs_dict['key1'])
|
|
self.assertEqual('value2', group_specs_dict['key2'])
|
|
|
|
@mock.patch.object(rpc, 'get_notifier')
|
|
@mock.patch.object(db, 'group_type_get', return_value={})
|
|
@mock.patch.object(db, 'group_type_specs_update_or_create',
|
|
return_value={})
|
|
def test_group_types_create(self,
|
|
mock_update_or_create,
|
|
mock_group_type_get,
|
|
mock_rpc_notifier):
|
|
req = fakes.HTTPRequest.blank('v3/%s/group_specs' %
|
|
fake.PROJECT_ID,
|
|
use_admin_context=True,
|
|
version=mv.GROUP_TYPE)
|
|
self.controller.create(req, fake.GROUP_ID,
|
|
body=create_fake_group_specs)
|
|
self.assertTrue(mock_rpc_notifier.called)
|
|
|
|
@mock.patch.object(rpc, 'get_notifier')
|
|
@mock.patch.object(db, 'group_type_get', return_value={})
|
|
@mock.patch.object(db, 'group_type_specs_get',
|
|
return_value=fake_group_specs)
|
|
@mock.patch.object(db, 'group_type_specs_update_or_create',
|
|
return_value={})
|
|
def test_group_types_update(self,
|
|
mock_update_or_create,
|
|
mock_typ_specs_get,
|
|
mock_group_type_get,
|
|
mock_rpc_notifier):
|
|
req = fakes.HTTPRequest.blank('v3/%s/group_specs' %
|
|
fake.PROJECT_ID,
|
|
use_admin_context=True,
|
|
version=mv.GROUP_TYPE)
|
|
self.controller.update(req,
|
|
fake.GROUP_TYPE_ID,
|
|
'id',
|
|
body=update_fake_group_specs)
|
|
self.assertTrue(mock_rpc_notifier.called)
|
|
|
|
@mock.patch.object(db, 'group_type_specs_get',
|
|
return_value=fake_group_specs)
|
|
@mock.patch.object(db, 'group_type_get', return_value={})
|
|
def test_group_types_show(self,
|
|
mock_group_type_get,
|
|
mock_fake_group_specs):
|
|
req = fakes.HTTPRequest.blank('v3/%s/group_specs' %
|
|
fake.PROJECT_ID,
|
|
use_admin_context=True,
|
|
version=mv.GROUP_TYPE)
|
|
res_dict = self.controller.show(req, fake.GROUP_TYPE_ID, 'key1')
|
|
self.assertEqual('value1', res_dict['key1'])
|
|
|
|
@mock.patch.object(rpc, 'get_notifier')
|
|
@mock.patch.object(db, 'group_type_specs_delete', return_value={})
|
|
@mock.patch.object(db, 'group_type_get', return_value={})
|
|
def test_group_types_delete(self,
|
|
mock_group_type_get,
|
|
mock_group_spec_delete,
|
|
rpc_notifier_mock):
|
|
req = fakes.HTTPRequest.blank('v3/%s/group_specs' %
|
|
fake.PROJECT_ID,
|
|
use_admin_context=True,
|
|
version=mv.GROUP_TYPE)
|
|
self.controller.delete(req, fake.GROUP_TYPE_ID, 'key1')
|
|
self.assertTrue(rpc_notifier_mock.called)
|
|
|
|
@mock.patch.object(rpc, 'get_notifier')
|
|
@mock.patch.object(db, 'group_type_specs_update_or_create',
|
|
return_value={})
|
|
def test_check_type_should_raise_exception(self,
|
|
mock_db_update_or_create,
|
|
mock_rpc_notifier):
|
|
req = fakes.HTTPRequest.blank('v3/%s/group_specs' %
|
|
fake.PROJECT_ID,
|
|
use_admin_context=True,
|
|
version=mv.GROUP_TYPE)
|
|
self.assertRaises(webob.exc.HTTPNotFound,
|
|
self.controller.create,
|
|
req,
|
|
fake.GROUP_ID,
|
|
body=create_fake_group_specs)
|
|
|
|
@mock.patch.object(rpc, 'get_notifier')
|
|
@mock.patch.object(db, 'group_type_get', return_value={})
|
|
def test_delete_should_raise_exception(self,
|
|
mock_group_type_get,
|
|
mock_get_notifier):
|
|
req = fakes.HTTPRequest.blank('v3/%s/group_specs' %
|
|
fake.PROJECT_ID,
|
|
use_admin_context=True,
|
|
version=mv.GROUP_TYPE)
|
|
self.assertRaises(webob.exc.HTTPNotFound,
|
|
self.controller.delete,
|
|
req,
|
|
fake.GROUP_TYPE_ID,
|
|
'key1')
|
|
|
|
@mock.patch.object(db, 'group_type_get', return_value={})
|
|
def test_update_should_raise_exceptions(self, mock_group_type_get):
|
|
req = fakes.HTTPRequest.blank('v3/%s/group_specs' %
|
|
fake.PROJECT_ID,
|
|
use_admin_context=True,
|
|
version=mv.GROUP_TYPE)
|
|
self.assertRaises(exception.ValidationError,
|
|
self.controller.update,
|
|
req,
|
|
fake.GROUP_TYPE_ID,
|
|
'id', body=None)
|
|
self.assertRaises(exception.ValidationError, self.controller.update,
|
|
req, fake.GROUP_TYPE_ID, 'id',
|
|
body=fake_group_specs)
|
|
self.assertRaises(exception.ValidationError, self.controller.update,
|
|
req, fake.GROUP_TYPE_ID, 'key1',
|
|
body=fake_group_specs)
|
|
|
|
@mock.patch.object(db, 'group_type_specs_get',
|
|
return_value=fake_group_specs)
|
|
@mock.patch.object(db, 'group_type_get', return_value={})
|
|
def test_show_should_raise_exception(self,
|
|
mock_group_type_get,
|
|
mock_group_type_specs_get):
|
|
req = fakes.HTTPRequest.blank('v3/%s/group_specs' %
|
|
fake.PROJECT_ID,
|
|
use_admin_context=True,
|
|
version=mv.GROUP_TYPE)
|
|
self.assertRaises(webob.exc.HTTPNotFound,
|
|
self.controller.show,
|
|
req,
|
|
fake.GROUP_TYPE_ID,
|
|
'key')
|
|
|
|
@mock.patch.object(rpc, 'get_notifier')
|
|
@mock.patch.object(db, 'group_type_get', return_value={})
|
|
@mock.patch.object(db, 'group_type_specs_update_or_create',
|
|
return_value={})
|
|
def test_check_key_name_should_raise_exception(self,
|
|
mock_update_or_create,
|
|
mock_group_type_get,
|
|
mock_rpc_notifier):
|
|
req = fakes.HTTPRequest.blank('v3/%s/group_specs' %
|
|
fake.PROJECT_ID,
|
|
use_admin_context=True,
|
|
version=mv.GROUP_TYPE)
|
|
self.assertRaises(exception.ValidationError, self.controller.create,
|
|
req, fake.GROUP_ID, body=incorrect_fake_group_specs)
|