yardstick/benchmark/scenarios/lib/get_server.py

   1 ##############################################################################
   2 # Copyright (c) 2017 Huawei Technologies Co.,Ltd and others.
   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 from __future__ import print_function
  11 from __future__ import absolute_import
  12
  13 import logging
  14
  15 from yardstick.benchmark.scenarios import base
  16 import yardstick.common.openstack_utils as op_utils
  17
  18 LOG = logging.getLogger(__name__)
  19
  20
  21 class GetServer(base.Scenario):
  22     """Get a server instance
  23
  24   Parameters
  25     server_id - ID of the server
  26         type:    string
  27         unit:    N/A
  28         default: null
  29     server_name - name of the server
  30         type:    string
  31         unit:    N/A
  32         default: null
  33
  34     Either server_id or server_name is required.
  35
  36   Outputs
  37     rc - response code of getting server instance
  38         0 for success
  39         1 for failure
  40         type:    int
  41         unit:    N/A
  42     server - instance of the server
  43         type:    dict
  44         unit:    N/A
  45     """
  46
  47     __scenario_type__ = "GetServer"
  48
  49     def __init__(self, scenario_cfg, context_cfg):
  50         self.scenario_cfg = scenario_cfg
  51         self.context_cfg = context_cfg
  52         self.options = self.scenario_cfg.get('options', {})
  53
  54         self.server_id = self.options.get("server_id")
  55         if self.server_id:
  56             LOG.debug('Server id is %s', self.server_id)
  57
  58         default_name = self.scenario_cfg.get('host',
  59                                              self.scenario_cfg.get('target'))
  60         self.server_name = self.options.get('server_name', default_name)
  61         if self.server_name:
  62             LOG.debug('Server name is %s', self.server_name)
  63
  64         self.nova_client = op_utils.get_nova_client()
  65
  66     def run(self, result):
  67         """execute the test"""
  68
  69         if self.server_id:
  70             server = self.nova_client.servers.get(self.server_id)
  71         else:
  72             server = op_utils.get_server_by_name(self.server_name)
  73
  74         keys = self.scenario_cfg.get('output', '').split()
  75
  76         if server:
  77             LOG.info("Get server successful!")
  78             values = [0, self._change_obj_to_dict(server)]
  79         else:
  80             LOG.info("Get server failed!")
  81             values = [1]
  82
  83         return self._push_to_outputs(keys, values)