def editSideTag(sidetag,
debuginfo=None,
rpm_macros=None,
remove_rpm_macros=None):
"""Restricted ability to modify sidetags, parent tag must have:
sidetag_debuginfo_allowed: 1
sidetag_rpm_macros_allowed: 1
in extra, if modifying functions should work. For blocking/unblocking
further policy must be compatible with these operations.
:param sidetag: sidetag id or name
:type sidetag: int or str
:param debuginfo: set or disable debuginfo repo generation
:type debuginfo: bool
:param rpm_macros: add/update rpms macros in extra
:type rpm_macros: dict
:param remove_rpm_macros: remove rpm macros from extra
:type remove_rpm_macros: list of str
"""
context.session.assertLogin()
user = get_user(context.session.user_id, strict=True)
sidetag = get_tag(sidetag, strict=True)
# sanity/access
is_sidetag(sidetag, raise_error=True)
is_sidetag_owner(sidetag, user, raise_error=True)
parent_id = readInheritanceData(sidetag['id'])[0]['parent_id']
parent = get_tag(parent_id)
if debuginfo is not None and not parent['extra'].get(
'sidetag_debuginfo_allowed'):
raise koji.GenericError(
"Debuginfo setting is not allowed in parent tag.")
if (rpm_macros is not None or remove_rpm_macros is not None) \
and not parent['extra'].get('sidetag_rpm_macros_allowed'):
raise koji.GenericError(
"RPM macros change is not allowed in parent tag.")
kwargs = {'extra': {}}
if debuginfo is not None:
kwargs['extra']['with_debuginfo'] = bool(debuginfo)
if rpm_macros is not None:
for macro, value in rpm_macros.items():
kwargs['extra']['rpm.macro.%s' % macro] = value
if remove_rpm_macros is not None:
kwargs['remove_extra'] = [
'rpm.macro.%s' % m for m in remove_rpm_macros
]
_edit_tag(sidetag['id'], **kwargs)
def runroot(tagInfo, arch, command, channel=None, **opts):
""" Create a runroot task """
context.session.assertPerm('runroot')
taskopts = {
'priority': 15,
'arch': arch,
}
taskopts['channel'] = channel or 'runroot'
if arch == 'noarch':
#not all arches can generate a proper buildroot for all tags
tag = kojihub.get_tag(tagInfo)
if not tag['arches']:
raise koji.GenericError('no arches defined for tag %s' %
tag['name'])
#get all known arches for the system
fullarches = kojihub.get_all_arches()
tagarches = tag['arches'].split()
# If our tag can't do all arches, then we need to
# specify one of the arches it can do.
if set(fullarches) - set(tagarches):
chanarches = get_channel_arches(taskopts['channel'])
choices = [x for x in tagarches if x in chanarches]
if not choices:
raise koji.GenericError('no common arches for tag/channel: %s/%s' \
% (tagInfo, taskopts['channel']))
taskopts['arch'] = koji.canonArch(random.choice(choices))
args = koji.encode_args(tagInfo, arch, command, **opts)
return kojihub.make_task('runroot', args, **taskopts)
def handle_sidetag_untag(cbtype, *args, **kws):
"""Remove a side tag when its last build is untagged
Note, that this is triggered only in case, that some build exists. For
never used tags, some other policy must be applied. Same holds for users
which don't untag their builds.
"""
if "tag" not in kws:
# shouldn't happen, but...
return
tag = get_tag(kws["tag"]["id"], strict=False)
if not tag:
# also shouldn't happen, but just in case
return
if not is_sidetag(tag):
return
# is the tag now empty?
query = QueryProcessor(
tables=["tag_listing"],
clauses=["tag_id = %(tag_id)s", "active IS TRUE"],
values={"tag_id": tag["id"]},
opts={"countOnly": True},
)
if query.execute():
return
# looks like we've just untagged the last build from a side tag
try:
# XXX: are we double updating tag_listing?
_remove_sidetag(tag)
except koji.GenericError:
pass
def runroot(tagInfo, arch, command, channel=None, **opts):
""" Create a runroot task """
context.session.assertPerm('runroot')
taskopts = {
'priority': 15,
'arch': arch,
}
taskopts['channel'] = channel or 'runroot'
if arch == 'noarch':
#not all arches can generate a proper buildroot for all tags
tag = kojihub.get_tag(tagInfo)
if not tag['arches']:
raise koji.GenericError, 'no arches defined for tag %s' % tag['name']
#get all known arches for the system
fullarches = kojihub.get_all_arches()
tagarches = tag['arches'].split()
# If our tag can't do all arches, then we need to
# specify one of the arches it can do.
if set(fullarches) - set(tagarches):
chanarches = get_channel_arches(taskopts['channel'])
choices = [x for x in tagarches if x in chanarches]
if not choices:
raise koji.GenericError, 'no common arches for tag/channel: %s/%s' \
% (tagInfo, taskopts['channel'])
taskopts['arch'] = koji.canonArch(random.choice(choices))
args = koji.encode_args(tagInfo, arch, command,**opts)
return kojihub.make_task('runroot', args, **taskopts)
def listSideTags(basetag=None, user=None, queryOpts=None):
"""List all sidetags with additional filters
:param basetag: filter by basteag id or name
:type basetag: int or str
:param user: filter by userid or username
:type user: int or str
:param queryOpts: additional query options
{countOnly, order, offset, limit}
:type queryOpts: dict
:returns: list of dicts: id, name, user_id, user_name
"""
# te1.sidetag
# te2.user_id
# te3.basetag
if user is not None:
user_id = str(get_user(user, strict=True)["id"])
else:
user_id = None
if basetag is not None:
basetag_id = get_tag(basetag, strict=True)["id"]
else:
basetag_id = None
joins = [
"LEFT JOIN tag_extra AS te1 ON tag.id = te1.tag_id",
"LEFT JOIN tag_extra AS te2 ON tag.id = te2.tag_id",
"LEFT JOIN users ON CAST(te2.value AS INTEGER) = users.id",
]
clauses = [
"te1.active IS TRUE",
"te1.key = 'sidetag'",
"te1.value = 'true'",
"te2.active IS TRUE",
"te2.key = 'sidetag_user_id'"
]
if user_id:
clauses.append("te2.value = %(user_id)s")
if basetag_id:
joins.append("LEFT JOIN tag_inheritance ON tag.id = tag_inheritance.tag_id")
clauses.extend(
[
"tag_inheritance.active IS TRUE",
"tag_inheritance.parent_id = %(basetag_id)s",
]
)
query = QueryProcessor(
tables=["tag"],
clauses=clauses,
columns=["tag.id", "tag.name", "te2.value", "users.name"],
aliases=["id", "name", "user_id", "user_name"],
joins=joins,
values={"basetag_id": basetag_id, "user_id": user_id},
opts=queryOpts,
)
return query.execute()
def createSideTag(basetag, debuginfo=False):
"""Create a side tag.
:param basetag: name or ID of base tag
:type basetag: str or int
:param debuginfo: should buildroot repos contain debuginfo?
:type debuginfo: bool
"""
# Any logged-in user is able to request creation of side tags,
# as long the request meets the policy.
context.session.assertLogin()
user = get_user(context.session.user_id, strict=True)
basetag = get_tag(basetag, strict=True)
query = QueryProcessor(
tables=["tag_extra"],
clauses=[
"key='sidetag_user_id'", "value=%(user_id)s", "active IS TRUE"
],
columns=["COUNT(*)"],
aliases=["user_tags"],
values={"user_id": str(user["id"])},
)
user_tags = query.executeOne()
if user_tags is None:
# should not ever happen
raise koji.GenericError("Unknown db error")
# Policy is a very flexible mechanism, that can restrict for which
# tags sidetags can be created, or which users can create sidetags etc.
assert_policy("sidetag", {
"tag": basetag["id"],
"number_of_tags": user_tags["user_tags"]
})
# ugly, it will waste one number in tag_id_seq, but result will match with
# id assigned by _create_tag
tag_id = nextval("tag_id_seq") + 1
sidetag_name = "%s-side-%s" % (basetag["name"], tag_id)
extra = {
"sidetag": True,
"sidetag_user": user["name"],
"sidetag_user_id": user["id"],
}
if debuginfo:
extra['with_debuginfo'] = True
sidetag_id = _create_tag(
sidetag_name,
parent=basetag["id"],
arches=basetag["arches"],
extra=extra,
)
_create_build_target(sidetag_name, sidetag_id, sidetag_id)
return {"name": sidetag_name, "id": sidetag_id}
def removeSideTag(sidetag):
"""Remove a side tag
:param sidetag: id or name of sidetag
:type sidetag: int or str
"""
context.session.assertLogin()
user = get_user(context.session.user_id, strict=True)
sidetag = get_tag(sidetag, strict=True)
# sanity/access
is_sidetag(sidetag, raise_error=True)
is_sidetag_owner(sidetag, user, raise_error=True)
_remove_sidetag(sidetag)
def rockymsg(cbtype, *args, **kws):
logger = logging.getLogger(PLUGIN_NAME)
logger.debug('Called the %s callback, args: %s; kws: %s', cbtype,
str(args), str(kws))
tag = kws['tag']['name']
build_task_id = kws['build']['task_id']
build_target = _get_build_target(build_task_id)
logger.debug('Build target: %s', build_target)
arches = DEFAULT_ARCHES
if build_target:
build_tag = kojihub.get_tag(build_target['build_tag_name'])
arches = build_tag['arches']
payload = {'action': cbtype, 'tag': tag, 'arches': arches}
job = _dispatch_on_topic(payload)
if job:
logger.info('Sending payload: %s to mqtt - ret code: %s' %
(payload, job))
def run(self, data):
user = policy_get_user(data)
tag = get_tag(data['tag'])
return is_sidetag_owner(tag, user)
def run(self, data):
tag = get_tag(data['tag'])
return is_sidetag(tag)
def test_get_tag_non_exist_tag(self):
taginfo = 'test-tag'
self.query_executeOne.return_value = None
with self.assertRaises(koji.GenericError) as ex:
kojihub.get_tag(taginfo, strict=True)
self.assertEqual("No such tagInfo: '%s'" % taginfo, str(ex.exception))
def test_get_tag_invalid_taginfo(self):
taginfo = {'test-tag': 'value'}
with self.assertRaises(koji.GenericError) as ex:
kojihub.get_tag(taginfo, strict=True)
self.assertEqual("Invalid type for tagInfo: %s" % type(taginfo),
str(ex.exception))
def createSideTag(basetag, debuginfo=False, suffix=None):
"""Create a side tag.
:param basetag: name or ID of base tag
:type basetag: str or int
:param debuginfo: should buildroot repos contain debuginfo?
:type debuginfo: bool
:param suffix: suffix which will be appended to generated sidetag name
List of allowed suffixes needs to be defined in config.
:type suffix: str
:returns dict: sidetag name + id
"""
if suffix and suffix not in ALLOWED_SUFFIXES:
raise koji.GenericError("%s suffix is not allowed for sidetag" % suffix)
# Any logged-in user is able to request creation of side tags,
# as long the request meets the policy.
context.session.assertLogin()
user = get_user(context.session.user_id, strict=True)
basetag = get_tag(basetag, strict=True)
query = QueryProcessor(
tables=["tag_extra"],
clauses=["key='sidetag_user_id'", "value=%(user_id)s", "active IS TRUE"],
columns=["COUNT(*)"],
aliases=["user_tags"],
values={"user_id": str(user["id"])},
)
user_tags = query.executeOne()
if user_tags is None:
# should not ever happen
raise koji.GenericError("Unknown db error")
# Policy is a very flexible mechanism, that can restrict for which
# tags sidetags can be created, or which users can create sidetags etc.
assert_policy(
"sidetag", {"tag": basetag["id"], "number_of_tags": user_tags["user_tags"]}
)
# ugly, it will waste one number in tag_id_seq, but result will match with
# id assigned by _create_tag
tag_id = nextval("tag_id_seq") + 1
sidetag_name = NAME_TEMPLATE.format(basetag=basetag["name"], tag_id=tag_id)
if suffix:
sidetag_name += '-%s' % suffix
extra = {
"sidetag": True,
"sidetag_user": user["name"],
"sidetag_user_id": user["id"],
}
if debuginfo:
extra['with_debuginfo'] = True
sidetag_id = _create_tag(
sidetag_name,
parent=basetag["id"],
arches=basetag["arches"],
extra=extra,
)
_create_build_target(sidetag_name, sidetag_id, sidetag_id)
return {"name": sidetag_name, "id": sidetag_id}
