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) |
| 15 | |
| 16 | def tearDown(self): |
| 17 | log.set_threshold(self.threshold) |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 18 | super().tearDown() |
Fred Drake | edcac8f | 2004-08-03 18:53:07 +0000 | [diff] [blame] | 19 | |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 20 | |
| 21 | class TempdirManager(object): |
| 22 | """Mix-in class that handles temporary directories for test cases. |
| 23 | |
| 24 | This is intended to be used with unittest.TestCase. |
| 25 | """ |
| 26 | |
| 27 | def setUp(self): |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 28 | super().setUp() |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 29 | self.tempdirs = [] |
| 30 | |
| 31 | def tearDown(self): |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 32 | super().tearDown() |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 33 | while self.tempdirs: |
| 34 | d = self.tempdirs.pop() |
Tarek Ziadé | c1375d5 | 2009-02-14 14:35:51 +0000 | [diff] [blame] | 35 | shutil.rmtree(d, os.name in ('nt', 'cygwin')) |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 36 | |
| 37 | def mkdtemp(self): |
| 38 | """Create a temporary directory that will be cleaned up. |
| 39 | |
| 40 | Returns the path of the directory. |
| 41 | """ |
| 42 | d = tempfile.mkdtemp() |
| 43 | self.tempdirs.append(d) |
| 44 | return d |
| 45 | |
Tarek Ziadé | baf5180 | 2009-03-31 21:37:16 +0000 | [diff] [blame] | 46 | def write_file(self, path, content='xxx'): |
Tarek Ziadé | 0d0506e | 2009-02-16 21:49:12 +0000 | [diff] [blame] | 47 | """Writes a file in the given path. |
| 48 | |
| 49 | |
| 50 | path can be a string or a sequence. |
| 51 | """ |
| 52 | if isinstance(path, (list, tuple)): |
| 53 | path = os.path.join(*path) |
| 54 | f = open(path, 'w') |
| 55 | try: |
| 56 | f.write(content) |
| 57 | finally: |
| 58 | f.close() |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 59 | |
Tarek Ziadé | baf5180 | 2009-03-31 21:37:16 +0000 | [diff] [blame] | 60 | def create_dist(self, pkg_name='foo', **kw): |
| 61 | """Will generate a test environment. |
| 62 | |
| 63 | This function creates: |
| 64 | - a Distribution instance using keywords |
| 65 | - a temporary directory with a package structure |
| 66 | |
| 67 | It returns the package directory and the distribution |
| 68 | instance. |
| 69 | """ |
| 70 | tmp_dir = self.mkdtemp() |
| 71 | pkg_dir = os.path.join(tmp_dir, pkg_name) |
| 72 | os.mkdir(pkg_dir) |
| 73 | dist = Distribution(attrs=kw) |
| 74 | |
| 75 | return pkg_dir, dist |
| 76 | |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 77 | class DummyCommand: |
| 78 | """Class to store options for retrieval via set_undefined_options().""" |
| 79 | |
| 80 | def __init__(self, **kwargs): |
| 81 | for kw, val in kwargs.items(): |
| 82 | setattr(self, kw, val) |
| 83 | |
| 84 | def ensure_finalized(self): |
| 85 | pass |
Tarek Ziadé | 29bbb96 | 2009-05-10 12:02:35 +0000 | [diff] [blame^] | 86 | |
| 87 | class EnvironGuard(object): |
| 88 | |
| 89 | def setUp(self): |
| 90 | super(EnvironGuard, self).setUp() |
| 91 | self.environ = EnvironmentVarGuard() |
| 92 | |
| 93 | def tearDown(self): |
| 94 | self.environ.__exit__() |
| 95 | super(EnvironGuard, self).tearDown() |