openstack
/
metalsmith
Code Issues Proposed changes

CLI: use --resource-class instead of a positional argument 

Change-Id: Ic0808253a6c417ae9de71c24606375d998946630
This commit is contained in:
Dmitry Tantsur 2018-06-18 16:20:27 +02:00
parent 8464fced77
commit 675fa04dda
4 changed files with 37 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.rst
View File

@ -29,14 +29,15 @@ Generic usage is as follows::
metalsmith --os-cloud <CLOUD NAME> deploy --image <GLANCE IMAGE> \
--network <NEUTRON NET> --ssh-public-key <PATH TO SSH PUBLIC KEY> \
<RESOURCE CLASS>
--resource-class <RESOURCE CLASS>
This is an example suitable for TripleO (replace ``compute`` with the profile
you want to deploy)::
source ~/stackrc
metalsmith deploy --image overcloud-full --network ctlplane \
--capability profile=compute --ssh-public-key ~/.ssh/id_rsa.pub baremetal
--capability profile=compute --ssh-public-key ~/.ssh/id_rsa.pub \
--resource-class baremetal
To remove the deployed instance::

3
metalsmith/_cmd.py
View File

@ -119,7 +119,8 @@ def _parse_args(args, config):
deploy.add_argument('--ssh-public-key', help='SSH public key to load')
deploy.add_argument('--hostname', help='Host name to use, defaults to '
'Node\'s name or UUID')
deploy.add_argument('resource_class', help='node resource class to deploy')
deploy.add_argument('--resource-class', required=True,
help='node resource class to deploy')
undeploy = subparsers.add_parser('undeploy')
undeploy.set_defaults(func=_do_undeploy)

53
metalsmith/test/test_cmd.py
View File

