move the useful functions out of the group plugin into a class on its own
This commit is contained in:
Stephan Kulow
parent
7de20e2097
commit
248a013254
430
osc-group.py
430
osc-group.py
@ -1,430 +0,0 @@
|
||||
#!/usr/bin/env python
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# (C) 2013 coolo@suse.de, openSUSE.org
|
||||
# (C) 2013 tchvatal@suse.cz, openSUSE.org
|
||||
# Distribute under GPLv2 or GPLv3
|
||||
|
||||
import osc
|
||||
import osc.core
|
||||
|
||||
from osc import cmdln
|
||||
from osc import conf
|
||||
|
||||
OSC_GROUP_VERSION='0.0.4'
|
||||
|
||||
def _print_version(self):
|
||||
""" Print version information about this extension. """
|
||||
|
||||
print('{0}'.format(self.OSC_GROUP_VERSION))
|
||||
quit(0)
|
||||
|
||||
def _extract(self, attr, type_, from_, root):
|
||||
return [type_(x.attrib[attr]) for x in root.findall(from_)]
|
||||
|
||||
def _group_find_request_id(self, request, opts):
|
||||
"""
|
||||
Look up the request by ID to verify if it is correct
|
||||
:param request: ID of the added request
|
||||
:param opts: obs options
|
||||
"""
|
||||
|
||||
url = makeurl(opts.apiurl, ['request'], 'states=new,review,declined&project=openSUSE:Factory&view=collection')
|
||||
f = http_GET(url)
|
||||
root = ET.parse(f).getroot()
|
||||
|
||||
res = self._extract('id', int, 'request', root)
|
||||
|
||||
# we have various stuff passed, and it might or might not be int we need for the comparison
|
||||
try:
|
||||
i = int(request)
|
||||
except ValueError:
|
||||
return None
|
||||
|
||||
if i in res:
|
||||
return request
|
||||
else:
|
||||
# raise oscerr.WrongArgs('There is no request for SR#{0}'.format(request))
|
||||
return None
|
||||
|
||||
def _group_find_request_package(self, package, opts):
|
||||
"""
|
||||
Look up the package by its name and return the SR#
|
||||
:param package: name of the package
|
||||
:param opts: obs options
|
||||
"""
|
||||
|
||||
url = makeurl(opts.apiurl, ['request'], 'states=new,review&project=openSUSE:Factory&view=collection&package={0}'.format(package))
|
||||
f = http_GET(url)
|
||||
root = ET.parse(f).getroot()
|
||||
|
||||
res = self._extract('id', int, 'request', root)
|
||||
|
||||
# Remove this check as obs is case insensitive and in some cases we want to add even multiple pkgs
|
||||
# if len(res) > 1:
|
||||
# raise oscerr.WrongArgs('There are multiple requests for package "{0}": {1}'.format(package, ', '.join(map(str, res))))
|
||||
|
||||
if len(res) == 0 or res[0] == 0:
|
||||
#raise oscerr.WrongArgs('There is no request for package "{0}"'.format(package))
|
||||
return None
|
||||
|
||||
return res
|
||||
|
||||
def _group_find_request_project(self, source_project, opts):
|
||||
"""
|
||||
Look up the source project by its name and return the SR#(s)
|
||||
:param source_project: name of the source project
|
||||
:param opts: obs options
|
||||
"""
|
||||
|
||||
url = makeurl(opts.apiurl, ['request'], 'states=new,review&project=openSUSE:Factory&view=collection')
|
||||
f = http_GET(url)
|
||||
root = ET.parse(f).getroot()
|
||||
|
||||
res = []
|
||||
for rq in root.findall('request'):
|
||||
for a in rq.findall('action'):
|
||||
s = a.find('source')
|
||||
if s is not None and s.get('project') == source_project:
|
||||
res.append(int(rq.attrib['id']))
|
||||
|
||||
if len(res) == 0:
|
||||
#raise oscerr.WrongArgs('There are no requests for base project "{0}"'.format(source_project))
|
||||
return None
|
||||
|
||||
return res
|
||||
|
||||
def _group_find_request_group(self, request, opts):
|
||||
"""
|
||||
Look up if the SR# is already in some group and if it is return the ID of GR#
|
||||
:param request: name of the source project
|
||||
:param opts: obs options
|
||||
"""
|
||||
|
||||
url = makeurl(opts.apiurl, ['search', 'request', 'id?match=action/grouped/@id={0}'.format(request)] )
|
||||
f = http_GET(url)
|
||||
root = ET.parse(f).getroot()
|
||||
|
||||
res = self._extract('id', int, 'request', root)
|
||||
|
||||
if len(res) > 1:
|
||||
raise oscerr.WrongArgs('There are multiple group requests for package "{0}". This should not happen.'.format(request))
|
||||
|
||||
if len(res) == 0 or res[0] == 0:
|
||||
#raise oscerr.WrongArgs('There is no grouping request for package "{0}"'.format(package))
|
||||
return None
|
||||
|
||||
return res[0]
|
||||
|
||||
def _group_find_sr(self, pkgs, opts):
|
||||
"""
|
||||
Search for all various mutations and return list of SR#s
|
||||
:param pkgs: mesh of argumets to search for
|
||||
:param opts: obs options
|
||||
"""
|
||||
|
||||
print("Searching for SR#s based on the arguments...")
|
||||
srids = []
|
||||
for p in pkgs:
|
||||
request = self._group_find_request_package(p, opts)
|
||||
if not request:
|
||||
request = self._group_find_request_id(p, opts)
|
||||
if not request:
|
||||
request = self._group_find_request_project(p, opts)
|
||||
if not request:
|
||||
raise oscerr.WrongArgs('No SR# found for: {0}'.format(p))
|
||||
else:
|
||||
srids.append(request)
|
||||
|
||||
# Flattens the multi level list we actually have here
|
||||
def iterFlatten(root):
|
||||
if isinstance(root, (list, tuple)):
|
||||
for element in root:
|
||||
for e in iterFlatten(element):
|
||||
yield e
|
||||
else:
|
||||
yield root
|
||||
|
||||
# this is needed in order to ensure we have one level list not nested one
|
||||
return list(iterFlatten(srids))
|
||||
|
||||
def _group_verify_grouping(self, srids, opts, require_grouping = False):
|
||||
"""
|
||||
Verifies if the SRs are part of some GR and if not return list of those remaining.
|
||||
:param srids: list of request IDs
|
||||
:param opts: obs options
|
||||
:param require_grouping: if passed return list of GR#s for the SR#s and fail if they are not members of any
|
||||
"""
|
||||
|
||||
print("Checking wether the requests are already in grouping project...")
|
||||
grids = []
|
||||
for sr in srids:
|
||||
group = self._group_find_request_group(sr, opts)
|
||||
if group:
|
||||
if require_grouping:
|
||||
grids.append(group)
|
||||
else:
|
||||
print "Request #{0} is already in Group {1}".format(sr,group)
|
||||
# # only remove the ID from grouping, we will error out only if we return empty set
|
||||
# else:
|
||||
# #raise oscerr.WrongArgs('SR#{0} is already in GR#{1}'.format(sr, group))
|
||||
else:
|
||||
if require_grouping:
|
||||
# Can't assert as in the automagic group finding we need to pass here
|
||||
#raise oscerr.WrongArgs('SR#{0} is not member of any group request'.format(sr))
|
||||
grids.append(0)
|
||||
else:
|
||||
# package is not in group so we append it for return
|
||||
grids.append(sr)
|
||||
|
||||
if not require_grouping and len(grids) < 1:
|
||||
# we can have just one srid
|
||||
if isinstance(srids, int):
|
||||
srids = str(srids)
|
||||
else:
|
||||
srids = ', '.join(map(str, srids))
|
||||
raise oscerr.WrongArgs('All added request already are in groups: {0}'.format(srids))
|
||||
|
||||
return grids
|
||||
|
||||
def _group_verify_type(self, grid, opts):
|
||||
"""
|
||||
Verify the GR# to ensure it is grouping request to start with
|
||||
:param grid: ID of grouping request we want to verify
|
||||
:param opts: obs options
|
||||
"""
|
||||
|
||||
print("Checking if GR# is proper type...")
|
||||
url = makeurl(opts.apiurl, ['search', 'request', 'id?match=(action/@type=\'group\'+and+(state/@name=\'new\'+or+state/@name=\'review\'))'])
|
||||
f = http_GET(url)
|
||||
root = ET.parse(f).getroot()
|
||||
|
||||
res = self._extract('id', int, 'request', root)
|
||||
|
||||
# we have various stuff passed, and it might or might not be int we need for the comparison
|
||||
try:
|
||||
i = int(grid)
|
||||
except ValueError:
|
||||
#raise oscerr.WrongArgs('GR#{0} is not proper open grouping request'.format(grid))
|
||||
return None
|
||||
|
||||
if not i in res:
|
||||
#raise oscerr.WrongArgs('GR#{0} is not proper open grouping request'.format(grid))
|
||||
return None
|
||||
|
||||
return i
|
||||
|
||||
def _group_create(self, name, pkgs, opts):
|
||||
"""
|
||||
Create grouping request from selected pkgs/project/ids
|
||||
:param name: name of the group
|
||||
:param pkgs: list of packages to group
|
||||
:param opts: obs options
|
||||
"""
|
||||
|
||||
srids = self._group_find_sr(pkgs, opts)
|
||||
srids = self._group_verify_grouping(srids, opts)
|
||||
|
||||
# compose the xml
|
||||
xml='<request><action type="group">'
|
||||
for r in srids:
|
||||
xml += "<grouped id='" + str(r) + "'/>"
|
||||
xml += '</action><description>' + str(name) + '</description></request>'
|
||||
|
||||
# sent the request to server
|
||||
query = {'cmd': 'create'}
|
||||
u = makeurl(opts.apiurl, ['request'], query=query)
|
||||
f = http_POST(u, data=xml)
|
||||
root = ET.parse(f).getroot().attrib['id']
|
||||
|
||||
print('Created GR#{0} with following requests: {1}'.format(str(root), ', '.join(map(str, srids))))
|
||||
|
||||
def _group_add(self, grid, pkgs, opts):
|
||||
"""
|
||||
Append selected packages to grouping request
|
||||
:param grid: grouping request id
|
||||
:param pkgs: list of packages to append
|
||||
:param opts: obs options
|
||||
"""
|
||||
|
||||
# check if first argument is actual grouping ID and if not try to find
|
||||
# the group id in other requests
|
||||
returned_group = self._group_verify_type(grid, opts)
|
||||
if returned_group:
|
||||
srids = self._group_find_sr(pkgs, opts)
|
||||
srids = self._group_verify_grouping(srids, opts)
|
||||
else:
|
||||
# here we add the grid to pkgs and search among all to get at least one
|
||||
# usefull group request id
|
||||
pkgs += (grid,)
|
||||
srids = self._group_find_sr(pkgs, opts)
|
||||
|
||||
pkg_grids = self._group_verify_grouping(srids, opts, True)
|
||||
pkg_grids = list(set(pkg_grids))
|
||||
# if there is 1 group it means we found only the fallback 0
|
||||
if len(pkg_grids) == 1:
|
||||
raise oscerr.WrongArgs('There is no grouping request ID among all submitted packages:')
|
||||
# if the groups are more than 2 we have multiple grouping IDs which is also not good
|
||||
if len(pkg_grids) > 2:
|
||||
raise oscerr.WrongArgs('There are multiple grouping request IDs among added packages: {0}'.format(', '.join(pkg_grids)))
|
||||
grid = pkg_grids[1]
|
||||
|
||||
# now remove the package that provided the GR# from the pkgs addition list
|
||||
for sr in srids:
|
||||
group = self._group_find_request_group(sr, opts)
|
||||
if group:
|
||||
srids.remove(sr)
|
||||
|
||||
for r in srids:
|
||||
query = {'cmd': 'addrequest'}
|
||||
query['newid'] = str(r)
|
||||
url = makeurl(opts.apiurl, ['request', str(grid)], query=query)
|
||||
f = http_POST(url)
|
||||
root = ET.parse(f).getroot()
|
||||
print('Added SR#{0} to group request GR#{1}'.format(r, grid))
|
||||
|
||||
def _group_remove(self, grid, pkgs, opts):
|
||||
"""
|
||||
Remove selected packages from grouping request
|
||||
:param grid: grouping request id
|
||||
:param pkgs: list of packages to remove
|
||||
:param opts: obs options
|
||||
"""
|
||||
|
||||
srids = self._group_find_sr(pkgs, opts)
|
||||
self._group_verify_type(grid, opts)
|
||||
srid_groups = self._group_verify_grouping(srids, opts, True)
|
||||
|
||||
# ensure there are no mixed packages from different group request
|
||||
for i in srid_groups:
|
||||
if not int(i) == int(grid):
|
||||
raise oscerr.WrongArgs('Some of the SR#s do not belong to group request GR#{0}'.format(grid))
|
||||
|
||||
# remove the SR#s from the GR#
|
||||
for r in srids:
|
||||
query = {'cmd': 'removerequest'}
|
||||
query['oldid'] = str(r)
|
||||
u = makeurl(opts.apiurl, ['request', str(grid)], query=query)
|
||||
f = http_POST(u)
|
||||
root = ET.parse(f).getroot()
|
||||
print('Removed SR#{0} from group request GR#{1}'.format(r, grid))
|
||||
|
||||
def _print_group_header(self, grid, opts):
|
||||
"""
|
||||
Print header showing the content of the GR#
|
||||
:param grid: grouping request id
|
||||
:param opts: obs options
|
||||
"""
|
||||
url = makeurl(opts.apiurl, ['request', str(grid)])
|
||||
f = http_GET(url)
|
||||
root = ET.parse(f).getroot()
|
||||
|
||||
description = str(root.find('description').text)
|
||||
date = str(root.find('state').attrib['when'])
|
||||
author = str(root.find('state').attrib['who'])
|
||||
|
||||
# count the elements:
|
||||
counter = root.find('action')
|
||||
res = self._extract('id', int, 'grouped', counter)
|
||||
items = len(res)
|
||||
print('{0} | {1} | {2} | {3} | {4}'.format(grid, author, date, items, description))
|
||||
|
||||
|
||||
def _group_list_requests(self, grid, opts):
|
||||
"""
|
||||
List open grouping requests or list content of one GR#
|
||||
:param grid: grouping request id if None lists all open grouping requests
|
||||
:param opts: obs options
|
||||
"""
|
||||
|
||||
# header content description
|
||||
print(' ID | Author | Date | Open items | Name ')
|
||||
|
||||
if grid:
|
||||
return
|
||||
|
||||
# search up the GR#s
|
||||
url = makeurl(opts.apiurl, ['search', 'request', 'id?match=(action/@type=\'group\'+and+(state/@name=\'new\'+or+state/@name=\'review\'))'] )
|
||||
f = http_GET(url)
|
||||
root = ET.parse(f).getroot()
|
||||
|
||||
for rq in self._extract('id', int, 'request', root):
|
||||
self._print_group_header(rq, opts)
|
||||
|
||||
|
||||
@cmdln.option('-v', '--version', action='store_true',
|
||||
dest='version',
|
||||
help='show version of the plugin')
|
||||
@cmdln.option('-n', '--name',
|
||||
help='set name of created group')
|
||||
def do_group(self, subcmd, opts, *args):
|
||||
"""${cmd_name}: group packages into one group for verification
|
||||
|
||||
"list" (or "l") will list SR ids grouped into selected group or without
|
||||
argument will list all current group requests (GR#)
|
||||
|
||||
"add" (or "a") will add package(s) into selected group request or group all packages in to
|
||||
group request if one of the packages is in such and no GR# is specified
|
||||
|
||||
"create" (or "c") will create new group request with added package(s)
|
||||
|
||||
"remove" (or "r") will remove SR#(s) from selected group request
|
||||
|
||||
Usage:
|
||||
osc group list [GR#]
|
||||
osc group add [GR#] [package-name | Source:Repository:/ | SR#]
|
||||
osc group create [--name "Name of the group"] [package-name | Source:Repository:/ | SR#]
|
||||
osc group remove GR# [package-name | Source:Repository:/ | SR#]
|
||||
|
||||
${cmd_option_list}
|
||||
"""
|
||||
|
||||
if opts.version:
|
||||
self._print_version()
|
||||
|
||||
# available commands
|
||||
cmds = ['list', 'l', 'add', 'a', 'create', 'c', 'remove', 'r']
|
||||
if not args or args[0] not in cmds:
|
||||
raise oscerr.WrongArgs('Unknown grouping action. Choose one of the {0}.'.format(', '.join(cmds)))
|
||||
|
||||
# verify the argument counts match the commands
|
||||
cmd = args[0]
|
||||
if cmd in ['list', 'l']:
|
||||
min_args, max_args = 0, 1
|
||||
elif cmd in ['add', 'a', 'remove', 'r']:
|
||||
min_args, max_args = 2, None
|
||||
elif cmd in ['create', 'c']:
|
||||
min_args, max_args = 1, None
|
||||
else:
|
||||
raise oscerr.WrongArgs('Unknown command: {0}'.format(cmd))
|
||||
if len(args) - 1 < min_args:
|
||||
raise oscerr.WrongArgs('Too few arguments.')
|
||||
if not max_args is None and len(args) - 1 > max_args:
|
||||
raise oscerr.WrongArgs('Too many arguments.')
|
||||
|
||||
# init the obs access
|
||||
opts.apiurl = conf.config['apiurl']
|
||||
|
||||
if cmd in ['list', 'l']:
|
||||
# check if there is GR#
|
||||
if len(args) < 2:
|
||||
self._group_list_requests(None, opts)
|
||||
else:
|
||||
self._group_list_requests(args[1], opts)
|
||||
elif cmd in ['add', 'a']:
|
||||
self._group_add(args[1], args[2:], opts)
|
||||
elif cmd in [ 'remove', 'r']:
|
||||
self._group_remove(args[1], args[2:], opts)
|
||||
elif cmd in ['create', 'c']:
|
||||
# check if name is set
|
||||
if opts.name:
|
||||
name = opts.name
|
||||
else:
|
||||
name = ', '.join(args[1:])
|
||||
self._group_create(name, args[1:], opts)
|
||||
|
||||
#Local Variables:
|
||||
#mode: python
|
||||
#py-indent-offset: 4
|
||||
#tab-width: 8
|
||||
#End:
|
||||
@ -25,7 +25,7 @@ from osc.core import server_diff
|
||||
_plugin_dir = os.path.expanduser('~/.osc-plugins')
|
||||
sys.path.append(_plugin_dir)
|
||||
from osclib.stagingapi import StagingAPI
|
||||
|
||||
from osclib.request_finder import RequestFinder
|
||||
|
||||
OSC_STAGING_VERSION='0.0.1'
|
||||
|
||||
@ -248,10 +248,7 @@ def do_staging(self, subcmd, opts, *args):
|
||||
api = StagingAPI(opts.apiurl)
|
||||
|
||||
# call the respective command and parse args by need
|
||||
if cmd in ['push', 'p']:
|
||||
project = args[1]
|
||||
self._staging_push(project, opts)
|
||||
elif cmd in ['check']:
|
||||
if cmd in ['check']:
|
||||
return api.check_project_status(api.prj_from_letter(args[1]))
|
||||
elif cmd in ['remove', 'r']:
|
||||
project = args[1]
|
||||
@ -264,8 +261,8 @@ def do_staging(self, subcmd, opts, *args):
|
||||
osclib.freeze_command.FreezeCommand(opts.apiurl).perform(api.prj_from_letter(args[1]))
|
||||
elif cmd in ['select']:
|
||||
stprj = api.prj_from_letter(args[1])
|
||||
for i in range(2, len(args)):
|
||||
api.rq_to_prj(args[i], stprj)
|
||||
for rq in RequestFinder.find_sr(args[2:], opts.apiurl):
|
||||
api.rq_to_prj(rq, stprj)
|
||||
elif cmd in ['move']:
|
||||
sprj = api.prj_from_letter(args[1])
|
||||
tprj = api.prj_from_letter(args[2])
|
||||
|
||||
99
osclib/request_finder.py
Normal file
99
osclib/request_finder.py
Normal file
@ -0,0 +1,99 @@
|
||||
# a helper class
|
||||
|
||||
import osc
|
||||
from osc import cmdln
|
||||
from osc.core import *
|
||||
|
||||
class RequestFinder:
|
||||
|
||||
@classmethod
|
||||
def find_request_id(self, request, apiurl):
|
||||
"""
|
||||
Look up the request by ID to verify if it is correct
|
||||
:param request: ID of the added request
|
||||
:param apiurl: OBS url
|
||||
"""
|
||||
|
||||
url = makeurl(apiurl, ['request', str(request)])
|
||||
try:
|
||||
f = http_GET(url)
|
||||
except HTTPError:
|
||||
return None
|
||||
|
||||
root = ET.parse(f).getroot()
|
||||
|
||||
if root.get('id', None) != request:
|
||||
return None
|
||||
|
||||
project = root.find('action').find('target').get('project')
|
||||
if project != 'openSUSE:Factory':
|
||||
raise oscerr.WrongArgs('Request {} is not for openSUSE:Factory, but for {}'.format(request, project))
|
||||
self.srids.add(int(request))
|
||||
return True
|
||||
|
||||
@classmethod
|
||||
def find_request_package(self, package, apiurl):
|
||||
"""
|
||||
Look up the package by its name and return the SR#
|
||||
:param package: name of the package
|
||||
:param apiurl: OBS url
|
||||
"""
|
||||
|
||||
url = makeurl(apiurl, ['request'], 'states=new,review,declined&project=openSUSE:Factory&view=collection&package={}'.format(package))
|
||||
f = http_GET(url)
|
||||
root = ET.parse(f).getroot()
|
||||
|
||||
ret = None
|
||||
for x in root.findall('request'):
|
||||
# TODO: check the package matches - OBS is case insensitive
|
||||
self.srids.add(int(x.get('id')))
|
||||
ret = True
|
||||
|
||||
if len(self.srids) > 1:
|
||||
raise oscerr.WrongArgs('There are multiple requests for package "{0}": {1}'.format(package, ', '.join(map(str, res))))
|
||||
|
||||
return ret
|
||||
|
||||
@classmethod
|
||||
def find_request_project(self, source_project, apiurl):
|
||||
"""
|
||||
Look up the source project by its name and return the SR#(s)
|
||||
:param source_project: name of the source project
|
||||
:param apiurl: OBS url
|
||||
"""
|
||||
|
||||
url = makeurl(apiurl, ['request'], 'states=new,review&project=openSUSE:Factory&view=collection')
|
||||
f = http_GET(url)
|
||||
root = ET.parse(f).getroot()
|
||||
|
||||
ret = None
|
||||
for rq in root.findall('request'):
|
||||
for a in rq.findall('action'):
|
||||
s = a.find('source')
|
||||
if s is not None and s.get('project') == source_project:
|
||||
self.srids.add(int(rq.attrib['id']))
|
||||
ret = True
|
||||
|
||||
return ret
|
||||
|
||||
@classmethod
|
||||
def find_sr(self, pkgs, apiurl):
|
||||
"""
|
||||
Search for all various mutations and return list of SR#s
|
||||
:param pkgs: mesh of argumets to search for
|
||||
:param apiurl: OBS url
|
||||
"""
|
||||
|
||||
print("Searching for SR#s based on the arguments...")
|
||||
self.srids = set()
|
||||
for p in pkgs:
|
||||
if self.find_request_package(p, apiurl):
|
||||
continue
|
||||
if self.find_request_id(p, apiurl):
|
||||
continue
|
||||
if self.find_request_project(p, apiurl):
|
||||
continue
|
||||
raise oscerr.WrongArgs('No SR# found for: {0}'.format(p))
|
||||
|
||||
# this is needed in order to ensure we have one level list not nested one
|
||||
return sorted(list(self.srids))
|
||||
Loading…
x
Reference in New Issue
Block a user