Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	2423	bd9f435		Jul 26 2016, 7:22 AM	★	★
Diff 2	2426	bd9f435	- polishing, moar tests	Jul 26 2016, 8:07 AM	★	★
Diff 3	2427	8fd5656	improved unit tests	Jul 26 2016, 8:44 AM	★	★
Diff 4	2428	bd9f435	try one more time, this time with full history	Jul 26 2016, 8:46 AM	★	★
Diff 5	2429	25fadf9	rLTRNfd753bc2baff54038400fa413ccc4c0e7efb4381	Jul 26 2016, 8:51 AM	★	★

Commit	Tree	Parents	Author	Summary	Date
ae8252a1be60	63ff10756f91	8fd5656a69f5	Kamil Páral	unit test improvements	Jul 26 2016, 8:42 AM
8fd5656a69f5	fdf38d5b51a8	bd9f435ec64b	Lukas Brabec	check that shell directive command is string or list (Show More…)	Jul 26 2016, 8:18 AM

Diff 2429

libtaskotron/directives/shell_directive.py

Show All 30 Lines		19	description: \|
31		31
32	This directive is intended for basic simple scripting or running commands. If you need anything	32		This directive is intended for basic simple scripting or running commands. If you need anything
33	more advanced, it's recommended to create a standalone script (bash, perl, etc) and execute it	33		more advanced, it's recommended to create a standalone script (bash, perl, etc) and execute it
34	instead.	34		instead.
35	returns: \|	35		returns: \|
36	The stdout of executed shell command, in case of multiple commands, output of the last one is	36		The stdout of executed shell command, in case of multiple commands, output of the last one is
37	returned.	37		returned.
38	raises: \|	38		raises: \|
39	* :class:`.TaskotronDirectiveError`: when parameter of shell directive is not a list, if command	39		* :class:`.TaskotronDirectiveError`: if shell directive does not consist of a list of commands;
40	to be executed does not exist or if command returned non-zero returncode (returncode can be	40		if command is not a string or a list of strings; if command to be executed does not exist; if
41	ignored, see examples).	41		command returned non-zero returncode (returncode can be ignored, see examples).
42
43	version_added: 0.4.15	42		version_added: 0.4.15
44	"""	43		"""
45		44
46	EXAMPLES = """	45		EXAMPLES = """
47	This executes the shell command in subprocess::	46		This executes the shell command in subprocess::
48		47
49	- name: pull docker image	48		- name: pull docker image
50	shell:	49		shell:
▲ Show 20 Lines • Show All 72 Lines • ▼ Show 20 Line(s)		115	def process(self, params, arg_data, ignorereturn=False):
123	output = ""	122		output = ""
124		123
125	for cmd in params:	124		for cmd in params:
126	if isinstance(cmd, dict) and 'ignorereturn' in cmd:	125		if isinstance(cmd, dict) and 'ignorereturn' in cmd:
127	output = self.process(cmd['ignorereturn'], arg_data, ignorereturn=True)	126		output = self.process(cmd['ignorereturn'], arg_data, ignorereturn=True)
128	continue	127		continue
129		128
130	try:	129		try:
131	if isinstance(cmd, list):	130		if isinstance(cmd, list) and all([isinstance(c, basestring) for c in cmd]):
132	log.info("Executing process: %s", cmd)	131		log.info("Executing process: %s", cmd)
133	output = check_output(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT,	132		output = check_output(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
134	bufsize=1, close_fds=True, cwd=basedir)	133		bufsize=1, close_fds=True, cwd=basedir)
135	else:	134		elif isinstance(cmd, basestring):
136	log.info("Executing shell: %s", cmd)	135		log.info("Executing shell: %s", cmd)
137	output = check_output(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT,	136		output = check_output(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
138	bufsize=1, close_fds=True, cwd=basedir, shell=True)	137		bufsize=1, close_fds=True, cwd=basedir, shell=True)
		138		else:
		139		cmd_type = [type(c) for c in cmd] if isinstance(cmd, list) else type(cmd)
		140		raise TaskotronDirectiveError("Command %r is in invalid type %r, use string or"
		141		" list of strings" % (cmd, cmd_type))
