From a84eadd788ec9544c79b26a47f5ef34f6b34c359 Mon Sep 17 00:00:00 2001 From: Michal 'vorner' Vaner Date: Wed, 9 Mar 2011 23:42:52 +0100 Subject: [PATCH] [trac610] Test work with separate builddir If we ask python to import module.submodule, it gets the first module/ directory with __init__.py in it. This is a problem if our module (actually bindctl program) has some generated and some ready files. So this uses the module.submodule only for the not generated ones, and has module/ directly in path for the generated (we import submodule, not module.submodule). This is only in the test. --- src/bin/bindctl/Makefile.am | 5 +- src/bin/bindctl/bindctl-source.py.in | 138 ++++++++++++++++++++++++++ src/bin/bindctl/tests/Makefile.am | 2 +- src/bin/bindctl/tests/bindctl_test.py | 2 +- 4 files changed, 143 insertions(+), 4 deletions(-) create mode 100755 src/bin/bindctl/bindctl-source.py.in diff --git a/src/bin/bindctl/Makefile.am b/src/bin/bindctl/Makefile.am index 13a5c7fdea..2f412ece88 100644 --- a/src/bin/bindctl/Makefile.am +++ b/src/bin/bindctl/Makefile.am @@ -5,12 +5,13 @@ man_MANS = bindctl.1 EXTRA_DIST = $(man_MANS) bindctl.xml -python_PYTHON = __init__.py bindcmd.py cmdparse.py exception.py moduleinfo.py mycollections.py +python_PYTHON = __init__.py bindcmd.py cmdparse.py exception.py moduleinfo.py \ + mycollections.py pythondir = $(pyexecdir)/bindctl bindctldir = $(pkgdatadir) -CLEANFILES = bindctl +CLEANFILES = bindctl bindctl_main.pyc if ENABLE_MAN diff --git a/src/bin/bindctl/bindctl-source.py.in b/src/bin/bindctl/bindctl-source.py.in new file mode 100755 index 0000000000..01307e9798 --- /dev/null +++ b/src/bin/bindctl/bindctl-source.py.in @@ -0,0 +1,138 @@ +#!@PYTHON@ + +# Copyright (C) 2009 Internet Systems Consortium. +# +# Permission to use, copy, modify, and distribute this software for any +# purpose with or without fee is hereby granted, provided that the above +# copyright notice and this permission notice appear in all copies. +# +# THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SYSTEMS CONSORTIUM +# DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL +# INTERNET SYSTEMS CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, +# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING +# FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, +# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION +# WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +"""This is the main calling class for the bindctl configuration and + command tool. It sets up a command interpreter and runs that.""" + +import sys; sys.path.append ('@@PYTHONPATH@@') + +from bindctl.moduleinfo import * +from bindctl.bindcmd import * +import pprint +from optparse import OptionParser, OptionValueError +import isc.util.process + +isc.util.process.rename() + +# This is the version that gets displayed to the user. +# The VERSION string consists of the module name, the module version +# number, and the overall BIND 10 version number (set in configure.ac). +VERSION = "bindctl 20110217 (BIND 10 @PACKAGE_VERSION@)" + +DEFAULT_IDENTIFIER_DESC = "The identifier specifies the config item. Child elements are separated with the '/' character. List indices can be specified with '[i]', where i is an integer specifying the index, starting with 0. Examples: 'Boss/start_auth', 'Recurse/listen_on[0]/address'. If no identifier is given, shows the item at the current location." + +def prepare_config_commands(tool): + '''Prepare fixed commands for local configuration editing''' + module = ModuleInfo(name = CONFIG_MODULE_NAME, desc = "Configuration commands.") + cmd = CommandInfo(name = "show", desc = "Show configuration.") + param = ParamInfo(name = "argument", type = "string", optional=True, desc = "If you specify the argument 'all' (before the identifier), recursively show all child elements for the given identifier.") + cmd.add_param(param) + param = ParamInfo(name = "identifier", type = "string", optional=True, desc = DEFAULT_IDENTIFIER_DESC) + cmd.add_param(param) + module.add_command(cmd) + + cmd = CommandInfo(name = "show_json", desc = "Show full configuration in JSON format.") + param = ParamInfo(name = "identifier", type = "string", optional=True, desc = DEFAULT_IDENTIFIER_DESC) + cmd.add_param(param) + module.add_command(cmd) + + cmd = CommandInfo(name = "add", desc = "Add an entry to configuration list. If no value is given, a default value is added.") + param = ParamInfo(name = "identifier", type = "string", optional=True, desc = DEFAULT_IDENTIFIER_DESC) + cmd.add_param(param) + param = ParamInfo(name = "value", type = "string", optional=True, desc = "Specifies a value to add to the list. It must be in correct JSON format and complete.") + cmd.add_param(param) + module.add_command(cmd) + + cmd = CommandInfo(name = "remove", desc = "Remove entry from configuration list.") + param = ParamInfo(name = "identifier", type = "string", optional=True, desc = DEFAULT_IDENTIFIER_DESC) + cmd.add_param(param) + param = ParamInfo(name = "value", type = "string", optional=True, desc = "Specifies a value to remove from the list. It must be in correct JSON format and complete.") + cmd.add_param(param) + module.add_command(cmd) + + cmd = CommandInfo(name = "set", desc = "Set a configuration value.") + param = ParamInfo(name = "identifier", type = "string", optional=True, desc = DEFAULT_IDENTIFIER_DESC) + cmd.add_param(param) + param = ParamInfo(name = "value", type = "string", optional=False, desc = "Specifies a value to set. It must be in correct JSON format and complete.") + cmd.add_param(param) + module.add_command(cmd) + + cmd = CommandInfo(name = "unset", desc = "Unset a configuration value (i.e. revert to the default, if any).") + param = ParamInfo(name = "identifier", type = "string", optional=False, desc = DEFAULT_IDENTIFIER_DESC) + cmd.add_param(param) + module.add_command(cmd) + + cmd = CommandInfo(name = "diff", desc = "Show all local changes that have not been committed.") + module.add_command(cmd) + + cmd = CommandInfo(name = "revert", desc = "Revert all local changes.") + module.add_command(cmd) + + cmd = CommandInfo(name = "commit", desc = "Commit all local changes.") + module.add_command(cmd) + + cmd = CommandInfo(name = "go", desc = "Go to a specific configuration part.") + param = ParamInfo(name = "identifier", type="string", optional=False, desc = DEFAULT_IDENTIFIER_DESC) + cmd.add_param(param) + module.add_command(cmd) + + tool.add_module_info(module) + +def check_port(option, opt_str, value, parser): + if (value < 0) or (value > 65535): + raise OptionValueError('%s requires a port number (0-65535)' % opt_str) + parser.values.port = value + +def check_addr(option, opt_str, value, parser): + ipstr = value + ip_family = socket.AF_INET + if (ipstr.find(':') != -1): + ip_family = socket.AF_INET6 + + try: + socket.inet_pton(ip_family, ipstr) + except: + raise OptionValueError("%s invalid ip address" % ipstr) + + parser.values.addr = value + +def set_bindctl_options(parser): + parser.add_option('-p', '--port', dest='port', type='int', + action='callback', callback=check_port, + default='8080', help='port for cmdctl of bind10') + + parser.add_option('-a', '--address', dest='addr', type='string', + action='callback', callback=check_addr, + default='127.0.0.1', help='IP address for cmdctl of bind10') + + parser.add_option('-c', '--certificate-chain', dest='cert_chain', + type='string', action='store', + help='PEM formatted server certificate validation chain file') + + parser.add_option('--csv-file-dir', dest='csv_file_dir', type='string', + default=None, action='store', + help='Directory to store the password CSV file') + +if __name__ == '__main__': + parser = OptionParser(version = VERSION) + set_bindctl_options(parser) + (options, args) = parser.parse_args() + server_addr = options.addr + ':' + str(options.port) + tool = BindCmdInterpreter(server_addr, pem_file=options.cert_chain, + csv_file_dir=options.csv_file_dir) + prepare_config_commands(tool) + tool.run() diff --git a/src/bin/bindctl/tests/Makefile.am b/src/bin/bindctl/tests/Makefile.am index 8a7a6237b9..d2bb90fe71 100644 --- a/src/bin/bindctl/tests/Makefile.am +++ b/src/bin/bindctl/tests/Makefile.am @@ -11,6 +11,6 @@ if ENABLE_PYTHON_COVERAGE endif for pytest in $(PYTESTS) ; do \ echo Running test: $$pytest ; \ - env PYTHONPATH=$(abs_top_srcdir)/src/lib/python:$(abs_top_builddir)/src/lib/python:$(abs_top_srcdir)/src/bin \ + env PYTHONPATH=$(abs_top_srcdir)/src/lib/python:$(abs_top_builddir)/src/lib/python:$(abs_top_builddir)/src/bin/bindctl:$(abs_top_srcdir)/src/bin \ $(PYCOVERAGE_RUN) $(abs_srcdir)/$$pytest || exit ; \ done diff --git a/src/bin/bindctl/tests/bindctl_test.py b/src/bin/bindctl/tests/bindctl_test.py index 34f684345e..dd492c11f5 100644 --- a/src/bin/bindctl/tests/bindctl_test.py +++ b/src/bin/bindctl/tests/bindctl_test.py @@ -22,7 +22,7 @@ import getpass from optparse import OptionParser from isc.config.config_data import ConfigData, MultiConfigData from isc.config.module_spec import ModuleSpec -from bindctl.bindctl_source import set_bindctl_options +from bindctl_main import set_bindctl_options from bindctl import cmdparse from bindctl import bindcmd from bindctl.moduleinfo import *