1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
# -*- coding: utf-8 -*-
'''
:codeauthor: :email:`Pedro Algarvio (pedro@algarvio.me)`
:copyright: © 2015-2018 by the SaltStack Team, see AUTHORS for more details.
:license: Apache 2.0, see LICENSE for more details.
pytest_logging.plugin
~~~~~~~~~~~~~~~~~~~~~
'''
# pylint: disable=protected-access,redefined-outer-name
# Import python libs
from __future__ import absolute_import
import os
import shutil
import logging
from functools import partial
# Import py libs
import py
# Import pytest libs
import pytest
from _pytest.pathlib import Path
try:
from _pytest.monkeypatch import MonkeyPatch
except ImportError:
from _pytest.monkeypatch import monkeypatch as MonkeyPatch
from pytest_tempdir import hookspec
log = logging.getLogger('pytest.tempdir')
def pytest_addhooks(pluginmanager):
'''
Register our new hooks
'''
pluginmanager.add_hookspecs(hookspec)
def pytest_addoption(parser):
'''
Add CLI options to py.test
'''
group = parser.getgroup('tempdir', 'Temporary Directory Options')
group.addoption('--tempdir-basename',
default=None,
help='The predictable temporary directory base name. '
'Defaults to the current directory name if not '
'passed as a CLI parameter and if not defined '
'using the tempdir_basename session scoped fixture. '
'If the temporary directory exists when the test '
'session starts, IT WILL BE WIPED!')
group.addoption('--tempdir-no-clean',
default=False,
action='store_true',
help='Disable the removal of the created temporary directory')
def pytest_report_header(config):
'''
return a string to be displayed as header info for terminal reporting.
'''
return 'tempdir: {0}'.format(config._tempdir.strpath)
class TempDir(object):
def __init__(self, config):
self.config = config
self._prepare()
def _prepare(self):
self.counters = {}
basename = None
cli_tempdir_basename = self.config.getvalue('tempdir_basename')
if cli_tempdir_basename is not None:
basename = cli_tempdir_basename
else:
# Let's see if we have a pytest_tempdir_basename hook implementation
basename = self.config.hook.pytest_tempdir_basename()
if basename is None:
# If by now, basename is still None, use the current directory name
basename = os.path.basename(py.path.local().strpath) # pylint: disable=no-member
mpatch = MonkeyPatch()
temproot = self.config.hook.pytest_tempdir_temproot()
if not isinstance(temproot, Path):
temproot = py.path.local(temproot)
# Let's get the full real path to the tempdir
tempdir = temproot.join(basename).realpath()
if tempdir.exists():
# If it exists, it's a stale tempdir. Remove it
log.warning('Removing stale tempdir: %s', tempdir.strpath)
shutil.rmtree(tempdir.strpath, ignore_errors=True)
# Make sure the tempdir is created
tempdir.ensure(dir=True)
# Store a reference the tempdir for cleanup purposes when ending the test
# session
mpatch.setattr(self.config, '_tempdir', self, raising=False)
# Register the cleanup actions
self.config._cleanup.extend([
mpatch.undo,
self._clean_up_tempdir
])
self.tempdir = tempdir
def _clean_up_tempdir(self):
'''
Clean up temporary directory
'''
if self.config.getvalue('--tempdir-no-clean') is False:
log.debug('Cleaning up the tempdir: %s', self.tempdir.strpath)
try:
shutil.rmtree(self.tempdir.strpath, ignore_errors=True)
except py.error.ENOENT: # pylint: disable=no-member
pass
else:
log.debug('No cleaning up tempdir: %s', self.tempdir.strpath)
def mkdir(self, path, use_existing=False):
abspath = self.tempdir.join(path)
if abspath not in self.counters:
self.counters[abspath] = 0
while True:
newdir = self.tempdir.join('{0}{1}'.format(path, self.counters[abspath]))
if newdir.exists() and use_existing is False:
self.counters[abspath] += 1
continue
log.debug('New Dir: %s', newdir)
return newdir.ensure(dir=True)
def __getattribute__(self, name):
try:
return object.__getattribute__(self, name)
except AttributeError:
return getattr(self.tempdir, name)
def pytest_configure(config):
'''
Configure the tempdir
'''
# Prep tempdir
TempDir(config)
@pytest.mark.trylast
def pytest_tempdir_temproot():
return py.path.local.get_temproot() # pylint: disable=no-member
@pytest.fixture(scope='session')
def tempdir(request):
'''
tmpdir pytest fixture
'''
return request.config._tempdir
|
