Skip to content

Fix passing kiwi options #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schaefi merged 1 commit into from
Sep 9, 2026
Merged

Fix passing kiwi options #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 2 additions & 19 deletions kiwi_stackbuild_plugin/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,9 @@
# along with kiwi-stackbuild. If not, see <http://www.gnu.org/licenses/>
#
import typer
import itertools
from pathlib import Path
from typing import (
Annotated, Optional, List, Union, no_type_check
Annotated, Optional, List, no_type_check
)

typers = {
Expand Down Expand Up @@ -53,23 +52,7 @@ def kiwi(
option.
"""
Cli = ctx.obj
args = ctx.args
for option in list(set(args)):
if type(option) is not str or not option.startswith('-'):
continue
k: List[Union[str, List]] = [option]
v = []
indexes = [n for n, x in enumerate(args) if x == option]
if len(indexes) > 1:
for index in indexes:
v.append(args[index + 1])
for index in sorted(indexes, reverse=True):
del args[index + 1]
del args[index]
k.append(v)
args += k
Cli.subcommand_args['stackbuild']['system_build_or_create'] = \
dict(itertools.zip_longest(*[iter(args)] * 2))
Cli.subcommand_args['stackbuild']['system_build_or_create'] = ctx.args
Cli.global_args['command'] = 'stackbuild'
Cli.global_args['system'] = True
Cli.cli_ok = True
Expand Down
81 changes: 49 additions & 32 deletions kiwi_stackbuild_plugin/tasks/system_stackbuild.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,7 @@
import logging
from unittest.mock import patch
from docopt import docopt
from typing import (
Dict, List
)
from typing import List

import kiwi.tasks.system_build
import kiwi.tasks.system_create
Expand Down Expand Up @@ -182,7 +180,7 @@ def process(self) -> None:
def _validate_kiwi_create_command(
self, kiwi_create_command: List[str]
) -> List[str]:
if self.command_args.get('<kiwi_create_command_args>'):
if self.command_args.get('<kiwi_create_command_args>'): # pragma: nocover
# construct create command from docopt command line
kiwi_create_command += self.command_args.get(
'<kiwi_create_command_args>'
Expand All @@ -200,19 +198,44 @@ def _validate_kiwi_create_command(
kiwi.tasks.system_create.__doc__,
argv=kiwi_create_command
)
kiwi_command = [
'system', 'create'
]
for option, value in validated_create_command.items():
if option.startswith('-') and value:
if isinstance(value, bool):
kiwi_command.append(option)
elif isinstance(value, str):
kiwi_command.extend([option, value])
elif isinstance(value, list):
for element in value:
kiwi_command.extend([option, element])
else:
validated_create_command = \
self.command_args.get('system_build_or_create')
kiwi_command = [
'system', 'create'
] + self.command_args.get('system_build_or_create')

# rebuild kiwi create command from validated docopt parser result
return self._rebuild_kiwi_command(
validated_create_command, 'create'
# rebuild kiwi create command
final_kiwi_command = ['kiwi-ng']
if self.global_args.get('--type'):
final_kiwi_command.append('--type')
final_kiwi_command.append(self.global_args.get('--type'))
if self.global_args.get('--profile'):
for profile in sorted(set(self.global_args.get('--profile'))):
final_kiwi_command.append('--profile')
final_kiwi_command.append(profile)
final_kiwi_command += kiwi_command
log.debug(
'Building with:{0} {1}'.format(
os.linesep, final_kiwi_command
)
)
return final_kiwi_command

def _validate_kiwi_build_command(
self, kiwi_build_command: List[str]
) -> List[str]:
if self.command_args.get('<kiwi_build_command_args>'):
if self.command_args.get('<kiwi_build_command_args>'): # pragma: nocover
# construct build command from given command line
kiwi_build_command += self.command_args.get(
'<kiwi_build_command_args>'
Expand All @@ -230,30 +253,24 @@ def _validate_kiwi_build_command(
kiwi.tasks.system_build.__doc__,
argv=kiwi_build_command
)
kiwi_command = [
'system', 'build'
]
for option, value in validated_build_command.items():
if option.startswith('-') and value:
if isinstance(value, bool):
kiwi_command.append(option)
elif isinstance(value, str):
kiwi_command.extend([option, value])
elif isinstance(value, list):
for element in value:
kiwi_command.extend([option, element])
else:
validated_build_command = \
self.command_args.get('system_build_or_create')

# rebuild kiwi build command from validated parser result
return self._rebuild_kiwi_command(
validated_build_command, 'build'
)
kiwi_command = [
'system', 'build'
] + self.command_args.get('system_build_or_create')

def _rebuild_kiwi_command(
self, validated_options_dict: Dict, command: str
) -> List[str]:
kiwi_command = [
'system', command
]
for option, value in validated_options_dict.items():
if option.startswith('-') and value:
if isinstance(value, bool):
kiwi_command.append(option)
elif isinstance(value, str):
kiwi_command.extend([option, value])
elif isinstance(value, list):
for element in value:
kiwi_command.extend([option, element])
# rebuild kiwi build command
final_kiwi_command = ['kiwi-ng']
if self.global_args.get('--type'):
final_kiwi_command.append('--type')
Expand Down
136 changes: 12 additions & 124 deletions test/unit/tasks/system_stackbuild_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ def setup(self):
sys.argv = [
sys.argv[0], '--profile', 'a', '--profile', 'b',
'--type', 'iso', 'system', 'stackbuild',
'--stash', 'name', '--target-dir', 'some-target-dir', '--',
'--stash', 'name', '--target-dir', 'some-target-dir', 'kiwi',
'--signing-key', 'some-key'
]
self.task = SystemStackbuildTask()
Expand All @@ -32,11 +32,8 @@ def _init_command_args(self):
self.task.command_args['--from-registry'] = None
self.task.command_args['--target-dir'] = None
self.task.command_args['--description'] = None
self.task.command_args['<kiwi_build_command_args>'] = [
'--', '--signing-key', 'some-key'
]
self.task.command_args['<kiwi_create_command_args>'] = [
'--', '--signing-key', 'some-key'
self.task.command_args['system_build_or_create'] = [
'--signing-key', 'some-key'
]

@patch('kiwi_stackbuild_plugin.tasks.system_stackbuild.Help')
Expand Down Expand Up @@ -99,65 +96,11 @@ def test_process_rebuild_typer_commandline(
mock_Path_create, mock_Privileges
):
self._init_command_args()
self.task.command_args['<kiwi_build_command_args>'] = None
self.task.command_args['<kiwi_create_command_args>'] = None
self.task.command_args['system_build_or_create'] = {
'--root': '/some/target-dir/build/image-root',
'--target-dir': '/some/target-dir',
'--signing-key': 'some-key'
}
self.task.command_args['stackbuild'] = True
self.task.command_args['--stash'] = ['name']
self.task.command_args['--target-dir'] = '/some/target-dir'
self.task.command_args['--from-registry'] = 'registry.uri'
mock_os_path_exists.return_value = False
mock_Command_run.return_value.output = '/podman/mount/path'
kiwi_task = Mock()
mock_SystemCreateTask.return_value = kiwi_task
self.task.process()
assert mock_Command_run.call_args_list == [
call(['podman', 'pull', 'registry.uri/name']),
call(['podman', 'image', 'mount', 'name']),
call(
[
'rsync', '--archive', '--hard-links', '--xattrs',
'--acls', '--one-file-system', '--inplace',
'/podman/mount/path/',
'/some/target-dir/build/image-root'
]
),
call(
['podman', 'image', 'umount', '--force', 'name'],
raise_on_error=False
)
self.task.command_args['system_build_or_create'] = [
'--root', '/some/target-dir/build/image-root',
'--target-dir', '/some/target-dir',
'--signing-key', 'some-key'
]
mock_SystemCreateTask.assert_called_once_with(
should_perform_task_setup=False
)
kiwi_task.process.assert_called_once_with()
mock_patch_object.assert_called_once_with(
sys, 'argv', [
'kiwi-ng', '--type', 'iso',
'--profile', 'a', '--profile', 'b',
'system', 'create',
'--root', '/some/target-dir/build/image-root',
'--target-dir', '/some/target-dir',
'--signing-key', 'some-key'
]
)

@patch('kiwi_stackbuild_plugin.tasks.system_stackbuild.Privileges')
@patch('kiwi_stackbuild_plugin.tasks.system_stackbuild.Path.create')
@patch('kiwi_stackbuild_plugin.tasks.system_stackbuild.Command.run')
@patch('kiwi_stackbuild_plugin.tasks.system_stackbuild.SystemCreateTask')
@patch('os.path.exists')
@patch('kiwi_stackbuild_plugin.tasks.system_stackbuild.patch.object')
def test_process_rebuild(
self, mock_patch_object, mock_os_path_exists,
mock_SystemCreateTask, mock_Command_run,
mock_Path_create, mock_Privileges
):
self._init_command_args()
self.task.command_args['stackbuild'] = True
self.task.command_args['--stash'] = ['name']
self.task.command_args['--target-dir'] = '/some/target-dir'
Expand Down Expand Up @@ -210,67 +153,12 @@ def test_process_new_build_typer_commandline(
mock_Path_create, mock_Privileges
):
self._init_command_args()
self.task.command_args['<kiwi_build_command_args>'] = None
self.task.command_args['<kiwi_create_command_args>'] = None
self.task.command_args['system_build_or_create'] = {
'--description': '/path/to/kiwi/description',
'--target-dir': '/some/target-dir',
'--allow-existing-root': True,
'--signing-key': 'some-key'
}
self.task.command_args['stackbuild'] = True
self.task.command_args['--stash'] = ['name']
self.task.command_args['--target-dir'] = '/some/target-dir'
self.task.command_args['--description'] = '/path/to/kiwi/description'
self.task.command_args['--from-registry'] = 'registry.uri'
mock_os_path_exists.return_value = False
mock_Command_run.return_value.output = '/podman/mount/path'
kiwi_task = Mock()
mock_SystemBuildTask.return_value = kiwi_task
self.task.process()
assert mock_Command_run.call_args_list == [
call(['podman', 'pull', 'registry.uri/name']),
call(['podman', 'image', 'mount', 'name']),
call(
[
'rsync', '--archive', '--hard-links', '--xattrs',
'--acls', '--one-file-system', '--inplace',
'/podman/mount/path/',
'/some/target-dir/build/image-root'
]
),
call(
['podman', 'image', 'umount', '--force', 'name'],
raise_on_error=False
)
self.task.command_args['system_build_or_create'] = [
'--description', '/path/to/kiwi/description',
'--target-dir', '/some/target-dir',
'--allow-existing-root',
'--signing-key', 'some-key'
]
mock_SystemBuildTask.assert_called_once_with(
should_perform_task_setup=False
)
kiwi_task.process.assert_called_once_with()
mock_patch_object.assert_called_once_with(
sys, 'argv', [
'kiwi-ng', '--type', 'iso',
'--profile', 'a', '--profile', 'b',
'system', 'build',
'--description', '/path/to/kiwi/description',
'--target-dir', '/some/target-dir',
'--allow-existing-root', '--signing-key', 'some-key'
]
)

@patch('kiwi_stackbuild_plugin.tasks.system_stackbuild.Privileges')
@patch('kiwi_stackbuild_plugin.tasks.system_stackbuild.Path.create')
@patch('kiwi_stackbuild_plugin.tasks.system_stackbuild.Command.run')
@patch('kiwi_stackbuild_plugin.tasks.system_stackbuild.SystemBuildTask')
@patch('os.path.exists')
@patch('kiwi_stackbuild_plugin.tasks.system_stackbuild.patch.object')
def test_process_new_build(
self, mock_patch_object, mock_os_path_exists,
mock_SystemBuildTask, mock_Command_run,
mock_Path_create, mock_Privileges
):
self._init_command_args()
self.task.command_args['stackbuild'] = True
self.task.command_args['--stash'] = ['name']
self.task.command_args['--target-dir'] = '/some/target-dir'
Expand Down
Loading