ArielGlenn has uploaded a new change for review.
https://gerrit.wikimedia.org/r/301712
Change subject: tiny script that retrieves config values from dump config files
......................................................................
tiny script that retrieves config values from dump config files
for use by bash wrappers around maintenance scripts that rely
on these config files
Bug: T141563
Change-Id: I2ba21ccaab50212b7bd33d32c7732b0c80d55c6f
---
A xmldumps-backup/getconfig.py
A xmldumps-backup/getconfigvals.py
2 files changed, 249 insertions(+), 0 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/operations/dumps
refs/changes/12/301712/1
diff --git a/xmldumps-backup/getconfig.py b/xmldumps-backup/getconfig.py
new file mode 100644
index 0000000..9d80d29
--- /dev/null
+++ b/xmldumps-backup/getconfig.py
@@ -0,0 +1,111 @@
+import ConfigParser
+import getopt
+import sys
+import os
+import json
+
+
+def get_sections_settingnames(args):
+ '''
+ given a string section1:name1,name2...;section2:name1,name2...
+ return a dict with lists of names by section
+ '''
+ fields = args.split(';')
+ sections = {}
+ for field in fields:
+ section, items = field.split(':', 1)
+ sections[section] = items.split(',')
+ return sections
+
+
+def getconfs(configfile, args):
+ '''
+ given a configfile path and a string
+ section1:name1,name2...;section2:name1,name2...
+ print a json representation of a dict with
+ the setting names and values per section
+ '''
+ conf = ConfigParser.SafeConfigParser()
+ conf.read(configfile)
+ confs = {}
+ sections = get_sections_settingnames(args)
+ for section in sections:
+ confs[section] = {}
+ for setting in sections[section]:
+ if conf.has_option(section, setting):
+ confs[section][setting] = conf.get(section, setting)
+ print json.dumps(confs)
+
+
+def usage(message=None):
+ '''
+ display a helpful usage message with
+ an optional introductory message first
+ '''
+
+ if message is not None:
+ sys.stderr.write(message)
+ sys.stderr.write("\n")
+ usage_message = """
+Usage: getconfig.py --configfile path
+ --args section:name[,name...][;section:name[,name...]]
+ [--help]
+
+Get and display in json format settings and values from a config
+file in ConfigParser format
+
+Note that this script does not load any defaults for config values.
+
+Options:
+
+ --configfile (-c): path to config fiel
+ --args (-a): names of args for which to check the config file;
+ config file section names must be specified
+ along with the arg names
+ --help (-h): display this usage message
+
+Example: getconfig.py --configfile confs/wikidump.conf --args
'tools:php,mysqldump,gzip'
+"""
+ sys.stderr.write(usage_message)
+ sys.exit(1)
+
+
+def main():
+ 'main entry point, does all the work'
+
+ configfile = None
+ args = None
+
+ try:
+ (options, remainder) = getopt.gnu_getopt(
+ sys.argv[1:], "c:a:h", ["configfile=", "args=", "help"])
+
+ except getopt.GetoptError as err:
+ usage("Unknown option specified: " + str(err))
+
+ for (opt, val) in options:
+ if opt in ["-c", "--configfile"]:
+ configfile = val
+ elif opt in ["-a", "--args"]:
+ args = val
+ elif opt in ["-h", "--help"]:
+ usage('Help for this script\n')
+ else:
+ usage("Unknown option specified: <%s>" % opt)
+
+ if len(remainder) > 0:
+ usage("Unknown option(s) specified: <%s>" % remainder[0])
+
+ if configfile is None:
+ usage("Mandatory argument --configfile not specified")
+ if args is None:
+ usage("Mandatory argument --args not specified")
+
+ if not os.path.exists(configfile):
+ usage("no such file found: " + configfile)
+
+ getconfs(configfile, args)
+
+
+if __name__ == '__main__':
+ main()
diff --git a/xmldumps-backup/getconfigvals.py b/xmldumps-backup/getconfigvals.py
new file mode 100644
index 0000000..9cc9f49
--- /dev/null
+++ b/xmldumps-backup/getconfigvals.py
@@ -0,0 +1,138 @@
+import ConfigParser
+import getopt
+import sys
+import os
+import json
+
+
+def get_sections_settingnames(args):
+ '''
+ given a string section1:name1,name2...;section2:name1,name2...
+ return a dict with lists of names by section
+ '''
+ fields = args.split(';')
+ sections = {}
+ for field in fields:
+ section, items = field.split(':', 1)
+ sections[section] = items.split(',')
+ return sections
+
+
+def getconfs(configfile, args, outformat):
+ '''
+ given a configfile path and a string
+ section1:name1,name2...;section2:name1,name2...
+ print a json representation of a dict with
+ the setting names and values per section
+ '''
+ conf = ConfigParser.SafeConfigParser()
+ conf.read(configfile)
+ confs = {}
+ sections = get_sections_settingnames(args)
+ for section in sections:
+ confs[section] = {}
+ for setting in sections[section]:
+ if conf.has_option(section, setting):
+ confs[section][setting] = conf.get(section, setting)
+ if outformat == "json":
+ print json.dumps(confs)
+ elif outformat == "txt":
+ for section in confs:
+ print "section:%s" % section
+ for item in confs[section]:
+ print "item:%s:%s" % (item, confs[section][item])
+ elif outformat == "values":
+ for section in confs:
+ for item in sorted(confs[section]):
+ print "%s" % confs[section][item]
+ else:
+ for section in confs:
+ for item in confs[section]:
+ print "%s %s" % (item, confs[section][item])
+
+
+def usage(message=None):
+ '''
+ display a helpful usage message with
+ an optional introductory message first
+ '''
+
+ if message is not None:
+ sys.stderr.write(message)
+ sys.stderr.write("\n")
+ usage_message = """
+Usage: getconfigvals.py --configfile path
+ --args section:name[,name...][;section:name[,name...]]
+ [--help]
+
+Get and display settings and values from a config file
+in ConfigParser format
+
+Note that this script does not load any defaults for config values.
+
+Options:
+
+ --configfile (-c): path to config fiel
+ --args (-a): names of args for which to check the config file;
+ config file section names must be specified
+ along with the arg names
+ --format (-f): output format (json, txt, pairs, values), default: txt
+ json does what you expect, with a dict of section names,
item names
+ and values. txt produces a text representation with each
section and
+ item on a separate line. pairs produces item names and
values
+ only, each on a separate line, space separated. values
produces
+ a list of values only, one on each line, sorted by item
name
+ within each section.
+ If an item is missing it is silently ignored.
+ --help (-h): display this usage message
+
+Example: getconfig.py --configfile confs/wikidump.conf --args
'tools:php,mysqldump,gzip'
+"""
+ sys.stderr.write(usage_message)
+ sys.exit(1)
+
+
+def main():
+ 'main entry point, does all the work'
+
+ configfile = None
+ args = None
+ outformat = "txt"
+
+ try:
+ (options, remainder) = getopt.gnu_getopt(
+ sys.argv[1:], "c:a:f:h", ["configfile=", "args=", "format=",
"help"])
+
+ except getopt.GetoptError as err:
+ usage("Unknown option specified: " + str(err))
+
+ for (opt, val) in options:
+ if opt in ["-c", "--configfile"]:
+ configfile = val
+ elif opt in ["-a", "--args"]:
+ args = val
+ elif opt in ["-f", "--format"]:
+ outformat = val
+ elif opt in ["-h", "--help"]:
+ usage('Help for this script\n')
+ else:
+ usage("Unknown option specified: <%s>" % opt)
+
+ if len(remainder) > 0:
+ usage("Unknown option(s) specified: <%s>" % remainder[0])
+
+ if configfile is None:
+ usage("Mandatory argument --configfile not specified")
+ if args is None:
+ usage("Mandatory argument --args not specified")
+ if outformat not in ["txt", "json", "pairs", "values"]:
+ usage("Unknown format type %s" % outformat)
+
+ if not os.path.exists(configfile):
+ usage("no such file found: " + configfile)
+
+ getconfs(configfile, args, outformat)
+
+
+if __name__ == '__main__':
+ main()
--
To view, visit https://gerrit.wikimedia.org/r/301712
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I2ba21ccaab50212b7bd33d32c7732b0c80d55c6f
Gerrit-PatchSet: 1
Gerrit-Project: operations/dumps
Gerrit-Branch: master
Gerrit-Owner: ArielGlenn <ar...@wikimedia.org>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
