debian-koji-osbuild/plugins/cli/osbuild.py
Christian Kellner 78ed04dbd6 plugins: support for ostree specific options
OStree compose requests need special options, like the `ref` the
`parent` and the `url`. Add support for those options to all three
plugins:
  The command line plugin now takes `--ostree-{parent,ref,url}`
  and passes it to koji via the existing options dictionary.

  The JSON schemata in the hub plugin was adjusted to allow these
  new options.

  Finally the builder plugin will look for the new `ostree` dict
  inside the options, create an `OSTreeOptions` object from it,
  and attach it to each image request.

NB: since the ostree options are per image request and are thus
architecture dependent we support a "$arch" substition in the
`parent` and `ref` options that will be resolved by the plugin;
this allows to builds arch specific commits for with a single
compose request.

Add the respective unit tests.
2022-02-14 13:14:19 +01:00

138 lines
4.6 KiB
Python
Executable file

"""Koji osbuild integration - koji client plugin
This koji plugin provides a new 'osbuild-image' command for the koji
command line tool. It uses the 'osbuildImage' XMLRPC endpoint, that
is provided by the koji osbuild plugin for the koji hub.
"""
from pprint import pprint
import koji
import koji_cli.lib as kl
from koji.plugin import export_cli
def parse_args(argv):
usage = ("usage: %prog osbuild-image [options] <name> <version> "
"<distro> <target> <arch> [<arch> ...]")
parser = kl.OptionParser(usage=kl.get_usage_str(usage))
parser.add_option("--nowait", action="store_false", dest="wait",
help="Don't wait on image creation")
parser.add_option("--ostree-parent", type=str, dest="ostree_parent",
help="The OSTree commit parent for OSTree commit image types")
parser.add_option("--ostree-ref", type=str, dest="ostree_ref",
help="The OSTree commit ref for OSTree commit image types")
parser.add_option("--ostree-url", type=str, dest="ostree_url",
help="URL to the OSTree repo for OSTree commit image types")
parser.add_option("--release", help="Forcibly set the release field")
parser.add_option("--repo", action="append",
help=("Specify a repo that will override the repo used to install "
"RPMs in the image. May be used multiple times. The "
"build tag repo associated with the target is the default."))
parser.add_option("--image-type", metavar="TYPE",
help='Request an image-type [default: guest-image]',
type=str, action="append", default=[])
parser.add_option("--skip-tag", action="store_true",
help="Do not attempt to tag package")
parser.add_option("--wait", action="store_true",
help="Wait on the image creation, even if running in the background")
opts, args = parser.parse_args(argv)
if len(args) < 5:
parser.error("At least five arguments are required: a name, "
"a version, a distribution, a build target, "
"and 1 or more architectures.")
for i, arg in enumerate(("name", "version", "distro", "target")):
setattr(opts, arg, args[i])
setattr(opts, "arch", args[4:])
return opts
def check_target(session, name):
"""Check the target with name exists and has a destination tag"""
target = session.getBuildTarget(name)
if not target:
raise koji.GenericError("Unknown build target: %s" % name)
tag = session.getTag(target['dest_tag'])
if not tag:
raise koji.GenericError("Unknown destination tag: %s" %
target['dest_tag_name'])
@export_cli
def handle_osbuild_image(options, session, argv):
"[build] Build images via osbuild"
args = parse_args(argv)
name, version, arch, target = args.name, args.version, args.arch, args.target
distro, image_types = args.distro, args.image_type
if not image_types:
image_types = ["guest-image"]
opts = {}
if args.release:
opts["release"] = args.release
if args.repo:
opts["repo"] = args.repo
if args.skip_tag:
opts["skip_tag"] = True
# ostree command line parameters
ostree = {}
if args.ostree_parent:
ostree["parent"] = args.ostree_parent
if args.ostree_ref:
ostree["ref"] = args.ostree_ref
if args.ostree_url:
ostree["url"] = args.ostree_url
if ostree:
opts["ostree"] = ostree
# Do some early checks to be able to give quick feedback
check_target(session, target)
if not options.quiet:
print("name:", name)
print("version:", version)
print("distro:", distro)
print("arches:", ", ".join(arch))
print("target:", target)
print("image types ", str(image_types))
pprint(opts)
kl.activate_session(session, options)
task_id = session.osbuildImage(name, version, distro, image_types, target, arch, opts=opts)
if not options.quiet:
print("Created task: %s" % task_id)
print("Task info: %s/taskinfo?taskID=%s" % (options.weburl, task_id))
# pylint: disable=protected-access
if (args.wait is None and kl._running_in_bg()) or args.wait is False:
# either running in the background or must not wait by user's
# request. All done.
return None
session.logout()
res = kl.watch_tasks(session, [task_id], quiet=options.quiet)
if res == 0:
result = session.getTaskResult(task_id)
print(result)
return res