@ -44,7 +44,8 @@ class TestDeploy(testtools.TestCase):
instance.is_deployed = True
instance.ip_addresses.return_value = {'private': ['1.2.3.4']}
args = ['deploy', '--network', 'mynet', '--image', 'myimg', 'compute']
args = ['deploy', '--network', 'mynet', '--image', 'myimg',
'--resource-class', 'compute']
_cmd.main(args)
mock_pr.assert_called_once_with(
@ -83,7 +84,7 @@ class TestDeploy(testtools.TestCase):
instance.to_dict.return_value = {'node': 'dict'}
args = ['--format', 'json', 'deploy', '--network', 'mynet',
'--image', 'myimg', 'compute']
'--image', 'myimg', '--resource-class', 'compute']
fake_io = six.StringIO()
with mock.patch('sys.stdout', fake_io):
_cmd.main(args)
@ -123,7 +124,8 @@ class TestDeploy(testtools.TestCase):
instance.node.uuid = '123'
instance.state = 'active'
args = ['deploy', '--network', 'mynet', '--image', 'myimg', 'compute']
args = ['deploy', '--network', 'mynet', '--image', 'myimg',
'--resource-class', 'compute']
_cmd.main(args)
self.mock_print.assert_called_once_with(mock.ANY, node='123',
@ -137,7 +139,8 @@ class TestDeploy(testtools.TestCase):
instance.node.uuid = '123'
instance.state = 'deploying'
args = ['deploy', '--network', 'mynet', '--image', 'myimg', 'compute']
args = ['deploy', '--network', 'mynet', '--image', 'myimg',
'--resource-class', 'compute']
_cmd.main(args)
self.mock_print.assert_called_once_with(mock.ANY, node='123',
@ -149,7 +152,8 @@ class TestDeploy(testtools.TestCase):
instance.create_autospec(_provisioner.Instance)
instance.is_deployed = False
args = ['deploy', '--network', 'mynet', '--image', 'myimg', 'compute']
args = ['deploy', '--network', 'mynet', '--image', 'myimg',
'--resource-class', 'compute']
_cmd.main(args)
self.assertFalse(mock_log.called)
@ -157,7 +161,7 @@ class TestDeploy(testtools.TestCase):
def test_args_dry_run(self, mock_os_conf, mock_pr):
args = ['--dry-run', 'deploy', '--network', 'mynet',
'--image', 'myimg', 'compute']
'--image', 'myimg', '--resource-class', 'compute']
_cmd.main(args)
mock_pr.assert_called_once_with(
cloud_region=mock_os_conf.return_value.get_one.return_value,
@ -179,7 +183,7 @@ class TestDeploy(testtools.TestCase):
@mock.patch.object(_cmd, 'logging', autospec=True)
def test_args_debug(self, mock_log, mock_os_conf, mock_pr):
args = ['--debug', 'deploy', '--network', 'mynet', '--image', 'myimg',
'compute']
'--resource-class', 'compute']
_cmd.main(args)
mock_pr.assert_called_once_with(
cloud_region=mock_os_conf.return_value.get_one.return_value,
@ -209,7 +213,7 @@ class TestDeploy(testtools.TestCase):
@mock.patch.object(_cmd, 'logging', autospec=True)
def test_args_quiet(self, mock_log, mock_os_conf, mock_pr):
args = ['--quiet', 'deploy', '--network', 'mynet', '--image', 'myimg',
'compute']
'--resource-class', 'compute']
_cmd.main(args)
mock_pr.assert_called_once_with(
cloud_region=mock_os_conf.return_value.get_one.return_value,
@ -241,7 +245,7 @@ class TestDeploy(testtools.TestCase):
@mock.patch.object(_cmd, 'logging', autospec=True)
def test_args_verbose_1(self, mock_log, mock_os_conf, mock_pr):
args = ['-v', 'deploy', '--network', 'mynet', '--image', 'myimg',
'compute']
'--resource-class', 'compute']
_cmd.main(args)
mock_pr.assert_called_once_with(
cloud_region=mock_os_conf.return_value.get_one.return_value,
@ -271,7 +275,7 @@ class TestDeploy(testtools.TestCase):
@mock.patch.object(_cmd, 'logging', autospec=True)
def test_args_verbose_2(self, mock_log, mock_os_conf, mock_pr):
args = ['-vv', 'deploy', '--network', 'mynet', '--image', 'myimg',
'compute']
'--resource-class', 'compute']
_cmd.main(args)
mock_pr.assert_called_once_with(
cloud_region=mock_os_conf.return_value.get_one.return_value,
@ -301,7 +305,7 @@ class TestDeploy(testtools.TestCase):
@mock.patch.object(_cmd, 'logging', autospec=True)
def test_args_verbose_3(self, mock_log, mock_os_conf, mock_pr):
args = ['-vvv', 'deploy', '--network', 'mynet', '--image', 'myimg',
'compute']
'--resource-class', 'compute']
_cmd.main(args)
mock_pr.assert_called_once_with(
cloud_region=mock_os_conf.return_value.get_one.return_value,
@ -330,7 +334,8 @@ class TestDeploy(testtools.TestCase):
@mock.patch.object(_cmd.LOG, 'critical', autospec=True)
def test_reservation_failure(self, mock_log, mock_os_conf, mock_pr):
args = ['deploy', '--network', 'mynet', '--image', 'myimg', 'compute']
args = ['deploy', '--network', 'mynet', '--image', 'myimg',
'--resource-class', 'compute']
failure = RuntimeError('boom')
mock_pr.return_value.reserve_node.side_effect = failure
self.assertRaises(SystemExit, _cmd.main, args)
@ -338,7 +343,8 @@ class TestDeploy(testtools.TestCase):
@mock.patch.object(_cmd.LOG, 'critical', autospec=True)
def test_deploy_failure(self, mock_log, mock_os_conf, mock_pr):
args = ['deploy', '--network', 'mynet', '--image', 'myimg', 'compute']
args = ['deploy', '--network', 'mynet', '--image', 'myimg',
'--resource-class', 'compute']
failure = RuntimeError('boom')
mock_pr.return_value.provision_node.side_effect = failure
self.assertRaises(SystemExit, _cmd.main, args)
@ -346,14 +352,15 @@ class TestDeploy(testtools.TestCase):
@mock.patch.object(_cmd.LOG, 'critical', autospec=True)
def test_invalid_hostname(self, mock_log, mock_os_conf, mock_pr):
args = ['deploy', '--hostname', 'n_1', '--image', 'myimg', 'compute']
args = ['deploy', '--hostname', 'n_1', '--image', 'myimg',
'--resource-class', 'compute']
self.assertRaises(SystemExit, _cmd.main, args)
self.assertTrue(mock_log.called)
def test_args_capabilities(self, mock_os_conf, mock_pr):
args = ['deploy', '--network', 'mynet', '--image', 'myimg',
'--capability', 'foo=bar', '--capability', 'answer=42',
'compute']
'--resource-class', 'compute']
_cmd.main(args)
mock_pr.assert_called_once_with(
cloud_region=mock_os_conf.return_value.get_one.return_value,
@ -378,7 +385,7 @@ class TestDeploy(testtools.TestCase):
fp.flush()
args = ['deploy', '--network', 'mynet', '--image', 'myimg',
'--ssh-public-key', fp.name, 'compute']
'--ssh-public-key', fp.name, '--resource-class', 'compute']
_cmd.main(args)
mock_pr.assert_called_once_with(
cloud_region=mock_os_conf.return_value.get_one.return_value,
@ -398,7 +405,8 @@ class TestDeploy(testtools.TestCase):
wait=1800)
def test_args_port(self, mock_os_conf, mock_pr):
args = ['deploy', '--port', 'myport', '--image', 'myimg', 'compute']
args = ['deploy', '--port', 'myport', '--image', 'myimg',
'--resource-class', 'compute']
_cmd.main(args)
mock_pr.assert_called_once_with(
cloud_region=mock_os_conf.return_value.get_one.return_value,
@ -418,7 +426,7 @@ class TestDeploy(testtools.TestCase):
wait=1800)
def test_args_no_nics(self, mock_os_conf, mock_pr):
args = ['deploy', '--image', 'myimg', 'compute']
args = ['deploy', '--image', 'myimg', '--resource-class', 'compute']
_cmd.main(args)
mock_pr.assert_called_once_with(
cloud_region=mock_os_conf.return_value.get_one.return_value,
@ -440,7 +448,7 @@ class TestDeploy(testtools.TestCase):
def test_args_networks_and_ports(self, mock_os_conf, mock_pr):
args = ['deploy', '--network', 'net1', '--port', 'port1',
'--port', 'port2', '--network', 'net2',
'--image', 'myimg', 'compute']
'--image', 'myimg', '--resource-class', 'compute']
_cmd.main(args)
mock_pr.assert_called_once_with(
cloud_region=mock_os_conf.return_value.get_one.return_value,
@ -461,7 +469,8 @@ class TestDeploy(testtools.TestCase):
wait=1800)
def test_args_hostname(self, mock_os_conf, mock_pr):
args = ['deploy', '--hostname', 'host', '--image', 'myimg', 'compute']
args = ['deploy', '--hostname', 'host', '--image', 'myimg',
'--resource-class', 'compute']
_cmd.main(args)
mock_pr.assert_called_once_with(
cloud_region=mock_os_conf.return_value.get_one.return_value,
@ -482,7 +491,7 @@ class TestDeploy(testtools.TestCase):
def test_args_custom_wait(self, mock_os_conf, mock_pr):
args = ['deploy', '--network', 'mynet', '--image', 'myimg',
'--wait', '3600', 'compute']
'--wait', '3600', '--resource-class', 'compute']
_cmd.main(args)
mock_pr.assert_called_once_with(
cloud_region=mock_os_conf.return_value.get_one.return_value,
@ -503,7 +512,7 @@ class TestDeploy(testtools.TestCase):
def test_args_no_wait(self, mock_os_conf, mock_pr):
args = ['deploy', '--network', 'mynet', '--image', 'myimg',
'--no-wait', 'compute']
'--no-wait', '--resource-class', 'compute']
_cmd.main(args)
mock_pr.assert_called_once_with(
cloud_region=mock_os_conf.return_value.get_one.return_value,

2
roles/metalsmith_deployment/tasks/main.yml
View File

@ -22,7 +22,7 @@
{% if netboot %}
--netboot
{% endif %}
{{ resource_class }}
--resource-class {{ resource_class }}
when: state == 'present'
vars:
extra_args: "{{ instance.extra_args | default(metalsmith_extra_args) }}"