def test_mock_abs_path(self):
"""It should be possible 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".
"""
bm = BinMocker()
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(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, '')
def test_bin_mocker(self):
with BinMocker('foo', 'bad') 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_side_effect(self):
"""New feature - we can add a side_effect to our mock.
"""
bm = BinMocker(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_cmd_as_list(self):
"""When bm.runscript() is called with a list arg it should bypass the shell.
"""
with BinMocker('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 setUp(self):
self.bm = BinMocker()
for p, s in PROGS_TO_MOCK.items(): self.bm.add_mock(p, side_effect=s)
self.environment = dict()
# See the errors in all their glory
self.maxDiff = None
def test_side_effect(self):
"""New feature - we can add a side_effect to our mock.
"""
bm = BinMocker()
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)
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')
def test_character_escaping(self):
with BinMocker('foo') 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 ])
res1 = bm.runscript(script)
self.assertEqual(bm.last_stdout, '')
self.assertEqual(bm.last_stderr, '')
self.assertEqual(bm.last_calls, dict(foo=args))
def setUp(self):
"""Make a shadow folder, and in it have subdirs runs and fastqdata and log.
Initialize BinMocker.
Calculate the test environment needed to run the driver.sh script.
"""
self.temp_dir = mkdtemp()
for d in ['runs', 'fastqdata', 'log']:
os.mkdir(os.path.join(self.temp_dir, d))
self.bm = BinMocker()
for p, s in PROGS_TO_MOCK.items():
self.bm.add_mock(p, side_effect=s)
# Set the driver to run in our test harness. Note I can set
# $BIN_LOCATION to more than one path.
# Also we need to set VERBOSE to the driver even if it's not set for this test script.
self.environment = dict(
PROM_RUNS=os.path.join(self.temp_dir, 'runs'),
FASTQDATA=os.path.join(self.temp_dir, 'fastqdata'),
UPSTREAM='TEST',
UPSTREAM_TEST='',
BIN_LOCATION=self.bm.mock_bin_dir + ':' + os.path.dirname(DRIVER),
LOG_DIR=os.path.join(self.temp_dir,
'log'), #this is redundant if...
MAINLOG="/dev/stdout",
ENVIRON_SH='/dev/null',
VERBOSE='yes',
PY3_VENV='none',
DEL_REMOTE_CELLS='yes',
)
# Now clear any of these environment variables that might have been set outside
# of this script.
for e in self.environment:
if e in os.environ: del (os.environ[e])
# See the errors in all their glory
self.maxDiff = None
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 BinMocker(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')