cubicweb: comparison cwctl.py

equal deleted inserted replaced

-:2cf127d4f5fd
+:b4bcabf55e77
 def kill(*args):
 """win32 kill implementation"""
 def getpgid():
 """win32 getpgid implementation"""
 from logilab.common.clcommands import CommandLine
 from logilab.common.shellutils import ASK
+from logilab.common.configuration import merge_options
 from cubicweb import ConfigurationError, ExecutionError, BadCommandUsage
 from cubicweb.utils import support_args
 from cubicweb.cwconfig import CubicWebConfiguration as cwcfg, CWDEV, CONFIGURATIONS
 from cubicweb.toolsutils import Command, rm, create_dir, underline_title
 # base commands ###############################################################
 class ListCommand(Command):
 """List configurations, cubes and instances.
-list available configurations, installed cubes, and registered instances
+List available configurations, installed cubes, and registered instances.
+If given, the optional argument allows to restrict listing only a category of items.
 """
 name = 'list'
+arguments = '[all|cubes|configurations|instances]'
 options = (
 ('verbose',
 {'short': 'v', 'action' : 'store_true',
 'help': "display more information."}),
 )
 def run(self, args):
 """run the command with its specific arguments"""
-if args:
+if not args:
+mode = 'all'
+elif len(args) == 1:
+mode = args[0]
+else:
 raise BadCommandUsage('Too many arguments')
 from cubicweb.migration import ConfigurationProblem
-print 'CubicWeb %s (%s mode)' % (cwcfg.cubicweb_version(), cwcfg.mode)
-print
+if mode == 'all':
-print 'Available configurations:'
+print 'CubicWeb %s (%s mode)' % (cwcfg.cubicweb_version(), cwcfg.mode)
-for config in CONFIGURATIONS:
+print
-print '*', config.name
-for line in config.__doc__.splitlines():
+if mode in ('all', 'config', 'configurations'):
-line = line.strip()
+print 'Available configurations:'
-if not line:
+for config in CONFIGURATIONS:
-continue
+print '*', config.name
-print '   ', line
+for line in config.__doc__.splitlines():
-print
+line = line.strip()
-cfgpb = ConfigurationProblem(cwcfg)
+if not line:
-try:
+continue
-cubesdir = pathsep.join(cwcfg.cubes_search_path())
+print '   ', line
-namesize = max(len(x) for x in cwcfg.available_cubes())
+print
-except ConfigurationError as ex:
-print 'No cubes available:', ex
+if mode in ('all', 'cubes'):
-except ValueError:
+cfgpb = ConfigurationProblem(cwcfg)
-print 'No cubes available in %s' % cubesdir
+try:
-else:
+cubesdir = pathsep.join(cwcfg.cubes_search_path())
-print 'Available cubes (%s):' % cubesdir
+namesize = max(len(x) for x in cwcfg.available_cubes())
-for cube in cwcfg.available_cubes():
+except ConfigurationError as ex:
-try:
+print 'No cubes available:', ex
-tinfo = cwcfg.cube_pkginfo(cube)
+except ValueError:
-tversion = tinfo.version
+print 'No cubes available in %s' % cubesdir
-cfgpb.add_cube(cube, tversion)
+else:
-except (ConfigurationError, AttributeError) as ex:
+print 'Available cubes (%s):' % cubesdir
-tinfo = None
+for cube in cwcfg.available_cubes():
-tversion = '[missing cube information: %s]' % ex
+try:
-print '* %s %s' % (cube.ljust(namesize), tversion)
+tinfo = cwcfg.cube_pkginfo(cube)
-if self.config.verbose:
+tversion = tinfo.version
-if tinfo:
+cfgpb.add_cube(cube, tversion)
-descr = getattr(tinfo, 'description', '')
+except (ConfigurationError, AttributeError) as ex:
-if not descr:
+tinfo = None
-descr = getattr(tinfo, 'short_desc', '')
+tversion = '[missing cube information: %s]' % ex
+print '* %s %s' % (cube.ljust(namesize), tversion)
+if self.config.verbose:
+if tinfo:
+descr = getattr(tinfo, 'description', '')
+if not descr:
+descr = getattr(tinfo, 'short_desc', '')
+if descr:
+warn('[3.8] short_desc is deprecated, update %s'
+' pkginfo' % cube, DeprecationWarning)
+else:
+descr = tinfo.__doc__
 if descr:
-warn('[3.8] short_desc is deprecated, update %s'
+print '    '+ '    \n'.join(descr.splitlines())
-' pkginfo' % cube, DeprecationWarning)
+modes = detect_available_modes(cwcfg.cube_dir(cube))
-else:
+print '    available modes: %s' % ', '.join(modes)
-descr = tinfo.__doc__
-if descr:
-print '    '+ '    \n'.join(descr.splitlines())
-modes = detect_available_modes(cwcfg.cube_dir(cube))
-print '    available modes: %s' % ', '.join(modes)
-print
-try:
-regdir = cwcfg.instances_dir()
-except ConfigurationError as ex:
-print 'No instance available:', ex
 print
