Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

""" 

merged implementation of the cache provider 

 

the name cache was not chosen to ensure pluggy automatically 

ignores the external pytest-cache 

""" 

from __future__ import absolute_import 

from __future__ import division 

from __future__ import print_function 

 

import json 

import os 

from collections import OrderedDict 

 

import attr 

import py 

import six 

 

import pytest 

from .compat import _PY2 as PY2 

from .pathlib import Path 

from .pathlib import resolve_from_str 

from .pathlib import rmtree 

 

README_CONTENT = u"""\ 

# pytest cache directory # 

 

This directory contains data from the pytest's cache plugin, 

which provides the `--lf` and `--ff` options, as well as the `cache` fixture. 

 

**Do not** commit this to version control. 

 

See [the docs](https://docs.pytest.org/en/latest/cache.html) for more information. 

""" 

 

CACHEDIR_TAG_CONTENT = b"""\ 

Signature: 8a477f597d28d172789f06886806bc55 

# This file is a cache directory tag created by pytest. 

# For information about cache directory tags, see: 

# http://www.bford.info/cachedir/spec.html 

""" 

 

 

@attr.s 

class Cache(object): 

_cachedir = attr.ib(repr=False) 

_config = attr.ib(repr=False) 

 

@classmethod 

def for_config(cls, config): 

cachedir = cls.cache_dir_from_config(config) 

if config.getoption("cacheclear") and cachedir.exists(): 

rmtree(cachedir, force=True) 

cachedir.mkdir() 

return cls(cachedir, config) 

 

@staticmethod 

def cache_dir_from_config(config): 

return resolve_from_str(config.getini("cache_dir"), config.rootdir) 

 

def warn(self, fmt, **args): 

from _pytest.warnings import _issue_warning_captured 

from _pytest.warning_types import PytestWarning 

 

_issue_warning_captured( 

PytestWarning(fmt.format(**args) if args else fmt), 

self._config.hook, 

stacklevel=3, 

) 

 

def makedir(self, name): 

""" return a directory path object with the given name. If the 

directory does not yet exist, it will be created. You can use it 

to manage files likes e. g. store/retrieve database 

dumps across test sessions. 

 

:param name: must be a string not containing a ``/`` separator. 

Make sure the name contains your plugin or application 

identifiers to prevent clashes with other cache users. 

""" 

name = Path(name) 

if len(name.parts) > 1: 

raise ValueError("name is not allowed to contain path separators") 

res = self._cachedir.joinpath("d", name) 

res.mkdir(exist_ok=True, parents=True) 

return py.path.local(res) 

 

def _getvaluepath(self, key): 

return self._cachedir.joinpath("v", Path(key)) 

 

def get(self, key, default): 

""" return cached value for the given key. If no value 

was yet cached or the value cannot be read, the specified 

default is returned. 

 

:param key: must be a ``/`` separated value. Usually the first 

name is the name of your plugin or your application. 

:param default: must be provided in case of a cache-miss or 

invalid cache values. 

 

""" 

path = self._getvaluepath(key) 

try: 

with path.open("r") as f: 

return json.load(f) 

except (ValueError, IOError, OSError): 

return default 

 

def set(self, key, value): 

""" save value for the given key. 

 

:param key: must be a ``/`` separated value. Usually the first 

name is the name of your plugin or your application. 

:param value: must be of any combination of basic 

python types, including nested types 

like e. g. lists of dictionaries. 

""" 

path = self._getvaluepath(key) 

try: 

if path.parent.is_dir(): 

cache_dir_exists_already = True 

else: 

cache_dir_exists_already = self._cachedir.exists() 

path.parent.mkdir(exist_ok=True, parents=True) 

except (IOError, OSError): 

self.warn("could not create cache path {path}", path=path) 

return 

try: 

f = path.open("wb" if PY2 else "w") 

except (IOError, OSError): 

self.warn("cache could not write path {path}", path=path) 

else: 

with f: 

json.dump(value, f, indent=2, sort_keys=True) 

if not cache_dir_exists_already: 

self._ensure_supporting_files() 

 

def _ensure_supporting_files(self): 

"""Create supporting files in the cache dir that are not really part of the cache.""" 

if self._cachedir.is_dir(): 

