#!/usr/bin/env python
# -*- encoding: utf-8 -*-
"""Generate a reST file from configuration files
"""
import argparse
import ConfigParser
import csv
import logging
import os
import sys
import yaml
_logger = logging.getLogger(__name__)
__version__ = '0.1.0'
__date__ = '2016-07-15'
__updated__ = '2016-07-15'
def main(argv=None): # IGNORE:C0111
"""Parse arguments and launch conversion
"""
if argv is None:
argv = sys.argv
else:
sys.argv.extend(argv)
program_version = __version__
program_build_date = str(__updated__)
program_version_message = '%%(prog)s %s (%s)' % (
program_version, program_build_date)
program_shortdesc = __doc__.split("\n")[1]
program_license = '''%s
Created by Vincent Hatakeyama on %s.
Copyright 2016 XCG Consulting. All rights reserved.
Licensed under the MIT License
Distributed on an "AS IS" basis without warranties
or conditions of any kind, either express or implied.
USAGE
''' % (
program_shortdesc,
str(__date__),
)
# Argument parsing
parser = argparse.ArgumentParser(
description=program_license,
formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument(
'-V', '--version', action='version',
version=program_version_message)
parser.add_argument(
'-v', '--verbose', dest='verbose', action='count',
help="set verbosity level [default: %(default)s]")
parser.add_argument(
'-d',
'--directory',
help="Source directory [default: %(default)s]",
default='..',
)
parser.add_argument(
'-o',
'--output',
help="Output file name",
)
nmspc = parser.parse_args()
verbose = nmspc.verbose
if not verbose:
logging.basicConfig(level=logging.WARN)
if verbose == 1:
logging.basicConfig(level=logging.INFO)
if verbose and verbose > 1:
logging.basicConfig(level=logging.DEBUG)
basedir = os.path.dirname(sys.argv[0])
conf2rst(basedir, nmspc.directory, nmspc.output)
def conf2rst(basedir, directory, output=None):
"""
:param basedir: directory with the odoo_versions.csv file
:param output: file to write to, else prints in stdout
"""
# read setup.cfg
parser = ConfigParser.ConfigParser()
setup_path = os.path.join(directory, 'setup.cfg')
parser.read(setup_path)
odoo_type = parser.get('odoo_scripts', 'odoo_type', 'odoo8')
addon_dirs = parser.get('odoo_scripts', 'addon_dirs', '').split()
# analyse Dockerfile if any
if 'odoo_type' != 'bzr':
dockerfile_path = os.path.join(directory, 'Dockerfile')
with open(dockerfile_path) as dockerfile_file:
for line in dockerfile_file:
if line.startswith('FROM '):
dockerbase = line[5:].strip()
_logger.info("Docker base: %s", dockerbase)
# load odoo_version.csv
versions = {}
# add path to script
with open(os.path.join(basedir, 'odoo_versions.csv')) as versions_file:
reader = csv.reader(versions_file, delimiter=',')
for line in reader:
versions[line[0]] = line[1]
if odoo_type != 'bzr':
odoo_version = versions.get(dockerbase, "Unknown")
else:
odoo_version = 'bzr'
_logger.info("Odoo version %s", odoo_version)
rst = {
'odoo': {"Odoo": {'version': odoo_version}},
'tools': {}, 'modules': {}, 'other': {}, 'group of modules': {}
}
# load the conf file
# test if there is a .hgconf file
hgconf_path = os.path.join(directory, '.hgconf')
if os.path.exists(hgconf_path):
_logger.debug("Found .hgconf at %s", hgconf_path)
parser = ConfigParser.ConfigParser()
parser.read(hgconf_path)
for section in parser.sections():
layout = parser.get(section, 'layout')
if layout == 'odoo_scripts':
group = 'tools'
elif any(layout == addon_dir for addon_dir in addon_dirs):
group = 'group of modules'
elif any(
layout.startswith(addon_dir) for addon_dir in addon_dirs
):
group = 'modules'
else:
group = 'other'
rst[group][section] = {
'version': parser.get(section, 'track'),
'repository': parser.get(section, 'pulluri'),
}
# handle nest.yaml case
confnest_path = os.path.join(directory, 'nest.yaml')
if os.path.exists(confnest_path):
_logger.debug("Found nest.yaml at %s", confnest_path)
stream = open(confnest_path, 'r')
data = yaml.safe_load(stream)
repos = data['repos']
for module in repos:
layout = repos[module]['layout']
if layout == 'odoo_scripts':
group = 'tools'
elif any(layout == addon_dir for addon_dir in addon_dirs):
group = 'group of modules'
elif any(
layout.startswith(addon_dir) for addon_dir in addon_dirs
):
group = 'modules'
else:
group = 'other'
rst[group][module] = {
'version': repos[module]['track'],
'repository': repos[module]['pulluri'],
}
# output the rst
if output:
with open(output, 'wb') as output_file:
write_rst(output_file, rst)
else:
write_rst(sys.stdout, rst)
def write_rst(out, rst, headers=True):
"""Write rst to out (be it an open file or std out).
We use anonymous links here (2 underscores) to avoid conflicts when the
same version is shared by 2 repos (as the "link target" system would then
be in use).
"""
out.write("Versions\n")
out.write("========\n\n")
for group in ('odoo', 'modules', 'group of modules', 'other', 'tools'):
if rst.get(group):
out.write(".. list-table:: %s\n" % group)
out.write(" :widths: 2 3\n")
if headers:
out.write(" :header-rows: 1\n")
out.write("\n")
if headers:
out.write(" * - element\n")
out.write(" - version\n")
for element in rst[group].keys():
out.write(" * - %s\n" % element)
version = rst[group][element]['version']
repository = rst[group][element].get('repository', '')
if repository.startswith('ssh://hg@bitbucket.org/'):
text = '`%s <%s/commits/%s>`__' % (
version,
repository.replace(
'ssh://hg@bitbucket.org/',
'https://bitbucket.org/'),
version)
elif repository.startswith('git@bitbucket.org:'):
text = '`%s <%s/commits/%s>`__' % (
version,
repository.replace(
'git@bitbucket.org:',
'https://bitbucket.org/').replace('.git', ''),
version)
else:
text = version
out.write(" - %s\n" % text)
out.write("\n")
if __name__ == '__main__':
main()