Merge "Raise Exception if HA test case failed"
[yardstick.git] / yardstick / benchmark / scenarios / storage / fio.py
index 4eaf879..b99e342 100644 (file)
@@ -6,25 +6,28 @@
 # which accompanies this distribution, and is available at
 # http://www.apache.org/licenses/LICENSE-2.0
 ##############################################################################
-import pkg_resources
+from __future__ import absolute_import
+from __future__ import print_function
+
 import logging
-import json
+
+import pkg_resources
+from oslo_serialization import jsonutils
 
 import yardstick.ssh as ssh
 from yardstick.benchmark.scenarios import base
 
 LOG = logging.getLogger(__name__)
-LOG.setLevel(logging.DEBUG)
 
 
 class Fio(base.Scenario):
-    """Execute fio benchmark on host
+    """Execute fio benchmark in a host
 
   Parameters
     filename - file name for fio workload
         type:    string
         unit:    na
-        default: /home/ec2-user/data.raw
+        default: /home/ubuntu/data.raw
     bs - block size used for the io units
         type:    int
         unit:    bytes
@@ -37,10 +40,26 @@ class Fio(base.Scenario):
         type:    string
         unit:    na
         default: write
+    rwmixwrite - percentage of a mixed workload that should be writes
+        type: int
+        unit: percentage
+        default: 50
     ramp_time - run time before logging any performance
         type:    int
         unit:    seconds
         default: 20
+    direct - whether use non-buffered I/O or not
+        type:    boolean
+        unit:    na
+        default: 1
+    size - total size of I/O for this job.
+        type:    string
+        unit:    na
+        default: 1g
+    numjobs - number of clones (processes/threads performing the same workload) of this job
+        type:    int
+        unit:    na
+        default: 1
 
     Read link below for more fio args description:
         http://www.bluestop.org/fio/HOWTO.txt
@@ -49,46 +68,48 @@ class Fio(base.Scenario):
 
     TARGET_SCRIPT = "fio_benchmark.bash"
 
-    def __init__(self, context):
-        self.context = context
+    def __init__(self, scenario_cfg, context_cfg):
+        self.scenario_cfg = scenario_cfg
+        self.context_cfg = context_cfg
         self.setup_done = False
 
     def setup(self):
-        '''scenario setup'''
+        """scenario setup"""
         self.target_script = pkg_resources.resource_filename(
             "yardstick.benchmark.scenarios.storage",
             Fio.TARGET_SCRIPT)
-        user = self.context.get("user", "root")
-        host = self.context.get("host", None)
-        key_filename = self.context.get("key_filename", "~/.ssh/id_rsa")
+        host = self.context_cfg["host"]
 
-        LOG.debug("user:%s, host:%s", user, host)
-        self.client = ssh.SSH(user, host, key_filename=key_filename)
+        self.client = ssh.SSH.from_node(host, defaults={"user": "root"})
         self.client.wait(timeout=600)
 
         # copy script to host
-        self.client.run("cat > ~/fio.sh",
-                        stdin=open(self.target_script, "rb"))
+        self.client._put_file_shell(self.target_script, '~/fio.sh')
 
         self.setup_done = True
 
-    def run(self, args):
+    def run(self, result):
         """execute the benchmark"""
-        default_args = "-ioengine=libaio -direct=1 " \
-            "-group_reporting -numjobs=1 -time_based"
+        default_args = "-ioengine=libaio -group_reporting -time_based -time_based " \
+            "--output-format=json"
 
         if not self.setup_done:
             self.setup()
 
-        options = args["options"]
-        filename = options.get("filename", "/home/ec2-user/data.raw")
+        options = self.scenario_cfg["options"]
+        filename = options.get("filename", "/home/ubuntu/data.raw")
         bs = options.get("bs", "4k")
         iodepth = options.get("iodepth", "1")
         rw = options.get("rw", "write")
         ramp_time = options.get("ramp_time", 20)
+        size = options.get("size", "1g")
+        direct = options.get("direct", "1")
+        numjobs = options.get("numjobs", "1")
+        rwmixwrite = options.get("rwmixwrite", 50)
         name = "yardstick-fio"
         # if run by a duration runner