readme_path = self._cachedir / "README.md" 

if not readme_path.is_file(): 

readme_path.write_text(README_CONTENT) 

 

gitignore_path = self._cachedir.joinpath(".gitignore") 

if not gitignore_path.is_file(): 

msg = u"# Created by pytest automatically.\n*" 

gitignore_path.write_text(msg, encoding="UTF-8") 

 

cachedir_tag_path = self._cachedir.joinpath("CACHEDIR.TAG") 

if not cachedir_tag_path.is_file(): 

cachedir_tag_path.write_bytes(CACHEDIR_TAG_CONTENT) 

 

 

class LFPlugin(object): 

""" Plugin which implements the --lf (run last-failing) option """ 

 

def __init__(self, config): 

self.config = config 

active_keys = "lf", "failedfirst" 

self.active = any(config.getoption(key) for key in active_keys) 

self.lastfailed = config.cache.get("cache/lastfailed", {}) 

self._previously_failed_count = None 

self._no_failures_behavior = self.config.getoption("last_failed_no_failures") 

 

def pytest_report_collectionfinish(self): 

if self.active and self.config.getoption("verbose") >= 0: 

if not self._previously_failed_count: 

return None 

noun = "failure" if self._previously_failed_count == 1 else "failures" 

suffix = " first" if self.config.getoption("failedfirst") else "" 

mode = "rerun previous {count} {noun}{suffix}".format( 

count=self._previously_failed_count, suffix=suffix, noun=noun 

) 

return "run-last-failure: %s" % mode 

 

def pytest_runtest_logreport(self, report): 

if (report.when == "call" and report.passed) or report.skipped: 

self.lastfailed.pop(report.nodeid, None) 

elif report.failed: 

self.lastfailed[report.nodeid] = True 

 

def pytest_collectreport(self, report): 

passed = report.outcome in ("passed", "skipped") 

if passed: 

if report.nodeid in self.lastfailed: 

self.lastfailed.pop(report.nodeid) 

self.lastfailed.update((item.nodeid, True) for item in report.result) 

else: 

self.lastfailed[report.nodeid] = True 

 

def pytest_collection_modifyitems(self, session, config, items): 

if self.active: 

if self.lastfailed: 

previously_failed = [] 

previously_passed = [] 

for item in items: 

if item.nodeid in self.lastfailed: 

previously_failed.append(item) 

else: 

previously_passed.append(item) 

self._previously_failed_count = len(previously_failed) 

if not previously_failed: 

# running a subset of all tests with recorded failures outside 

# of the set of tests currently executing 

return 

if self.config.getoption("lf"): 

items[:] = previously_failed 

config.hook.pytest_deselected(items=previously_passed) 

else: 

items[:] = previously_failed + previously_passed 

elif self._no_failures_behavior == "none": 

config.hook.pytest_deselected(items=items) 

items[:] = [] 

 

def pytest_sessionfinish(self, session): 

config = self.config 

if config.getoption("cacheshow") or hasattr(config, "slaveinput"): 

return 

 

saved_lastfailed = config.cache.get("cache/lastfailed", {}) 

if saved_lastfailed != self.lastfailed: 

config.cache.set("cache/lastfailed", self.lastfailed) 

 

 

class NFPlugin(object): 

""" Plugin which implements the --nf (run new-first) option """ 

 

def __init__(self, config): 

self.config = config 

self.active = config.option.newfirst 

self.cached_nodeids = config.cache.get("cache/nodeids", []) 

 

def pytest_collection_modifyitems(self, session, config, items): 

if self.active: 

new_items = OrderedDict() 

other_items = OrderedDict() 

for item in items: 

if item.nodeid not in self.cached_nodeids: 

new_items[item.nodeid] = item 

else: 

other_items[item.nodeid] = item 

 

items[:] = self._get_increasing_order( 

six.itervalues(new_items) 

) + self._get_increasing_order(six.itervalues(other_items)) 

self.cached_nodeids = [x.nodeid for x in items if isinstance(x, pytest.Item)] 

 

def _get_increasing_order(self, items): 

return sorted(items, key=lambda item: item.fspath.mtime(), reverse=True) 

 

def pytest_sessionfinish(self, session): 

config = self.config 

