fe123fb267
Allow to put a disk.sh script as part of the image description which is called for the disk image types `vmx` and `oem` only and runs after the synchronisation of the root tree into the disk image loop file. At call time of the script the device name of the currently mapped root device is passed as a parameter. The chroot environment for the call is the mounted disk itself which makes this different from the config.sh/images.sh caller environment. This Fixes #1464
123 lines
3.8 KiB
Python
123 lines
3.8 KiB
Python
# Copyright (c) 2015 SUSE Linux GmbH. All rights reserved.
|
|
#
|
|
# This file is part of kiwi.
|
|
#
|
|
# kiwi is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# kiwi is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with kiwi. If not, see <http://www.gnu.org/licenses/>
|
|
#
|
|
from tempfile import NamedTemporaryFile
|
|
from typing import Optional, Any
|
|
from collections.abc import Iterable
|
|
|
|
# project
|
|
from kiwi.command import Command
|
|
from kiwi.defaults import Defaults
|
|
|
|
from kiwi.exceptions import KiwiShellVariableValueError
|
|
|
|
|
|
class Shell:
|
|
"""
|
|
**Special character handling for shell evaluated code**
|
|
"""
|
|
@staticmethod
|
|
def quote(message):
|
|
"""
|
|
Quote characters which have a special meaning for bash
|
|
but should be used as normal characters. actually I had
|
|
planned to use pipes.quote but it does not quote as I
|
|
had expected it. e.g 'name_wit_a_$' does not quote the $
|
|
so we do it on our own for the scope of kiwi
|
|
|
|
:param str message: message text
|
|
|
|
:return: quoted text
|
|
|
|
:rtype: str
|
|
"""
|
|
# \\ quoting must be first in the list
|
|
quote_characters = ['\\', '$', '"', '`', '!']
|
|
for quote in quote_characters:
|
|
message = message.replace(quote, '\\' + quote)
|
|
return message
|
|
|
|
@staticmethod
|
|
def quote_key_value_file(filename):
|
|
"""
|
|
Quote given input file which has to be of the form
|
|
key=value to be able to become sourced by the shell
|
|
|
|
:param str filename: file path name
|
|
|
|
:return: quoted text
|
|
|
|
:rtype: str
|
|
"""
|
|
temp_copy = NamedTemporaryFile()
|
|
Command.run(['cp', filename, temp_copy.name])
|
|
Shell.run_common_function('baseQuoteFile', [temp_copy.name])
|
|
with open(temp_copy.name) as quoted:
|
|
return quoted.read().splitlines()
|
|
|
|
@staticmethod
|
|
def run_common_function(name, parameters):
|
|
"""
|
|
Run a function implemented in config/functions.sh
|
|
|
|
:param str name: function name
|
|
:param list parameters: function arguments
|
|
"""
|
|
Command.run(
|
|
[
|
|
'bash', '-c',
|
|
'source ' + ''.join(
|
|
[
|
|
Defaults.get_common_functions_file(),
|
|
'; ', name, ' ', ' '.join(parameters)
|
|
]
|
|
)
|
|
]
|
|
)
|
|
|
|
@staticmethod
|
|
def format_to_variable_value(value: Optional[Any]) -> str:
|
|
"""
|
|
Format given variable value to return a string value
|
|
representation that can be sourced by shell scripts.
|
|
If the provided value is not representable as a string
|
|
(list, dict, tuple etc) an exception is raised
|
|
|
|
:param any value: a python variable
|
|
|
|
:raises KiwiShellVariableValueError: if value is an iterable
|
|
|
|
:return: string value representation
|
|
|
|
:rtype: str
|
|
"""
|
|
if value is None:
|
|
return ''
|
|
if isinstance(value, bool):
|
|
return format(value).lower()
|
|
elif isinstance(value, str):
|
|
return value
|
|
elif isinstance(value, bytes):
|
|
return format(value.decode())
|
|
elif isinstance(value, Iterable):
|
|
# we will have a hard time to turn an iterable (list, dict ...)
|
|
# into a useful string
|
|
raise KiwiShellVariableValueError(
|
|
'Value cannot be {0}'.format(type(value))
|
|
)
|
|
return format(value)
|