enable debug logging inside the test suite
ClosedPublic
Actions

Authored by kparal on Mar 27 2014, 2:04 PM.

Details

Reviewers

tflink
mkrizek
pschindl
jskladan

Commits

rLTRN8158705593ea: enable debug logging inside the test suite

Summary

When some test fails, it will now display the logged output as part of
stderr. Also it's now possible to display logged output even for passed
tests using py.test -s option. This is sometimes very handy, so keep this in mind! :-)

Test Plan

Unfortunatelly I can't demonstrate it at the moment too much, because we don't use much debug logging in libtaskotron. But with the upcoming config.py, this is making miracles. For any failed test, you also see any logged output as captured by py.test. That helps to discover the issue greatly.

You can also run something like py.test --functional -s testing/test_check.py (notice -s) and you'll see full output even for passed tests, not just failing ones. Again, this can be used to verify that your test is executing the correct code paths.

Diff Detail

Lint

Lint Skipped

Unit

Unit Tests Skipped

Overall, looks good. Any thoughts about removing sys._called_from_test?

testing/conftest.py
50–58	This is still a hack but we're not using it, so I propose that we remove it

Overall, looks good. Any thoughts about removing sys._called_from_test?

I did that in D34. I can do it as part of this patch, why not.

remove sys hack

I did that in D34. I can do it as part of this patch, why not.

Either way works. Looks good to me, please squash and merge into develop

Closed by commit rLTRN8158705593ea (authored by @kparal).

Revision Contents

			Path
M			testing/conftest.py (24 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	89	2e7085e		Mar 27 2014, 2:04 PM	★	★
Diff 2	91	2e7085e	- remove sys hack	Mar 27 2014, 7:29 PM	★	★
Diff 3	92	2e7085e	Commit rLTRN8158705593ea365cebfe2250d4e0ecceac05da03	Mar 28 2014, 7:44 AM	★	★

Commit	Tree	Parents	Author	Summary	Date
3fa0b8c1adbc	d36bc78c768e	aec35ae2d2db	Kamil Páral	remove sys hack	Mar 27 2014, 7:28 PM
aec35ae2d2db	fe4caee8c679	2e7085e4e9dc	Kamil Páral	enable debug logging inside the test suite (Show More…)	Mar 27 2014, 1:47 PM

Diff 92

View Options

testing/conftest.py

1	#
2	# conftest.py - utils for py.test
3	#
4	# Copyright 2011, Red Hat, Inc.	1		# Copyright 2011, Red Hat, Inc.
5	#	2		#
6	# This program is free software; you can redistribute it and/or modify	3		# This program is free software; you can redistribute it and/or modify
7	# it under the terms of the GNU General Public License as published by	4		# it under the terms of the GNU General Public License as published by
8	# the Free Software Foundation; either version 2 of the License, or	5		# the Free Software Foundation; either version 2 of the License, or
9	# (at your option) any later version.	6		# (at your option) any later version.
10	#	7		#
11	# This program is distributed in the hope that it will be useful,	8		# This program is distributed in the hope that it will be useful,
12	# but WITHOUT ANY WARRANTY; without even the implied warranty of	9		# but WITHOUT ANY WARRANTY; without even the implied warranty of
13	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the	10		# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14	# GNU General Public License for more details.	11		# GNU General Public License for more details.
15	#	12		#
16	# You should have received a copy of the GNU General Public License along	13		# You should have received a copy of the GNU General Public License along
17	# with this program; if not, write to the Free Software Foundation, Inc.,	14		# with this program; if not, write to the Free Software Foundation, Inc.,
18	# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.	15		# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19	#	16		#
20	# Author: Tim Flink <tflink@redhat.com>	17		# Author: Tim Flink <tflink@redhat.com>
21		18
		19		'''py.test configuration and plugins
		20		Read more at: http://pytest.org/latest/plugins.html#conftest-py-plugins'''
		21
		22		import logging
		23
		24		import libtaskotron.logger
		25
22		26
23	def pytest_addoption(parser):	27		def pytest_addoption(parser):
24	"""	28		"""
25	Add an option to the py.test parser to detect when the functional tests	29		Add an option to the py.test parser to detect when the functional tests
26	should be detected and run	30		should be detected and run
27	"""	31		"""
28		32
29	parser.addoption('--functional', action='store_true', default=False,	33		parser.addoption('--functional', action='store_true', default=False,
30	help='Add functional tests')	34		help='Add functional tests')
31		35
32		36
33	def pytest_ignore_collect(path, config):	37		def pytest_ignore_collect(path, config):
34	"""Prevents collection of any files named functest* to speed up non	38		"""Prevents collection of any files named functest* to speed up non
35	integration tests"""	39		integration tests"""
36	if path.fnmatch('functest'):	40		if path.fnmatch('functest'):
37	try:	41		try:
38	is_functional = config.getvalue('functional')	42		is_functional = config.getvalue('functional')
39	except KeyError:	43		except KeyError:
40	return True	44		return True
41		45
42	return not is_functional	46		return not is_functional
43		47
44		48
45	def pytest_configure(config):	49		def pytest_configure(config):
46	"""This is a bit of a hack to detect whether or not we are running inside	50		"""Called after command line options have been parsed and all plugins and
47	a test environment"""	51		initial conftest files been loaded."""
48	import sys	52
49		53		# enable debug logging for taskotron
50	sys._called_from_test = True	54		# This will allow us to use libtaskotron-logged output for failed tests.
		55		# You can also use "py.test -s" option to see all output even for passed
		56		# tests (of course, it's better to run the suite with just a single file
		57		# rather than the whole directory in this case)
		58		libtaskotron.logger.init(level=logging.DEBUG)
			tflinkUnsubmitted Not Done This is still a hack but we're not using it, so I propose that we remove it