mbligh | 0526936 | 2007-10-16 16:58:11 +0000 | [diff] [blame] | 1 | # Copyright Martin J. Bligh, Andy Whitcroft, 2007 |
| 2 | # |
mbligh | ea397bb | 2008-02-02 19:17:51 +0000 | [diff] [blame] | 3 | # Define the server-side test class |
mbligh | 0526936 | 2007-10-16 16:58:11 +0000 | [diff] [blame] | 4 | # |
mbligh | 0526936 | 2007-10-16 16:58:11 +0000 | [diff] [blame] | 5 | |
mbligh | 089f1e3 | 2009-06-22 18:26:45 +0000 | [diff] [blame] | 6 | import os, tempfile, logging |
mbligh | ea397bb | 2008-02-02 19:17:51 +0000 | [diff] [blame] | 7 | |
jadmanski | 54f90af | 2008-10-10 16:20:55 +0000 | [diff] [blame] | 8 | from autotest_lib.client.common_lib import log, utils, test as common_test |
mbligh | 0526936 | 2007-10-16 16:58:11 +0000 | [diff] [blame] | 9 | |
| 10 | |
mbligh | ccb9e18 | 2008-04-17 15:42:10 +0000 | [diff] [blame] | 11 | class test(common_test.base_test): |
mbligh | 089f1e3 | 2009-06-22 18:26:45 +0000 | [diff] [blame] | 12 | disable_sysinfo_install_cache = False |
mbligh | 43dd549 | 2009-09-03 20:20:51 +0000 | [diff] [blame] | 13 | host_parameter = None |
mbligh | dccabe3 | 2008-02-01 17:39:32 +0000 | [diff] [blame] | 14 | |
| 15 | |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 16 | _sysinfo_before_test_script = """\ |
jadmanski | 54f90af | 2008-10-10 16:20:55 +0000 | [diff] [blame] | 17 | import pickle |
| 18 | from autotest_lib.client.bin import test |
| 19 | mytest = test.test(job, '', %r) |
| 20 | job.sysinfo.log_before_each_test(mytest) |
| 21 | sysinfo_pickle = os.path.join(mytest.outputdir, 'sysinfo.pickle') |
| 22 | pickle.dump(job.sysinfo, open(sysinfo_pickle, 'w')) |
| 23 | job.record('GOOD', '', 'sysinfo.before') |
| 24 | """ |
| 25 | |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 26 | _sysinfo_after_test_script = """\ |
jadmanski | 54f90af | 2008-10-10 16:20:55 +0000 | [diff] [blame] | 27 | import pickle |
| 28 | from autotest_lib.client.bin import test |
| 29 | mytest = test.test(job, '', %r) |
Dan Shi | 4eba9f0 | 2014-06-18 13:58:05 -0700 | [diff] [blame] | 30 | # success is passed in so diffable_logdir can decide if or not to collect |
| 31 | # full log content. |
| 32 | mytest.success = %s |
jadmanski | 54f90af | 2008-10-10 16:20:55 +0000 | [diff] [blame] | 33 | sysinfo_pickle = os.path.join(mytest.outputdir, 'sysinfo.pickle') |
| 34 | if os.path.exists(sysinfo_pickle): |
| 35 | job.sysinfo = pickle.load(open(sysinfo_pickle)) |
| 36 | job.sysinfo.__init__(job.resultdir) |
| 37 | job.sysinfo.log_after_each_test(mytest) |
| 38 | job.record('GOOD', '', 'sysinfo.after') |
| 39 | """ |
| 40 | |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 41 | # this script is ran after _sysinfo_before_test_script and before |
| 42 | # _sysinfo_after_test_script which means the pickle file exists |
| 43 | # already and should be dumped with updated state for |
| 44 | # _sysinfo_after_test_script to pick it up later |
| 45 | _sysinfo_iteration_script = """\ |
| 46 | import pickle |
| 47 | from autotest_lib.client.bin import test |
| 48 | mytest = test.test(job, '', %r) |
| 49 | sysinfo_pickle = os.path.join(mytest.outputdir, 'sysinfo.pickle') |
| 50 | if os.path.exists(sysinfo_pickle): |
| 51 | job.sysinfo = pickle.load(open(sysinfo_pickle)) |
| 52 | job.sysinfo.__init__(job.resultdir) |
| 53 | job.sysinfo.%s(mytest, iteration=%d) |
| 54 | pickle.dump(job.sysinfo, open(sysinfo_pickle, 'w')) |
| 55 | job.record('GOOD', '', 'sysinfo.iteration.%s') |
| 56 | """ |
| 57 | |
jadmanski | 54f90af | 2008-10-10 16:20:55 +0000 | [diff] [blame] | 58 | |
jadmanski | 7c7aff3 | 2009-03-25 22:43:07 +0000 | [diff] [blame] | 59 | def install_autotest_and_run(func): |
| 60 | def wrapper(self, mytest): |
mbligh | 3524589 | 2009-06-08 16:43:21 +0000 | [diff] [blame] | 61 | host, at, outputdir = self._install() |
mbligh | 089f1e3 | 2009-06-22 18:26:45 +0000 | [diff] [blame] | 62 | try: |
| 63 | host.erase_dir_contents(outputdir) |
| 64 | func(self, mytest, host, at, outputdir) |
| 65 | finally: |
| 66 | # the test class can define this flag to make us remove the |
| 67 | # sysinfo install files and outputdir contents after each run |
| 68 | if mytest.disable_sysinfo_install_cache: |
| 69 | self.cleanup(host_close=False) |
mbligh | 3524589 | 2009-06-08 16:43:21 +0000 | [diff] [blame] | 70 | |
jadmanski | 7c7aff3 | 2009-03-25 22:43:07 +0000 | [diff] [blame] | 71 | return wrapper |
| 72 | |
| 73 | |
jadmanski | 54f90af | 2008-10-10 16:20:55 +0000 | [diff] [blame] | 74 | class _sysinfo_logger(object): |
| 75 | def __init__(self, job): |
| 76 | self.job = job |
| 77 | self.pickle = None |
mbligh | 3524589 | 2009-06-08 16:43:21 +0000 | [diff] [blame] | 78 | |
| 79 | # for now support a single host |
| 80 | self.host = None |
| 81 | self.autotest = None |
| 82 | self.outputdir = None |
| 83 | |
jadmanski | 54f90af | 2008-10-10 16:20:55 +0000 | [diff] [blame] | 84 | if len(job.machines) != 1: |
| 85 | # disable logging on multi-machine tests |
| 86 | self.before_hook = self.after_hook = None |
mbligh | 3524589 | 2009-06-08 16:43:21 +0000 | [diff] [blame] | 87 | self.before_iteration_hook = self.after_iteration_hook = None |
jadmanski | 54f90af | 2008-10-10 16:20:55 +0000 | [diff] [blame] | 88 | |
| 89 | |
| 90 | def _install(self): |
mbligh | 3524589 | 2009-06-08 16:43:21 +0000 | [diff] [blame] | 91 | if not self.host: |
| 92 | from autotest_lib.server import hosts, autotest |
| 93 | self.host = hosts.create_host(self.job.machines[0], |
| 94 | auto_monitor=False) |
mbligh | f780bbf | 2009-09-03 20:45:46 +0000 | [diff] [blame] | 95 | try: |
Dale Curtis | 74a314b | 2011-06-23 14:55:46 -0700 | [diff] [blame] | 96 | tmp_dir = self.host.get_tmp_dir(parent="/tmp/sysinfo") |
mbligh | f780bbf | 2009-09-03 20:45:46 +0000 | [diff] [blame] | 97 | self.autotest = autotest.Autotest(self.host) |
Dale Curtis | 74a314b | 2011-06-23 14:55:46 -0700 | [diff] [blame] | 98 | self.autotest.install(autodir=tmp_dir) |
mbligh | f780bbf | 2009-09-03 20:45:46 +0000 | [diff] [blame] | 99 | self.outputdir = self.host.get_tmp_dir() |
| 100 | except: |
| 101 | # if installation fails roll back the host |
| 102 | try: |
| 103 | self.host.close() |
| 104 | except: |
| 105 | logging.exception("Unable to close host %s", |
| 106 | self.host.hostname) |
| 107 | self.host = None |
| 108 | self.autotest = None |
| 109 | raise |
mbligh | 089f1e3 | 2009-06-22 18:26:45 +0000 | [diff] [blame] | 110 | else: |
| 111 | host = self.host |
| 112 | |
| 113 | # if autotest client dir does not exist, reinstall (it may have |
| 114 | # been removed by the test code) |
| 115 | autodir = host.get_autodir() |
| 116 | if not autodir or not host.path_exists(autodir): |
jadmanski | 27b5291 | 2009-08-14 17:09:15 +0000 | [diff] [blame] | 117 | self.autotest.install(autodir=autodir) |
mbligh | 089f1e3 | 2009-06-22 18:26:45 +0000 | [diff] [blame] | 118 | |
| 119 | # if the output dir does not exist, recreate it |
| 120 | if not host.path_exists(self.outputdir): |
| 121 | host.run('mkdir -p %s' % self.outputdir) |
mbligh | 3524589 | 2009-06-08 16:43:21 +0000 | [diff] [blame] | 122 | |
| 123 | return self.host, self.autotest, self.outputdir |
jadmanski | 54f90af | 2008-10-10 16:20:55 +0000 | [diff] [blame] | 124 | |
| 125 | |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 126 | def _pull_pickle(self, host, outputdir): |
| 127 | """Pulls from the client the pickle file with the saved sysinfo state. |
| 128 | """ |
jadmanski | 54f90af | 2008-10-10 16:20:55 +0000 | [diff] [blame] | 129 | fd, path = tempfile.mkstemp(dir=self.job.tmpdir) |
| 130 | os.close(fd) |
| 131 | host.get_file(os.path.join(outputdir, "sysinfo.pickle"), path) |
| 132 | self.pickle = path |
| 133 | |
| 134 | |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 135 | def _push_pickle(self, host, outputdir): |
| 136 | """Pushes the server saved sysinfo pickle file to the client. |
| 137 | """ |
jadmanski | 54f90af | 2008-10-10 16:20:55 +0000 | [diff] [blame] | 138 | if self.pickle: |
| 139 | host.send_file(self.pickle, |
| 140 | os.path.join(outputdir, "sysinfo.pickle")) |
| 141 | os.remove(self.pickle) |
| 142 | self.pickle = None |
| 143 | |
jadmanski | 54f90af | 2008-10-10 16:20:55 +0000 | [diff] [blame] | 144 | |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 145 | def _pull_sysinfo_keyval(self, host, outputdir, mytest): |
| 146 | """Pulls sysinfo and keyval data from the client. |
| 147 | """ |
jadmanski | 54f90af | 2008-10-10 16:20:55 +0000 | [diff] [blame] | 148 | # pull the sysinfo data back on to the server |
| 149 | host.get_file(os.path.join(outputdir, "sysinfo"), mytest.outputdir) |
| 150 | |
| 151 | # pull the keyval data back into the local one |
| 152 | fd, path = tempfile.mkstemp(dir=self.job.tmpdir) |
| 153 | os.close(fd) |
| 154 | host.get_file(os.path.join(outputdir, "keyval"), path) |
| 155 | keyval = utils.read_keyval(path) |
| 156 | os.remove(path) |
| 157 | mytest.write_test_keyval(keyval) |
| 158 | |
| 159 | |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 160 | @log.log_and_ignore_errors("pre-test server sysinfo error:") |
jadmanski | 7c7aff3 | 2009-03-25 22:43:07 +0000 | [diff] [blame] | 161 | @install_autotest_and_run |
| 162 | def before_hook(self, mytest, host, at, outputdir): |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 163 | # run the pre-test sysinfo script |
| 164 | at.run(_sysinfo_before_test_script % outputdir, |
Dale Curtis | 9285ddf | 2011-01-05 11:47:24 -0800 | [diff] [blame] | 165 | results_dir=self.job.resultdir) |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 166 | |
| 167 | self._pull_pickle(host, outputdir) |
| 168 | |
| 169 | |
| 170 | @log.log_and_ignore_errors("pre-test iteration server sysinfo error:") |
jadmanski | 7c7aff3 | 2009-03-25 22:43:07 +0000 | [diff] [blame] | 171 | @install_autotest_and_run |
| 172 | def before_iteration_hook(self, mytest, host, at, outputdir): |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 173 | # this function is called after before_hook() se we have sysinfo state |
| 174 | # to push to the server |
| 175 | self._push_pickle(host, outputdir); |
| 176 | # run the pre-test iteration sysinfo script |
| 177 | at.run(_sysinfo_iteration_script % |
| 178 | (outputdir, 'log_before_each_iteration', mytest.iteration, |
| 179 | 'before'), |
Dale Curtis | 9285ddf | 2011-01-05 11:47:24 -0800 | [diff] [blame] | 180 | results_dir=self.job.resultdir) |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 181 | |
| 182 | # get the new sysinfo state from the client |
| 183 | self._pull_pickle(host, outputdir) |
| 184 | |
| 185 | |
| 186 | @log.log_and_ignore_errors("post-test iteration server sysinfo error:") |
jadmanski | 7c7aff3 | 2009-03-25 22:43:07 +0000 | [diff] [blame] | 187 | @install_autotest_and_run |
| 188 | def after_iteration_hook(self, mytest, host, at, outputdir): |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 189 | # push latest sysinfo state to the client |
| 190 | self._push_pickle(host, outputdir); |
| 191 | # run the post-test iteration sysinfo script |
| 192 | at.run(_sysinfo_iteration_script % |
| 193 | (outputdir, 'log_after_each_iteration', mytest.iteration, |
| 194 | 'after'), |
Dale Curtis | 9285ddf | 2011-01-05 11:47:24 -0800 | [diff] [blame] | 195 | results_dir=self.job.resultdir) |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 196 | |
| 197 | # get the new sysinfo state from the client |
| 198 | self._pull_pickle(host, outputdir) |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 199 | |
| 200 | |
| 201 | @log.log_and_ignore_errors("post-test server sysinfo error:") |
jadmanski | 7c7aff3 | 2009-03-25 22:43:07 +0000 | [diff] [blame] | 202 | @install_autotest_and_run |
| 203 | def after_hook(self, mytest, host, at, outputdir): |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 204 | self._push_pickle(host, outputdir); |
| 205 | # run the post-test sysinfo script |
Dan Shi | 4eba9f0 | 2014-06-18 13:58:05 -0700 | [diff] [blame] | 206 | at.run(_sysinfo_after_test_script % (outputdir, mytest.success), |
Dale Curtis | 9285ddf | 2011-01-05 11:47:24 -0800 | [diff] [blame] | 207 | results_dir=self.job.resultdir) |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 208 | |
| 209 | self._pull_sysinfo_keyval(host, outputdir, mytest) |
| 210 | |
| 211 | |
mbligh | 089f1e3 | 2009-06-22 18:26:45 +0000 | [diff] [blame] | 212 | def cleanup(self, host_close=True): |
mbligh | 3524589 | 2009-06-08 16:43:21 +0000 | [diff] [blame] | 213 | if self.host and self.autotest: |
| 214 | try: |
mbligh | 089f1e3 | 2009-06-22 18:26:45 +0000 | [diff] [blame] | 215 | try: |
| 216 | self.autotest.uninstall() |
| 217 | finally: |
| 218 | if host_close: |
| 219 | self.host.close() |
| 220 | else: |
| 221 | self.host.erase_dir_contents(self.outputdir) |
| 222 | |
| 223 | except Exception: |
| 224 | # ignoring exceptions here so that we don't hide the true |
| 225 | # reason of failure from runtest |
| 226 | logging.exception('Error cleaning up the sysinfo autotest/host ' |
| 227 | 'objects, ignoring it') |
mbligh | 3524589 | 2009-06-08 16:43:21 +0000 | [diff] [blame] | 228 | |
| 229 | |
mbligh | 0526936 | 2007-10-16 16:58:11 +0000 | [diff] [blame] | 230 | def runtest(job, url, tag, args, dargs): |
mbligh | 79a2ee1 | 2008-11-05 22:07:38 +0000 | [diff] [blame] | 231 | if not dargs.pop('disable_sysinfo', False): |
| 232 | logger = _sysinfo_logger(job) |
mbligh | 4395bbd | 2009-03-25 19:34:17 +0000 | [diff] [blame] | 233 | logging_args = [logger.before_hook, logger.after_hook, |
| 234 | logger.before_iteration_hook, |
| 235 | logger.after_iteration_hook] |
mbligh | 79a2ee1 | 2008-11-05 22:07:38 +0000 | [diff] [blame] | 236 | else: |
mbligh | 3524589 | 2009-06-08 16:43:21 +0000 | [diff] [blame] | 237 | logger = None |
| 238 | logging_args = [None, None, None, None] |
| 239 | |
mbligh | 43dd549 | 2009-09-03 20:20:51 +0000 | [diff] [blame] | 240 | # add in a hook that calls host.log_kernel if we can |
| 241 | def log_kernel_hook(mytest, existing_hook=logging_args[0]): |
| 242 | if mytest.host_parameter: |
| 243 | host = dargs[mytest.host_parameter] |
| 244 | if host: |
| 245 | host.log_kernel() |
| 246 | # chain this call with any existing hook |
| 247 | if existing_hook: |
| 248 | existing_hook(mytest) |
| 249 | logging_args[0] = log_kernel_hook |
| 250 | |
mbligh | 3524589 | 2009-06-08 16:43:21 +0000 | [diff] [blame] | 251 | try: |
| 252 | common_test.runtest(job, url, tag, args, dargs, locals(), globals(), |
| 253 | *logging_args) |
| 254 | finally: |
| 255 | if logger: |
| 256 | logger.cleanup() |