# 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. """Tests for `cratonclient.shell.v1.hosts_shell` module.""" import mock import re from argparse import Namespace from testtools import matchers from cratonclient import exceptions as exc from cratonclient.shell.v1 import hosts_shell from cratonclient.tests import base from cratonclient.v1 import hosts class TestHostsShell(base.ShellTestCase): """Test our craton hosts shell commands.""" re_options = re.DOTALL | re.MULTILINE host_valid_fields = None host_invalid_field = None def setUp(self): """Setup required test fixtures.""" super(TestHostsShell, self).setUp() self.host_valid_fields = Namespace(project_id=1, region_id=1, name='mock_host', ip_address='127.0.0.1', active=True) self.host_invalid_field = Namespace(project_id=1, region_id=1, name='mock_host', ip_address='127.0.0.1', active=True, invalid_foo='ignored') @mock.patch('cratonclient.v1.hosts.HostManager.list') def test_host_list_success(self, mock_list): """Verify that no arguments prints out all project hosts.""" self.shell('host-list') self.assertTrue(mock_list.called) @mock.patch('cratonclient.v1.hosts.HostManager.list') def test_host_list_parse_param_success(self, mock_list): """Verify that success of parsing a subcommand argument.""" self.shell('host-list --limit 0') self.assertTrue(mock_list.called) @mock.patch('cratonclient.v1.hosts.HostManager.list') def test_host_list_limit_0_succcess(self, mock_list): """Verify that --limit 0 prints out all project hosts.""" self.shell('host-list --limit 0') mock_list.assert_called_once_with(mock.ANY, limit=0) @mock.patch('cratonclient.v1.hosts.HostManager.list') def test_host_list_limit_positive_num_success(self, mock_list): """Verify --limit X, where X is a positive integer, succeeds. The command will print out X number of project hosts. """ self.shell('host-list --limit 1') mock_list.assert_called_once_with(mock.ANY, limit=1) def test_host_list_limit_negative_num_failure(self): """Verify --limit X, where X is a negative integer, fails. The command will cause a Command Error message response. """ self.assertRaises(exc.CommandError, self.shell, 'host-list --limit -1') @mock.patch('cratonclient.v1.hosts.HostManager.list') def test_host_list_cell_success(self, mock_list): """Verify --cell arguments successfully pass cell to Client.""" for cell_arg in ['-c', '--cell']: self.shell('host-list {0} 1'.format(cell_arg)) mock_list.assert_called_once_with(mock.ANY, cell=1) mock_list.reset_mock() @mock.patch('cratonclient.v1.hosts.HostManager.list') def test_host_list_detail_success(self, mock_list): """Verify --detail argument successfully pass detail to Client.""" self.shell('host-list --detail') mock_list.assert_called_once_with(mock.ANY, detail=True) @mock.patch('cratonclient.v1.hosts.HostManager.list') @mock.patch('cratonclient.common.cliutils.print_list') def test_host_list_fields_success(self, mock_printlist, mock_list): """Verify --fields argument successfully passed to Client.""" self.shell('host-list --fields id name') mock_list.assert_called_once_with(mock.ANY) mock_printlist.assert_called_once_with(mock.ANY, list({'id': 'ID', 'name': 'Name'})) @mock.patch('cratonclient.v1.hosts.HostManager.list') def test_host_list_detail_and_fields_specified(self, mock_list): """Verify --fields ignored when --detail argument passed in.""" self.shell('host-list --fields id name --detail') mock_list.assert_called_once_with(mock.ANY, detail=True) @mock.patch('cratonclient.v1.hosts.HostManager.list') def test_host_list_sort_key_field_key_success(self, mock_list): """Verify --sort-key arguments successfully passed to Client.""" self.shell('host-list --sort-key cell_id') mock_list.assert_called_once_with(mock.ANY, sort_key='cell_id', sort_dir='asc') def test_host_list_sort_key_invalid(self): """Verify --sort-key with invalid args, fails with Command Error.""" self.assertRaises(exc.CommandError, self.shell, 'host-list --sort-key invalid') @mock.patch('cratonclient.v1.hosts.HostManager.list') def test_host_list_sort_dir_not_passed_without_sort_key(self, mock_list): """Verify --sort-dir arg ignored without --sort-key.""" self.shell('host-list --sort-dir desc') mock_list.assert_called_once_with(mock.ANY) @mock.patch('cratonclient.v1.hosts.HostManager.list') def test_host_list_sort_dir_asc_success(self, mock_list): """Verify --sort-dir asc successfully passed to Client.""" self.shell('host-list --sort-key name --sort-dir asc') mock_list.assert_called_once_with(mock.ANY, sort_key='name', sort_dir='asc') @mock.patch('cratonclient.v1.hosts.HostManager.list') def test_host_list_sort_dir_desc_success(self, mock_list): """Verify --sort-dir desc successfully passed to Client.""" self.shell('host-list --sort-key name --sort-dir desc') mock_list.assert_called_once_with(mock.ANY, sort_key='name', sort_dir='desc') def test_host_list_sort_dir_invalid_value(self): """Verify --sort-dir with invalid args, fails with Command Error.""" self.assertRaises(exc.CommandError, self.shell, 'host-list --sort-key name --sort-dir invalid') def test_host_create_missing_required_args(self): """Verify that missing required args results in error message.""" expected_responses = [ '.*?^usage: craton host-create', '.*?^craton host-create: error:.*$' ] stdout, stderr = self.shell('host-create') actual_output = stdout + stderr for r in expected_responses: self.assertThat(actual_output, matchers.MatchesRegex(r, self.re_options)) @mock.patch('cratonclient.v1.hosts.HostManager.create') def test_do_host_create_calls_host_manager_with_fields(self, mock_create): """Verify that do host create calls HostManager create.""" client = mock.Mock() client.hosts = hosts.HostManager(mock.ANY, 'http://127.0.0.1/') hosts_shell.do_host_create(client, self.host_valid_fields) mock_create.assert_called_once_with(**vars(self.host_valid_fields)) @mock.patch('cratonclient.v1.hosts.HostManager.create') def test_do_host_create_ignores_unknown_fields(self, mock_create): """Verify that do host create ignores unknown field.""" client = mock.Mock() client.hosts = hosts.HostManager(mock.ANY, 'http://127.0.0.1/') hosts_shell.do_host_create(client, self.host_invalid_field) mock_create.assert_called_once_with(**vars(self.host_valid_fields))