+import contextlib
import unittest
+from typing import List, Optional
+from unittest import mock
-try:
- import mock
-except ImportError:
- from unittest import mock
+from orchestrator import HostSpec, InventoryHost
-from orchestrator import HostSpec
-
-from . import ControllerTestCase
-from ..controllers.host import get_hosts, Host, HostUi
from .. import mgr
+from ..controllers.host import Host, HostUi, get_device_osd_map, get_hosts, get_inventories
+from ..tools import NotificationQueue, TaskManager
+from . import ControllerTestCase # pylint: disable=no-name-in-module
+
+
+@contextlib.contextmanager
+def patch_orch(available: bool, hosts: Optional[List[HostSpec]] = None,
+ inventory: Optional[List[dict]] = None):
+ with mock.patch('dashboard.controllers.orchestrator.OrchClient.instance') as instance:
+ fake_client = mock.Mock()
+ fake_client.available.return_value = available
+ fake_client.get_missing_features.return_value = []
+
+ if hosts is not None:
+ fake_client.hosts.list.return_value = hosts
+
+ if inventory is not None:
+ def _list_inventory(hosts=None, refresh=False): # pylint: disable=unused-argument
+ inv_hosts = []
+ for inv_host in inventory:
+ if hosts is None or inv_host['name'] in hosts:
+ inv_hosts.append(InventoryHost.from_json(inv_host))
+ return inv_hosts
+ fake_client.inventory.list.side_effect = _list_inventory
+
+ instance.return_value = fake_client
+ yield fake_client
class HostControllerTest(ControllerTestCase):
@classmethod
def setup_server(cls):
+ NotificationQueue.start_queue()
+ TaskManager.init()
# pylint: disable=protected-access
Host._cp_config['tools.authenticate.on'] = False
cls.setup_controllers([Host])
+ @classmethod
+ def tearDownClass(cls):
+ NotificationQueue.stop()
+
@mock.patch('dashboard.controllers.host.get_hosts')
def test_host_list(self, mock_get_hosts):
hosts = [{
self.assertStatus(200)
self.assertJsonBody(hosts)
- @mock.patch('dashboard.controllers.orchestrator.OrchClient.instance')
- def test_get_1(self, instance):
+ def test_get_1(self):
mgr.list_servers.return_value = []
- fake_client = mock.Mock()
- fake_client.available.return_value = False
- instance.return_value = fake_client
-
- self._get('{}/node1'.format(self.URL_HOST))
- self.assertStatus(404)
+ with patch_orch(False):
+ self._get('{}/node1'.format(self.URL_HOST))
+ self.assertStatus(404)
- @mock.patch('dashboard.controllers.orchestrator.OrchClient.instance')
- def test_get_2(self, instance):
+ def test_get_2(self):
mgr.list_servers.return_value = [{'hostname': 'node1'}]
- fake_client = mock.Mock()
- fake_client.available.return_value = False
- instance.return_value = fake_client
-
- self._get('{}/node1'.format(self.URL_HOST))
- self.assertStatus(200)
- self.assertIn('labels', self.json_body())
+ with patch_orch(False):
+ self._get('{}/node1'.format(self.URL_HOST))
+ self.assertStatus(200)
+ self.assertIn('labels', self.json_body())
- @mock.patch('dashboard.controllers.orchestrator.OrchClient.instance')
- def test_get_3(self, instance):
+ def test_get_3(self):
mgr.list_servers.return_value = []
- fake_client = mock.Mock()
- fake_client.available.return_value = True
- fake_client.hosts.list.return_value = [HostSpec('node1')]
- instance.return_value = fake_client
-
- self._get('{}/node1'.format(self.URL_HOST))
- self.assertStatus(200)
- self.assertIn('labels', self.json_body())
+ with patch_orch(True, hosts=[HostSpec('node1')]):
+ self._get('{}/node1'.format(self.URL_HOST))
+ self.assertStatus(200)
+ self.assertIn('labels', self.json_body())
- @mock.patch('dashboard.controllers.orchestrator.OrchClient.instance')
- def test_set_labels(self, instance):
+ def test_set_labels(self):
mgr.list_servers.return_value = []
-
- fake_client = mock.Mock()
- fake_client.available.return_value = True
- fake_client.hosts.list.return_value = [
+ orch_hosts = [
HostSpec('node0', labels=['aaa', 'bbb'])
]
- fake_client.hosts.remove_label = mock.Mock()
- fake_client.hosts.add_label = mock.Mock()
- instance.return_value = fake_client
+ with patch_orch(True, hosts=orch_hosts) as fake_client:
+ fake_client.hosts.remove_label = mock.Mock()
+ fake_client.hosts.add_label = mock.Mock()
+
+ payload = {'update_labels': True, 'labels': ['bbb', 'ccc']}
+ self._put('{}/node0'.format(self.URL_HOST), payload)
+ self.assertStatus(200)
+ fake_client.hosts.remove_label.assert_called_once_with('node0', 'aaa')
+ fake_client.hosts.add_label.assert_called_once_with('node0', 'ccc')
+
+ # return 400 if type other than List[str]
+ self._put('{}/node0'.format(self.URL_HOST), {'update_labels': True,
+ 'labels': 'ddd'})
+ self.assertStatus(400)
+
+ def test_host_maintenance(self):
+ mgr.list_servers.return_value = []
+ orch_hosts = [
+ HostSpec('node0'),
+ HostSpec('node1')
+ ]
+ with patch_orch(True, hosts=orch_hosts):
+ # enter maintenance mode
+ self._put('{}/node0'.format(self.URL_HOST), {'maintenance': True})
+ self.assertStatus(200)
+
+ # force enter maintenance mode
+ self._put('{}/node1'.format(self.URL_HOST), {'maintenance': True, 'force': True})
+ self.assertStatus(200)
+
+ # exit maintenance mode
+ self._put('{}/node0'.format(self.URL_HOST), {'maintenance': True})
+ self.assertStatus(200)
+ self._put('{}/node1'.format(self.URL_HOST), {'maintenance': True})
+ self.assertStatus(200)
+
+ # maintenance without orchestrator service
+ with patch_orch(False):
+ self._put('{}/node0'.format(self.URL_HOST), {'maintenance': True})
+ self.assertStatus(503)
+
+ @mock.patch('dashboard.controllers.host.time')
+ def test_identify_device(self, mock_time):
+ url = '{}/host-0/identify_device'.format(self.URL_HOST)
+ with patch_orch(True) as fake_client:
+ payload = {
+ 'device': '/dev/sdz',
+ 'duration': '1'
+ }
+ self._task_post(url, payload)
+ self.assertStatus(200)
+ mock_time.sleep.assert_called()
+ calls = [
+ mock.call('host-0', '/dev/sdz', 'ident', True),
+ mock.call('host-0', '/dev/sdz', 'ident', False),
+ ]
+ fake_client.blink_device_light.assert_has_calls(calls)
+
+ @mock.patch('dashboard.controllers.host.get_inventories')
+ def test_inventory(self, mock_get_inventories):
+ inventory_url = '{}/host-0/inventory'.format(self.URL_HOST)
+ with patch_orch(True):
+ tests = [
+ {
+ 'url': inventory_url,
+ 'inventories': [{'a': 'b'}],
+ 'refresh': None,
+ 'resp': {'a': 'b'}
+ },
+ {
+ 'url': '{}?refresh=true'.format(inventory_url),
+ 'inventories': [{'a': 'b'}],
+ 'refresh': "true",
+ 'resp': {'a': 'b'}
+ },
+ {
+ 'url': inventory_url,
+ 'inventories': [],
+ 'refresh': None,
+ 'resp': {}
+ },
+ ]
+ for test in tests:
+ mock_get_inventories.reset_mock()
+ mock_get_inventories.return_value = test['inventories']
+ self._get(test['url'])
+ mock_get_inventories.assert_called_once_with(['host-0'], test['refresh'])
+ self.assertEqual(self.json_body(), test['resp'])
+ self.assertStatus(200)
- self._put('{}/node0'.format(self.URL_HOST), {'labels': ['bbb', 'ccc']})
- self.assertStatus(200)
- fake_client.hosts.remove_label.assert_called_once_with('node0', 'aaa')
- fake_client.hosts.add_label.assert_called_once_with('node0', 'ccc')
+ # list without orchestrator service
+ with patch_orch(False):
+ self._get(inventory_url)
+ self.assertStatus(503)
class HostUiControllerTest(ControllerTestCase):
HostUi._cp_config['tools.authenticate.on'] = False
cls.setup_controllers([HostUi])
- @mock.patch('dashboard.controllers.orchestrator.OrchClient.instance')
- def test_labels(self, instance):
- fake_client = mock.Mock()
- fake_client.available.return_value = True
- fake_client.hosts.list.return_value = [
+ def test_labels(self):
+ orch_hosts = [
HostSpec('node1', labels=['foo']),
HostSpec('node2', labels=['foo', 'bar'])
]
- instance.return_value = fake_client
- self._get('{}/labels'.format(self.URL_HOST))
- self.assertStatus(200)
- labels = self.json_body()
- labels.sort()
- self.assertListEqual(labels, ['bar', 'foo'])
+ with patch_orch(True, hosts=orch_hosts):
+ self._get('{}/labels'.format(self.URL_HOST))
+ self.assertStatus(200)
+ labels = self.json_body()
+ labels.sort()
+ self.assertListEqual(labels, ['bar', 'foo'])
+
+ @mock.patch('dashboard.controllers.host.get_inventories')
+ def test_inventory(self, mock_get_inventories):
+ inventory_url = '{}/inventory'.format(self.URL_HOST)
+ with patch_orch(True):
+ tests = [
+ {
+ 'url': inventory_url,
+ 'refresh': None
+ },
+ {
+ 'url': '{}?refresh=true'.format(inventory_url),
+ 'refresh': "true"
+ },
+ ]
+ for test in tests:
+ mock_get_inventories.reset_mock()
+ mock_get_inventories.return_value = [{'a': 'b'}]
+ self._get(test['url'])
+ mock_get_inventories.assert_called_once_with(None, test['refresh'])
+ self.assertEqual(self.json_body(), [{'a': 'b'}])
+ self.assertStatus(200)
+
+ # list without orchestrator service
+ with patch_orch(False):
+ self._get(inventory_url)
+ self.assertStatus(503)
class TestHosts(unittest.TestCase):
- @mock.patch('dashboard.controllers.orchestrator.OrchClient.instance')
- def test_get_hosts(self, instance):
+ def test_get_hosts(self):
mgr.list_servers.return_value = [{
'hostname': 'node1'
}, {
'hostname': 'localhost'
}]
-
- fake_client = mock.Mock()
- fake_client.available.return_value = True
- fake_client.hosts.list.return_value = [
+ orch_hosts = [
HostSpec('node1', labels=['foo', 'bar']),
HostSpec('node2', labels=['bar'])
]
- instance.return_value = fake_client
- hosts = get_hosts()
- self.assertEqual(len(hosts), 3)
- checks = {
- 'localhost': {
- 'sources': {
- 'ceph': True,
- 'orchestrator': False
+ with patch_orch(True, hosts=orch_hosts):
+ hosts = get_hosts()
+ self.assertEqual(len(hosts), 3)
+ checks = {
+ 'localhost': {
+ 'sources': {
+ 'ceph': True,
+ 'orchestrator': False
+ },
+ 'labels': []
},
- 'labels': []
+ 'node1': {
+ 'sources': {
+ 'ceph': True,
+ 'orchestrator': True
+ },
+ 'labels': ['bar', 'foo']
+ },
+ 'node2': {
+ 'sources': {
+ 'ceph': False,
+ 'orchestrator': True
+ },
+ 'labels': ['bar']
+ }
+ }
+ for host in hosts:
+ hostname = host['hostname']
+ self.assertDictEqual(host['sources'], checks[hostname]['sources'])
+ self.assertListEqual(host['labels'], checks[hostname]['labels'])
+
+ @mock.patch('dashboard.controllers.host.mgr.get')
+ def test_get_device_osd_map(self, mgr_get):
+ mgr_get.side_effect = lambda key: {
+ 'osd_metadata': {
+ '0': {
+ 'hostname': 'node0',
+ 'devices': 'nvme0n1,sdb',
+ },
+ '1': {
+ 'hostname': 'node0',
+ 'devices': 'nvme0n1,sdc',
+ },
+ '2': {
+ 'hostname': 'node1',
+ 'devices': 'sda',
+ },
+ '3': {
+ 'hostname': 'node2',
+ 'devices': '',
+ }
+ }
+ }[key]
+
+ device_osd_map = get_device_osd_map()
+ mgr.get.assert_called_with('osd_metadata')
+ # sort OSD IDs to make assertDictEqual work
+ for devices in device_osd_map.values():
+ for host in devices.keys():
+ devices[host] = sorted(devices[host])
+ self.assertDictEqual(device_osd_map, {
+ 'node0': {
+ 'nvme0n1': [0, 1],
+ 'sdb': [0],
+ 'sdc': [1],
},
'node1': {
- 'sources': {
- 'ceph': True,
- 'orchestrator': True
- },
- 'labels': ['bar', 'foo']
+ 'sda': [2]
+ }
+ })
+
+ @mock.patch('dashboard.controllers.host.str_to_bool')
+ @mock.patch('dashboard.controllers.host.get_device_osd_map')
+ def test_get_inventories(self, mock_get_device_osd_map, mock_str_to_bool):
+ mock_get_device_osd_map.return_value = {
+ 'host-0': {
+ 'nvme0n1': [1, 2],
+ 'sdb': [1],
+ 'sdc': [2]
},
- 'node2': {
- 'sources': {
- 'ceph': False,
- 'orchestrator': True
- },
- 'labels': ['bar']
+ 'host-1': {
+ 'sdb': [3]
}
}
- for host in hosts:
- hostname = host['hostname']
- self.assertDictEqual(host['sources'], checks[hostname]['sources'])
- self.assertListEqual(host['labels'], checks[hostname]['labels'])
+ inventory = [
+ {
+ 'name': 'host-0',
+ 'addr': '1.2.3.4',
+ 'devices': [
+ {'path': 'nvme0n1'},
+ {'path': '/dev/sdb'},
+ {'path': '/dev/sdc'},
+ ]
+ },
+ {
+ 'name': 'host-1',
+ 'addr': '1.2.3.5',
+ 'devices': [
+ {'path': '/dev/sda'},
+ {'path': 'sdb'},
+ ]
+ }
+ ]
+
+ with patch_orch(True, inventory=inventory) as orch_client:
+ mock_str_to_bool.return_value = True
+
+ hosts = ['host-0', 'host-1']
+ inventories = get_inventories(hosts, 'true')
+ mock_str_to_bool.assert_called_with('true')
+ orch_client.inventory.list.assert_called_once_with(hosts=hosts, refresh=True)
+ self.assertEqual(len(inventories), 2)
+ host0 = inventories[0]
+ self.assertEqual(host0['name'], 'host-0')
+ self.assertEqual(host0['addr'], '1.2.3.4')
+ self.assertEqual(host0['devices'][0]['osd_ids'], [1, 2])
+ self.assertEqual(host0['devices'][1]['osd_ids'], [1])
+ self.assertEqual(host0['devices'][2]['osd_ids'], [2])
+ host1 = inventories[1]
+ self.assertEqual(host1['name'], 'host-1')
+ self.assertEqual(host1['addr'], '1.2.3.5')
+ self.assertEqual(host1['devices'][0]['osd_ids'], [])
+ self.assertEqual(host1['devices'][1]['osd_ids'], [3])
projects / ceph.git / blobdiff