Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 1 | """Support code for distutils test cases.""" |
Tarek Ziadé | c1375d5 | 2009-02-14 14:35:51 +0000 | [diff] [blame] | 2 | import os |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 3 | import shutil |
| 4 | import tempfile |
| 5 | |
Fred Drake | edcac8f | 2004-08-03 18:53:07 +0000 | [diff] [blame] | 6 | from distutils import log |
Tarek Ziadé | baf5180 | 2009-03-31 21:37:16 +0000 | [diff] [blame] | 7 | from distutils.core import Distribution |
Tarek Ziadé | 29bbb96 | 2009-05-10 12:02:35 +0000 | [diff] [blame] | 8 | from test.support import EnvironmentVarGuard |
Fred Drake | edcac8f | 2004-08-03 18:53:07 +0000 | [diff] [blame] | 9 | |
| 10 | class LoggingSilencer(object): |
| 11 | |
| 12 | def setUp(self): |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 13 | super().setUp() |
Fred Drake | edcac8f | 2004-08-03 18:53:07 +0000 | [diff] [blame] | 14 | self.threshold = log.set_threshold(log.FATAL) |
Tarek Ziadé | 5af55c6 | 2009-05-16 16:52:13 +0000 | [diff] [blame^] | 15 | # catching warnings |
| 16 | # when log will be replaced by logging |
| 17 | # we won't need such monkey-patch anymore |
| 18 | self._old_log = log.Log._log |
| 19 | log.Log._log = self._log |
| 20 | self.logs = [] |
Fred Drake | edcac8f | 2004-08-03 18:53:07 +0000 | [diff] [blame] | 21 | |
| 22 | def tearDown(self): |
| 23 | log.set_threshold(self.threshold) |
Tarek Ziadé | 5af55c6 | 2009-05-16 16:52:13 +0000 | [diff] [blame^] | 24 | log.Log._log = self._old_log |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 25 | super().tearDown() |
Fred Drake | edcac8f | 2004-08-03 18:53:07 +0000 | [diff] [blame] | 26 | |
Tarek Ziadé | 5af55c6 | 2009-05-16 16:52:13 +0000 | [diff] [blame^] | 27 | def _log(self, level, msg, args): |
| 28 | self.logs.append((level, msg, args)) |
| 29 | |
| 30 | def get_logs(self, *levels): |
| 31 | def _format(msg, args): |
| 32 | if len(args) == 0: |
| 33 | return msg |
| 34 | return msg % args |
| 35 | return [_format(msg, args) for level, msg, args |
| 36 | in self.logs if level in levels] |
| 37 | |
| 38 | def clear_logs(self): |
| 39 | self.logs = [] |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 40 | |
| 41 | class TempdirManager(object): |
| 42 | """Mix-in class that handles temporary directories for test cases. |
| 43 | |
| 44 | This is intended to be used with unittest.TestCase. |
| 45 | """ |
| 46 | |
| 47 | def setUp(self): |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 48 | super().setUp() |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 49 | self.tempdirs = [] |
| 50 | |
| 51 | def tearDown(self): |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 52 | super().tearDown() |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 53 | while self.tempdirs: |
| 54 | d = self.tempdirs.pop() |
Tarek Ziadé | c1375d5 | 2009-02-14 14:35:51 +0000 | [diff] [blame] | 55 | shutil.rmtree(d, os.name in ('nt', 'cygwin')) |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 56 | |
| 57 | def mkdtemp(self): |
| 58 | """Create a temporary directory that will be cleaned up. |
| 59 | |
| 60 | Returns the path of the directory. |
| 61 | """ |
| 62 | d = tempfile.mkdtemp() |
| 63 | self.tempdirs.append(d) |
| 64 | return d |
| 65 | |
Tarek Ziadé | baf5180 | 2009-03-31 21:37:16 +0000 | [diff] [blame] | 66 | def write_file(self, path, content='xxx'): |
Tarek Ziadé | 0d0506e | 2009-02-16 21:49:12 +0000 | [diff] [blame] | 67 | """Writes a file in the given path. |
| 68 | |
| 69 | |
| 70 | path can be a string or a sequence. |
| 71 | """ |
| 72 | if isinstance(path, (list, tuple)): |
| 73 | path = os.path.join(*path) |
| 74 | f = open(path, 'w') |
| 75 | try: |
| 76 | f.write(content) |
| 77 | finally: |
| 78 | f.close() |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 79 | |
Tarek Ziadé | baf5180 | 2009-03-31 21:37:16 +0000 | [diff] [blame] | 80 | def create_dist(self, pkg_name='foo', **kw): |
| 81 | """Will generate a test environment. |
| 82 | |
| 83 | This function creates: |
| 84 | - a Distribution instance using keywords |
| 85 | - a temporary directory with a package structure |
| 86 | |
| 87 | It returns the package directory and the distribution |
| 88 | instance. |
| 89 | """ |
| 90 | tmp_dir = self.mkdtemp() |
| 91 | pkg_dir = os.path.join(tmp_dir, pkg_name) |
| 92 | os.mkdir(pkg_dir) |
| 93 | dist = Distribution(attrs=kw) |
| 94 | |
| 95 | return pkg_dir, dist |
| 96 | |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 97 | class DummyCommand: |
| 98 | """Class to store options for retrieval via set_undefined_options().""" |
| 99 | |
| 100 | def __init__(self, **kwargs): |
| 101 | for kw, val in kwargs.items(): |
| 102 | setattr(self, kw, val) |
| 103 | |
| 104 | def ensure_finalized(self): |
| 105 | pass |
Tarek Ziadé | 29bbb96 | 2009-05-10 12:02:35 +0000 | [diff] [blame] | 106 | |
| 107 | class EnvironGuard(object): |
| 108 | |
| 109 | def setUp(self): |
| 110 | super(EnvironGuard, self).setUp() |
| 111 | self.environ = EnvironmentVarGuard() |
| 112 | |
| 113 | def tearDown(self): |
| 114 | self.environ.__exit__() |
| 115 | super(EnvironGuard, self).tearDown() |