-        duration_time = self.context.get("duration", None)
+        duration_time = self.scenario_cfg["runner"].get("duration", None) \
+            if "runner" in self.scenario_cfg else None
         # if run by an arithmetic runner
         arithmetic_time = options.get("duration", None)
         if duration_time:
@@ -98,49 +119,82 @@ class Fio(base.Scenario):
         else:
             runtime = 30
 
-        args = "-filename=%s -bs=%s -iodepth=%s -rw=%s -ramp_time=%s " \
-               "-runtime=%s -name=%s" \
-               % (filename, bs, iodepth, rw, ramp_time, runtime, name)
-        cmd = "sudo bash fio.sh %s %s %s" \
-              % (filename, args, default_args)
+        cmd_args = "-filename=%s -direct=%s -bs=%s -iodepth=%s -rw=%s -rwmixwrite=%s " \
+                   "-size=%s -ramp_time=%s -numjobs=%s -runtime=%s -name=%s %s" \
+                   % (filename, direct, bs, iodepth, rw, rwmixwrite, size, ramp_time, numjobs,
+                      runtime, name, default_args)
+        cmd = "sudo bash fio.sh %s %s" % (filename, cmd_args)
         LOG.debug("Executing command: %s", cmd)
-        status, stdout, stderr = self.client.execute(cmd)
+        # Set timeout, so that the cmd execution does not exit incorrectly
+        # when the test run time is last long
+        timeout = int(ramp_time) + int(runtime) + 600
+        status, stdout, stderr = self.client.execute(cmd, timeout=timeout)
         if status:
             raise RuntimeError(stderr)
 
-        data = json.loads(stdout)
-
-        # TODO: add sla check
-
-        return data
+        raw_data = jsonutils.loads(stdout)
+
+        # The bandwidth unit is KB/s, and latency unit is us
+        if rw in ["read", "randread", "rw", "randrw"]:
+            result["read_bw"] = raw_data["jobs"][0]["read"]["bw"]
+            result["read_iops"] = raw_data["jobs"][0]["read"]["iops"]
+            result["read_lat"] = raw_data["jobs"][0]["read"]["lat"]["mean"]
+        if rw in ["write", "randwrite", "rw", "randrw"]:
+            result["write_bw"] = raw_data["jobs"][0]["write"]["bw"]
+            result["write_iops"] = raw_data["jobs"][0]["write"]["iops"]
+            result["write_lat"] = raw_data["jobs"][0]["write"]["lat"]["mean"]
+
+        if "sla" in self.scenario_cfg:
+            sla_error = ""
+            for k, v in result.items():
+                if k not in self.scenario_cfg['sla']:
+                    continue
+
+                if "lat" in k:
+                    # For lattency small value is better
+                    max_v = float(self.scenario_cfg['sla'][k])
+                    if v > max_v:
+                        sla_error += "%s %f > sla:%s(%f); " % (k, v, k, max_v)
+                else:
+                    # For bandwidth and iops big value is better
+                    min_v = int(self.scenario_cfg['sla'][k])
+                    if v < min_v:
+                        sla_error += "%s %d < " \
+                            "sla:%s(%d); " % (k, v, k, min_v)
+
+            assert sla_error == "", sla_error
 
 
 def _test():
-    '''internal test function'''
+    """internal test function"""
     key_filename = pkg_resources.resource_filename("yardstick.resources",
                                                    "files/yardstick_key")
     ctx = {
-        "host": "10.0.0.101",
-        "user": "ec2-user",
-        "key_filename": key_filename
+        "host": {
+            "ip": "10.229.47.137",
+            "user": "root",
+            "key_filename": key_filename
+        }
     }
 
     logger = logging.getLogger("yardstick")
     logger.setLevel(logging.DEBUG)
 
-    fio = Fio(ctx)
-
     options = {
-        "filename": "/home/ec2-user/data.raw",
+        "filename": "/home/ubuntu/data.raw",
         "bs": "4k",
         "iodepth": "1",
-        "rw": "write",
-        "ramp_time": 10,
+        "rw": "rw",
+        "ramp_time": 1,
+        "duration": 10
     }
+    result = {}
     args = {"options": options}
 
-    result = fio.run(args)
-    print result
+    fio = Fio(args, ctx)
+    fio.run(result)
+    print(result)
+
 
 if __name__ == '__main__':
     _test()