if config.getoption("cacheshow") or hasattr(config, "slaveinput"): 

return 

 

config.cache.set("cache/nodeids", self.cached_nodeids) 

 

 

def pytest_addoption(parser): 

group = parser.getgroup("general") 

group.addoption( 

"--lf", 

"--last-failed", 

action="store_true", 

dest="lf", 

help="rerun only the tests that failed " 

"at the last run (or all if none failed)", 

) 

group.addoption( 

"--ff", 

"--failed-first", 

action="store_true", 

dest="failedfirst", 

help="run all tests but run the last failures first. " 

"This may re-order tests and thus lead to " 

"repeated fixture setup/teardown", 

) 

group.addoption( 

"--nf", 

"--new-first", 

action="store_true", 

dest="newfirst", 

help="run tests from new files first, then the rest of the tests " 

"sorted by file mtime", 

) 

group.addoption( 

"--cache-show", 

action="store_true", 

dest="cacheshow", 

help="show cache contents, don't perform collection or tests", 

) 

group.addoption( 

"--cache-clear", 

action="store_true", 

dest="cacheclear", 

help="remove all cache contents at start of test run.", 

) 

cache_dir_default = ".pytest_cache" 

if "TOX_ENV_DIR" in os.environ: 

cache_dir_default = os.path.join(os.environ["TOX_ENV_DIR"], cache_dir_default) 

parser.addini("cache_dir", default=cache_dir_default, help="cache directory path.") 

group.addoption( 

"--lfnf", 

"--last-failed-no-failures", 

action="store", 

dest="last_failed_no_failures", 

choices=("all", "none"), 

default="all", 

help="change the behavior when no test failed in the last run or no " 

"information about the last failures was found in the cache", 

) 

 

 

def pytest_cmdline_main(config): 

if config.option.cacheshow: 

from _pytest.main import wrap_session 

 

return wrap_session(config, cacheshow) 

 

 

@pytest.hookimpl(tryfirst=True) 

def pytest_configure(config): 

config.cache = Cache.for_config(config) 

config.pluginmanager.register(LFPlugin(config), "lfplugin") 

config.pluginmanager.register(NFPlugin(config), "nfplugin") 

 

 

@pytest.fixture 

def cache(request): 

""" 

Return a cache object that can persist state between testing sessions. 

 

cache.get(key, default) 

cache.set(key, value) 

 

Keys must be a ``/`` separated value, where the first part is usually the 

name of your plugin or application to avoid clashes with other cache users. 

 

Values can be any object handled by the json stdlib module. 

""" 

return request.config.cache 

 

 

def pytest_report_header(config): 

"""Display cachedir with --cache-show and if non-default.""" 

if config.option.verbose or config.getini("cache_dir") != ".pytest_cache": 

cachedir = config.cache._cachedir 

# TODO: evaluate generating upward relative paths 

# starting with .., ../.. if sensible 

 

try: 

displaypath = cachedir.relative_to(config.rootdir) 

except ValueError: 

displaypath = cachedir 

return "cachedir: {}".format(displaypath) 

 

 

def cacheshow(config, session): 

from pprint import pformat 

 

tw = py.io.TerminalWriter() 

tw.line("cachedir: " + str(config.cache._cachedir)) 

if not config.cache._cachedir.is_dir(): 

tw.line("cache is empty") 

return 0 

dummy = object() 

basedir = config.cache._cachedir 

vdir = basedir / "v" 

tw.sep("-", "cache values") 

for valpath in sorted(x for x in vdir.rglob("*") if x.is_file()): 

key = valpath.relative_to(vdir) 

val = config.cache.get(key, dummy) 

if val is dummy: 

tw.line("%s contains unreadable content, will be ignored" % key) 

else: 

tw.line("%s contains:" % key) 

for line in pformat(val).splitlines(): 

tw.line(" " + line) 

 

ddir = basedir / "d" 

if ddir.is_dir(): 

contents = sorted(ddir.rglob("*")) 

tw.sep("-", "cache directories") 

for p in contents: 

# if p.check(dir=1): 

# print("%s/" % p.relto(basedir)) 

if p.is_file(): 

key = p.relative_to(basedir) 

tw.line("{} is a file of length {:d}".format(key, p.stat().st_size)) 

return 0