def test_non_shebang_binaries_ignored(self):
"""Native binaries are ignored.
If the executable is a native binary, and thus not have a
shebang, it's ignored.
"""
snapdir = common.get_snapdir()
os.mkdir(snapdir)
relative_exe_path = 'test_relexepath'
# Choose a content which can't be decoded with utf-8, to make
# sure no decoding errors happen.
exe_contents = b'\xf0\xf1'
with open(os.path.join(snapdir, relative_exe_path), 'wb') as exe:
exe.write(exe_contents)
relative_wrapper_path = meta._wrap_exe(relative_exe_path)
wrapper_path = os.path.join(snapdir, relative_wrapper_path)
expected = ('#!/bin/sh\n'
'\n\n'
'exec "$SNAP/test_relexepath" $*\n')
with open(wrapper_path) as wrapper_file:
wrapper_contents = wrapper_file.read()
self.assertEqual(expected, wrapper_contents)
with open(os.path.join(snapdir, relative_exe_path), 'rb') as exe:
self.assertEqual(exe_contents, exe.read())
def test_wrap_exe_must_write_wrapper(self, mock_assemble_env):
mock_assemble_env.return_value = """\
PATH={0}/part1/install/usr/bin:{0}/part1/install/bin
""".format(common.get_partsdir())
snapdir = common.get_snapdir()
os.mkdir(snapdir)
relative_exe_path = 'test_relexepath'
open(os.path.join(snapdir, relative_exe_path), 'w').close()
# Check that the wrapper is created even if there is already a file
# with the same name.
open(os.path.join('snap', 'test_relexepath.wrapper'), 'w').close()
relative_wrapper_path = meta._wrap_exe(relative_exe_path)
wrapper_path = os.path.join(snapdir, relative_wrapper_path)
expected = ('#!/bin/sh\n'
'PATH=$SNAP/usr/bin:$SNAP/bin\n'
'\n\n'
'exec "$SNAP/test_relexepath" $*\n')
with open(wrapper_path) as wrapper_file:
wrapper_contents = wrapper_file.read()
self.assertEqual(expected, wrapper_contents)
def test_non_snap_shebangs_ignored(self):
"""Shebangs not pointing to the snap's install dir are ignored.
If the shebang points to a system executable, there's no need to
interfere.
"""
snapdir = common.get_snapdir()
os.mkdir(snapdir)
relative_exe_path = 'test_relexepath'
exe_contents = '#!/bin/bash\necho hello\n'
with open(os.path.join(snapdir, relative_exe_path), 'w') as exe:
exe.write(exe_contents)
relative_wrapper_path = meta._wrap_exe(relative_exe_path)
wrapper_path = os.path.join(snapdir, relative_wrapper_path)
expected = ('#!/bin/sh\n'
'\n\n'
'exec "$SNAP/test_relexepath" $*\n')
with open(wrapper_path) as wrapper_file:
wrapper_contents = wrapper_file.read()
self.assertEqual(expected, wrapper_contents)
with open(os.path.join(snapdir, relative_exe_path), 'r') as exe:
self.assertEqual(exe_contents, exe.read())
def test_wrap_exe_writes_wrapper_with_basename(self, mock_assemble_env):
mock_assemble_env.return_value = """\
PATH={0}/part1/install/usr/bin:{0}/part1/install/bin
""".format(common.get_partsdir())
snapdir = common.get_snapdir()
os.mkdir(snapdir)
relative_exe_path = 'test_relexepath'
open(os.path.join(snapdir, relative_exe_path), 'w').close()
relative_wrapper_path = meta._wrap_exe(
relative_exe_path, basename='new-name')
wrapper_path = os.path.join(snapdir, relative_wrapper_path)
self.assertEqual(relative_wrapper_path, 'new-name.wrapper')
expected = ('#!/bin/sh\n'
'PATH=$SNAP/usr/bin:$SNAP/bin\n'
'\n\n'
'exec "$SNAP/test_relexepath" $*\n')
with open(wrapper_path) as wrapper_file:
wrapper_contents = wrapper_file.read()
self.assertEqual(expected, wrapper_contents)
def test_non_shebang_binaries_ignored(self):
"""Native binaries are ignored.
If the executable is a native binary, and thus not have a
shebang, it's ignored.
"""
snapdir = common.get_snapdir()
os.mkdir(snapdir)
relative_exe_path = 'test_relexepath'
# Choose a content which can't be decoded with utf-8, to make
# sure no decoding errors happen.
exe_contents = b'\xf0\xf1'
with open(os.path.join(snapdir, relative_exe_path), 'wb') as exe:
exe.write(exe_contents)
relative_wrapper_path = meta._wrap_exe(relative_exe_path)
wrapper_path = os.path.join(snapdir, relative_wrapper_path)
expected = ('#!/bin/sh\n' '\n\n' 'exec "$SNAP/test_relexepath" $*\n')
with open(wrapper_path) as wrapper_file:
wrapper_contents = wrapper_file.read()
self.assertEqual(expected, wrapper_contents)
with open(os.path.join(snapdir, relative_exe_path), 'rb') as exe:
self.assertEqual(exe_contents, exe.read())
def test_wrap_exe_writes_wrapper_with_basename(self, mock_assemble_env):
mock_assemble_env.return_value = """\
PATH={0}/part1/install/usr/bin:{0}/part1/install/bin
""".format(common.get_partsdir())
snapdir = common.get_snapdir()
os.mkdir(snapdir)
relative_exe_path = 'test_relexepath'
open(os.path.join(snapdir, relative_exe_path), 'w').close()
relative_wrapper_path = meta._wrap_exe(relative_exe_path,
basename='new-name')
wrapper_path = os.path.join(snapdir, relative_wrapper_path)
self.assertEqual(relative_wrapper_path, 'new-name.wrapper')
expected = ('#!/bin/sh\n'
'PATH=$SNAP/usr/bin:$SNAP/bin\n'
'\n\n'
'exec "$SNAP/test_relexepath" $*\n')
with open(wrapper_path) as wrapper_file:
wrapper_contents = wrapper_file.read()
self.assertEqual(expected, wrapper_contents)
def test_wrap_exe_must_write_wrapper(self, mock_assemble_env):
mock_assemble_env.return_value = """\
PATH={0}/part1/install/usr/bin:{0}/part1/install/bin
""".format(common.get_partsdir())
snapdir = common.get_snapdir()
os.mkdir(snapdir)
relative_exe_path = 'test_relexepath'
open(os.path.join(snapdir, relative_exe_path), 'w').close()
# Check that the wrapper is created even if there is already a file
# with the same name.
open(os.path.join('snap', 'test_relexepath.wrapper'), 'w').close()
relative_wrapper_path = meta._wrap_exe(relative_exe_path)
wrapper_path = os.path.join(snapdir, relative_wrapper_path)
expected = ('#!/bin/sh\n'
'PATH=$SNAP/usr/bin:$SNAP/bin\n'
'\n\n'
'exec "$SNAP/test_relexepath" $*\n')
with open(wrapper_path) as wrapper_file:
wrapper_contents = wrapper_file.read()
self.assertEqual(expected, wrapper_contents)
def test_exe_is_in_path(self, run_mock):
snapdir = common.get_snapdir()
app_path = os.path.join(snapdir, 'bin', 'app1')
os.makedirs(os.path.dirname(app_path))
open(app_path, 'w').close()
relative_wrapper_path = meta._wrap_exe('app1')
wrapper_path = os.path.join(snapdir, relative_wrapper_path)
expected = ('#!/bin/sh\n' '\n\n' 'exec "app1" $*\n')
with open(wrapper_path) as wrapper_file:
wrapper_contents = wrapper_file.read()
self.assertEqual(expected, wrapper_contents)
def test_exe_is_in_path(self, run_mock):
snapdir = common.get_snapdir()
app_path = os.path.join(snapdir, 'bin', 'app1')
os.makedirs(os.path.dirname(app_path))
open(app_path, 'w').close()
relative_wrapper_path = meta._wrap_exe('app1')
wrapper_path = os.path.join(snapdir, relative_wrapper_path)
expected = ('#!/bin/sh\n'
'\n\n'
'exec "app1" $*\n')
with open(wrapper_path) as wrapper_file:
wrapper_contents = wrapper_file.read()
self.assertEqual(expected, wrapper_contents)
def test_wrap_exe_must_write_wrapper(self):
snapdir = common.get_snapdir()
os.mkdir(snapdir)
relative_exe_path = "test_relexepath"
with open(os.path.join(snapdir, relative_exe_path), "w"):
pass
relative_wrapper_path = meta._wrap_exe(relative_exe_path)
wrapper_path = os.path.join(snapdir, relative_wrapper_path)
expected = "#!/bin/sh\n" "\n\n" 'exec "$SNAP_APP_PATH/test_relexepath" $*\n'
with open(wrapper_path) as wrapper_file:
wrapper_contents = wrapper_file.read()
self.assertEqual(expected, wrapper_contents)
def test_wrap_exe_must_write_wrapper(self):
snapdir = common.get_snapdir()
os.mkdir(snapdir)
relative_exe_path = 'test_relexepath'
with open(os.path.join(snapdir, relative_exe_path), 'w'):
pass
relative_wrapper_path = meta._wrap_exe(relative_exe_path)
wrapper_path = os.path.join(snapdir, relative_wrapper_path)
expected = ('#!/bin/sh\n'
'\n\n'
'exec "$SNAP_APP_PATH/test_relexepath" $*\n')
with open(wrapper_path) as wrapper_file:
wrapper_contents = wrapper_file.read()
self.assertEqual(expected, wrapper_contents)
def test_snap_shebangs_extracted(self):
"""Shebangs pointing to the snap's install dir get extracted.
If the exe has a shebang that points to the snap's install dir,
the wrapper script will execute it directly rather than relying
on the shebang.
The shebang needs to be an absolute path, and we don't know
in which directory the snap will be installed. Executing
it in the wrapper script allows us to use the $SNAP environment
variable.
"""
snapdir = common.get_snapdir()
partsdir = common.get_partsdir()
os.mkdir(snapdir)
relative_exe_path = 'test_relexepath'
shebang_path = os.path.join(
partsdir, 'testsnap', 'install', 'snap_exe')
exe_contents = '#!{}\n'.format(shebang_path)
with open(os.path.join(snapdir, relative_exe_path), 'w') as exe:
exe.write(exe_contents)
relative_wrapper_path = meta._wrap_exe(relative_exe_path)
wrapper_path = os.path.join(snapdir, relative_wrapper_path)
expected = (
'#!/bin/sh\n'
'\n\n'
'exec "$SNAP/snap_exe"'
' "$SNAP/test_relexepath" $*\n')
with open(wrapper_path) as wrapper_file:
wrapper_contents = wrapper_file.read()
self.assertEqual(expected, wrapper_contents)
with open(os.path.join(snapdir, relative_exe_path), 'r') as exe:
# The shebang wasn't changed, since we don't know what the
# path will be on the installed system.
self.assertEqual(exe_contents, exe.read())
def test_snap_shebangs_extracted(self):
"""Shebangs pointing to the snap's install dir get extracted.
If the exe has a shebang that points to the snap's install dir,
the wrapper script will execute it directly rather than relying
on the shebang.
The shebang needs to be an absolute path, and we don't know
in which directory the snap will be installed. Executing
it in the wrapper script allows us to use the $SNAP environment
variable.
"""
snapdir = common.get_snapdir()
partsdir = common.get_partsdir()
os.mkdir(snapdir)
relative_exe_path = 'test_relexepath'
shebang_path = os.path.join(partsdir, 'testsnap', 'install',
'snap_exe')
exe_contents = '#!{}\n'.format(shebang_path)
with open(os.path.join(snapdir, relative_exe_path), 'w') as exe:
exe.write(exe_contents)
relative_wrapper_path = meta._wrap_exe(relative_exe_path)
wrapper_path = os.path.join(snapdir, relative_wrapper_path)
expected = ('#!/bin/sh\n'
'\n\n'
'exec "$SNAP/snap_exe"'
' "$SNAP/test_relexepath" $*\n')
with open(wrapper_path) as wrapper_file:
wrapper_contents = wrapper_file.read()
self.assertEqual(expected, wrapper_contents)
with open(os.path.join(snapdir, relative_exe_path), 'r') as exe:
# The shebang wasn't changed, since we don't know what the
# path will be on the installed system.
self.assertEqual(exe_contents, exe.read())
def test_wrap_exe_must_write_wrapper(self, mock_assemble_env):
mock_assemble_env.return_value = """\
PATH={0}/part1/install/usr/bin:{0}/part1/install/bin
""".format(common.get_partsdir())
snapdir = common.get_snapdir()
os.mkdir(snapdir)
relative_exe_path = 'test_relexepath'
with open(os.path.join(snapdir, relative_exe_path), 'w'):
pass
relative_wrapper_path = meta._wrap_exe(relative_exe_path)
wrapper_path = os.path.join(snapdir, relative_wrapper_path)
expected = ('#!/bin/sh\n'
'PATH=$SNAP_APP_PATH/usr/bin:$SNAP_APP_PATH/bin\n'
'\n\n'
'exec "$SNAP_APP_PATH/test_relexepath" $*\n')
with open(wrapper_path) as wrapper_file:
wrapper_contents = wrapper_file.read()
self.assertEqual(expected, wrapper_contents)
def test_non_snap_shebangs_ignored(self):
"""Shebangs not pointing to the snap's install dir are ignored.
If the shebang points to a system executable, there's no need to
interfere.
"""
snapdir = common.get_snapdir()
os.mkdir(snapdir)
relative_exe_path = 'test_relexepath'
exe_contents = '#!/bin/bash\necho hello\n'
with open(os.path.join(snapdir, relative_exe_path), 'w') as exe:
exe.write(exe_contents)
relative_wrapper_path = meta._wrap_exe(relative_exe_path)
wrapper_path = os.path.join(snapdir, relative_wrapper_path)
expected = ('#!/bin/sh\n' '\n\n' 'exec "$SNAP/test_relexepath" $*\n')
with open(wrapper_path) as wrapper_file:
wrapper_contents = wrapper_file.read()
self.assertEqual(expected, wrapper_contents)
with open(os.path.join(snapdir, relative_exe_path), 'r') as exe:
self.assertEqual(exe_contents, exe.read())
