helpers.py revision 11571
111482Sandreas.sandberg@arm.com#!/usr/bin/env python 211482Sandreas.sandberg@arm.com# 311482Sandreas.sandberg@arm.com# Copyright (c) 2016 ARM Limited 411482Sandreas.sandberg@arm.com# All rights reserved 511482Sandreas.sandberg@arm.com# 611482Sandreas.sandberg@arm.com# The license below extends only to copyright in the software and shall 711482Sandreas.sandberg@arm.com# not be construed as granting a license to any other intellectual 811482Sandreas.sandberg@arm.com# property including but not limited to intellectual property relating 911482Sandreas.sandberg@arm.com# to a hardware implementation of the functionality of the software 1011482Sandreas.sandberg@arm.com# licensed hereunder. You may use the software subject to the license 1111482Sandreas.sandberg@arm.com# terms below provided that you ensure that this notice is replicated 1211482Sandreas.sandberg@arm.com# unmodified and in its entirety in all distributions of the software, 1311482Sandreas.sandberg@arm.com# modified or unmodified, in source code or in binary form. 1411482Sandreas.sandberg@arm.com# 1511482Sandreas.sandberg@arm.com# Redistribution and use in source and binary forms, with or without 1611482Sandreas.sandberg@arm.com# modification, are permitted provided that the following conditions are 1711482Sandreas.sandberg@arm.com# met: redistributions of source code must retain the above copyright 1811482Sandreas.sandberg@arm.com# notice, this list of conditions and the following disclaimer; 1911482Sandreas.sandberg@arm.com# redistributions in binary form must reproduce the above copyright 2011482Sandreas.sandberg@arm.com# notice, this list of conditions and the following disclaimer in the 2111482Sandreas.sandberg@arm.com# documentation and/or other materials provided with the distribution; 2211482Sandreas.sandberg@arm.com# neither the name of the copyright holders nor the names of its 2311482Sandreas.sandberg@arm.com# contributors may be used to endorse or promote products derived from 2411482Sandreas.sandberg@arm.com# this software without specific prior written permission. 2511482Sandreas.sandberg@arm.com# 2611482Sandreas.sandberg@arm.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2711482Sandreas.sandberg@arm.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2811482Sandreas.sandberg@arm.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2911482Sandreas.sandberg@arm.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 3011482Sandreas.sandberg@arm.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3111482Sandreas.sandberg@arm.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3211482Sandreas.sandberg@arm.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3311482Sandreas.sandberg@arm.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3411482Sandreas.sandberg@arm.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3511482Sandreas.sandberg@arm.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3611482Sandreas.sandberg@arm.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3711482Sandreas.sandberg@arm.com# 3811482Sandreas.sandberg@arm.com# Authors: Andreas Sandberg 3911482Sandreas.sandberg@arm.com 4011482Sandreas.sandberg@arm.comimport subprocess 4111482Sandreas.sandberg@arm.comfrom threading import Timer 4211482Sandreas.sandberg@arm.comimport time 4311571Sandreas.sandberg@arm.comimport re 4411482Sandreas.sandberg@arm.com 4511482Sandreas.sandberg@arm.comclass CallTimeoutException(Exception): 4611482Sandreas.sandberg@arm.com """Exception that indicates that a process call timed out""" 4711482Sandreas.sandberg@arm.com 4811482Sandreas.sandberg@arm.com def __init__(self, status, stdout, stderr): 4911482Sandreas.sandberg@arm.com self.status = status 5011482Sandreas.sandberg@arm.com self.stdout = stdout 5111482Sandreas.sandberg@arm.com self.stderr = stderr 5211482Sandreas.sandberg@arm.com 5311482Sandreas.sandberg@arm.comclass ProcessHelper(subprocess.Popen): 5411482Sandreas.sandberg@arm.com """Helper class to run child processes. 5511482Sandreas.sandberg@arm.com 5611482Sandreas.sandberg@arm.com This class wraps a subprocess.Popen class and adds support for 5711482Sandreas.sandberg@arm.com using it in a with block. When the process goes out of scope, it's 5811482Sandreas.sandberg@arm.com automatically terminated. 5911482Sandreas.sandberg@arm.com 6011482Sandreas.sandberg@arm.com with ProcessHelper(["/bin/ls"], stdout=subprocess.PIPE) as p: 6111482Sandreas.sandberg@arm.com return p.call() 6211482Sandreas.sandberg@arm.com """ 6311482Sandreas.sandberg@arm.com def __init__(self, *args, **kwargs): 6411482Sandreas.sandberg@arm.com super(ProcessHelper, self).__init__(*args, **kwargs) 6511482Sandreas.sandberg@arm.com 6611482Sandreas.sandberg@arm.com def _terminate_nicely(self, timeout=5): 6711482Sandreas.sandberg@arm.com def on_timeout(): 6811482Sandreas.sandberg@arm.com self.kill() 6911482Sandreas.sandberg@arm.com 7011482Sandreas.sandberg@arm.com if self.returncode is not None: 7111482Sandreas.sandberg@arm.com return self.returncode 7211482Sandreas.sandberg@arm.com 7311482Sandreas.sandberg@arm.com timer = Timer(timeout, on_timeout) 7411482Sandreas.sandberg@arm.com self.terminate() 7511482Sandreas.sandberg@arm.com status = self.wait() 7611482Sandreas.sandberg@arm.com timer.cancel() 7711482Sandreas.sandberg@arm.com 7811482Sandreas.sandberg@arm.com return status 7911482Sandreas.sandberg@arm.com 8011482Sandreas.sandberg@arm.com def __enter__(self): 8111482Sandreas.sandberg@arm.com return self 8211482Sandreas.sandberg@arm.com 8311482Sandreas.sandberg@arm.com def __exit__(self, exc_type, exc_value, traceback): 8411482Sandreas.sandberg@arm.com if self.returncode is None: 8511482Sandreas.sandberg@arm.com self._terminate_nicely() 8611482Sandreas.sandberg@arm.com 8711482Sandreas.sandberg@arm.com def call(self, timeout=0): 8811482Sandreas.sandberg@arm.com self._timeout = False 8911482Sandreas.sandberg@arm.com def on_timeout(): 9011482Sandreas.sandberg@arm.com self._timeout = True 9111482Sandreas.sandberg@arm.com self._terminate_nicely() 9211482Sandreas.sandberg@arm.com 9311482Sandreas.sandberg@arm.com status, stdout, stderr = None, None, None 9411482Sandreas.sandberg@arm.com timer = Timer(timeout, on_timeout) 9511482Sandreas.sandberg@arm.com if timeout: 9611482Sandreas.sandberg@arm.com timer.start() 9711482Sandreas.sandberg@arm.com 9811482Sandreas.sandberg@arm.com stdout, stderr = self.communicate() 9911482Sandreas.sandberg@arm.com status = self.wait() 10011482Sandreas.sandberg@arm.com 10111482Sandreas.sandberg@arm.com timer.cancel() 10211482Sandreas.sandberg@arm.com 10311482Sandreas.sandberg@arm.com if self._timeout: 10411482Sandreas.sandberg@arm.com self._terminate_nicely() 10511482Sandreas.sandberg@arm.com raise CallTimeoutException(self.returncode, stdout, stderr) 10611482Sandreas.sandberg@arm.com else: 10711482Sandreas.sandberg@arm.com return status, stdout, stderr 10811482Sandreas.sandberg@arm.com 10911571Sandreas.sandberg@arm.comclass FileIgnoreList(object): 11011571Sandreas.sandberg@arm.com """Helper class to implement file ignore lists. 11111571Sandreas.sandberg@arm.com 11211571Sandreas.sandberg@arm.com This class implements ignore lists using plain string matching and 11311571Sandreas.sandberg@arm.com regular expressions. In the simplest use case, rules are created 11411571Sandreas.sandberg@arm.com statically upon initialization: 11511571Sandreas.sandberg@arm.com 11611571Sandreas.sandberg@arm.com ignore_list = FileIgnoreList(name=("ignore_me.txt", ), rex=(r".*~", ) 11711571Sandreas.sandberg@arm.com 11811571Sandreas.sandberg@arm.com Ignores can be queried using in the same ways as normal Python 11911571Sandreas.sandberg@arm.com containers: 12011571Sandreas.sandberg@arm.com 12111571Sandreas.sandberg@arm.com if file_name in ignore_list: 12211571Sandreas.sandberg@arm.com print "Ignoring %s" % file_name 12311571Sandreas.sandberg@arm.com 12411571Sandreas.sandberg@arm.com 12511571Sandreas.sandberg@arm.com New rules can be added at runtime by extending the list in the 12611571Sandreas.sandberg@arm.com rules attribute: 12711571Sandreas.sandberg@arm.com 12811571Sandreas.sandberg@arm.com ignore_list.rules.append(FileIgnoreList.simple("bar.txt")) 12911571Sandreas.sandberg@arm.com """ 13011571Sandreas.sandberg@arm.com 13111571Sandreas.sandberg@arm.com @staticmethod 13211571Sandreas.sandberg@arm.com def simple(r): 13311571Sandreas.sandberg@arm.com return lambda f: f == r 13411571Sandreas.sandberg@arm.com 13511571Sandreas.sandberg@arm.com @staticmethod 13611571Sandreas.sandberg@arm.com def rex(r): 13711571Sandreas.sandberg@arm.com re_obj = r if hasattr(r, "search") else re.compile(r) 13811571Sandreas.sandberg@arm.com return lambda name: re_obj.search(name) 13911571Sandreas.sandberg@arm.com 14011571Sandreas.sandberg@arm.com def __init__(self, names=(), rex=()): 14111571Sandreas.sandberg@arm.com self.rules = [ FileIgnoreList.simple(n) for n in names ] + \ 14211571Sandreas.sandberg@arm.com [ FileIgnoreList.rex(r) for r in rex ] 14311571Sandreas.sandberg@arm.com 14411571Sandreas.sandberg@arm.com def __contains__(self, name): 14511571Sandreas.sandberg@arm.com for rule in self.rules: 14611571Sandreas.sandberg@arm.com if rule(name): 14711571Sandreas.sandberg@arm.com return True 14811571Sandreas.sandberg@arm.com return False 14911571Sandreas.sandberg@arm.com 15011482Sandreas.sandberg@arm.comif __name__ == "__main__": 15111482Sandreas.sandberg@arm.com # Run internal self tests to ensure that the helpers are working 15211482Sandreas.sandberg@arm.com # properly. The expected output when running this script is 15311482Sandreas.sandberg@arm.com # "SUCCESS!". 15411482Sandreas.sandberg@arm.com 15511482Sandreas.sandberg@arm.com cmd_foo = [ "/bin/echo", "-n", "foo" ] 15611482Sandreas.sandberg@arm.com cmd_sleep = [ "/bin/sleep", "10" ] 15711482Sandreas.sandberg@arm.com 15811482Sandreas.sandberg@arm.com # Test that things don't break if the process hasn't been started 15911482Sandreas.sandberg@arm.com with ProcessHelper(cmd_foo) as p: 16011482Sandreas.sandberg@arm.com pass 16111482Sandreas.sandberg@arm.com 16211482Sandreas.sandberg@arm.com with ProcessHelper(cmd_foo, stdout=subprocess.PIPE) as p: 16311482Sandreas.sandberg@arm.com status, stdout, stderr = p.call() 16411482Sandreas.sandberg@arm.com assert stdout == "foo" 16511482Sandreas.sandberg@arm.com assert status == 0 16611482Sandreas.sandberg@arm.com 16711482Sandreas.sandberg@arm.com try: 16811482Sandreas.sandberg@arm.com with ProcessHelper(cmd_sleep) as p: 16911482Sandreas.sandberg@arm.com status, stdout, stderr = p.call(timeout=1) 17011482Sandreas.sandberg@arm.com assert False, "Timeout not triggered" 17111482Sandreas.sandberg@arm.com except CallTimeoutException: 17211482Sandreas.sandberg@arm.com pass 17311482Sandreas.sandberg@arm.com 17411571Sandreas.sandberg@arm.com ignore_list = FileIgnoreList( 17511571Sandreas.sandberg@arm.com names=("ignore.txt", "foo/test.txt"), 17611571Sandreas.sandberg@arm.com rex=(r"~$", re.compile("^#"))) 17711571Sandreas.sandberg@arm.com 17811571Sandreas.sandberg@arm.com assert "ignore.txt" in ignore_list 17911571Sandreas.sandberg@arm.com assert "bar.txt" not in ignore_list 18011571Sandreas.sandberg@arm.com assert "foo/test.txt" in ignore_list 18111571Sandreas.sandberg@arm.com assert "test.txt" not in ignore_list 18211571Sandreas.sandberg@arm.com assert "file1.c~" in ignore_list 18311571Sandreas.sandberg@arm.com assert "file1.c" not in ignore_list 18411571Sandreas.sandberg@arm.com assert "#foo" in ignore_list 18511571Sandreas.sandberg@arm.com assert "foo#" not in ignore_list 18611571Sandreas.sandberg@arm.com 18711571Sandreas.sandberg@arm.com ignore_list.rules.append(FileIgnoreList.simple("bar.txt")) 18811571Sandreas.sandberg@arm.com assert "bar.txt" in ignore_list 18911571Sandreas.sandberg@arm.com 19011482Sandreas.sandberg@arm.com print "SUCCESS!" 191