139		142
140	except subprocess.CalledProcessError as e:	143		except subprocess.CalledProcessError as e:
141	if not ignorereturn:	144		if not ignorereturn:
142	raise TaskotronDirectiveError(e)	145		raise TaskotronDirectiveError(e)
143	except OSError as e:	146		except OSError as e:
144	raise TaskotronDirectiveError(e)	147		raise TaskotronDirectiveError(e)
145		148
146	return output	149		return output

View Options

testing/test_shell_directive.py

1	# -- coding: utf-8 --	1	# -- coding: utf-8 --
2	# Copyright 2009-2016, Red Hat, Inc.	2	# Copyright 2009-2016, Red Hat, Inc.
3	# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>	3	# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>
4	# See the LICENSE file for more details on Licensing	4	# See the LICENSE file for more details on Licensing
5		5
6	from libtaskotron.directives import shell_directive	6	from libtaskotron.directives import shell_directive
7	from libtaskotron.exceptions import TaskotronDirectiveError	7	from libtaskotron.exceptions import TaskotronDirectiveError
8		8
9	import os	9	import os
10	import pytest	10	import pytest
11	import subprocess
12	import mock	11	import mock
13		12
14	OUTPUT = "Piko a Rybi prsty"	13	OUTPUT = "Piko a Rybi prsty"
15	PATH = os.path.realpath(__file__)	14	PATH = os.path.realpath(__file__)
16		15
17		16
		17	@pytest.mark.usefixtures("setup")
18	class TestCheckCommand(object):	18	class TestCheckCommand(object):
19	def test_a_list(self, monkeypatch):
20	test_params = ['cmd.exe']
21	test_arg_data = {'task': PATH}
22	test_directive = shell_directive.ShellDirective()
23		19
24	stub_check_output = mock.Mock(return_value=OUTPUT)	20	@pytest.fixture
25	monkeypatch.setattr(shell_directive, 'check_output', stub_check_output)	21	def setup(self, monkeypatch):
		22	self.shell_dir = shell_directive.ShellDirective()
		23	self.mock_check_output = mock.Mock()
		24	monkeypatch.setattr(shell_directive, 'check_output', self.mock_check_output)
		25	self.arg_data = {'task': PATH}
		26
		27	def test_a_list(self):
		28	test_params = ['cmd.exe']
		29	self.mock_check_output.return_value = OUTPUT
26		30
27	output = test_directive.process(test_params, test_arg_data)	31	output = self.shell_dir.process(test_params, self.arg_data)
28		32
29	assert output == OUTPUT	33	assert output == OUTPUT
30		34
31	def test_not_a_list(self, monkeypatch):	35	def test_not_a_list(self, monkeypatch):
32	test_params = {'a dict': 'instead of a list'}	36	test_params = {'a dict': 'instead of a list'}
33	test_arg_data = {'task': PATH}
34	test_directive = shell_directive.ShellDirective()
35		37
36	monkeypatch.setattr(subprocess, 'check_output', mock.Mock())	38	with pytest.raises(TaskotronDirectiveError):
		39	self.shell_dir.process(test_params, self.arg_data)
		40
		41	assert not self.mock_check_output.called
		42
		43	def test_cmd_not_a_str(self, monkeypatch):
		44	test_params = [False]
37		45
38	with pytest.raises(TaskotronDirectiveError):	46	with pytest.raises(TaskotronDirectiveError):
39	test_directive.process(test_params, test_arg_data)	47	self.shell_dir.process(test_params, self.arg_data)
		48
		49	assert not self.mock_check_output.called
		50
		51	def test_cmd_not_a_list_of_strs(self, monkeypatch):
		52	test_params = [['echo', False]]
		53
		54	with pytest.raises(TaskotronDirectiveError):
		55	self.shell_dir.process(test_params, self.arg_data)
		56
		57	assert not self.mock_check_output.called

			Path	Packages
M			libtaskotron/directives/shell_directive.py (15 lines)
M			testing/test_shell_directive.py (42 lines)

check that shell directive command is string or list
ClosedPublic
Actions

Details

Diff Detail

Revision Contents

Diff 2429

libtaskotron/directives/shell_directive.py

testing/test_shell_directive.py

check that shell directive command is string or listClosedPublicActions

Details

Diff Detail

Revision Contents

Diff 2429

libtaskotron/directives/shell_directive.py

testing/test_shell_directive.py

check that shell directive command is string or list
ClosedPublic
Actions