rel-eng/packages/spacewalk-utils | 2
utils/spacewalk-manage-channel-lifecycle | 422 +++++++++++++++++++++++++++++++
utils/spacewalk-utils.spec | 6
3 files changed, 428 insertions(+), 2 deletions(-)
New commits:
commit a2e7756323ac813deaa34046dca96d242f63f1b1
Author: Aron Parsons <aronparsons(a)gmail.com>
Date: Sun Mar 18 17:19:04 2012 -0400
Automatic commit of package [spacewalk-utils] release [1.8.2-1].
diff --git a/rel-eng/packages/spacewalk-utils b/rel-eng/packages/spacewalk-utils
index 2a19558..71ec5ba 100644
--- a/rel-eng/packages/spacewalk-utils
+++ b/rel-eng/packages/spacewalk-utils
@@ -1 +1 @@
-1.8.1-1 utils/
+1.8.2-1 utils/
diff --git a/utils/spacewalk-utils.spec b/utils/spacewalk-utils.spec
index a6f449d..40aecd7 100644
--- a/utils/spacewalk-utils.spec
+++ b/utils/spacewalk-utils.spec
@@ -1,7 +1,7 @@
%define rhnroot %{_prefix}/share/rhn
Name: spacewalk-utils
-Version: 1.8.1
+Version: 1.8.2
Release: 1%{?dist}
Summary: Utilities that may be run against a Spacewalk server.
@@ -87,6 +87,10 @@ spacewalk-pylint $RPM_BUILD_ROOT%{rhnroot}
%changelog
+* Sun Mar 18 2012 Aron Parsons <aronparsons(a)gmail.com> 1.8.2-1
+- added spacewalk-manage-channel-lifecycle script (aronparsons(a)gmail.com)
+- spacewalk-clone-by-date manpage bugfixes/cleanups (shardy(a)redhat.com)
+
* Mon Mar 05 2012 Michael Mraka <michael.mraka(a)redhat.com> 1.8.1-1
- reused function from spacewalk.common.cli
- login(), logout() moved to spacewalk.common.cli
commit 22c0619c5c6cb556c3cacff715221d134dd21faf
Author: Aron Parsons <aronparsons(a)gmail.com>
Date: Sun Mar 18 17:18:48 2012 -0400
added spacewalk-manage-channel-lifecycle script
diff --git a/utils/spacewalk-manage-channel-lifecycle b/utils/spacewalk-manage-channel-lifecycle
new file mode 100755
index 0000000..a13aecc
--- /dev/null
+++ b/utils/spacewalk-manage-channel-lifecycle
@@ -0,0 +1,422 @@
+#!/usr/bin/python
+#
+# Licensed under the GNU General Public License Version 3
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+# Copyright 2012 Aron Parsons <aronparsons(a)gmail.com>
+#
+
+import getpass, logging, os, re, sys, time, xmlrpclib
+from optparse import Option, OptionParser
+
+SESSION_CACHE = os.path.expanduser("~/.spacewalk-manage-lifecycle-session")
+
+##############################################################################
+
+# determine the name of the next phase
+def get_next_phase(current_name):
+ try:
+ current_num = phases.index(current_name)
+ except:
+ logging.error('Invalid phase name: %s' % current_name)
+ sys.exit(1)
+
+ # return the next phase name
+ try:
+ return phases[current_num + 1]
+ except IndexError:
+ logging.error("Maximum phase exceeded! You can't move past '%s'." \
+ % phases[-1])
+ return None
+
+
+def print_channel_tree():
+ tree = {}
+
+ # determine parent channels so we can make a pretty tree for the user
+ for channel in all_channels:
+ if channel.get('parent_label'):
+ if not tree.has_key(channel.get('parent_label')):
+ tree[channel.get('parent_label')] = []
+
+ tree[channel.get('parent_label')].append(channel.get('label'))
+ else:
+ tree[channel.get('label')] = []
+
+ # print the channels in a tree format
+ for parent in sorted(tree.keys()):
+ print parent
+ if len(tree[parent]):
+ for child in sorted(tree[parent]):
+ print ' |- %s' % child
+
+ print
+
+
+def channel_exists(channel, quiet = False):
+ try:
+ details = client.channel.software.getDetails(session, channel)
+ return True
+ except xmlrpclib.Fault, e:
+ if options.debug: logging.exception(e)
+ if not quiet: logging.error('Channel %s does not exist' % channel)
+ return False
+
+
+def merge_channels(source_label, dest_label):
+ if dest_label.startswith('rhel') and not options.tolerant:
+ logging.error("Destination lablel starts with 'rhel'. Aborting!")
+ logging.error("Pass --tolerant to override this")
+ sys.exit(1)
+
+ if options.exclude_channel:
+ for pattern in options.exclude_channel:
+ if source_label == pattern:
+ logging.info('Skipping %s due to an exclude filter' \
+ % source_label)
+ return
+
+ # remove all the packages from the channel if requested
+ if options.clear_channel or options.rollback:
+ clear_channel(dest_label)
+
+ logging.info('Merging packages from %s into %s' % \
+ (source_label, dest_label))
+
+ if not options.dry_run:
+ # merge the packages from one channel into another
+ try:
+ packages = client.channel.software.mergePackages(session,
+ source_label,
+ dest_label)
+
+ logging.info('Added %i packages' % len(packages))
+ except xmlrpclib.Fault, e:
+ if options.debug: logging.exception(e)
+ logging.error('Failed to merge packages')
+
+ if options.tolerant:
+ return False
+ else:
+ sys.exit(1)
+
+ if not options.no_errata:
+ logging.info('Merging errata into %s' % dest_label)
+
+ if not options.dry_run:
+ # merge the errata from one channel into another
+ try:
+ errata = client.channel.software.mergeErrata(session,
+ source_label,
+ dest_label)
+
+ logging.info('Added %i errata' % len(errata))
+ except xmlrpclib.Fault, e:
+ if options.debug: logging.exception(e)
+ logging.error('Failed to merge errata')
+
+ if options.tolerant:
+ return False
+ else:
+ sys.exit(1)
+
+ print
+
+
+def clone_channel(source_label, details):
+ if options.exclude_channel:
+ for pattern in options.exclude_channel:
+ if source_label == pattern:
+ logging.info('Skipping %s due to an exclude filter' \
+ % source_label)
+ return
+
+ # channel doesn't exist, clone it from the original
+ logging.info('Cloning %s from %s' % (details['label'], source_label))
+
+ if not options.dry_run:
+ try:
+ client.channel.software.clone(session, source_label, details, False)
+ except xmlrpclib.Fault, e:
+ if options.debug: logging.exception(e)
+ logging.error('Failed to clone channel')
+
+ if options.tolerant:
+ return False
+ else:
+ sys.exit(1)
+
+
+def clear_channel(label):
+ logging.info('Clearing all errata from %s' % label)
+
+ if not options.dry_run:
+ # attempt to clear the errata from the channel
+ try:
+ all_errata = client.channel.software.listErrata(session, label)
+ errata_names = [ e.get('advisory_name') for e in all_errata ]
+ client.channel.software.removeErrata(session,
+ label,
+ errata_names,
+ False)
+ except xmlrpclib.Fault, e:
+ if options.debug: logging.exception(e)
+ logging.warning('Failed to clear errata from %s' % label)
+
+ if not options.dry_run:
+ logging.info('Clearing all packages from %s' % label)
+ all_packages = client.channel.software.listAllPackages(session, label)
+ package_ids = [ p.get('id') for p in all_packages ]
+ client.channel.software.removePackages(session, label, package_ids)
+
+
+def build_channel_labels(source):
+ if options.archive:
+ # prefix the existing channel with 'archive-YYYYMMDD-'
+ date_string = time.strftime('%Y%m%d', time.gmtime())
+ destination = 'archive-%s-%s' % (date_string, source)
+ elif options.init:
+ destination = '%s-%s' % (phases[0], source)
+
+ if channel_exists(destination, quiet = True):
+ logging.error('%s already exists. Use --promote instead.' \
+ % destination)
+ sys.exit(1)
+ elif options.promote:
+ # get the phase label from the channel label
+ match = re.search('^(\w+)-', source)
+
+ if match:
+ current_phase = match.group(1)
+
+ # check if this is a base channel
+ if current_phase == 'rhel':
+ destination = '%s-%s' % (phases[0], source)
+ else:
+ next_phase = get_next_phase(current_phase)
+
+ # replace the name of the phase in the destination label
+ destination = re.sub('^%s' % current_phase,
+ '%s' % next_phase,
+ source)
+ else:
+ logging.error('Invalid channel label: %s' % source)
+ sys.exit(1)
+ elif options.rollback:
+ # strip off the archive prefix when rolling back
+ destination = re.sub('archive-\d{8}-', '', source)
+
+ return (source, destination)
+
+##############################################################################
+
+usage='''usage: %prog [options]
+
+Create a 'dev' channel based on the latest packages:
+spacewalk-manage-channel-lifecycle -c rhel-x86_64-server-6 --init
+
+Promote the packages from 'dev' to 'test':
+spacewalk-manage-channel-lifecycle -c dev-rhel-x86_64-server-6 --promote
+
+Promote the packages from 'test' to 'prod':
+spacewalk-manage-channel-lifecycle -c test-rhel-x86_64-server-6 --promote
+
+Archive a production channel:
+spacewalk-manage-channel-lifecycle -c prod-rhel-x86_64-server-6 --archive
+
+Rollback the production channel to an archived version:
+spacewalk-manage-channel-lifecycle \\
+ -c archive-20110520-prod-rhel-x86_64-server-6 --rollback'''
+
+option_list = [
+ Option('-l', '--list-channels', help='list existing channels',
+ action='store_true'),
+ Option('', '--init', help='initialize a development channel',
+ action='store_true'),
+ Option('', '--promote', help='promote a channel to the next phase',
+ action='store_true'),
+ Option('', '--archive', help='archive a channel', action='store_true'),
+ Option('', '--rollback', help='rollback', action='store_true'),
+ Option('-c', '--channel', help='channel to init/promote/archive/rollback'),
+ Option('-C', '--clear-channel',
+ help='clear all packages/errata from the channel before merging',
+ action='store_true'),
+ Option('-x', '--exclude-channel', help = 'skip these channels',
+ action='append'),
+ Option('', '--no-errata', help="don't merge errata data with --promote",
+ action='store_true'),
+ Option('', '--no-children', help="don't operate on child channels",
+ action='store_true'),
+ Option('-P', '--phases', default = 'dev,test,prod',
+ help='comma-separated list of phases [default: %default]'),
+ Option('-u', '--username', help='Spacewalk username'),
+ Option('-p', '--password', help='Spacewalk password'),
+ Option('-s', '--server',
+ help='Spacewalk server [default: %default]', default='localhost'),
+ Option('-n', '--dry-run', help="don't perform any operations",
+ action='store_true'),
+ Option('-t', '--tolerant', help='be tolerant of errors',
+ action='store_true'),
+ Option('-d', '--debug', help='enable debug logging', action='count')
+]
+
+parser = OptionParser(option_list = option_list, usage = usage)
+(options, args) = parser.parse_args()
+
+if options.debug:
+ level = logging.DEBUG
+else:
+ level = logging.INFO
+
+logging.basicConfig(level = level, format='%(levelname)s: %(message)s')
+
+# sanity check
+if not (options.init or options.promote or options.archive or options.rollback \
+ or options.list_channels):
+ logging.error("You must provide an action " + \
+ "(--init/--promote/--archive/--rollback/--list-channels)")
+ sys.exit(1)
+elif not options.list_channels and not options.channel:
+ logging.error('--channel is required')
+ sys.exit(1)
+
+# parse the list of phases
+phases = options.phases.split(',')
+
+if len(phases) < 2:
+ logging.error('You must define at least 2 phases')
+ sys.exit(1)
+
+# determine if you want to enable XMLRPC debugging
+if options.debug > 1:
+ xmlrpc_debug = True
+else:
+ xmlrpc_debug = False
+
+# connect to the server
+client = xmlrpclib.Server('https://%s/rpc/api' % options.server,
+ verbose = xmlrpc_debug)
+
+session = None
+
+# check for an existing session
+if os.path.exists(SESSION_CACHE):
+ try:
+ fh = open(SESSION_CACHE, 'r')
+ session = fh.readline()
+ fh.close()
+ except IOError, e:
+ if options.debug: logging.exception(e)
+ logging.debug('Failed to read session cache')
+
+ # validate the session
+ try:
+ client.channel.listMyChannels(session)
+ except xmlrpclib.Fault, e:
+ if options.debug: logging.exception(e)
+ logging.warning('Existing session is invalid')
+ session = None
+
+if not session:
+ # prompt for the username
+ if not options.username:
+ options.username = raw_input('Spacewalk Username: ')
+
+ # prompt for the password
+ if not options.password:
+ options.password = getpass.getpass('Spacewalk Password: ')
+
+ # login to the server
+ try:
+ session = client.auth.login(options.username, options.password)
+ except xmlrpclib.Fault, e:
+ if options.debug: logging.exception(e)
+ logging.error('Failed to log into %s' % options.server)
+ sys.exit(1)
+
+ # save the session for subsuquent runs
+ try:
+ fh = open(SESSION_CACHE, 'w')
+ fh.write(session)
+ fh.close()
+ except IOError, e:
+ if options.debug: logging.exception(e)
+ logging.warning('Failed to write session cache')
+
+# list all of the channels once
+try:
+ all_channels = client.channel.listSoftwareChannels(session)
+ all_channel_labels = [ c.get('label') for c in all_channels ]
+except xmlrpclib.Fault, e:
+ if options.debug: logging.exception(e)
+ logging.error('Could not retrieve the list of software channels')
+ sys.exit(1)
+
+# list the available custom channels and exit
+if options.list_channels:
+ print_channel_tree()
+ sys.exit(0)
+
+# ensure the source channel exists
+if not channel_exists(options.channel):
+ sys.exit(1)
+
+# determine the channel labels for the parent channel
+(parent_source, parent_dest) = build_channel_labels(options.channel)
+
+# inform the user that no changes will take place
+if options.dry_run:
+ logging.info('DRY RUN - No changes are being made to the channels')
+ time.sleep(2)
+ print
+
+# merge packages/errata if the destination channel label already exists,
+# otherwise clone it from the source channel
+if parent_dest in all_channel_labels:
+ merge_channels(parent_source, parent_dest)
+else:
+ # channel doesn't exist, clone it from the original
+ details = { 'label' : parent_dest,
+ 'name' : parent_dest,
+ 'summary' : parent_dest }
+
+ clone_channel(parent_source, details)
+
+if not options.no_children:
+ children = []
+
+ # get the child channels for the source parent channel
+ for channel in all_channels:
+ if channel.get('parent_label') == parent_source:
+ children.append(channel.get('label'))
+
+ for label in children:
+ # determine the child channels for the source parent channel
+ (child_source, child_dest) = build_channel_labels(label)
+
+ # merge packages/errata if the destination channel label already exists,
+ # otherwise clone it from the source channel
+ if child_dest in all_channel_labels:
+ merge_channels(child_source, child_dest)
+ else:
+ details = { 'label' : child_dest,
+ 'name' : child_dest,
+ 'summary' : child_dest,
+ 'parent_label' : parent_dest }
+
+ clone_channel(child_source, details)
+
+# vim:ts=4:expandtab:
