yardstick/tests/unit/orchestrator/test_kubernetes.py

   1 ##############################################################################
   2 # Copyright (c) 2017 Intel Corporation
   3 #
   4 # All rights reserved. This program and the accompanying materials
   5 # are made available under the terms of the Apache License, Version 2.0
   6 # which accompanies this distribution, and is available at
   7 # http://www.apache.org/licenses/LICENSE-2.0
   8 ##############################################################################
   9
  10 import copy
  11
  12 import mock
  13
  14 from yardstick.common import exceptions
  15 from yardstick.common import kubernetes_utils
  16 from yardstick.orchestrator import kubernetes
  17 from yardstick.tests.unit import base
  18
  19
  20 class GetTemplateTestCase(base.BaseUnitTestCase):
  21
  22     def test_get_template(self):
  23         output_t = {
  24             "apiVersion": "v1",
  25             "kind": "ReplicationController",
  26             "metadata": {
  27                 "name": "host-k8s-86096c30"
  28             },
  29             "spec": {
  30                 "replicas": 1,
  31                 "template": {
  32                     "metadata": {
  33                         "labels": {
  34                             "app": "host-k8s-86096c30"
  35                         }
  36                     },
  37                     "spec": {
  38                         "containers": [
  39                             {
  40                                 "args": [
  41                                     "-c",
  42                                     "chmod 700 ~/.ssh; chmod 600 ~/.ssh/*; \
  43 service ssh restart;while true ; do sleep 10000; done"
  44                                 ],
  45                                 "command": [
  46                                     "/bin/bash"
  47                                 ],
  48                                 "image": "openretriever/yardstick",
  49                                 "name": "host-k8s-86096c30-container",
  50                                 "volumeMounts": [
  51                                     {
  52                                         "mountPath": "/tmp/.ssh/",
  53                                         "name": "k8s-86096c30-key",
  54                                         "readOnly": False
  55                                     }
  56                                 ]
  57                             }
  58                         ],
  59                         "volumes": [
  60                             {
  61                                 "configMap": {
  62                                     "name": "k8s-86096c30-key"
  63                                 },
  64                                 "name": "k8s-86096c30-key"
  65                             }
  66                         ],
  67                         "nodeSelector": {
  68                             "kubernetes.io/hostname": "node-01"
  69                         },
  70                         "restartPolicy": "Always",
  71                         "tolerations": [
  72                             {"operator": "Exists"}
  73                         ]
  74                     }
  75                 }
  76             }
  77         }
  78         input_s = {
  79             'command': '/bin/bash',
  80             'args': ['-c', 'chmod 700 ~/.ssh; chmod 600 ~/.ssh/*; \
  81 service ssh restart;while true ; do sleep 10000; done'],
  82             'ssh_key': 'k8s-86096c30-key',
  83             'nodeSelector': {'kubernetes.io/hostname': 'node-01'},
  84             'volumes': [],
  85             'restartPolicy': 'Always'
  86         }
  87         name = 'host-k8s-86096c30'
  88         output_r = kubernetes.ReplicationControllerObject(
  89             name, **input_s).get_template()
  90         self.assertEqual(output_r, output_t)
  91
  92     def test_get_template_invalid_restart_policy(self):
  93         input_s = {'restartPolicy': 'invalid_option'}
  94         name = 'host-k8s-86096c30'
  95         with self.assertRaises(exceptions.KubernetesWrongRestartPolicy):
  96             kubernetes.ReplicationControllerObject(
  97                 name, **input_s).get_template()
  98
  99
 100 class GetRcPodsTestCase(base.BaseUnitTestCase):
 101
 102     @mock.patch('yardstick.orchestrator.kubernetes.k8s_utils.get_pod_list')
 103     def test_get_rc_pods(self, mock_get_pod_list):
 104         servers = {
 105             'host': {
 106                 'image': 'openretriever/yardstick',
 107                 'command': '/bin/bash',
 108                 'args': ['-c', 'chmod 700 ~/.ssh; chmod 600 ~/.ssh/*; \
 109 service ssh restart;while true ; do sleep 10000; done']
 110             },
 111             'target': {
 112                 'image': 'openretriever/yardstick',
 113                 'command': '/bin/bash',
 114                 'args': ['-c', 'chmod 700 ~/.ssh; chmod 600 ~/.ssh/*; \
 115 service ssh restart;while true ; do sleep 10000; done']
 116             }
 117         }
 118         k8s_template = kubernetes.KubernetesTemplate('k8s-86096c30', servers)
 119         mock_get_pod_list.return_value.items = []
 120         pods = k8s_template.get_rc_pods()
 121         self.assertEqual(pods, [])
 122
 123
 124 class ReplicationControllerObjectTestCase(base.BaseUnitTestCase):
 125
 126     def test__init_one_container(self):
 127         pod_name = 'pod_name'
 128         _kwargs = {'args': ['arg1', 'arg2'],
 129                    'image': 'fake_image',
 130                    'command': 'fake_command'}
 131         k8s_obj = kubernetes.ReplicationControllerObject(pod_name, **_kwargs)
 132         self.assertEqual(1, len(k8s_obj._containers))
 133         container = k8s_obj._containers[0]
 134         self.assertEqual(['arg1', 'arg2'], container._args)
 135         self.assertEqual('fake_image', container._image)
 136         self.assertEqual(['fake_command'], container._command)
 137         self.assertEqual([], container._volume_mounts)
 138
 139     def test__init_multipe_containers(self):
 140         pod_name = 'pod_name'
 141         containers = []
 142         for i in range(5):
 143             containers.append({'args': ['arg1', 'arg2'],
 144                                'image': 'fake_image_%s' % i,
 145                                'command': 'fake_command_%s' % i})
 146         _kwargs = {'containers': containers}
 147         k8s_obj = kubernetes.ReplicationControllerObject(pod_name, **_kwargs)
 148         self.assertEqual(5, len(k8s_obj._containers))
 149         for i in range(5):
 150             container = k8s_obj._containers[i]
 151             self.assertEqual(['arg1', 'arg2'], container._args)
 152             self.assertEqual('fake_image_%s' % i, container._image)
 153             self.assertEqual(['fake_command_%s' % i], container._command)
 154             self.assertEqual([], container._volume_mounts)
 155
 156     def test__add_volumes(self):
 157         volume1 = {'name': 'fake_sshkey',
 158                    'configMap': {'name': 'fake_sshkey'}}
 159         volume2 = {'name': 'volume2',
 160                    'configMap': 'data'}
 161         k8s_obj = kubernetes.ReplicationControllerObject(
 162             'name', ssh_key='fake_sshkey', volumes=[volume2])
 163         k8s_obj._add_volumes()
 164         volumes = k8s_obj.template['spec']['template']['spec']['volumes']
 165         self.assertEqual(sorted([volume1, volume2], key=lambda k: k['name']),
 166                          sorted(volumes, key=lambda k: k['name']))
 167
 168     def test__add_volumes_no_volumes(self):
 169         volume1 = {'name': 'fake_sshkey',
 170                    'configMap': {'name': 'fake_sshkey'}}
 171         k8s_obj = kubernetes.ReplicationControllerObject(
 172             'name', ssh_key='fake_sshkey')
 173         k8s_obj._add_volumes()
 174         volumes = k8s_obj.template['spec']['template']['spec']['volumes']
 175         self.assertEqual([volume1], volumes)
 176
 177     def test__create_ssh_key_volume(self):
 178         expected = {'name': 'fake_sshkey',
 179                     'configMap': {'name': 'fake_sshkey'}}
 180         k8s_obj = kubernetes.ReplicationControllerObject(
 181             'name', ssh_key='fake_sshkey')
 182         self.assertEqual(expected, k8s_obj._create_ssh_key_volume())
 183
 184     def test__create_volume_item(self):
 185         for vol_type in kubernetes_utils.get_volume_types():
 186             volume = {'name': 'vol_name',
 187                       vol_type: 'data'}
 188             self.assertEqual(
 189                 volume,
 190                 kubernetes.ReplicationControllerObject.
 191                     _create_volume_item(volume))
 192
 193     def test__create_volume_item_invalid_type(self):
 194         volume = {'name': 'vol_name',
 195                   'invalid_type': 'data'}
 196         with self.assertRaises(exceptions.KubernetesTemplateInvalidVolumeType):
 197             kubernetes.ReplicationControllerObject._create_volume_item(volume)
 198
 199     def test__add_security_context(self):
 200         k8s_obj = kubernetes.ReplicationControllerObject('pod_name')
 201         self.assertNotIn('securityContext',
 202                          k8s_obj.template['spec']['template']['spec'])
 203
 204         k8s_obj._security_context = {'key_pod': 'value_pod'}
 205         k8s_obj._add_security_context()
 206         self.assertEqual(
 207             {'key_pod': 'value_pod'},
 208             k8s_obj.template['spec']['template']['spec']['securityContext'])
 209
 210     def test__add_security_context_by_init(self):
 211         containers = []
 212         for i in range(5):
 213             containers.append(
 214                 {'securityContext': {'key%s' % i: 'value%s' % i}})
 215         _kwargs = {'containers': containers,
 216                    'securityContext': {'key_pod': 'value_pod'}}
 217         k8s_obj = kubernetes.ReplicationControllerObject('pod_name', **_kwargs)
 218         self.assertEqual(
 219             {'key_pod': 'value_pod'},
 220             k8s_obj.template['spec']['template']['spec']['securityContext'])
 221         for i in range(5):
 222             container = (
 223                 k8s_obj.template['spec']['template']['spec']['containers'][i])
 224             self.assertEqual({'key%s' % i: 'value%s' % i},
 225                              container['securityContext'])
 226
 227     def test__add_networks(self):
 228         k8s_obj = kubernetes.ReplicationControllerObject(
 229             'name', networks=['network1', 'network2', 'network3'])
 230         k8s_obj._add_networks()
 231         networks = k8s_obj.\
 232             template['spec']['template']['metadata']['annotations']['networks']
 233         expected = ('[{"name": "network1"}, {"name": "network2"}, '
 234                     '{"name": "network3"}]')
 235         self.assertEqual(expected, networks)
 236
 237     def test__add_tolerations(self):
 238         _kwargs = {'tolerations': [{'key': 'key1',
 239                                     'value': 'value2',
 240                                     'effect': 'effect3',
 241                                     'operator': 'operator4',
 242                                     'wrong_key': 'error_key'}]
 243                    }
 244         k8s_obj = kubernetes.ReplicationControllerObject('pod_name', **_kwargs)
 245         k8s_obj._add_tolerations()
 246         _tol = k8s_obj.template['spec']['template']['spec']['tolerations']
 247         self.assertEqual(1, len(_tol))
 248         self.assertEqual({'key': 'key1',
 249                           'value': 'value2',
 250                           'effect': 'effect3',
 251                           'operator': 'operator4'},
 252                          _tol[0])
 253
 254     def test__add_tolerations_default(self):
 255         k8s_obj = kubernetes.ReplicationControllerObject('pod_name')
 256         k8s_obj._add_tolerations()
 257         _tol = k8s_obj.template['spec']['template']['spec']['tolerations']
 258         self.assertEqual(1, len(_tol))
 259         self.assertEqual({'operator': 'Exists'}, _tol[0])
 260
 261
 262 class ContainerObjectTestCase(base.BaseUnitTestCase):
 263
 264     def test__create_volume_mounts(self):
 265         volume_mount = {'name': 'fake_name',
 266                         'mountPath': 'fake_path'}
 267         ssh_vol = {'name': 'fake_ssh_key',
 268                    'mountPath': kubernetes.ContainerObject.SSH_MOUNT_PATH,
 269                    'readOnly': False}
 270         expected = copy.deepcopy(volume_mount)
 271         expected['readOnly'] = False
 272         expected = [expected, ssh_vol]
 273         container_obj = kubernetes.ContainerObject(
 274             'cname', 'fake_ssh_key', volumeMounts=[volume_mount])
 275         output = container_obj._create_volume_mounts()
 276         self.assertEqual(expected, output)
 277
 278     def test__create_volume_mounts_no_volume_mounts(self):
 279         ssh_vol = {'name': 'fake_ssh_key2',
 280                    'mountPath': kubernetes.ContainerObject.SSH_MOUNT_PATH,
 281                    'readOnly': False}
 282         container_obj = kubernetes.ContainerObject('name', 'fake_ssh_key2')
 283         output = container_obj._create_volume_mounts()
 284         self.assertEqual([ssh_vol], output)
 285
 286     def test__create_volume_mounts_item(self):
 287         volume_mount = {'name': 'fake_name',
 288                         'mountPath': 'fake_path'}
 289         expected = copy.deepcopy(volume_mount)
 290         expected['readOnly'] = False
 291         output = kubernetes.ContainerObject._create_volume_mounts_item(
 292             volume_mount)
 293         self.assertEqual(expected, output)
 294
 295     def test_get_container_item(self):
 296         volume_mount = {'name': 'fake_name',
 297                         'mountPath': 'fake_path'}
 298         args = ['arg1', 'arg2']
 299         container_obj = kubernetes.ContainerObject(
 300             'cname', ssh_key='fake_sshkey', volumeMount=[volume_mount],
 301             args=args)
 302         expected = {'args': args,
 303                     'command': [kubernetes.ContainerObject.COMMAND_DEFAULT],
 304                     'image': kubernetes.ContainerObject.IMAGE_DEFAULT,
 305                     'name': 'cname-container',
 306                     'volumeMounts': container_obj._create_volume_mounts()}
 307         self.assertEqual(expected, container_obj.get_container_item())
 308
 309     def test_get_container_item_with_security_context(self):
 310         volume_mount = {'name': 'fake_name',
 311                         'mountPath': 'fake_path'}
 312         args = ['arg1', 'arg2']
 313         container_obj = kubernetes.ContainerObject(
 314             'cname', ssh_key='fake_sshkey', volumeMount=[volume_mount],
 315             args=args, securityContext={'key': 'value'})
 316         expected = {'args': args,
 317                     'command': [kubernetes.ContainerObject.COMMAND_DEFAULT],
 318                     'image': kubernetes.ContainerObject.IMAGE_DEFAULT,
 319                     'name': 'cname-container',
 320                     'volumeMounts': container_obj._create_volume_mounts(),
 321                     'securityContext': {'key': 'value'}}
 322         self.assertEqual(expected, container_obj.get_container_item())
 323
 324     def test_get_container_item_with_env(self):
 325         volume_mount = {'name': 'fake_name',
 326                         'mountPath': 'fake_path'}
 327         args = ['arg1', 'arg2']
 328         container_obj = kubernetes.ContainerObject(
 329             'cname', ssh_key='fake_sshkey', volumeMount=[volume_mount],
 330             args=args, env=[{'name': 'fake_var_name',
 331                              'value': 'fake_var_value'}])
 332         expected = {'args': args,
 333                     'command': [kubernetes.ContainerObject.COMMAND_DEFAULT],
 334                     'image': kubernetes.ContainerObject.IMAGE_DEFAULT,
 335                     'name': 'cname-container',
 336                     'volumeMounts': container_obj._create_volume_mounts(),
 337                     'env': [{'name': 'fake_var_name',
 338                              'value': 'fake_var_value'}]}
 339         self.assertEqual(expected, container_obj.get_container_item())
 340
 341     def test_get_container_item_with_ports_multi_parameter(self):
 342         volume_mount = {'name': 'fake_name',
 343                         'mountPath': 'fake_path'}
 344         args = ['arg1', 'arg2']
 345         container_obj = kubernetes.ContainerObject(
 346             'cname', ssh_key='fake_sshkey', volumeMount=[volume_mount],
 347             args=args, ports=[{'containerPort': 'fake_port_name',
 348                                'hostPort': 'fake_host_port',
 349                                'name': 'fake_name',
 350                                'protocol': 'fake_protocol',
 351                                'invalid_varible': 'fakeinvalid_varible',
 352                                'hostIP': 'fake_port_number'}])
 353         expected = {'args': args,
 354                     'command': [
 355                         kubernetes.ContainerObject.COMMAND_DEFAULT],
 356                     'image': kubernetes.ContainerObject.IMAGE_DEFAULT,
 357                     'name': 'cname-container',
 358                     'volumeMounts': container_obj._create_volume_mounts(),
 359                     'ports': [{'containerPort': 'fake_port_name',
 360                                'hostPort': 'fake_host_port',
 361                                'name': 'fake_name',
 362                                'protocol': 'fake_protocol',
 363                                'hostIP': 'fake_port_number'}]}
 364         self.assertEqual(expected, container_obj.get_container_item())
 365
 366     def test_get_container_item_with_ports_no_container_port(self):
 367         with self.assertRaises(exceptions.KubernetesContainerPortNotDefined):
 368             volume_mount = {'name': 'fake_name',
 369                             'mountPath': 'fake_path'}
 370             args = ['arg1', 'arg2']
 371             container_obj = kubernetes.ContainerObject(
 372                     'cname', ssh_key='fake_sshkey', volumeMount=[volume_mount],
 373                     args=args, ports=[{'hostPort': 'fake_host_port',
 374                                        'name': 'fake_name',
 375                                        'protocol': 'fake_protocol',
 376                                        'hostIP': 'fake_port_number'}])
 377             container_obj.get_container_item()
 378
 379     def test_get_container_item_with_resources(self):
 380         volume_mount = {'name': 'fake_name',
 381                         'mountPath': 'fake_path'}
 382         args = ['arg1', 'arg2']
 383         resources = {'requests': {'key1': 'val1'},
 384                      'limits': {'key2': 'val2'},
 385                      'other_key': {'key3': 'val3'}}
 386         container_obj = kubernetes.ContainerObject(
 387             'cname', ssh_key='fake_sshkey', volumeMount=[volume_mount],
 388             args=args, resources=resources)
 389         expected = {'args': args,
 390                     'command': [kubernetes.ContainerObject.COMMAND_DEFAULT],
 391                     'image': kubernetes.ContainerObject.IMAGE_DEFAULT,
 392                     'name': 'cname-container',
 393                     'volumeMounts': container_obj._create_volume_mounts(),
 394                     'resources': {'requests': {'key1': 'val1'},
 395                                   'limits': {'key2': 'val2'}}}
 396         self.assertEqual(expected, container_obj.get_container_item())
 397
 398
 399 class CustomResourceDefinitionObjectTestCase(base.BaseUnitTestCase):
 400
 401     def test__init(self):
 402         template = {
 403             'metadata': {
 404                 'name': 'newcrds.ctx_name.com'
 405             },
 406             'spec': {
 407                 'group': 'ctx_name.com',
 408                 'version': 'v2',
 409                 'scope': 'scope',
 410                 'names': {'plural': 'newcrds',
 411                           'singular': 'newcrd',
 412                           'kind': 'Newcrd'}
 413             }
 414         }
 415         crd_obj = kubernetes.CustomResourceDefinitionObject(
 416             'ctx_name', name='newcrd', version='v2', scope='scope')
 417         self.assertEqual('newcrds.ctx_name.com', crd_obj._name)
 418         self.assertEqual(template, crd_obj._template)
 419
 420     def test__init_missing_parameter(self):
 421         with self.assertRaises(exceptions.KubernetesCRDObjectDefinitionError):
 422             kubernetes.CustomResourceDefinitionObject('ctx_name',
 423                                                       noname='name')
 424
 425
 426 class NetworkObjectTestCase(base.BaseUnitTestCase):
 427
 428     def setUp(self):
 429         self.net_obj = kubernetes.NetworkObject(name='fake_name',
 430                                                 plugin='fake_plugin',
 431                                                 args='fake_args')
 432
 433     def test__init_missing_parameter(self):
 434         with self.assertRaises(
 435                 exceptions.KubernetesNetworkObjectDefinitionError):
 436             kubernetes.NetworkObject('network_name', plugin='plugin')
 437         with self.assertRaises(
 438                 exceptions.KubernetesNetworkObjectDefinitionError):
 439             kubernetes.NetworkObject('network_name', args='args')
 440
 441     @mock.patch.object(kubernetes_utils, 'get_custom_resource_definition')
 442     def test_crd(self, mock_get_crd):
 443         mock_crd = mock.Mock()
 444         mock_get_crd.return_value = mock_crd
 445         net_obj = copy.deepcopy(self.net_obj)
 446         self.assertEqual(mock_crd, net_obj.crd)
 447
 448     def test_template(self):
 449         net_obj = copy.deepcopy(self.net_obj)
 450         expected = {'apiVersion': 'group.com/v2',
 451                     'kind': kubernetes.NetworkObject.KIND,
 452                     'metadata': {
 453                         'name': 'fake_name'},
 454                     'plugin': 'fake_plugin',
 455                     'args': 'fake_args'}
 456         crd = mock.Mock()
 457         crd.spec.group = 'group.com'
 458         crd.spec.version = 'v2'
 459         net_obj._crd = crd
 460         self.assertEqual(expected, net_obj.template)
 461
 462     def test_group(self):
 463         net_obj = copy.deepcopy(self.net_obj)
 464         net_obj._crd = mock.Mock()
 465         net_obj._crd.spec.group = 'fake_group'
 466         self.assertEqual('fake_group', net_obj.group)
 467
 468     def test_version(self):
 469         net_obj = copy.deepcopy(self.net_obj)
 470         net_obj._crd = mock.Mock()
 471         net_obj._crd.spec.version = 'version_4'
 472         self.assertEqual('version_4', net_obj.version)
 473
 474     def test_plural(self):
 475         net_obj = copy.deepcopy(self.net_obj)
 476         net_obj._crd = mock.Mock()
 477         net_obj._crd.spec.names.plural = 'name_ending_in_s'
 478         self.assertEqual('name_ending_in_s', net_obj.plural)
 479
 480     def test_scope(self):
 481         net_obj = copy.deepcopy(self.net_obj)
 482         net_obj._crd = mock.Mock()
 483         net_obj._crd.spec.scope = 'Cluster'
 484         self.assertEqual('Cluster', net_obj.scope)
 485
 486     @mock.patch.object(kubernetes_utils, 'create_network')
 487     def test_create(self, mock_create_network):
 488         net_obj = copy.deepcopy(self.net_obj)
 489         net_obj._scope = 'scope'
 490         net_obj._group = 'group'
 491         net_obj._version = 'version'
 492         net_obj._plural = 'plural'
 493         net_obj._template = 'template'
 494         net_obj.create()
 495         mock_create_network.assert_called_once_with(
 496             'scope', 'group', 'version', 'plural', 'template')
 497
 498     @mock.patch.object(kubernetes_utils, 'delete_network')
 499     def test_delete(self, mock_delete_network):
 500         net_obj = copy.deepcopy(self.net_obj)
 501         net_obj._scope = 'scope'
 502         net_obj._group = 'group'
 503         net_obj._version = 'version'
 504         net_obj._plural = 'plural'
 505         net_obj._name = 'name'
 506         net_obj.delete()
 507         mock_delete_network.assert_called_once_with(
 508             'scope', 'group', 'version', 'plural', 'name')
 509
 510
 511 class ServiceNodePortObjectTestCase(base.BaseUnitTestCase):
 512
 513     def test__init(self):
 514         with mock.patch.object(kubernetes.ServiceNodePortObject, '_add_port') \
 515                 as mock_add_port:
 516             kubernetes.ServiceNodePortObject('fake_name',
 517                                              node_ports=[{'port': 80}])
 518
 519         mock_add_port.assert_has_calls([mock.call(22, protocol='TCP'),
 520                                         mock.call(80)])
 521
 522     def test__add_port(self):
 523         nodeport_object = kubernetes.ServiceNodePortObject('fake_name')
 524         port_ssh = {'port': 22,
 525                     'protocol': 'TCP',}
 526         port_definition = {'port': 80,
 527                            'protocol': 'TCP',
 528                            'name': 'web',
 529                            'targetPort': 10080,
 530                            'nodePort': 30080}
 531         port = copy.deepcopy(port_definition)
 532         port.pop('port')
 533         nodeport_object._add_port(80, **port)
 534         self.assertEqual([port_ssh, port_definition],
 535                          nodeport_object.template['spec']['ports'])
 536
 537     @mock.patch.object(kubernetes_utils, 'create_service')
 538     def test_create(self, mock_create_service):
 539         nodeport_object = kubernetes.ServiceNodePortObject('fake_name')
 540         nodeport_object.template = 'fake_template'
 541         nodeport_object.create()
 542         mock_create_service.assert_called_once_with('fake_template')
 543
 544     @mock.patch.object(kubernetes_utils, 'delete_service')
 545     def test_delete(self, mock_delete_service):
 546         nodeport_object = kubernetes.ServiceNodePortObject('fake_name')
 547         nodeport_object.delete()
 548         mock_delete_service.assert_called_once_with('fake_name-service')