-return
-instances = list_instances(regdir)
+if mode in ('all', 'instances'):
-if instances:
+try:
-print 'Available instances (%s):' % regdir
+regdir = cwcfg.instances_dir()
-for appid in instances:
+except ConfigurationError as ex:
-modes = cwcfg.possible_configurations(appid)
+print 'No instance available:', ex
-if not modes:
+print
-print '* %s (BROKEN instance, no configuration found)' % appid
+return
-continue
+instances = list_instances(regdir)
-print '* %s (%s)' % (appid, ', '.join(modes))
+if instances:
-try:
+print 'Available instances (%s):' % regdir
-config = cwcfg.config_for(appid, modes[0])
+for appid in instances:
-except Exception as exc:
+modes = cwcfg.possible_configurations(appid)
-print '    (BROKEN instance, %s)' % exc
+if not modes:
-continue
+print '* %s (BROKEN instance, no configuration found)' % appid
-else:
+continue
-print 'No instance available in %s' % regdir
+print '* %s (%s)' % (appid, ', '.join(modes))
-print
+try:
-# configuration management problem solving
+config = cwcfg.config_for(appid, modes[0])
-cfgpb.solve()
+except Exception as exc:
-if cfgpb.warnings:
+print '    (BROKEN instance, %s)' % exc
-print 'Warnings:\n', '\n'.join('* '+txt for txt in cfgpb.warnings)
+continue
-if cfgpb.errors:
+else:
-print 'Errors:'
+print 'No instance available in %s' % regdir
-for op, cube, version, src in cfgpb.errors:
+print
-if op == 'add':
-print '* cube', cube,
+if mode == 'all':
-if version:
+# configuration management problem solving
-print ' version', version,
+cfgpb.solve()
-print 'is not installed, but required by %s' % src
+if cfgpb.warnings:
-else:
+print 'Warnings:\n', '\n'.join('* '+txt for txt in cfgpb.warnings)
-print '* cube %s version %s is installed, but version %s is required by %s' % (
+if cfgpb.errors:
-cube, cfgpb.cubes[cube], version, src)
+print 'Errors:'
+for op, cube, version, src in cfgpb.errors:
+if op == 'add':
+print '* cube', cube,
+if version:
+print ' version', version,
+print 'is not installed, but required by %s' % src
+else:
+print '* cube %s version %s is installed, but version %s is required by %s' % (
+cube, cfgpb.cubes[cube], version, src)
 def check_options_consistency(config):
 if config.automatic and config.config_level > 0:
 raise BadCommandUsage('--automatic and --config-level should not be '
 'used together')
 'default': 'all-in-one',
 'help': 'installation type, telling which part of an instance '
 'should be installed. You can list available configurations using the'
 ' "list" command. Default to "all-in-one", e.g. an installation '
 'embedding both the RQL repository and the web server.',
+}),
+('no-db-create',
+{'short': 'S',
+'action': 'store_true',
+'default': False,
+'help': 'stop after creation and do not continue with db-create',
 }),
 )
 def run(self, args):
 """run the command with its specific arguments"""
 from logilab.common.shellutils import chown
 # this directory should be owned by the uid of the server process
 print 'set %s as owner of the data directory' % config['uid']
 chown(config.appdatahome, config['uid'])
 print '\n-> creation done for %s\n' % repr(config.apphome)[1:-1]
-helper.postcreate(self.config.automatic, self.config.config_level)
+if not self.config.no_db_create:
+helper.postcreate(self.config.automatic, self.config.config_level)
 def _handle_win32(self, config, appid):
 if sys.platform != 'win32':
 return
 service_template = """
 identifiers of the instances to list versions for.
 """
 name = 'versions'
 def versions_instance(self, appid):
-from logilab.common.changelog import Version
 config = cwcfg.config_for(appid)
 # should not raise error if db versions don't match fs versions
 config.repairing = True
 if hasattr(config, 'set_sources_mode'):
 config.set_sources_mode(('migration',))
 repo = config.migration_handler().repo_connect()
 vcconf = repo.get_versions()
 for key in sorted(vcconf):
 print key+': %s.%s.%s' % vcconf[key]
 class ShellCommand(Command):
 """Run an interactive migration shell on an instance. This is a python shell
 with enhanced migration commands predefined in the namespace. An additional
 argument may be given corresponding to a file containing commands to execute
 def run(self, args):
 """run the command with its specific arguments"""
 for cube in cwcfg.available_cubes():
 print cube
+class ConfigureInstanceCommand(InstanceCommand):
+"""Configure instance.
+<instance>...
+identifier of the instance to configure.
+"""
+name = 'configure'
+actionverb = 'configured'
+options = merge_options(InstanceCommand.options +
+(('param',
+{'short': 'p', 'type' : 'named', 'metavar' : 'key1:value1,key2:value2',
+'default': None,
+'help': 'set <key> to <value> in configuration file.',
+}),
+))
+def configure_instance(self, appid):
+if self.config.param is not None:
+appcfg = cwcfg.config_for(appid)
+for key, value in self.config.param.iteritems():
+try:
+appcfg.global_set_option(key, value)
+except KeyError:
+raise ConfigurationError('unknown configuration key "%s" for mode %s' % (key, appcfg.name))
+appcfg.save()
 for cmdcls in (ListCommand,
 CreateInstanceCommand, DeleteInstanceCommand,
 StartInstanceCommand, StopInstanceCommand, RestartInstanceCommand,
 ReloadConfigurationCommand, StatusCommand,
 UpgradeInstanceCommand,
 ListVersionsInstanceCommand,
 ShellCommand,
 RecompileInstanceCatalogsCommand,
 ListInstancesCommand, ListCubesCommand,
+ConfigureInstanceCommand,
 ):
 CWCTL.register(cmdcls)
 def run(args):
 """command line tool"""
 import os
 sys.stdout = os.fdopen(sys.stdout.fileno(), 'w', 0)

branch	stable
changeset 9013	b4bcabf55e77
parent 8994	df64cca71c36
parent 9002	f98d1c46ed9f
child 9251	e4d753c8b1c4
child 9315	5298cfb132e6