Merge "standardize ssh auth"
[yardstick.git] / yardstick / benchmark / scenarios / compute / unixbench.py
1 ##############################################################################
2 # Copyright (c) 2015 Huawei Technologies Co.,Ltd and other.
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 from __future__ import absolute_import
10 from __future__ import print_function
11
12 import logging
13
14 import pkg_resources
15 from oslo_serialization import jsonutils
16
17 import yardstick.ssh as ssh
18 from yardstick.benchmark.scenarios import base
19
20 LOG = logging.getLogger(__name__)
21
22
23 class Unixbench(base.Scenario):
24     """Execute Unixbench cpu benchmark in a host
25     The Run script takes a number of options which you can use to customise a
26     test, and you can specify the names of the tests to run.  The full usage
27     is:
28
29     Run [ -q | -v ] [-i <n> ] [-c <n> [-c <n> ...]] [test ...]
30
31     -i <count>    Run <count> iterations for each test -- slower tests
32                 use <count> / 3, but at least 1.  Defaults to 10 (3 for
33                 slow tests).
34     -c <n>        Run <n> copies of each test in parallel.
35
36     Parameters for setting unixbench
37         run_mode - Run in quiet mode or verbose mode
38             type:       string
39             unit:       None
40             default:    None
41         test_type - The available tests are organised into categories;
42             type:       string
43             unit:       None
44             default:    None
45         iterations - Run <count> iterations for each test -- slower tests
46         use <count> / 3, but at least 1.  Defaults to 10 (3 for slow tests).
47             type:       int
48             unit:       None
49             default:    None
50         copies - Run <n> copies of each test in parallel.
51             type:       int
52             unit:       None
53             default:    None
54
55     more info https://github.com/kdlucas/byte-unixbench/blob/master/UnixBench
56     """
57     __scenario_type__ = "UnixBench"
58
59     TARGET_SCRIPT = "unixbench_benchmark.bash"
60
61     def __init__(self, scenario_cfg, context_cfg):
62         self.scenario_cfg = scenario_cfg
63         self.context_cfg = context_cfg
64         self.setup_done = False
65
66     def setup(self):
67         """scenario setup"""
68         self.target_script = pkg_resources.resource_filename(
69             "yardstick.benchmark.scenarios.compute",
70             Unixbench.TARGET_SCRIPT)
71
72         host = self.context_cfg["host"]
73
74         self.client = ssh.SSH.from_node(host, defaults={"user": "ubuntu"})
75         self.client.wait(timeout=600)
76
77         # copy scripts to host
78         self.client._put_file_shell(
79             self.target_script, '~/unixbench_benchmark.sh')
80
81         self.setup_done = True
82
83     def run(self, result):
84         """execute the benchmark"""
85
86         if not self.setup_done:
87             self.setup()
88
89         options = self.scenario_cfg["options"]
90
91         run_mode = options.get("run_mode", None)
92         LOG.debug("Executing run_mode: %s", run_mode)
93         cmd_args = ""
94         if run_mode == "quiet":
95             cmd_args = "-q"
96         elif run_mode == "verbose":
97             cmd_args = "-v"
98
99         option_pair_list = [("iterations", "-i"),
100                             ("copies", "-c")]
101         for option_pair in option_pair_list:
102             if option_pair[0] in options:
103                 cmd_args += " %s %s " % (option_pair[1],
104                                          options[option_pair[0]])
105
106         test_type = options.get("test_type", None)
107         if test_type is not None:
108             cmd_args += " %s " % (test_type)
109
110         cmd = "sudo bash unixbench_benchmark.sh %s" % (cmd_args)
111         LOG.debug("Executing command: %s", cmd)
112         status, stdout, stderr = self.client.execute(cmd)
113         if status:
114             raise RuntimeError(stderr)
115
116         result.update(jsonutils.loads(stdout))
117
118         if "sla" in self.scenario_cfg:
119             sla_error = ""
120             for t, score in result.items():
121                 if t not in self.scenario_cfg['sla']:
122                     continue
123                 sla_score = float(self.scenario_cfg['sla'][t])
124                 score = float(score)
125                 if score < sla_score:
126                     sla_error += "%s score %f < sla:%s_score(%f); " % \
127                         (t, score, t, sla_score)
128             assert sla_error == "", sla_error
129
130
131 def _test():  # pragma: no cover
132     """internal test function"""
133     key_filename = pkg_resources.resource_filename('yardstick.resources',
134                                                    'files/yardstick_key')
135     ctx = {
136         'host': {
137             'ip': '10.229.47.137',
138             'user': 'root',
139             'key_filename': key_filename
140         }
141     }
142
143     options = {
144         'test_type': 'dhrystone',
145         'run_mode': 'verbose'
146     }
147
148     args = {'options': options}
149     result = {}
150
151     p = Unixbench(args, ctx)
152     p.run(result)
153     print(result)
154
155
156 if __name__ == '__main__':
157     _test()