1 # Copyright (C) 2006 Novell Inc. All rights reserved.
2 # This program is free software; it may be used, copied, modified
3 # and distributed under the terms of the GNU General Public Licence,
4 # either version 2, or version 3 (at your option).
11 import urlgrabber.progress
12 from optparse import SUPPRESS_HELP
14 MAN_HEADER = r""".TH %(ucname)s "1" "%(date)s" "%(name)s %(version)s" "User Commands"
16 %(name)s \- openSUSE build service command-line tool.
19 [\fIGLOBALOPTS\fR] \fISUBCOMMAND \fR[\fIOPTS\fR] [\fIARGS\fR...]
24 openSUSE build service command-line tool.
28 Type 'osc help <subcommand>' for more detailed help on a specific subcommand.
30 For additional information, see
31 * http://en.opensuse.org/Build_Service_Tutorial
32 * http://en.opensuse.org/Build_Service/CLI
34 You can modify osc commands, or roll you own, via the plugin API:
35 * http://en.opensuse.org/Build_Service/osc_plugins
37 osc was written by several authors. This man page is automatically generated.
40 class Osc(cmdln.Cmdln):
41 """Usage: osc [GLOBALOPTS] SUBCOMMAND [OPTS] [ARGS...]
42 or: osc help SUBCOMMAND
44 openSUSE build service command-line tool.
45 Type 'osc help <subcommand>' for help on a specific subcommand.
50 For additional information, see
51 * http://en.opensuse.org/Build_Service_Tutorial
52 * http://en.opensuse.org/Build_Service/CLI
54 You can modify osc commands, or roll you own, via the plugin API:
55 * http://en.opensuse.org/Build_Service/osc_plugins
60 man_header = MAN_HEADER
61 man_footer = MAN_FOOTER
63 def __init__(self, *args, **kwargs):
64 cmdln.Cmdln.__init__(self, *args, **kwargs)
65 cmdln.Cmdln.do_help.aliases.append('h')
67 def get_version(self):
68 return get_osc_version()
70 def get_optparser(self):
71 """this is the parser for "global" options (not specific to subcommand)"""
73 optparser = cmdln.CmdlnOptionParser(self, version=get_osc_version())
74 optparser.add_option('--debugger', action='store_true',
75 help='jump into the debugger before executing anything')
76 optparser.add_option('--post-mortem', action='store_true',
77 help='jump into the debugger in case of errors')
78 optparser.add_option('-t', '--traceback', action='store_true',
79 help='print call trace in case of errors')
80 optparser.add_option('-H', '--http-debug', action='store_true',
81 help='debug HTTP traffic')
82 optparser.add_option('-d', '--debug', action='store_true',
83 help='print info useful for debugging')
84 optparser.add_option('-A', '--apiurl', dest='apiurl',
86 help='specify URL to access API server at or an alias')
87 optparser.add_option('-c', '--config', dest='conffile',
89 help='specify alternate configuration file')
90 optparser.add_option('--no-keyring', action='store_true',
91 help='disable usage of desktop keyring system')
92 optparser.add_option('--no-gnome-keyring', action='store_true',
93 help='disable usage of GNOME Keyring')
94 optparser.add_option('-v', '--verbose', dest='verbose', action='count', default=0,
95 help='increase verbosity')
96 optparser.add_option('-q', '--quiet', dest='verbose', action='store_const', const=-1,
97 help='be quiet, not verbose')
101 def postoptparse(self, try_again = True):
102 """merge commandline options into the config"""
104 conf.get_config(override_conffile = self.options.conffile,
105 override_apiurl = self.options.apiurl,
106 override_debug = self.options.debug,
107 override_http_debug = self.options.http_debug,
108 override_traceback = self.options.traceback,
109 override_post_mortem = self.options.post_mortem,
110 override_no_keyring = self.options.no_keyring,
111 override_no_gnome_keyring = self.options.no_gnome_keyring,
112 override_verbose = self.options.verbose)
113 except oscerr.NoConfigfile, e:
114 print >>sys.stderr, e.msg
115 print >>sys.stderr, 'Creating osc configuration file %s ...' % e.file
118 config['user'] = raw_input('Username: ')
119 config['pass'] = getpass.getpass()
120 if self.options.no_keyring:
121 config['use_keyring'] = '0'
122 if self.options.no_gnome_keyring:
123 config['gnome_keyring'] = '0'
124 if self.options.apiurl:
125 config['apiurl'] = self.options.apiurl
127 conf.write_initial_config(e.file, config)
128 print >>sys.stderr, 'done'
129 if try_again: self.postoptparse(try_again = False)
130 except oscerr.ConfigMissingApiurl, e:
131 print >>sys.stderr, e.msg
133 user = raw_input('Username: ')
134 passwd = getpass.getpass()
135 conf.add_section(e.file, e.url, user, passwd)
136 if try_again: self.postoptparse(try_again = False)
138 self.options.verbose = conf.config['verbose']
139 self.download_progress = None
140 if conf.config.get('show_download_progress', False):
141 from meter import TextMeter
142 self.download_progress = TextMeter(hide_finished=True)
145 def get_cmd_help(self, cmdname):
146 doc = self._get_cmd_handler(cmdname).__doc__
147 doc = self._help_reindent(doc)
148 doc = self._help_preprocess(doc, cmdname)
149 doc = doc.rstrip() + '\n' # trim down trailing space
150 return self._str(doc)
152 def get_api_url(self):
153 localdir = os.getcwd()
154 if (is_package_dir(localdir) or is_project_dir(localdir)) and not self.options.apiurl:
155 return store_read_apiurl(os.curdir)
157 return conf.config['apiurl']
159 # overridden from class Cmdln() to use config variables in help texts
160 def _help_preprocess(self, help, cmdname):
161 help = cmdln.Cmdln._help_preprocess(self, help, cmdname)
162 return help % conf.config
165 def do_init(self, subcmd, opts, project, package=None):
166 """${cmd_name}: Initialize a directory as working copy
168 Initialize an existing directory to be a working copy of an
169 (already existing) buildservice project/package.
171 (This is the same as checking out a package and then copying sources
172 into the directory. It does NOT create a new package. To create a
173 package, use 'osc meta pkg ... ...')
175 You wouldn't normally use this command.
177 To get a working copy of a package (e.g. for building it or working on
178 it, you would normally use the checkout command. Use "osc help
179 checkout" to get help for it.
188 init_project_dir(conf.config['apiurl'], os.curdir, project)
189 print 'Initializing %s (Project: %s)' % (os.curdir, project)
191 init_package_dir(conf.config['apiurl'], project, package, os.path.curdir)
192 print 'Initializing %s (Project: %s, Package: %s)' % (os.curdir, project, package)
198 @cmdln.option('-a', '--arch', metavar='ARCH',
199 help='specify architecture (only for binaries)')
200 @cmdln.option('-r', '--repo', metavar='REPO',
201 help='specify repository (only for binaries)')
202 @cmdln.option('-b', '--binaries', action='store_true',
203 help='list built binaries instead of sources')
204 @cmdln.option('-R', '--revision', metavar='REVISION',
205 help='specify revision (only for sources)')
206 @cmdln.option('-e', '--expand', action='store_true',
207 help='expand linked package (only for sources)')
208 @cmdln.option('-u', '--unexpand', action='store_true',
209 help='always work with unexpanded (source) packages')
210 @cmdln.option('-v', '--verbose', action='store_true',
211 help='print extra information')
212 @cmdln.option('-l', '--long', action='store_true', dest='verbose',
213 help='print extra information')
214 def do_list(self, subcmd, opts, *args):
215 """${cmd_name}: List sources or binaries on the server
217 Examples for listing sources:
218 ls # list all projects
219 ls PROJECT # list packages in a project
220 ls PROJECT PACKAGE # list source files of package of a project
221 ls PROJECT PACKAGE <file> # list <file> if this file exists
222 ls -v PROJECT PACKAGE # verbosely list source files of package
223 ls -l PROJECT PACKAGE # verbosely list source files of package
224 ll PROJECT PACKAGE # verbosely list source files of package
225 LL PROJECT PACKAGE # verbosely list source files of expanded link
227 With --verbose, the following fields will be shown for each item:
229 Revision number of the last commit
231 Date and time of the last commit
233 Examples for listing binaries:
234 ls -b PROJECT # list all binaries of a project
235 ls -b PROJECT -a ARCH # list ARCH binaries of a project
236 ls -b PROJECT -r REPO # list binaries in REPO
237 ls -b PROJECT PACKAGE REPO ARCH
240 ${cmd_name} [PROJECT [PACKAGE]]
241 ${cmd_name} -b [PROJECT [PACKAGE [REPO [ARCH]]]]
245 apiurl = conf.config['apiurl']
246 args = slash_split(args)
249 if subcmd == 'lL' or subcmd == 'LL':
263 if opts.repo != args[2]:
264 raise oscerr.WrongArgs("conflicting repos specified ('%s' vs '%s')"%(opts.repo, args[2]))
271 if not opts.binaries:
272 raise oscerr.WrongArgs('Too many arguments')
274 if opts.arch != args[3]:
275 raise oscerr.WrongArgs("conflicting archs specified ('%s' vs '%s')"%(opts.arch, args[3]))
280 if opts.binaries and opts.expand:
281 raise oscerr.WrongOptions('Sorry, --binaries and --expand are mutual exclusive.')
285 # ls -b toplevel doesn't make sense, so use info from
286 # current dir if available
289 if is_project_dir(dir):
290 project = store_read_project(dir)
291 elif is_package_dir(dir):
292 project = store_read_project(dir)
293 package = store_read_package(dir)
295 apiurl = self.get_api_url()
298 raise oscerr.WrongArgs('There are no binaries to list above project level.')
300 raise oscerr.WrongOptions('Sorry, the --revision option is not supported for binaries.')
304 if opts.repo and opts.arch:
305 repos.append(Repo(opts.repo, opts.arch))
306 elif opts.repo and not opts.arch:
307 repos = [repo for repo in get_repos_of_project(apiurl, project) if repo.name == opts.repo]
308 elif opts.arch and not opts.repo:
309 repos = [repo for repo in get_repos_of_project(apiurl, project) if repo.arch == opts.arch]
311 repos = get_repos_of_project(apiurl, project)
315 results.append((repo, get_binarylist(apiurl, project, repo.name, repo.arch, package=package, verbose=opts.verbose)))
317 for result in results:
320 print '%s/%s' % (result[0].name, result[0].arch)
325 print "%9d %s %-40s" % (f.size, shorttime(f.mtime), f.name)
331 elif not opts.binaries:
333 print '\n'.join(meta_get_project_list(conf.config['apiurl']))
337 if self.options.verbose:
338 print >>sys.stderr, 'Sorry, the --verbose option is not implemented for projects.'
340 raise oscerr.WrongOptions('Sorry, the --expand option is not implemented for projects.')
342 print '\n'.join(meta_get_packagelist(conf.config['apiurl'], project))
344 elif len(args) == 2 or len(args) == 3:
346 print_not_found = True
349 l = meta_get_filelist(conf.config['apiurl'],
352 verbose=opts.verbose,
355 link_seen = '_link' in l
357 out = [ '%s %7s %9d %s %s' % (i.md5, i.rev, i.size, shorttime(i.mtime), i.name) \
358 for i in l if not fname or fname == i.name ]
360 print_not_found = False
365 print_not_found = False
368 if opts.expand or opts.unexpand or not link_seen: break
369 m = show_files_meta(conf.config['apiurl'], project, package)
371 li.read(ET.fromstring(''.join(m)).find('linkinfo'))
373 raise oscerr.LinkExpandError(project, package, li.error)
374 project, package, rev = li.project, li.package, li.rev
376 print '# -> %s %s (%s)' % (project, package, rev)
378 print '# -> %s %s (latest)' % (project, package)
380 if fname and print_not_found:
381 print 'file \'%s\' does not exist' % fname
384 @cmdln.option('-f', '--force', action='store_true',
385 help='force generation of new patchinfo file')
386 @cmdln.option('--force-update', action='store_true',
387 help='drops away collected packages from an already built patch and let it collect again')
388 def do_patchinfo(self, subcmd, opts, *args):
389 """${cmd_name}: Generate and edit a patchinfo file.
391 A patchinfo file describes the packages for an update and the kind of
396 osc patchinfo PATCH_NAME
400 project_dir = localdir = os.getcwd()
401 if is_project_dir(localdir):
402 project = store_read_project(localdir)
403 apiurl = self.get_api_url()
405 sys.exit('This command must be called in a checked out project.')
407 for p in meta_get_packagelist(apiurl, project):
408 if p.startswith("_patchinfo:"):
411 if opts.force or not patchinfo:
412 print "Creating initial patchinfo..."
413 query='cmd=createpatchinfo'
415 query += "&name=" + args[0]
416 url = makeurl(apiurl, ['source', project], query=query)
418 for p in meta_get_packagelist(apiurl, project):
419 if p.startswith("_patchinfo:"):
422 if not os.path.exists(project_dir + "/" + patchinfo):
423 checkout_package(apiurl, project, patchinfo, prj_dir=project_dir)
425 filename = project_dir + "/" + patchinfo + "/_patchinfo"
429 @cmdln.option('-a', '--attribute', metavar='ATTRIBUTE',
430 help='affect only a given attribute')
431 @cmdln.option('--attribute-defaults', action='store_true',
432 help='include defined attribute defaults')
433 @cmdln.option('--attribute-project', action='store_true',
434 help='include project values, if missing in packages ')
435 @cmdln.option('-F', '--file', metavar='FILE',
436 help='read metadata from FILE, instead of opening an editor. '
437 '\'-\' denotes standard input. ')
438 @cmdln.option('-e', '--edit', action='store_true',
439 help='edit metadata')
440 @cmdln.option('-c', '--create', action='store_true',
441 help='create attribute without values')
442 @cmdln.option('-s', '--set', metavar='ATTRIBUTE_VALUES',
443 help='set attribute values')
444 @cmdln.option('--delete', action='store_true',
445 help='delete a pattern or attribute')
446 def do_meta(self, subcmd, opts, *args):
447 """${cmd_name}: Show meta information, or edit it
449 Show or edit build service metadata of type <prj|pkg|prjconf|user|pattern>.
451 This command displays metadata on buildservice objects like projects,
452 packages, or users. The type of metadata is specified by the word after
453 "meta", like e.g. "meta prj".
455 prj denotes metadata of a buildservice project.
456 prjconf denotes the (build) configuration of a project.
457 pkg denotes metadata of a buildservice package.
458 user denotes the metadata of a user.
459 pattern denotes installation patterns defined for a project.
461 To list patterns, use 'osc meta pattern PRJ'. An additional argument
462 will be the pattern file to view or edit.
464 With the --edit switch, the metadata can be edited. Per default, osc
465 opens the program specified by the environmental variable EDITOR with a
466 temporary file. Alternatively, content to be saved can be supplied via
467 the --file switch. If the argument is '-', input is taken from stdin:
468 osc meta prjconf home:user | sed ... | osc meta prjconf home:user -F -
470 When trying to edit a non-existing resource, it is created implicitly.
476 osc meta pkg PRJ PKG -e
477 osc meta attribute PRJ [PKG [SUBPACKAGE]] [--attribute ATTRIBUTE] [--create|--delete|--set [value_list]]
480 osc meta <prj|pkg|prjconf|user|pattern|attribute> ARGS...
481 osc meta <prj|pkg|prjconf|user|pattern|attribute> -e|--edit ARGS...
482 osc meta <prj|pkg|prjconf|user|pattern|attribute> -F|--file ARGS...
483 osc meta pattern --delete PRJ PATTERN
487 args = slash_split(args)
489 if not args or args[0] not in metatypes.keys():
490 raise oscerr.WrongArgs('Unknown meta type. Choose one of %s.' \
491 % ', '.join(metatypes))
497 min_args, max_args = 0, 2
498 elif cmd in ['pattern']:
499 min_args, max_args = 1, 2
500 elif cmd in ['attribute']:
501 min_args, max_args = 1, 3
502 elif cmd in ['prj', 'prjconf']:
503 min_args, max_args = 0, 1
505 min_args, max_args = 1, 1
507 if len(args) < min_args:
508 raise oscerr.WrongArgs('Too few arguments.')
509 if len(args) > max_args:
510 raise oscerr.WrongArgs('Too many arguments.')
514 if cmd in ['pkg', 'prj', 'prjconf' ]:
516 project = store_read_project(os.curdir)
522 package = store_read_package(os.curdir)
526 elif cmd == 'attribute':
532 if opts.attribute_project:
533 raise oscerr.WrongOptions('--attribute-project works only when also a package is given')
538 attributepath.append('source')
539 attributepath.append(project)
541 attributepath.append(package)
543 attributepath.append(subpackage)
544 attributepath.append('_attribute')
547 elif cmd == 'pattern':
553 # enforce pattern argument if needed
554 if opts.edit or opts.file:
555 raise oscerr.WrongArgs('A pattern file argument is required.')
558 if not opts.edit and not opts.file and not opts.delete and not opts.create and not opts.set:
560 sys.stdout.write(''.join(show_project_meta(conf.config['apiurl'], project)))
562 sys.stdout.write(''.join(show_package_meta(conf.config['apiurl'], project, package)))
563 elif cmd == 'attribute':
564 sys.stdout.write(''.join(show_attribute_meta(conf.config['apiurl'], project, package, subpackage, opts.attribute, opts.attribute_defaults, opts.attribute_project)))
565 elif cmd == 'prjconf':
566 sys.stdout.write(''.join(show_project_conf(conf.config['apiurl'], project)))
568 r = get_user_meta(conf.config['apiurl'], user)
570 sys.stdout.write(''.join(r))
571 elif cmd == 'pattern':
573 r = show_pattern_meta(conf.config['apiurl'], project, pattern)
575 sys.stdout.write(''.join(r))
577 r = show_pattern_metalist(conf.config['apiurl'], project)
579 sys.stdout.write('\n'.join(r) + '\n')
582 if opts.edit and not opts.file:
584 edit_meta(metatype='prj',
586 path_args=quote_plus(project),
589 'user': conf.config['user']}))
591 edit_meta(metatype='pkg',
593 path_args=(quote_plus(project), quote_plus(package)),
596 'user': conf.config['user']}))
597 elif cmd == 'prjconf':
598 edit_meta(metatype='prjconf',
600 path_args=quote_plus(project),
603 edit_meta(metatype='user',
605 path_args=(quote_plus(user)),
606 template_args=({'user': user}))
607 elif cmd == 'pattern':
608 edit_meta(metatype='pattern',
610 path_args=(project, pattern),
613 # create attribute entry
614 if (opts.create or opts.set) and cmd == 'attribute':
615 if not opts.attribute:
616 raise oscerr.WrongOptions('no attribute given to create')
619 opts.set = opts.set.replace('&', '&').replace('<', '<').replace('>', '>')
620 for i in opts.set.split(','):
621 values += '<value>%s</value>' % i
622 aname = opts.attribute.split(":")
623 d = '<attributes><attribute namespace=\'%s\' name=\'%s\' >%s</attribute></attributes>' % (aname[0], aname[1], values)
624 url = makeurl(conf.config['apiurl'], attributepath)
625 for data in streamfile(url, http_POST, data=d):
626 sys.stdout.write(data)
635 f = open(opts.file).read()
637 sys.exit('could not open file \'%s\'.' % opts.file)
640 edit_meta(metatype='prj',
643 path_args=quote_plus(project))
645 edit_meta(metatype='pkg',
648 path_args=(quote_plus(project), quote_plus(package)))
649 elif cmd == 'prjconf':
650 edit_meta(metatype='prjconf',
653 path_args=quote_plus(project))
655 edit_meta(metatype='user',
658 path_args=(quote_plus(user)))
659 elif cmd == 'pattern':
660 edit_meta(metatype='pattern',
663 path_args=(project, pattern))
668 path = metatypes[cmd]['path']
670 path = path % (project, pattern)
671 u = makeurl(conf.config['apiurl'], [path])
673 elif cmd == 'attribute':
674 if not opts.attribute:
675 raise oscerr.WrongOptions('no attribute given to create')
676 attributepath.append(opts.attribute)
677 u = makeurl(conf.config['apiurl'], attributepath)
678 for data in streamfile(u, http_DELETE):
679 sys.stdout.write(data)
681 raise oscerr.WrongOptions('The --delete switch is only for pattern metadata or attributes.')
684 @cmdln.option('-m', '--message', metavar='TEXT',
685 help='specify message TEXT')
686 @cmdln.option('-r', '--revision', metavar='REV',
687 help='for "create", specify a certain source revision ID (the md5 sum)')
688 @cmdln.option('-s', '--supersede', metavar='SUPERSEDE',
689 help='Superseding another request by this one')
690 @cmdln.option('--nodevelproject', action='store_true',
691 help='do not follow a defined devel project ' \
692 '(primary project where a package is developed)')
693 @cmdln.option('--cleanup', action='store_true',
694 help='remove package if submission gets accepted (default for home:<id>:branch projects)')
695 @cmdln.option('--no-cleanup', action='store_true',
696 help='never remove source package on accept, but update its content')
697 @cmdln.option('--no-update', action='store_true',
698 help='never touch source package on accept (will break source links)')
699 @cmdln.option('-d', '--diff', action='store_true',
700 help='show diff only instead of creating the actual request')
701 @cmdln.option('--yes', action='store_true',
702 help='proceed without asking.')
704 @cmdln.alias("submitreq")
705 @cmdln.alias("submitpac")
706 def do_submitrequest(self, subcmd, opts, *args):
707 """${cmd_name}: Create request to submit source into another Project
709 [See http://en.opensuse.org/Build_Service/Collaboration for information
712 See the "request" command for showing and modifing existing requests.
715 osc submitreq [OPTIONS]
716 osc submitreq [OPTIONS] DESTPRJ [DESTPKG]
717 osc submitreq [OPTIONS] SOURCEPRJ SOURCEPKG DESTPRJ [DESTPKG]
721 src_update = conf.config['submitrequest_on_accept_action'] or None
722 # we should check here for home:<id>:branch and default to update, but that would require OBS 1.7 server
724 src_update = "cleanup"
725 elif opts.no_cleanup:
726 src_update = "update"
728 src_update = "noupdate"
730 args = slash_split(args)
732 # remove this block later again
733 oldcmds = ['create', 'list', 'log', 'show', 'decline', 'accept', 'delete', 'revoke']
734 if args and args[0] in oldcmds:
735 print "************************************************************************"
736 print "* WARNING: It looks that you are using this command with a *"
737 print "* deprecated syntax. *"
738 print "* Please run \"osc sr --help\" and \"osc rq --help\" *"
739 print "* to see the new syntax. *"
740 print "************************************************************************"
741 if args[0] == 'create':
747 raise oscerr.WrongArgs('Too many arguments.')
749 if len(args) > 0 and len(args) <= 2 and is_project_dir(os.getcwd()):
750 sys.exit('osc submitrequest from project directory is only working without target specs and for source linked files\n')
752 apiurl = self.get_api_url()
754 if len(args) == 0 and is_project_dir(os.getcwd()):
756 # submit requests for multiple packages are currently handled via multiple requests
757 # They could be also one request with multiple actions, but that avoids to accepts parts of it.
758 project = store_read_project(os.curdir)
764 # loop via all packages for checking their state
765 for p in meta_get_packagelist(apiurl, project):
766 if p.startswith("_patchinfo:"):
769 # get _link info from server, that knows about the local state ...
770 u = makeurl(apiurl, ['source', project, p])
772 root = ET.parse(f).getroot()
773 linkinfo = root.find('linkinfo')
775 print "Package ", p, " is not a source link."
776 sys.exit("This is currently not supported.")
777 if linkinfo.get('error'):
778 print "Package ", p, " is a broken source link."
779 sys.exit("Please fix this first")
780 t = linkinfo.get('project')
782 if len(root.findall('entry')) > 1: # This is not really correct, but should work mostly
783 # Real fix is to ask the api if sources are modificated
784 # but there is no such call yet.
785 targetprojects.append(t)
787 print "Submitting package ", p
789 print " Skipping package ", p
791 print "Skipping package ", p, " since it is a source link pointing inside the project."
795 print "Submitting patchinfo ", ', '.join(pi), " to ", ', '.join(targetprojects)
796 print "\nEverything fine? Can we create the requests ? [y/n]"
797 if sys.stdin.read(1) != "y":
798 print >>sys.stderr, 'Aborted...'
799 raise oscerr.UserAbort()
801 # loop via all packages to do the action
803 result = create_submit_request(apiurl, project, p)
806 sys.exit("submit request creation failed")
807 sr_ids.append(result)
809 # create submit requests for all found patchinfos
813 options_block="""<options><sourceupdate>%s</sourceupdate></options> """ % (src_update)
816 for t in targetprojects:
817 s = """<action type="submit"> <source project="%s" package="%s" /> <target project="%s" package="%s" /> %s </action>""" % \
818 (project, p, t, p, options_block)
822 xml = """<request> %s <state name="new"/> <description>%s</description> </request> """ % \
823 (actionxml, cgi.escape(opts.message or ""))
824 u = makeurl(apiurl, ['request'], query='cmd=create')
825 f = http_POST(u, data=xml)
827 root = ET.parse(f).getroot()
828 sr_ids.append(root.get('id'))
830 print "Requests created: ",
833 sys.exit('Successfull finished')
836 # try using the working copy at hand
837 p = findpacs(os.curdir)[0]
838 src_project = p.prjname
841 if len(args) == 0 and p.islink():
842 dst_project = p.linkinfo.project
843 dst_package = p.linkinfo.package
845 dst_project = args[0]
847 dst_package = args[1]
849 dst_package = src_package
851 sys.exit('Package \'%s\' is not a source link, so I cannot guess the submit target.\n'
852 'Please provide it the target via commandline arguments.' % p.name)
854 modified = [i for i in p.filenamelist if p.status(i) != ' ' and p.status(i) != '?']
855 if len(modified) > 0:
856 print 'Your working copy has local modifications.'
857 repl = raw_input('Proceed without committing the local changes? (y|N) ')
859 raise oscerr.UserAbort()
861 # get the arguments from the commandline
862 src_project, src_package, dst_project = args[0:3]
864 dst_package = args[3]
866 dst_package = src_package
868 raise oscerr.WrongArgs('Incorrect number of arguments.\n\n' \
869 + self.get_cmd_help('request'))
871 if not opts.nodevelproject:
874 devloc = show_develproject(apiurl, dst_project, dst_package)
875 except urllib2.HTTPError:
876 print >>sys.stderr, """\
877 Warning: failed to fetch meta data for '%s' package '%s' (new package?) """ \
878 % (dst_project, dst_package)
882 dst_project != devloc and \
883 src_project != devloc:
885 A different project, %s, is defined as the place where development
886 of the package %s primarily takes place.
887 Please submit there instead, or use --nodevelproject to force direct submission.""" \
888 % (devloc, dst_package)
893 if opts.diff or not opts.message:
895 rdiff = 'old: %s/%s\nnew: %s/%s' %(dst_project, dst_package, src_project, src_package)
896 rdiff += server_diff(apiurl,
897 dst_project, dst_package, opts.revision,
898 src_project, src_package, None, True)
904 reqs = get_request_list(apiurl, dst_project, dst_package, req_type='submit')
905 user = conf.get_apiurl_usr(apiurl)
906 myreqs = [ i for i in reqs if i.state.who == user ]
909 print 'You already created the following submit request: %s.' % \
910 ', '.join([str(i.reqid) for i in myreqs ])
911 repl = raw_input('Supersede the old requests? (y/n/c) ')
912 if repl.lower() == 'c':
913 print >>sys.stderr, 'Aborting'
914 raise oscerr.UserAbort()
919 changes_re = re.compile(r'^--- .*\.changes ')
920 for line in rdiff.split('\n'):
921 if line.startswith('--- '):
922 if changes_re.match(line):
927 difflines.append(line)
928 opts.message = edit_message(footer=rdiff, template='\n'.join(parse_diff_for_commit_message('\n'.join(difflines))))
930 result = create_submit_request(apiurl,
931 src_project, src_package,
932 dst_project, dst_package,
933 opts.message, orev=opts.revision, src_update=src_update)
934 if repl.lower() == 'y':
936 change_request_state(apiurl, str(req.reqid), 'superseded',
937 'superseded by %s' % result, result)
940 r = change_request_state(conf.config['apiurl'],
941 opts.supersede, 'superseded', opts.message or '', result)
943 print 'created request id', result
946 @cmdln.option('-m', '--message', metavar='TEXT',
947 help='specify message TEXT')
949 @cmdln.alias("deletereq")
950 def do_deleterequest(self, subcmd, opts, *args):
951 """${cmd_name}: Create request to delete a package or project
955 osc deletereq [-m TEXT] PROJECT [PACKAGE]
959 args = slash_split(args)
962 raise oscerr.WrongArgs('Please specify at least a project.')
964 raise oscerr.WrongArgs('Too many arguments.')
966 apiurl = conf.config['apiurl']
974 opts.message = edit_message()
976 result = create_delete_request(apiurl, project, package, opts.message)
980 @cmdln.option('-m', '--message', metavar='TEXT',
981 help='specify message TEXT')
983 @cmdln.alias("changedevelreq")
984 def do_changedevelrequest(self, subcmd, opts, *args):
985 """${cmd_name}: Create request to change the devel package definition.
987 [See http://en.opensuse.org/Build_Service/Collaboration for information
990 See the "request" command for showing and modifing existing requests.
992 osc changedevelrequest PROJECT PACKAGE DEVEL_PROJECT [DEVEL_PACKAGE]
996 raise oscerr.WrongArgs('Too many arguments.')
998 apiurl = self.get_api_url()
1000 if len(args) == 0 and is_package_dir('.') and len(conf.config['getpac_default_project']):
1002 devel_project = store_read_project(wd)
1003 devel_package = package = store_read_package(wd)
1004 project = conf.config['getpac_default_project']
1007 raise oscerr.WrongArgs('Too few arguments.')
1009 devel_project = args[2]
1012 devel_package = package
1014 devel_package = args[3]
1016 if not opts.message:
1018 footer=textwrap.TextWrapper(width = 66).fill(
1019 'please explain why you like to change the devel project of %s/%s to %s/%s'
1020 % (project,package,devel_project,devel_package))
1021 opts.message = edit_message(footer)
1023 result = create_change_devel_request(apiurl,
1024 devel_project, devel_package,
1030 @cmdln.option('-d', '--diff', action='store_true',
1031 help='generate a diff')
1032 @cmdln.option('-u', '--unified', action='store_true',
1033 help='output the diff in the unified diff format')
1034 @cmdln.option('-m', '--message', metavar='TEXT',
1035 help='specify message TEXT')
1036 @cmdln.option('-t', '--type', metavar='TYPE',
1037 help='limit to requests which contain a given action type (submit/delete/change_devel)')
1038 @cmdln.option('-a', '--all', action='store_true',
1039 help='all states. Same as\'-s all\'')
1040 @cmdln.option('-s', '--state', default='', # default is 'all' if no args given, 'new' otherwise
1041 help='only list requests in one of the comma separated given states (new/accepted/revoked/declined) or "all" [default=new, or all, if no args given]')
1042 @cmdln.option('-D', '--days', metavar='DAYS',
1043 help='only list requests in state "new" or changed in the last DAYS. [default=%(request_list_days)s]')
1044 @cmdln.option('-U', '--user', metavar='USER',
1045 help='same as -M, but for the specified USER')
1046 @cmdln.option('-b', '--brief', action='store_true', default=False,
1047 help='print output in list view as list subcommand')
1048 @cmdln.option('-M', '--mine', action='store_true',
1049 help='only show requests created by yourself')
1050 @cmdln.option('-B', '--bugowner', action='store_true',
1051 help='also show requests about packages where I am bugowner')
1052 @cmdln.option('-i', '--interactive', action='store_true',
1053 help='interactive review of request')
1054 @cmdln.option('--non-interactive', action='store_true',
1055 help='non-interactive review of request')
1056 @cmdln.option('--exclude-target-project', action='append',
1057 help='exclude target project from request list')
1058 @cmdln.option('--involved-projects', action='store_true',
1059 help='show all requests for project/packages where USER is involved')
1061 @cmdln.alias("review")
1062 def do_request(self, subcmd, opts, *args):
1063 """${cmd_name}: Show and modify requests
1065 [See http://en.opensuse.org/Build_Service/Collaboration for information
1068 This command shows and modifies existing requests. To create new requests
1069 you need to call one of the following:
1072 osc changedevelrequest
1073 To send low level requests to the buildservice API, use:
1076 This command has the following sub commands:
1078 "list" lists open requests attached to a project or package or person.
1079 Uses the project/package of the current directory if none of
1080 -M, -U USER, project/package are given.
1082 "log" will show the history of the given ID
1084 "show" will show the request itself, and generate a diff for review, if
1085 used with the --diff option. The keyword show can be omitted if the ID is numeric.
1087 "decline" will change the request state to "declined" and append a
1088 message that you specify with the --message option.
1090 "wipe" will permanently delete a request.
1092 "revoke" will set the request state to "revoked" and append a
1093 message that you specify with the --message option.
1095 "accept" will change the request state to "accepted" and will trigger
1096 the actual submit process. That would normally be a server-side copy of
1097 the source package to the target package.
1099 "checkout" will checkout the request's source package. This only works for "submit" requests.
1102 osc request list [-M] [-U USER] [-s state] [-D DAYS] [-t type] [-B] [PRJ [PKG]]
1104 osc request [show] [-d] [-b] ID
1105 osc request accept [-m TEXT] ID
1106 osc request decline [-m TEXT] ID
1107 osc request revoke [-m TEXT] ID
1109 osc request checkout/co ID
1110 osc review accept [-m TEXT] ID
1111 osc review decline [-m TEXT] ID
1115 args = slash_split(args)
1117 if opts.all and opts.state:
1118 raise oscerr.WrongOptions('Sorry, the options \'--all\' and \'--state\' ' \
1119 'are mutually exclusive.')
1120 if opts.mine and opts.user:
1121 raise oscerr.WrongOptions('Sorry, the options \'--user\' and \'--mine\' ' \
1122 'are mutually exclusive.')
1123 if opts.interactive and opts.non_interactive:
1124 raise oscerr.WrongOptions('Sorry, the options \'--interactive\' and ' \
1125 '\'--non-interactive\' are mutually exclusive')
1130 if opts.state == '':
1133 if opts.state == '':
1136 cmds = ['list', 'log', 'show', 'decline', 'accept', 'wipe', 'revoke', 'checkout', 'co', 'help']
1137 if not args or args[0] not in cmds:
1138 raise oscerr.WrongArgs('Unknown request action %s. Choose one of %s.' \
1139 % (args[0],', '.join(cmds)))
1145 return self.do_help(['help', 'request'])
1148 min_args, max_args = 1, 1
1149 elif cmd in ['list']:
1150 min_args, max_args = 0, 2
1152 min_args, max_args = 1, 1
1153 if len(args) < min_args:
1154 raise oscerr.WrongArgs('Too few arguments.')
1155 if len(args) > max_args:
1156 raise oscerr.WrongArgs('Too many arguments.')
1158 apiurl = self.get_api_url()
1165 elif not opts.mine and not opts.user:
1167 project = store_read_project(os.curdir)
1168 package = store_read_package(os.curdir)
1169 except oscerr.NoWorkingCopy:
1174 elif cmd in ['log', 'show', 'decline', 'accept', 'wipe', 'revoke', 'checkout', 'co']:
1179 states = ('new', 'accepted', 'revoked', 'declined')
1180 state_list = opts.state.split(',')
1181 if opts.state == 'all':
1182 state_list = ['all']
1184 for s in state_list:
1186 raise oscerr.WrongArgs('Unknown state \'%s\', try one of %s' % (s, ','.join(states)))
1189 who = conf.get_apiurl_usr(apiurl)
1193 state_list = ['all']
1195 ## FIXME -B not implemented!
1197 if (self.options.debug):
1198 print 'list: option --bugowner ignored: not impl.'
1200 if opts.involved_projects:
1201 who = who or conf.get_apiurl_usr(apiurl)
1202 results = get_user_projpkgs_request_list(apiurl, who, req_state=state_list,
1203 req_type=opts.type, exclude_projects=opts.exclude_target_project or [])
1205 results = get_request_list(apiurl, project, package, who,
1206 state_list, opts.type, opts.exclude_target_project or [])
1207 results.sort(reverse=True)
1209 days = opts.days or conf.config['request_list_days']
1216 since = time.strftime('%Y-%m-%dT%H:%M:%S',time.localtime(time.time()-days*24*3600))
1219 ## bs has received 2009-09-20 a new xquery compare() function
1220 ## which allows us to limit the list inside of get_request_list
1221 ## That would be much faster for coolo. But counting the remainder
1222 ## would not be possible with current xquery implementation.
1223 ## Workaround: fetch all, and filter on client side.
1225 ## FIXME: date filtering should become implemented on server side
1226 for result in results:
1227 if days == 0 or result.state.when > since or result.state.name == 'new':
1228 print result.list_view()
1232 print "There are %d requests older than %s days.\n" % (skipped, days)
1235 for l in get_request_log(conf.config['apiurl'], reqid):
1240 r = get_request(conf.config['apiurl'], reqid)
1243 elif (opts.interactive or conf.config['request_show_interactive']) and not opts.non_interactive:
1244 return request_interactive_review(conf.config['apiurl'], r)
1247 # fixme: will inevitably fail if the given target doesn't exist
1248 if opts.diff and r.actions[0].type != 'submit':
1249 raise oscerr.WrongOptions('\'--diff\' is not possible for request type: \'%s\'' % r.actions[0].type)
1252 print server_diff(conf.config['apiurl'],
1253 r.actions[0].dst_project, r.actions[0].dst_package, None,
1254 r.actions[0].src_project, r.actions[0].src_package, r.actions[0].src_rev, opts.unified, True)
1255 except urllib2.HTTPError, e:
1257 e.osc_msg = 'Diff not possible'
1259 # backward compatiblity: only a recent api/backend supports the missingok parameter
1261 print server_diff(conf.config['apiurl'],
1262 r.actions[0].dst_project, r.actions[0].dst_package, None,
1263 r.actions[0].src_project, r.actions[0].src_package, r.actions[0].src_rev, opts.unified, False)
1264 except urllib2.HTTPError, e:
1265 e.osc_msg = 'Diff not possible'
1269 elif cmd == 'checkout' or cmd == 'co':
1270 r = get_request(conf.config['apiurl'], reqid)
1271 submits = [ i for i in r.actions if i.type == 'submit' ]
1272 if not len(submits):
1273 raise oscerr.WrongArgs('\'checkout\' only works for \'submit\' requests')
1274 checkout_package(conf.config['apiurl'], submits[0].src_project, submits[0].src_package, \
1275 submits[0].src_rev, expand_link=True, prj_dir=submits[0].src_project)
1278 if not opts.message:
1279 opts.message = edit_message()
1280 state_map = {'accept' : 'accepted', 'decline' : 'declined', 'wipe' : 'deleted', 'revoke' : 'revoked'}
1281 # Change review state only
1282 if subcmd == 'review':
1283 if cmd in ['accept', 'decline']:
1284 r = change_review_state(conf.config['apiurl'],
1285 reqid, state_map[cmd], conf.config['user'], '', opts.message or '')
1287 # Change state of entire request
1288 elif cmd in ['accept', 'decline', 'wipe', 'revoke']:
1289 r = change_request_state(conf.config['apiurl'],
1290 reqid, state_map[cmd], opts.message or '')
1293 # editmeta and its aliases are all depracated
1294 @cmdln.alias("editprj")
1295 @cmdln.alias("createprj")
1296 @cmdln.alias("editpac")
1297 @cmdln.alias("createpac")
1298 @cmdln.alias("edituser")
1299 @cmdln.alias("usermeta")
1301 def do_editmeta(self, subcmd, opts, *args):
1304 Obsolete command to edit metadata. Use 'meta' now.
1306 See the help output of 'meta'.
1310 print >>sys.stderr, 'This command is obsolete. Use \'osc meta <metatype> ...\'.'
1311 print >>sys.stderr, 'See \'osc help meta\'.'
1312 #self.do_help([None, 'meta'])
1316 @cmdln.option('-r', '--revision', metavar='rev',
1317 help='use the specified revision.')
1318 @cmdln.option('-u', '--unset', action='store_true',
1319 help='remove revision in link, it will point always to latest revision')
1320 def do_setlinkrev(self, subcmd, opts, *args):
1321 """${cmd_name}: Updates a revision number in a source link.
1323 This command adds or updates a specified revision number in a source link.
1324 The current revision of the source is used, if no revision number is specified.
1328 osc setlinkrev PROJECT [PACKAGE]
1332 args = slash_split(args)
1333 apiurl = conf.config['apiurl']
1336 p = findpacs(os.curdir)[0]
1341 sys.exit('Local directory is no checked out source link package, aborting')
1342 elif len(args) == 2:
1345 elif len(args) == 1:
1348 raise oscerr.WrongArgs('Incorrect number of arguments.\n\n' \
1349 + self.get_cmd_help('setlinkrev'))
1352 packages = [ package ]
1354 packages = meta_get_packagelist(apiurl, project)
1357 print "setting revision for package", p
1361 rev, dummy = parseRevisionOption(opts.revision)
1362 set_link_rev(apiurl, project, p, rev)
1365 def do_linktobranch(self, subcmd, opts, *args):
1366 """${cmd_name}: Convert a package containing a classic link with patch to a branch
1368 This command tells the server to convert a _link with or without a project.diff
1369 to a branch. This is a full copy with a _link file pointing to the branched place.
1372 osc linktobranch # can be used in checked out package
1373 osc linktobranch PROJECT PACKAGE
1376 args = slash_split(args)
1377 apiurl = self.get_api_url()
1381 project = store_read_project(wd)
1382 package = store_read_package(wd)
1383 update_local_dir = True
1385 raise oscerr.WrongArgs('Too few arguments (required none or two)')
1387 raise oscerr.WrongArgs('Too many arguments (required none or two)')
1391 update_local_dir = False
1394 link_to_branch(apiurl, project, package)
1395 if update_local_dir:
1397 pac.update(rev=pac.latest_rev())
1400 @cmdln.option('-C', '--cicount', choices=['add', 'copy', 'local'],
1401 help='cicount attribute in the link, known values are add, copy, and local, default in buildservice is currently add.')
1402 @cmdln.option('-c', '--current', action='store_true',
1403 help='link fixed against current revision.')
1404 @cmdln.option('-r', '--revision', metavar='rev',
1405 help='link the specified revision.')
1406 @cmdln.option('-f', '--force', action='store_true',
1407 help='overwrite an existing link file if it is there.')
1408 @cmdln.option('-d', '--disable-publish', action='store_true',
1409 help='disable publishing of the linked package')
1410 def do_linkpac(self, subcmd, opts, *args):
1411 """${cmd_name}: "Link" a package to another package
1413 A linked package is a clone of another package, but plus local
1414 modifications. It can be cross-project.
1416 The DESTPAC name is optional; the source packages' name will be used if
1419 Afterwards, you will want to 'checkout DESTPRJ DESTPAC'.
1421 To add a patch, add the patch as file and add it to the _link file.
1422 You can also specify text which will be inserted at the top of the spec file.
1424 See the examples in the _link file.
1427 osc linkpac SOURCEPRJ SOURCEPAC DESTPRJ [DESTPAC]
1431 args = slash_split(args)
1433 if not args or len(args) < 3:
1434 raise oscerr.WrongArgs('Incorrect number of arguments.\n\n' \
1435 + self.get_cmd_help('linkpac'))
1437 rev, dummy = parseRevisionOption(opts.revision)
1439 src_project = args[0]
1440 src_package = args[1]
1441 dst_project = args[2]
1443 dst_package = args[3]
1445 dst_package = src_package
1447 if src_project == dst_project and src_package == dst_package:
1448 raise oscerr.WrongArgs('Error: source and destination are the same.')
1450 if src_project == dst_project and not opts.cicount:
1451 # in this case, the user usually wants to build different spec
1452 # files from the same source
1453 opts.cicount = "copy"
1456 rev = show_upstream_rev(conf.config['apiurl'], src_project, src_package)
1458 if rev and not checkRevision(src_project, src_package, rev):
1459 print >>sys.stderr, 'Revision \'%s\' does not exist' % rev
1462 link_pac(src_project, src_package, dst_project, dst_package, opts.force, rev, opts.cicount, opts.disable_publish)
1464 @cmdln.option('-m', '--map-repo', metavar='SRC=TARGET[,SRC=TARGET]',
1465 help='Allows repository mapping(s) to be given as SRC=TARGET[,SRC=TARGET]')
1466 @cmdln.option('-d', '--disable-publish', action='store_true',
1467 help='disable publishing of the aggregated package')
1468 def do_aggregatepac(self, subcmd, opts, *args):
1469 """${cmd_name}: "Aggregate" a package to another package
1471 Aggregation of a package means that the build results (binaries) of a
1472 package are basically copied into another project.
1473 This can be used to make packages available from building that are
1474 needed in a project but available only in a different project. Note
1475 that this is done at the expense of disk space. See
1476 http://en.opensuse.org/Build_Service/Tips_and_Tricks#_link_and__aggregate
1477 for more information.
1479 The DESTPAC name is optional; the source packages' name will be used if
1483 osc aggregatepac SOURCEPRJ SOURCEPAC DESTPRJ [DESTPAC]
1487 args = slash_split(args)
1489 if not args or len(args) < 3:
1490 raise oscerr.WrongArgs('Incorrect number of arguments.\n\n' \
1491 + self.get_cmd_help('aggregatepac'))
1493 src_project = args[0]
1494 src_package = args[1]
1495 dst_project = args[2]
1497 dst_package = args[3]
1499 dst_package = src_package
1501 if src_project == dst_project and src_package == dst_package:
1502 raise oscerr.WrongArgs('Error: source and destination are the same.')
1506 for pair in opts.map_repo.split(','):
1507 src_tgt = pair.split('=')
1508 if len(src_tgt) != 2:
1509 raise oscerr.WrongOptions('map "%s" must be SRC=TARGET[,SRC=TARGET]' % opts.map_repo)
1510 repo_map[src_tgt[0]] = src_tgt[1]
1512 aggregate_pac(src_project, src_package, dst_project, dst_package, repo_map, opts.disable_publish)
1515 @cmdln.option('-c', '--client-side-copy', action='store_true',
1516 help='do a (slower) client-side copy')
1517 @cmdln.option('-k', '--keep-maintainers', action='store_true',
1518 help='keep original maintainers. Default is remove all and replace with the one calling the script.')
1519 @cmdln.option('-d', '--keep-develproject', action='store_true',
1520 help='keep develproject tag in the package metadata')
1521 @cmdln.option('-r', '--revision', metavar='rev',
1522 help='link the specified revision.')
1523 @cmdln.option('-t', '--to-apiurl', metavar='URL',
1524 help='URL of destination api server. Default is the source api server.')
1525 @cmdln.option('-m', '--message', metavar='TEXT',
1526 help='specify message TEXT')
1527 @cmdln.option('-e', '--expand', action='store_true',
1528 help='if the source package is a link then copy the expanded version of the link')
1529 def do_copypac(self, subcmd, opts, *args):
1530 """${cmd_name}: Copy a package
1532 A way to copy package to somewhere else.
1534 It can be done across buildservice instances, if the -t option is used.
1535 In that case, a client-side copy is implied.
1537 Using --client-side-copy always involves downloading all files, and
1538 uploading them to the target.
1540 The DESTPAC name is optional; the source packages' name will be used if
1544 osc copypac SOURCEPRJ SOURCEPAC DESTPRJ [DESTPAC]
1548 args = slash_split(args)
1550 if not args or len(args) < 3:
1551 raise oscerr.WrongArgs('Incorrect number of arguments.\n\n' \
1552 + self.get_cmd_help('copypac'))
1554 src_project = args[0]
1555 src_package = args[1]
1556 dst_project = args[2]
1558 dst_package = args[3]
1560 dst_package = src_package
1562 src_apiurl = conf.config['apiurl']
1564 dst_apiurl = conf.config['apiurl_aliases'].get(opts.to_apiurl, opts.to_apiurl)
1566 dst_apiurl = src_apiurl
1568 if src_apiurl != dst_apiurl:
1569 opts.client_side_copy = True
1571 rev, dummy = parseRevisionOption(opts.revision)
1574 comment = opts.message
1577 rev = show_upstream_rev(src_apiurl, src_project, src_package)
1578 comment = 'osc copypac from project:%s package:%s revision:%s' % ( src_project, src_package, rev )
1580 if src_project == dst_project and \
1581 src_package == dst_package and \
1583 src_apiurl == dst_apiurl:
1584 raise oscerr.WrongArgs('Source and destination are the same.')
1586 r = copy_pac(src_apiurl, src_project, src_package,
1587 dst_apiurl, dst_project, dst_package,
1588 client_side_copy=opts.client_side_copy,
1589 keep_maintainers=opts.keep_maintainers,
1590 keep_develproject=opts.keep_develproject,
1597 @cmdln.option('-c', '--checkout', action='store_true',
1598 help='Checkout branched package afterwards ' \
1599 '(\'osc bco\' is a shorthand for this option)' )
1600 @cmdln.option('-a', '--attribute', metavar='ATTRIBUTE',
1601 help='Use this attribute to find affected packages (default is OBS:Maintained)')
1602 @cmdln.option('-u', '--update-project-attribute', metavar='UPDATE_ATTRIBUTE',
1603 help='Use this attribute to find update projects (default is OBS:UpdateProject) ')
1604 def do_mbranch(self, subcmd, opts, *args):
1605 """${cmd_name}: Multiple branch of a package
1607 [See http://en.opensuse.org/Build_Service/Concepts/Maintenance for information
1610 This command is used for creating multiple links of defined version of a package
1611 in one project. This is esp. used for maintenance updates.
1613 The branched package will live in
1614 home:USERNAME:branches:ATTRIBUTE:PACKAGE
1615 if nothing else specified.
1618 osc mbranch [ SOURCEPACKAGE [ TARGETPROJECT ] ]
1621 args = slash_split(args)
1624 maintained_attribute = conf.config['maintained_attribute']
1625 maintained_update_project_attribute = conf.config['maintained_update_project_attribute']
1627 if not len(args) or len(args) > 2:
1628 raise oscerr.WrongArgs('Wrong number of arguments.')
1634 r = attribute_branch_pkg(conf.config['apiurl'], maintained_attribute, maintained_update_project_attribute, \
1638 print >>sys.stderr, 'ERROR: Attribute branch call came not back with a project.'
1641 print "Project " + r + " created."
1644 init_project_dir(conf.config['apiurl'], r, r)
1645 print statfrmt('A', r)
1648 for package in meta_get_packagelist(conf.config['apiurl'], r):
1650 checkout_package(conf.config['apiurl'], r, package, expand_link = True, prj_dir = r)
1652 print >>sys.stderr, 'Error while checkout package:\n', package
1654 if conf.config['verbose']:
1655 print 'Note: You can use "osc delete" or "osc submitpac" when done.\n'
1658 @cmdln.alias('branchco')
1660 @cmdln.alias('getpac')
1661 @cmdln.option('--nodevelproject', action='store_true',
1662 help='do not follow a defined devel project ' \
1663 '(primary project where a package is developed)')
1664 @cmdln.option('-c', '--checkout', action='store_true',
1665 help='Checkout branched package afterwards ' \
1666 '(\'osc bco\' is a shorthand for this option)' )
1667 @cmdln.option('-r', '--revision', metavar='rev',
1668 help='branch against a specific revision')
1669 @cmdln.option('-m', '--message', metavar='TEXT',
1670 help='specify message TEXT')
1671 def do_branch(self, subcmd, opts, *args):
1672 """${cmd_name}: Branch a package
1674 [See http://en.opensuse.org/Build_Service/Collaboration for information
1677 Create a source link from a package of an existing project to a new
1678 subproject of the requesters home project (home:branches:)
1680 The branched package will live in
1681 home:USERNAME:branches:PROJECT/PACKAGE
1682 if nothing else specified.
1684 With getpac or bco, the branched package will come from
1685 %(getpac_default_project)s
1686 if nothing else specified.
1690 osc branch SOURCEPROJECT SOURCEPACKAGE
1691 osc branch SOURCEPROJECT SOURCEPACKAGE TARGETPROJECT
1692 osc branch SOURCEPROJECT SOURCEPACKAGE TARGETPROJECT TARGETPACKAGE
1693 osc getpac SOURCEPACKAGE
1698 if subcmd == 'getpac' or subcmd == 'branchco' or subcmd == 'bco': opts.checkout = True
1699 args = slash_split(args)
1700 tproject = tpackage = None
1702 if (subcmd == 'getpac' or subcmd == 'bco') and len(args) == 1:
1703 print >>sys.stderr, 'defaulting to %s/%s' % (conf.config['getpac_default_project'], args[0])
1704 # python has no args.unshift ???
1705 args = [ conf.config['getpac_default_project'] , args[0] ]
1707 if len(args) == 0 and is_package_dir('.'):
1708 args = (store_read_project('.'), store_read_package('.'))
1710 if len(args) < 2 or len(args) > 4:
1711 raise oscerr.WrongArgs('Wrong number of arguments.')
1713 expected = 'home:%s:branches:%s' % (conf.config['user'], args[0])
1715 expected = tproject = args[2]
1719 if not opts.message:
1720 footer='please specify the purpose of your branch'
1721 template='This package was branched from %s in order to ...\n' % args[0]
1722 opts.message = edit_message(footer, template)
1724 exists, targetprj, targetpkg, srcprj, srcpkg = \
1725 branch_pkg(conf.config['apiurl'], args[0], args[1],
1726 nodevelproject=opts.nodevelproject, rev=opts.revision,
1727 target_project=tproject, target_package=tpackage,
1728 return_existing=opts.checkout, msg=opts.message or '')
1730 print >>sys.stderr, 'Using existing branch project: %s' % targetprj
1733 if not exists and (srcprj is not None and srcprj != args[0] or \
1734 srcprj is None and targetprj != expected):
1735 devloc = srcprj or targetprj
1736 if not srcprj and 'branches:' in targetprj:
1737 devloc = targetprj.split('branches:')[1]
1738 print '\nNote: The branch has been created of a different project,\n' \
1740 ' which is the primary location of where development for\n' \
1741 ' that package takes place.\n' \
1742 ' That\'s also where you would normally make changes against.\n' \
1743 ' A direct branch of the specified package can be forced\n' \
1744 ' with the --nodevelproject option.\n' % devloc
1746 package = tpackage or args[1]
1748 checkout_package(conf.config['apiurl'], targetprj, package,
1749 expand_link=True, prj_dir=targetprj)
1750 if conf.config['verbose']:
1751 print 'Note: You can use "osc delete" or "osc submitpac" when done.\n'
1754 if conf.get_configParser().get('general', 'apiurl') != conf.config['apiurl']:
1755 apiopt = '-A %s ' % conf.config['apiurl']
1756 print 'A working copy of the branched package can be checked out with:\n\n' \
1758 % (apiopt, targetprj, package)
1759 print_request_list(conf.config['apiurl'], args[0], args[1])
1761 print_request_list(conf.config['apiurl'], devloc, args[1])
1765 @cmdln.option('-f', '--force', action='store_true',
1766 help='deletes a package or an empty project')
1767 def do_rdelete(self, subcmd, opts, *args):
1768 """${cmd_name}: Delete a project or packages on the server.
1770 As a safety measure, project must be empty (i.e., you need to delete all
1771 packages first). If you are sure that you want to remove this project and all
1772 its packages use \'--force\' switch.
1775 osc rdelete -f PROJECT
1776 osc rdelete PROJECT PACKAGE [PACKAGE ...]
1781 args = slash_split(args)
1783 raise oscerr.WrongArgs('Missing argument.')
1789 # careful: if pkg is an empty string, the package delete request results
1790 # into a project delete request - which works recursively...
1792 delete_package(conf.config['apiurl'], prj, pkg)
1793 elif len(meta_get_packagelist(conf.config['apiurl'], prj)) >= 1 and not opts.force:
1794 print >>sys.stderr, 'Project contains packages. It must be empty before deleting it. ' \
1795 'If you are sure that you want to remove this project and all its ' \
1796 'packages use the \'--force\' switch'
1799 delete_project(conf.config['apiurl'], prj)
1802 def do_deletepac(self, subcmd, opts, *args):
1803 print """${cmd_name} is obsolete !
1806 osc delete for checked out packages or projects
1808 osc rdelete for server side operations."""
1813 @cmdln.option('-f', '--force', action='store_true',
1814 help='deletes a project and its packages')
1815 def do_deleteprj(self, subcmd, opts, project):
1816 """${cmd_name} is obsolete !
1823 @cmdln.alias('metafromspec')
1824 @cmdln.option('', '--specfile', metavar='FILE',
1825 help='Path to specfile. (if you pass more than working copy this option is ignored)')
1826 def do_updatepacmetafromspec(self, subcmd, opts, *args):
1827 """${cmd_name}: Update package meta information from a specfile
1829 ARG, if specified, is a package working copy.
1835 args = parseargs(args)
1836 if opts.specfile and len(args) == 1:
1837 specfile = opts.specfile
1840 pacs = findpacs(args)
1842 p.read_meta_from_spec(specfile)
1843 p.update_package_meta()
1847 @cmdln.option('-c', '--change', metavar='rev',
1848 help='the change made by revision rev (like -r rev-1:rev).'
1849 'If rev is negative this is like -r rev:rev-1.')
1850 @cmdln.option('-r', '--revision', metavar='rev1[:rev2]',
1851 help='If rev1 is specified it will compare your working copy against '
1852 'the revision (rev1) on the server. '
1853 'If rev1 and rev2 are specified it will compare rev1 against rev2 '
1854 '(NOTE: changes in your working copy are ignored in this case)')
1855 @cmdln.option('-p', '--plain', action='store_true',
1856 help='output the diff in plain (not unified) diff format')
1857 @cmdln.option('--missingok', action='store_true',
1858 help='do not fail if the source or target project/package does not exist on the server')
1859 def do_diff(self, subcmd, opts, *args):
1860 """${cmd_name}: Generates a diff
1862 Generates a diff, comparing local changes against the repository
1865 ARG, specified, is a filename to include in the diff.
1871 args = parseargs(args)
1872 pacs = findpacs(args)
1876 rev = int(opts.change)
1886 print >>sys.stderr, 'Revision \'%s\' not an integer' % opts.change
1889 rev1, rev2 = parseRevisionOption(opts.revision)
1893 diff += ''.join(make_diff(pac, rev1))
1895 diff += server_diff(pac.apiurl, pac.prjname, pac.name, rev1,
1896 pac.prjname, pac.name, rev2, not opts.plain, opts.missingok)
1901 @cmdln.option('--oldprj', metavar='OLDPRJ',
1902 help='project to compare against'
1903 ' (deprecated, use 3 argument form)')
1904 @cmdln.option('--oldpkg', metavar='OLDPKG',
1905 help='package to compare against'
1906 ' (deprecated, use 3 argument form)')
1907 @cmdln.option('-r', '--revision', metavar='N[:M]',
1908 help='revision id, where N = old revision and M = new revision')
1909 @cmdln.option('-p', '--plain', action='store_true',
1910 help='output the diff in plain (not unified) diff format')
1911 @cmdln.option('-c', '--change', metavar='rev',
1912 help='the change made by revision rev (like -r rev-1:rev). '
1913 'If rev is negative this is like -r rev:rev-1.')
1914 @cmdln.option('--missingok', action='store_true',
1915 help='do not fail if the source or target project/package does not exist on the server')
1916 def do_rdiff(self, subcmd, opts, *args):
1917 """${cmd_name}: Server-side "pretty" diff of two packages
1919 Compares two packages (three or four arguments) or shows the
1920 changes of a specified revision of a package (two arguments)
1922 If no revision is specified the latest revision is used.
1924 Note that this command doesn't return a normal diff (which could be
1925 applied as patch), but a "pretty" diff, which also compares the content
1930 osc ${cmd_name} OLDPRJ OLDPAC NEWPRJ [NEWPAC]
1931 osc ${cmd_name} PROJECT PACKAGE
1935 args = slash_split(args)
1946 new_project = args[0]
1947 new_package = args[1]
1949 old_project = opts.oldprj
1951 old_package = opts.oldpkg
1952 elif len(args) == 3 or len(args) == 4:
1953 if opts.oldprj or opts.oldpkg:
1954 raise oscerr.WrongArgs('--oldpkg and --oldprj are only valid with two arguments')
1955 old_project = args[0]
1956 new_package = old_package = args[1]
1957 new_project = args[2]
1959 new_package = args[3]
1961 raise oscerr.WrongArgs('Wrong number of arguments')
1966 rev = int(opts.change)
1976 print >>sys.stderr, 'Revision \'%s\' not an integer' % opts.change
1980 rev1, rev2 = parseRevisionOption(opts.revision)
1982 rdiff = server_diff(conf.config['apiurl'],
1983 old_project, old_package, rev1,
1984 new_project, new_package, rev2, not opts.plain, opts.missingok)
1989 def do_install(self, subcmd, opts, *args):
1990 """${cmd_name}: install a package after build via zypper in -r
1992 Not implemented yet. Use osc repourls,
1993 select the url you best like (standard),
1994 chop off after the last /, this should work with zypper.
2001 args = slash_split(args)
2002 args = expand_proj_pack(args)
2005 ## if there is only one argument, and it ends in .ymp
2006 ## then fetch it, Parse XML to get the first
2007 ## metapackage.group.repositories.repository.url
2008 ## and construct zypper cmd's for all
2009 ## metapackage.group.software.item.name
2011 ## if args[0] is already an url, the use it as is.
2013 cmd = "sudo zypper -p http://download.opensuse.org/repositories/%s/%s --no-refresh -v in %s" % (re.sub(':',':/',args[0]), 'openSUSE_11.1', args[1])
2014 print self.do_install.__doc__
2015 print "Example: \n" + cmd
2018 def do_repourls(self, subcmd, opts, *args):
2019 """${cmd_name}: Shows URLs of .repo files
2021 Shows URLs on which to access the project .repos files (yum-style
2022 metadata) on download.opensuse.org.
2025 osc repourls [PROJECT]
2030 apiurl = self.get_api_url()
2034 elif len(args) == 0:
2035 project = store_read_project('.')
2037 raise oscerr.WrongArgs('Wrong number of arguments')
2039 # XXX: API should somehow tell that
2040 url_tmpl = 'http://download.opensuse.org/repositories/%s/%s/%s.repo'
2041 repos = get_repositories_of_project(apiurl, project)
2043 print url_tmpl % (project.replace(':', ':/'), repo, project)
2046 @cmdln.option('-r', '--revision', metavar='rev',
2047 help='checkout the specified revision. '
2048 'NOTE: if you checkout the complete project '
2049 'this option is ignored!')
2050 @cmdln.option('-e', '--expand-link', action='store_true',
2051 help='if a package is a link, check out the expanded '
2052 'sources (no-op, since this became the default)')
2053 @cmdln.option('-u', '--unexpand-link', action='store_true',
2054 help='if a package is a link, check out the _link file ' \
2055 'instead of the expanded sources')
2056 @cmdln.option('-c', '--current-dir', action='store_true',
2057 help='place PACKAGE folder in the current directory' \
2058 'instead of a PROJECT/PACKAGE directory')
2059 @cmdln.option('-s', '--source-service-files', action='store_true',
2060 help='server side generated files of source services' \
2061 'gets downloaded as well' )
2062 @cmdln.option('-l', '--limit-size', metavar='limit_size',
2063 help='Skip all files with a given size')
2065 def do_checkout(self, subcmd, opts, *args):
2066 """${cmd_name}: Check out content from the repository
2068 Check out content from the repository server, creating a local working
2071 When checking out a single package, the option --revision can be used
2072 to specify a revision of the package to be checked out.
2074 When a package is a source link, then it will be checked out in
2075 expanded form. If --unexpand-link option is used, the checkout will
2076 instead produce the raw _link file plus patches.
2079 osc co PROJECT [PACKAGE] [FILE]
2080 osc co PROJECT # entire project
2081 osc co PROJECT PACKAGE # a package
2082 osc co PROJECT PACKAGE FILE # single file -> to current dir
2084 while inside a project directory:
2085 osc co PACKAGE # check out PACKAGE from project
2090 if opts.unexpand_link:
2094 if opts.source_service_files:
2095 service_files = True
2097 service_files = False
2099 args = slash_split(args)
2100 project = package = filename = None
2102 apiurl = self.get_api_url()
2105 project = project_dir = args[0]
2111 if args and len(args) == 1:
2112 localdir = os.getcwd()
2113 if is_project_dir(localdir):
2114 project = store_read_project(localdir)
2115 project_dir = localdir
2118 rev, dummy = parseRevisionOption(opts.revision)
2122 if rev and rev != "latest" and not checkRevision(project, package, rev):
2123 print >>sys.stderr, 'Revision \'%s\' does not exist' % rev
2127 get_source_file(apiurl, project, package, filename, revision=rev, progress_obj=self.download_progress)
2130 if opts.current_dir:
2132 checkout_package(apiurl, project, package, rev, expand_link=expand_link, \
2133 prj_dir=project_dir, service_files=service_files, progress_obj=self.download_progress, limit_size=opts.limit_size)
2134 print_request_list(apiurl, project, package)
2138 if sys.platform[:3] == 'win':
2139 prj_dir = prj_dir.replace(':', ';')
2140 if os.path.exists(prj_dir):
2141 sys.exit('osc: project \'%s\' already exists' % project)
2143 # check if the project does exist (show_project_meta will throw an exception)
2144 show_project_meta(apiurl, project)
2146 init_project_dir(apiurl, prj_dir, project)
2147 print statfrmt('A', prj_dir)
2150 for package in meta_get_packagelist(apiurl, project):
2152 checkout_package(apiurl, project, package, expand_link = expand_link, \
2153 prj_dir = prj_dir, service_files = service_files, progress_obj=self.download_progress, limit_size=opts.limit_size)
2154 except oscerr.LinkExpandError, e:
2155 print >>sys.stderr, 'Link cannot be expanded:\n', e
2156 print >>sys.stderr, 'Use "osc repairlink" for fixing merge conflicts:\n'
2157 # check out in unexpanded form at least
2158 checkout_package(apiurl, project, package, expand_link = False, \
2159 prj_dir = prj_dir, service_files = service_files, progress_obj=self.download_progress, limit_size=opts.limit_size)
2160 print_request_list(apiurl, project)
2163 raise oscerr.WrongArgs('Missing argument.\n\n' \
2164 + self.get_cmd_help('checkout'))
2167 @cmdln.option('-q', '--quiet', action='store_true',
2168 help='print as little as possible')
2169 @cmdln.option('-v', '--verbose', action='store_true',
2170 help='print extra information')
2172 def do_status(self, subcmd, opts, *args):
2173 """${cmd_name}: Show status of files in working copy
2175 Show the status of files in a local working copy, indicating whether
2176 files have been changed locally, deleted, added, ...
2178 The first column in the output specifies the status and is one of the
2179 following characters:
2180 ' ' no modifications
2185 '?' item is not under version control
2186 '!' item is missing (removed by non-osc command) or incomplete
2191 osc st file1 file2 ...
2194 osc status [OPTS] [PATH...]
2198 args = parseargs(args)
2200 # storage for single Package() objects
2202 # storage for a project dir ( { prj_instance : [ package objects ] } )
2205 # when 'status' is run inside a project dir, it should
2206 # stat all packages existing in the wc
2207 if is_project_dir(arg):
2208 prj = Project(arg, False)
2210 if conf.config['do_package_tracking']:
2212 for pac in prj.pacs_have:
2213 # we cannot create package objects if the dir does not exist
2214 if not pac in prj.pacs_broken:
2215 prjpacs[prj].append(os.path.join(arg, pac))
2217 pacpaths += [arg + '/' + n for n in prj.pacs_have]
2218 elif is_package_dir(arg):
2219 pacpaths.append(arg)
2220 elif os.path.isfile(arg):
2221 pacpaths.append(arg)
2223 msg = '\'%s\' is neither a project or a package directory' % arg
2224 raise oscerr.NoWorkingCopy, msg
2226 # process single packages
2227 lines = getStatus(findpacs(pacpaths), None, opts.verbose, opts.quiet)
2228 # process project dirs
2229 for prj, pacs in prjpacs.iteritems():
2230 lines += getStatus(findpacs(pacs), prj, opts.verbose, opts.quiet)
2232 print '\n'.join(lines)
2235 def do_add(self, subcmd, opts, *args):
2236 """${cmd_name}: Mark files to be added upon the next commit
2239 osc add FILE [FILE...]
2243 raise oscerr.WrongArgs('Missing argument.\n\n' \
2244 + self.get_cmd_help('add'))
2246 filenames = parseargs(args)
2250 def do_mkpac(self, subcmd, opts, *args):
2251 """${cmd_name}: Create a new package under version control
2254 osc mkpac new_package
2257 if not conf.config['do_package_tracking']:
2258 print >>sys.stderr, "to use this feature you have to enable \'do_package_tracking\' " \
2259 "in the [general] section in the configuration file"
2263 raise oscerr.WrongArgs('Wrong number of arguments.')
2265 createPackageDir(args[0])
2267 @cmdln.option('-r', '--recursive', action='store_true',
2268 help='If CWD is a project dir then scan all package dirs as well')
2270 def do_addremove(self, subcmd, opts, *args):
2271 """${cmd_name}: Adds new files, removes disappeared files
2273 Adds all files new in the local copy, and removes all disappeared files.
2275 ARG, if specified, is a package working copy.
2281 args = parseargs(args)
2283 for arg in arg_list:
2284 if is_project_dir(arg) and conf.config['do_package_tracking']:
2285 prj = Project(arg, False)
2286 for pac in prj.pacs_unvers:
2287 pac_dir = getTransActPath(os.path.join(prj.dir, pac))
2288 if os.path.isdir(pac_dir):
2289 addFiles([pac_dir], prj)
2290 for pac in prj.pacs_broken:
2291 if prj.get_state(pac) != 'D':
2292 prj.set_state(pac, 'D')
2293 print statfrmt('D', getTransActPath(os.path.join(prj.dir, pac)))
2295 for pac in prj.pacs_have:
2296 state = prj.get_state(pac)
2297 if state != None and state != 'D':
2298 pac_dir = getTransActPath(os.path.join(prj.dir, pac))
2299 args.append(pac_dir)
2301 prj.write_packages()
2302 elif is_project_dir(arg):
2303 print >>sys.stderr, 'osc: addremove is not supported in a project dir unless ' \
2304 '\'do_package_tracking\' is enabled in the configuration file'
2307 pacs = findpacs(args)
2309 p.todo = p.filenamelist + p.filenamelist_unvers
2311 for filename in p.todo:
2312 if os.path.isdir(filename):
2314 # ignore foo.rXX, foo.mine for files which are in 'C' state
2315 if os.path.splitext(filename)[0] in p.in_conflict:
2317 state = p.status(filename)
2320 # TODO: should ignore typical backup files suffix ~ or .orig
2322 print statfrmt('A', getTransActPath(os.path.join(p.dir, filename)))
2324 p.put_on_deletelist(filename)
2325 p.write_deletelist()
2326 os.unlink(os.path.join(p.storedir, filename))
2327 print statfrmt('D', getTransActPath(os.path.join(p.dir, filename)))
2332 @cmdln.alias('checkin')
2333 @cmdln.option('-m', '--message', metavar='TEXT',
2334 help='specify log message TEXT')
2335 @cmdln.option('-F', '--file', metavar='FILE',
2336 help='read log message from FILE')
2337 @cmdln.option('-f', '--force', default=False, action="store_true",
2338 help='force commit - do not tests a file list')
2339 def do_commit(self, subcmd, opts, *args):
2340 """${cmd_name}: Upload content to the repository server
2342 Upload content which is changed in your working copy, to the repository
2345 Optionally checks the state of a working copy, if found a file with
2346 unknown state, it requests an user input:
2347 * skip - don't change anything, just move to another file
2348 * remove - remove a file from dir
2349 * edit file list - edit filelist using EDITOR
2350 * commit - don't check anything and commit package
2351 * abort - abort commit - this is default value
2352 This can be supressed by check_filelist config item, or -f/--force
2353 command line option.
2356 osc ci # current dir
2358 osc ci file1 file2 ...
2364 args = parseargs(args)
2371 msg = open(opts.file).read()
2373 sys.exit('could not open file \'%s\'.' % opts.file)
2376 for arg in arg_list:
2377 if conf.config['do_package_tracking'] and is_project_dir(arg):
2378 Project(arg).commit(msg=msg)
2380 msg = edit_message()
2383 pacs = findpacs(args)
2385 if conf.config['check_filelist'] and not opts.force:
2386 check_filelist_before_commit(pacs)
2389 template = store_read_file(os.path.abspath('.'), '_commit_msg')
2390 # open editor for commit message
2391 # but first, produce status and diff to append to the template
2395 changed = getStatus([pac], quiet=True)
2398 diffs += ['\nDiff for working copy: %s' % pac.dir]
2399 diffs += make_diff(pac, 0)
2400 lines.extend(get_commit_message_template(pac))
2401 if template == None:
2402 template='\n'.join(lines)
2403 # if footer is empty, there is nothing to commit, and no edit needed.
2405 msg = edit_message(footer='\n'.join(footer), template=template)
2408 store_write_string(os.path.abspath('.'), '_commit_msg', msg)
2410 store_unlink_file(os.path.abspath('.'), '_commit_msg')
2412 if conf.config['do_package_tracking'] and len(pacs) > 0:
2416 # it is possible to commit packages from different projects at the same
2417 # time: iterate over all pacs and put each pac to the right project in the dict
2419 path = os.path.normpath(os.path.join(pac.dir, os.pardir))
2420 if is_project_dir(path):
2421 pac_path = os.path.basename(os.path.normpath(pac.absdir))
2422 prj_paths.setdefault(path, []).append(pac_path)
2423 files[pac_path] = pac.todo
2425 single_paths.append(pac.dir)
2426 for prj, packages in prj_paths.iteritems():
2427 Project(prj).commit(tuple(packages), msg, files)
2428 for pac in single_paths:
2429 Package(pac).commit(msg)
2434 store_unlink_file(os.path.abspath('.'), '_commit_msg')
2436 @cmdln.option('-r', '--revision', metavar='REV',
2437 help='update to specified revision (this option will be ignored '
2438 'if you are going to update the complete project or more than '
2440 @cmdln.option('-u', '--unexpand-link', action='store_true',
2441 help='if a package is an expanded link, update to the raw _link file')
2442 @cmdln.option('-e', '--expand-link', action='store_true',
2443 help='if a package is a link, update to the expanded sources')
2444 @cmdln.option('-s', '--source-service-files', action='store_true',
2445 help='Use server side generated sources instead of local generation.' )
2446 @cmdln.option('-l', '--limit-size', metavar='limit_size',
2447 help='Skip all files with a given size')
2449 def do_update(self, subcmd, opts, *args):
2450 """${cmd_name}: Update a working copy
2455 If the current working directory is a package, update it.
2456 If the directory is a project directory, update all contained
2457 packages, AND check out newly added packages.
2459 To update only checked out packages, without checking out new
2460 ones, you might want to use "osc up *" from within the project
2464 Update the packages specified by the path argument(s)
2466 When --expand-link is used with source link packages, the expanded
2467 sources will be checked out. Without this option, the _link file and
2468 patches will be checked out. The option --unexpand-link can be used to
2469 switch back to the "raw" source with a _link file plus patch(es).
2475 if (opts.expand_link and opts.unexpand_link) \
2476 or (opts.expand_link and opts.revision) \
2477 or (opts.unexpand_link and opts.revision):
2478 raise oscerr.WrongOptions('Sorry, the options --expand-link, --unexpand-link and '
2479 '--revision are mutually exclusive.')
2481 if opts.source_service_files: service_files = True
2482 else: service_files = False
2484 args = parseargs(args)
2487 for arg in arg_list:
2488 if is_project_dir(arg):
2489 prj = Project(arg, progress_obj=self.download_progress)
2491 if conf.config['do_package_tracking']:
2492 prj.update(expand_link=opts.expand_link,
2493 unexpand_link=opts.unexpand_link)
2496 # if not tracking package, and 'update' is run inside a project dir,
2497 # it should do the following:
2498 # (a) update all packages
2499 args += prj.pacs_have
2500 # (b) fetch new packages
2501 prj.checkout_missing_pacs(expand_link = not opts.unexpand_link)
2503 print_request_list(prj.apiurl, prj.name)
2506 pacs = findpacs(args, progress_obj=self.download_progress)
2508 if opts.revision and len(args) == 1:
2509 rev, dummy = parseRevisionOption(opts.revision)
2510 if not checkRevision(pacs[0].prjname, pacs[0].name, rev, pacs[0].apiurl):
2511 print >>sys.stderr, 'Revision \'%s\' does not exist' % rev
2518 print 'Updating %s' % p.name
2520 # FIXME: ugly workaround for #399247
2521 if opts.expand_link or opts.unexpand_link:
2522 if [ i for i in p.filenamelist+p.filenamelist_unvers if p.status(i) != ' ' and p.status(i) != '?']:
2523 print >>sys.stderr, 'osc: cannot expand/unexpand because your working ' \
2524 'copy has local modifications.\nPlease revert/commit them ' \
2529 if opts.expand_link and p.islink() and not p.isexpanded():
2530 if p.haslinkerror():
2532 rev = show_upstream_xsrcmd5(p.apiurl, p.prjname, p.name, revision=p.rev)
2534 rev = show_upstream_xsrcmd5(p.apiurl, p.prjname, p.name, revision=p.rev, linkrev="base")
2537 rev = p.linkinfo.xsrcmd5
2538 print 'Expanding to rev', rev
2539 elif opts.unexpand_link and p.islink() and p.isexpanded():
2540 print 'Unexpanding to rev', p.linkinfo.lsrcmd5
2541 rev = p.linkinfo.lsrcmd5
2542 elif p.islink() and p.isexpanded():
2543 rev = p.latest_rev()
2545 p.update(rev, service_files, opts.limit_size)
2546 if opts.unexpand_link:
2549 print_request_list(p.apiurl, p.prjname, p.name)
2552 @cmdln.option('-f', '--force', action='store_true',
2553 help='forces removal of entire package and its files')
2556 @cmdln.alias('remove')
2557 def do_delete(self, subcmd, opts, *args):
2558 """${cmd_name}: Mark files or package directories to be deleted upon the next 'checkin'
2561 cd .../PROJECT/PACKAGE
2562 osc delete FILE [...]
2564 osc delete PACKAGE [...]
2566 This command works on check out copies. Use "rdelete" for working on server
2567 side only. This is needed for removing the entire project.
2569 As a safety measure, projects must be empty (i.e., you need to delete all
2572 If you are sure that you want to remove a package and all
2573 its files use \'--force\' switch. Sometimes this also works without --force.
2579 raise oscerr.WrongArgs('Missing argument.\n\n' \
2580 + self.get_cmd_help('delete'))
2582 args = parseargs(args)
2583 # check if args contains a package which was removed by
2584 # a non-osc command and mark it with the 'D'-state
2587 if not os.path.exists(i):
2588 prj_dir, pac_dir = getPrjPacPaths(i)
2589 if is_project_dir(prj_dir):
2590 prj = Project(prj_dir, False)
2591 if i in prj.pacs_broken:
2592 if prj.get_state(i) != 'A':
2593 prj.set_state(pac_dir, 'D')
2595 prj.del_package_node(i)
2596 print statfrmt('D', getTransActPath(i))
2598 prj.write_packages()
2599 pacs = findpacs(args)
2603 prj_dir, pac_dir = getPrjPacPaths(p.absdir)
2604 if is_project_dir(prj_dir):
2605 if conf.config['do_package_tracking']:
2606 prj = Project(prj_dir, False)
2607 prj.delPackage(p, opts.force)
2609 print "WARNING: package tracking is disabled, operation skipped !"
2611 pathn = getTransActPath(p.dir)
2612 for filename in p.todo:
2613 ret, state = p.delete_file(filename, opts.force)
2615 print statfrmt('D', os.path.join(pathn, filename))
2618 sys.exit('\'%s\' is not under version control' % filename)
2619 elif state in ['A', 'M'] and not opts.force:
2620 sys.exit('\'%s\' has local modifications (use --force to remove this file)' % filename)
2623 def do_resolved(self, subcmd, opts, *args):
2624 """${cmd_name}: Remove 'conflicted' state on working copy files
2626 If an upstream change can't be merged automatically, a file is put into
2627 in 'conflicted' ('C') state. Within the file, conflicts are marked with
2628 special <<<<<<< as well as ======== and >>>>>>> lines.
2630 After manually resolving all conflicting parts, use this command to
2631 remove the 'conflicted' state.
2633 Note: this subcommand does not semantically resolve conflicts or
2634 remove conflict markers; it merely removes the conflict-related
2635 artifact files and allows PATH to be committed again.
2638 osc resolved FILE [FILE...]
2643 raise oscerr.WrongArgs('Missing argument.\n\n' \
2644 + self.get_cmd_help('resolved'))
2646 args = parseargs(args)
2647 pacs = findpacs(args)
2650 for filename in p.todo:
2651 print 'Resolved conflicted state of "%s"' % filename
2652 p.clear_from_conflictlist(filename)
2655 @cmdln.alias('platforms')
2656 def do_repositories(self, subcmd, opts, *args):
2657 """${cmd_name}: Shows available repositories
2661 Shows all available repositories/build targets
2663 2. osc repositories <project>
2664 Shows the configured repositories/build targets of a project
2672 print '\n'.join(get_repositories_of_project(conf.config['apiurl'], project))
2674 print '\n'.join(get_repositories(conf.config['apiurl']))
2678 def do_results_meta(self, subcmd, opts, *args):
2679 print "Command results_meta is obsolete. Please use: osc results --xml"
2683 @cmdln.option('-l', '--last-build', action='store_true',
2684 help='show last build results (succeeded/failed/unknown)')
2685 @cmdln.option('-r', '--repo', action='append', default = [],
2686 help='Show results only for specified repo(s)')
2687 @cmdln.option('-a', '--arch', action='append', default = [],
2688 help='Show results only for specified architecture(s)')
2689 @cmdln.option('', '--xml', action='store_true',
2690 help='generate output in XML (former results_meta)')
2691 def do_rresults(self, subcmd, opts, *args):
2692 print "Command rresults is obsolete. Running 'osc results' instead"
2693 self.do_results('results', opts, *args)
2697 @cmdln.option('-f', '--force', action='store_true', default=False,
2698 help="Don't ask and delete files")
2699 def do_rremove(self, subcmd, opts, project, package, *files):
2700 """${cmd_name}: Remove source files from selected package
2707 if not '/' in project:
2708 raise oscerr.WrongArgs("Missing operand, type osc help rremove for help")
2711 project, package = project.split('/')
2715 resp = raw_input("rm: remove source file `%s' from `%s/%s'? (yY|nN) " % (file, project, package))
2716 if resp not in ('y', 'Y'):
2719 delete_files(conf.config['apiurl'], project, package, (file, ))
2720 except urllib2.HTTPError, e:
2722 print >>sys.stderr, e
2724 if e.code in [ 400, 403, 404, 500 ]:
2725 if '<summary>' in body:
2726 msg = body.split('<summary>')[1]
2727 msg = msg.split('</summary>')[0]
2728 print >>sys.stderr, msg
2733 @cmdln.option('-l', '--last-build', action='store_true',
2734 help='show last build results (succeeded/failed/unknown)')
2735 @cmdln.option('-r', '--repo', action='append', default = [],
2736 help='Show results only for specified repo(s)')
2737 @cmdln.option('-a', '--arch', action='append', default = [],
2738 help='Show results only for specified architecture(s)')
2739 @cmdln.option('', '--xml', action='store_true', default=False,
2740 help='generate output in XML (former results_meta)')
2741 @cmdln.option('', '--csv', action='store_true', default=False,
2742 help='generate output in CSV format')
2743 @cmdln.option('', '--format', default='%(repository)s|%(arch)s|%(state)s|%(dirty)s|%(code)s|%(details)s',
2744 help='format string for csv output')
2745 def do_results(self, subcmd, opts, *args):
2746 """${cmd_name}: Shows the build results of a package
2749 osc results (inside working copy)
2750 osc results remote_project remote_package
2755 args = slash_split(args)
2757 apiurl = self.get_api_url()
2760 if is_project_dir(wd):
2764 opts.hide_legend = None
2765 opts.name_filter = None
2766 opts.status_filter = None
2767 opts.vertical = None
2768 self.do_prjresults('prjresults', opts, *args)
2771 project = store_read_project(wd)
2772 package = store_read_package(wd)
2774 raise oscerr.WrongArgs('Too few arguments (required none or two)')
2776 raise oscerr.WrongArgs('Too many arguments (required none or two)')
2781 if opts.xml and opts.csv:
2782 raise oscerr.WrongOptions("--xml and --csv are mutual exclusive")
2785 func = show_results_meta
2789 return format_results(get_package_results(*args), opts.format)
2796 print delim.join(func(apiurl, project, package, opts.last_build, opts.repo, opts.arch))
2798 # WARNING: this function is also called by do_results. You need to set a default there
2799 # as well when adding a new option!
2800 @cmdln.option('-q', '--hide-legend', action='store_true',
2801 help='hide the legend')
2802 @cmdln.option('-c', '--csv', action='store_true',
2804 @cmdln.option('-s', '--status-filter', metavar='STATUS',
2805 help='show only packages with buildstatus STATUS (see legend)')
2806 @cmdln.option('-n', '--name-filter', metavar='EXPR',
2807 help='show only packages whose names match EXPR')
2808 @cmdln.option('-a', '--arch', metavar='ARCH',
2809 help='show results only for specified architecture(s)')
2810 @cmdln.option('-r', '--repo', metavar='REPO',
2811 help='show results only for specified repo(s)')
2812 @cmdln.option('-V', '--vertical', action='store_true',
2813 help='list packages vertically instead horizontally')
2815 def do_prjresults(self, subcmd, opts, *args):
2816 """${cmd_name}: Shows project-wide build results
2819 osc prjresults (inside working copy)
2820 osc prjresults PROJECT
2824 apiurl = self.get_api_url()
2830 raise oscerr.WrongArgs('Wrong number of arguments.')
2833 project = store_read_project(wd)
2835 print '\n'.join(get_prj_results(apiurl, project, hide_legend=opts.hide_legend, csv=opts.csv, status_filter=opts.status_filter, name_filter=opts.name_filter, repo=opts.repo, arch=opts.arch, vertical=opts.vertical))
2838 @cmdln.option('-q', '--hide-legend', action='store_true',
2839 help='hide the legend')
2840 @cmdln.option('-c', '--csv', action='store_true',
2842 @cmdln.option('-s', '--status-filter', metavar='STATUS',
2843 help='show only packages with buildstatus STATUS (see legend)')
2844 @cmdln.option('-n', '--name-filter', metavar='EXPR',
2845 help='show only packages whose names match EXPR')
2848 def do_rprjresults(self, subcmd, opts, *args):
2849 print "Command rprjresults is obsolete. Please use 'osc prjresults'"
2853 @cmdln.option('-s', '--start', metavar='START',
2854 help='get log starting from the offset')
2855 def do_buildlog(self, subcmd, opts, *args):
2856 """${cmd_name}: Shows the build log of a package
2858 Shows the log file of the build of a package. Can be used to follow the
2859 log while it is being written.
2860 Needs to be called from within a package directory.
2862 The arguments REPOSITORY and ARCH are the first two columns in the 'osc
2863 results' output. If the buildlog url is used buildlog command has the
2864 same behavior as remotebuildlog.
2866 ${cmd_usage} [REPOSITORY ARCH | BUILDLOGURL]
2870 repository = arch = None
2872 apiurl = self.get_api_url()
2874 if len(args) == 1 and args[0].startswith('http'):
2875 apiurl, project, package, repository, arch = parse_buildlogurl(args[0])
2878 package = store_read_package(wd)
2879 project = store_read_project(wd)
2883 offset = int(opts.start)
2885 if not repository or not arch:
2889 repository = args[0]
2892 print_buildlog(apiurl, project, package, repository, arch, offset)
2895 def print_repos(self):
2898 if is_package_dir(wd):
2901 elif is_project_dir(wd):
2906 print 'Valid arguments for this %s are:' % str
2908 self.do_repos(None, None)
2910 raise oscerr.WrongArgs('Missing arguments')
2913 @cmdln.alias('rbuildlog')
2914 @cmdln.option('-s', '--start', metavar='START',
2915 help='get log starting from the offset')
2916 def do_remotebuildlog(self, subcmd, opts, *args):
2917 """${cmd_name}: Shows the build log of a package
2919 Shows the log file of the build of a package. Can be used to follow the
2920 log while it is being written.
2923 osc remotebuildlog project package repository arch
2925 osc remotebuildlog project/package/repository/arch
2927 osc remotebuildlog buildlogurl
2930 if len(args) == 1 and args[0].startswith('http'):
2931 apiurl, project, package, repository, arch = parse_buildlogurl(args[0])
2933 args = slash_split(args)
2934 apiurl = conf.config['apiurl']
2936 raise oscerr.WrongArgs('Too few arguments.')
2938 raise oscerr.WrongArgs('Too many arguments.')
2940 project, package, repository, arch = args
2944 offset = int(opts.start)
2946 print_buildlog(apiurl, project, package, repository, arch, offset)
2949 @cmdln.option('-s', '--start', metavar='START',
2950 help='get log starting from offset')
2951 def do_localbuildlog(self, subcmd, opts, *args):
2952 """${cmd_name}: Shows the build log of a local buildchroot
2955 osc lbl [REPOSITORY ARCH]
2956 osc lbl # show log of newest last local build
2960 if conf.config['build-type']:
2961 # FIXME: raise Exception instead
2962 print >>sys.stderr, 'Not implemented for VMs'
2966 package = store_read_package('.')
2968 files = glob.glob(os.path.join(os.getcwd(), store, "_buildinfo-*"))
2971 raise oscerr.WrongArgs('No buildconfig found, please specify repo and arch manually.')
2975 if os.stat(f).st_mtime > os.stat(cfg).st_mtime:
2977 root = ET.parse(cfg).getroot()
2978 project = root.get("project")
2979 repo = root.get("repository")
2980 arch = root.find("arch").text
2981 elif len(args) == 2:
2982 project = store_read_project('.')
2983 package = store_read_package('.')
2987 if is_package_dir(os.curdir):
2989 raise oscerr.WrongArgs('Wrong number of arguments.')
2991 buildroot = os.environ.get('OSC_BUILD_ROOT', conf.config['build-root'])
2992 buildroot = buildroot % {'project': project, 'package': package,
2993 'repo': repo, 'arch': arch}
2996 offset = int(opts.start)
2997 logfile = os.path.join(buildroot, '.build.log')
2998 if not os.path.isfile(logfile):
2999 raise oscerr.OscIOError(None, 'logfile \'%s\' does not exist' % logfile)
3000 f = open(logfile, 'r')
3002 data = f.read(BUFSIZE)
3004 sys.stdout.write(data)
3005 data = f.read(BUFSIZE)
3009 def do_triggerreason(self, subcmd, opts, *args):
3010 """${cmd_name}: Show reason why a package got triggered to build
3012 The server decides when a package needs to get rebuild, this command
3013 shows the detailed reason for a package. A brief reason is also stored
3014 in the jobhistory, which can be accessed via "osc jobhistory".
3016 Trigger reasons might be:
3017 - new build (never build yet or rebuild manually forced)
3018 - source change (eg. on updating sources)
3019 - meta change (packages which are used for building have changed)
3020 - rebuild count sync (In case that it is configured to sync release numbers)
3022 usage in package or project directory:
3023 osc reason REPOSITORY ARCH
3024 osc reason PROJECT PACKAGE REPOSITORY ARCH
3029 args = slash_split(args)
3030 project = package = repository = arch = None
3035 apiurl = self.get_api_url()
3037 if len(args) == 2: # 2
3038 if is_package_dir('.'):
3039 package = store_read_package(wd)
3041 raise oscerr.WrongArgs('package is not specified.')
3042 project = store_read_project(wd)
3043 repository = args[0]
3045 elif len(args) == 4:
3048 repository = args[2]
3051 raise oscerr.WrongArgs('Too many arguments.')
3053 print apiurl, project, package, repository, arch
3054 xml = show_package_trigger_reason(apiurl, project, package, repository, arch)
3055 root = ET.fromstring(xml)
3056 reason = root.find('explain').text
3058 if reason == "meta change":
3059 print "changed keys:"
3060 for package in root.findall('packagechange'):
3061 print " ", package.get('change'), package.get('key')
3064 # FIXME: the new osc syntax should allow to specify multiple packages
3065 # FIXME: the command should optionally use buildinfo data to show all dependencies
3066 @cmdln.alias('whatdependson')
3067 def do_dependson(self, subcmd, opts, *args):
3068 """${cmd_name}: Show the build dependencies
3070 The command dependson and whatdependson can be used to find out what
3071 will be triggered when a certain package changes.
3072 This is no guarantee, since the new build might have changed dependencies.
3074 dependson shows the build dependencies inside of a project, valid for a
3075 given repository and architecture.
3076 NOTE: to see all binary packages, which can trigger a build you need to
3077 refer the buildinfo, since this command shows only the dependencies
3078 inside of a project.
3080 The arguments REPOSITORY and ARCH can be taken from the first two columns
3081 of the 'osc repos' output.
3083 usage in package or project directory:
3084 osc dependson REPOSITORY ARCH
3085 osc whatdependson REPOSITORY ARCH
3088 osc dependson PROJECT [PACKAGE] REPOSITORY ARCH
3089 osc whatdependson PROJECT [PACKAGE] REPOSITORY ARCH
3094 args = slash_split(args)
3095 project = packages = repository = arch = reverse = None