def test_cmd_as_list(self):
"""When bm.runscript() is called with a list arg it should bypass the shell.
"""
with BashMocker('foo', 'bad', shell=self.shell) as bm:
bm.add_mock('bad', fail=True)
# Same as above
res1 = bm.runscript(['true'])
self.assertEqual(res1, 0)
self.assertEqual(bm.last_stdout, '')
self.assertEqual(bm.last_stderr, '')
self.assertEqual(bm.last_calls, bm.empty_calls())
self.assertEqual(bm.last_calls, dict(foo=[], bad=[]))
# Now echo some stuff.
res2 = bm.runscript(['echo', '123', '\n', '* <!!!"'])
self.assertEqual(res2, 0)
self.assertEqual(bm.last_stderr, '')
self.assertEqual(bm.last_stdout, '123 \n * <!!!"\n')
# And run the mocked scripts
res3 = bm.runscript(['foo'])
self.assertEqual(res3, 0)
self.assertEqual(bm.last_calls['foo'], [ [] ])
res4 = bm.runscript(['/usr/bin/env', 'bad', 'dog', ')))))'])
self.assertEqual(res4, 1)
self.assertEqual(bm.last_calls['foo'], [])
self.assertEqual(bm.last_calls['bad'], [ ["dog", ")))))"] ])
def test_bin_mocker(self):
with BashMocker('foo', 'bad', shell=self.shell) as bm:
bm.add_mock('bad', fail=True)
res1 = bm.runscript('true')
self.assertEqual(res1, 0)
self.assertEqual(bm.last_stdout, '')
self.assertEqual(bm.last_stderr, '')
self.assertEqual(bm.last_calls, bm.empty_calls())
self.assertEqual(bm.last_calls, dict(foo=[], bad=[]))
# Now something that actually calls things
res2 = bm.runscript('echo 123 ; foo foo args ; echo 456 ; ( echo 888 >&2 ) ; bad dog ; bad doggy')
self.assertEqual(res2, 1)
self.assertEqual(bm.last_stdout.rstrip().split('\n'), ['123', '456'])
self.assertEqual(bm.last_stderr.rstrip().split('\n'), ['888'])
self.assertEqual(bm.last_calls['foo'], [ ["foo", "args"] ])
self.assertEqual(bm.last_calls['bad'], [ ["dog"], ["doggy"] ])
# Test that everything resets properly
res3 = bm.runscript('true')
self.assertEqual(res3, 0)
self.assertEqual(bm.last_stdout, '')
self.assertEqual(bm.last_stderr, '')
self.assertEqual(bm.last_calls, dict(foo=[], bad=[]))
def test_character_escaping(self):
with BashMocker('foo', shell=self.shell) as bm:
# Some exotic looking args
args = [ [ "a", "b", "c", "a b c" ],
[ ''' ""''"<>!!! ''' ],
[ '\n\n', '', '\t\t \n\r\r' ],
[ '-' ] ]
script = ' ; '.join([ ' '.join(['foo'] + [quote(a) for a in alist])
for alist in args ])
bm.runscript(script)
self.assertEqual(bm.last_stdout, '')
self.assertEqual(bm.last_stderr, '')
self.assertEqual(bm.last_calls, dict(foo=args))
def test_mock_abs_2(self):
"""I was worried about a case where calling a function with no
args leaves the script args in "$@" but this doesn't seem to
happen. Good.
"""
bm = BashMocker(shell=self.shell)
self.addCleanup(bm.cleanup)
bm.add_mock('bibble', side_effect="/no/such/thing")
bm.add_mock("/no/such/thing", side_effect='echo "$@"')
res = bm.runscript('bibble abc 123')
self.assertEqual(bm.last_calls['bibble'], [ ['abc', '123'] ])
self.assertEqual(bm.last_calls['/no/such/thing'], [ [] ])
self.assertEqual(bm.last_stdout, '\n')
def test_fail_mock(self):
"""I was seeing weird behaviour on Ubuntu. Actually I don't think
binmocker was to blame but I'm keeping this test anyway.
"""
with BashMocker(shell=self.shell) as bm:
bm.add_mock('foo')
res = bm.runscript('foo')
self.assertEqual(res, 0)
self.assertEqual(bm.last_stdout, '')
res = bm.runscript('foo ; echo $?')
self.assertEqual(res, 0)
self.assertEqual(bm.last_stdout, '0\n')
# Now make it fail...
bm.add_mock('foo', fail=True)
res = bm.runscript('foo')
self.assertEqual(res, 1)
self.assertEqual(bm.last_stdout, '')
res = bm.runscript('foo ; echo $?')
self.assertEqual(res, 0)
self.assertEqual(bm.last_stdout, '1\n')
def test_side_effect(self):
"""New feature - we can add a side_effect to our mock.
"""
bm = BashMocker(shell=self.shell)
self.addCleanup(bm.cleanup)
# Side effect should happen but should not affect the return value.
bm.add_mock('this', side_effect="echo THIS ; false")
bm.add_mock('that', side_effect="echo THAT >&2 ; true", fail=True)
# Unless the side effect explicitly calls 'exit'.
bm.add_mock('theother', side_effect="echo THEOTHER ; exit $1")
res1 = bm.runscript('this')
self.assertEqual(res1, 0)
self.assertEqual(bm.last_stdout, 'THIS\n')
res2 = bm.runscript('that')
self.assertEqual(res2, 1)
self.assertEqual(bm.last_stderr, 'THAT\n')
res3 = bm.runscript('theother 42')
self.assertEqual(res3, 42)
self.assertEqual(bm.last_stdout, 'THEOTHER\n')
self.assertEqual(bm.last_calls, dict( this = [],
that = [],
theother = [[ '42' ]] ))
def test_mock_abs_path(self):
"""It's possible, if hacky, to mock out even commands referred to by
full path. Note that this will only work for things called from
BASH, not for things called indirectly like "env /bin/foo". And
it won't work on DASH or with BASH in compatibility mode as these don't
read BASH_ENV.
"""
bm = BashMocker(shell=self.shell)
self.addCleanup(bm.cleanup)
bm.add_mock('/bin/false', side_effect="echo THIS")
res1 = bm.runscript('/bin/false 123')
self.assertEqual(res1, 0)
self.assertEqual(bm.last_calls['/bin/false'], [ ['123'] ])
self.assertEqual(bm.last_stdout, 'THIS\n')
#Should also work if called from a sub-script.
bm.add_mock('woo', side_effect="/bin/false 789")
bm.add_mock('/bin/wibble', side_effect="woo 456")
res2 = bm.runscript('/bin/wibble 123')
self.assertEqual(res2, 0)
self.assertEqual(bm.last_calls['/bin/wibble'], [ ['123'] ])
self.assertEqual(bm.last_calls['woo'], [ ['456'] ])
self.assertEqual(bm.last_calls['/bin/false'], [ ['789'] ])
self.assertEqual(bm.last_stdout, 'THIS\n')
#Referring to a command stored in a var is OK
res3 = bm.runscript('cmd=/bin/false ; "$cmd" 123')
self.assertEqual(res3, 0)
self.assertEqual(bm.last_stdout, 'THIS\n')
#But calling a command via 'env' does call the actual command
res4 = bm.runscript('env /bin/false 123')
self.assertEqual(res4, 1)
self.assertEqual(bm.last_stdout, '')