Able to read and write ini configs with new arguments --config-file and --config-dump

config.ini.sample

@@ -0,0 +1,27 @@
+[djangocms_installer]
+db = sqlite://localhost/project.db
+i18n = yes
+use-tz = yes
+timezone =
+reversion = yes
+permissions = yes
+languages =
+django-version = stable
+cms-version = stable
+parent-dir = .
+bootstrap = no
+templates = no
+starting-page = no
+list-plugins = false
+dump-requirements = false
+no-input = false
+filer = false
+requirements =
+no-deps = false
+no-db-driver = false
+no-sync = false
+no-user = false
+template =
+extra-settings =
+skip-empty-check = false
+utc = false

djangocms_installer/config/__init__.py

@@ -9,7 +9,7 @@
 
 from tzlocal import get_localzone
 
-from . import data
+from . import data, ini
 from .internal import DbAction, validate_project
 from .. import compat, utils
 from ..utils import less_than_version, supported_versions
@@ -20,6 +20,12 @@ def parse(args):
     Define the available arguments
     """
     parser = argparse.ArgumentParser(description='Bootstrap a django CMS project.')
+    parser.add_argument('--config-file', dest='config_file', action='store',
+                        default=None,
+                        help='Configuration file for djangocms_installer')
+    parser.add_argument('--config-dump', dest='config_dump', action='store',
+                        default=None,
+                        help='Dump configuration file with current args')
     parser.add_argument('--db', '-d', dest='db', action=DbAction,
                         default='sqlite://localhost/project.db',
                         help='Database configuration (in URL format)')
@@ -103,7 +109,10 @@ def parse(args):
         for action in parser._positionals._actions:
             if action.dest == 'timezone':
                 action.default = 'UTC'
-    args = parser.parse_args(args)
+
+    # If config_args then pretend that config args came from the stdin and run parser again.
+    config_args = ini.parse_config_file(parser, args)
+    args = parser.parse_args(config_args + args)
 
     # First of all, check if the project name is valid
     if not validate_project(args.project_name):
@@ -129,6 +138,10 @@ def parse(args):
                          "please choose a different one\n" % args.project_path)
         sys.exit(4)
 
+    if args.config_dump and os.path.isfile(args.config_dump):
+        sys.stdout.write('Cannot dump because given configuration file "%s" is exists.\n' % args.config_dump)
+        sys.exit(8)
+
     for item in data.CONFIGURABLE_OPTIONS:
         action = parser._option_string_actions[item]
         choices = default = ""
@@ -296,6 +309,9 @@ def parse(args):
     setattr(args, 'urlconf_path',
             os.path.join(args.project_directory, args.project_name, 'urls.py').strip())
 
+    if args.config_dump:
+        ini.dump_config_file(args.config_dump, args, parser)
+
     return args
 
 

djangocms_installer/config/ini.py

@@ -0,0 +1,122 @@
+# -*- coding: utf-8 -*-
+from __future__ import print_function
+
+import sys
+
+try:
+    from configparser import ConfigParser  # Python 3.
+except ImportError:
+    from ConfigParser import ConfigParser  # Python 2.
+
+from .data import CMS_VERSION_MATRIX, DJANGO_VERSION_MATRIX
+
+
+SECTION = 'djangocms_installer'
+
+
+def parse_config_file(parser, stdin_args):
+    """Parse config file.
+
+    Returns a list of additional args.
+    """
+    config_args = []
+
+    # Temporary switch required args and save them to restore.
+    required_args = []
+    for action in parser._actions:
+        if action.required:
+            required_args.append(action)
+            action.required = False
+
+    parsed_args = parser.parse_args(stdin_args)
+
+    # Restore required args.
+    for action in required_args:
+        action.required = True
+
+    if not parsed_args.config_file:
+        return config_args
+
+    config = ConfigParser()
+    if not config.read(parsed_args.config_file):
+        sys.stderr.write("Config file '%s' doesn't exists\n" % parsed_args.config_file)
+        sys.exit(7)  # It isn't used anythere.
+
+    config_args = _convert_config_to_stdin(config, parser)
+    return config_args
+
+
+def dump_config_file(filename, args, parser=None):
+    """Dump args to config file."""
+    config = ConfigParser()
+    config.add_section(SECTION)
+    if parser is None:
+        for attr in args:
+            config.set(SECTION, attr, args.attr)
+    else:
+        keys_empty_values_not_pass = (
+            '--extra-settings', '--languages', '--requirements', '--template', '--timezone')
+
+        #_positionals._option_string_actions
+        for action in parser._actions:
+            if action.dest in ('help', 'config_file', 'config_dump', 'project_name'):
+                continue
+
+            keyp = action.option_strings[0]
+            option_name = keyp.lstrip('-')
+            option_value = getattr(args, action.dest)
+            if any([i for i in keys_empty_values_not_pass if i in action.option_strings]):
+                if action.dest == 'timezone':
+                    config.set(SECTION, option_name, option_value.zone)
+                elif action.dest == 'languages':
+                    if len(option_value) == 1 and option_value[0] == 'en':
+                        config.set(SECTION, option_name, '')
+                    else:
+                        config.set(SECTION, option_name, ','.join())
+                else:
+                    config.set(SECTION, option_name, option_value if option_value else '')
+            elif action.choices == ('yes', 'no'):
+                config.set(SECTION, option_name, 'yes' if option_value else 'no')
+            elif action.dest == 'templates':
+                config.set(SECTION, option_name, option_value if option_value else 'no')
+            elif action.dest == 'cms_version':
+                version = 'stable' if option_value == CMS_VERSION_MATRIX['stable'] else option_value
+                config.set(SECTION, option_name, version)
+            elif action.dest == 'django_version':
+                version = 'stable' if option_value == DJANGO_VERSION_MATRIX['stable'] else option_value
+                config.set(SECTION, option_name, version)
+            elif action.const:
+                config.set(SECTION, option_name, 'true' if option_value else 'false')
+            else:
+                config.set(SECTION, option_name, str(option_value))
+    with open(filename, 'w') as fp:
+        config.write(fp)
+
+
+def _convert_config_to_stdin(config, parser):
+    """Convert config options to stdin args.
+
+    Especially boolean values, for more information
+    @see https://docs.python.org/3.4/library/configparser.html#supported-datatypes
+    """
+    keys_empty_values_not_pass = (
+        '--extra-settings', '--languages', '--requirements', '--template', '--timezone')
+    args = []
+    for key, val in config.items(SECTION):
+        keyp = '--%s' % key
+        action = parser._option_string_actions[keyp]
+
+        if action.const:
+            try:
+                if config.getboolean(SECTION, key):
+                    args.append(keyp)
+            except ValueError:
+                args.extend([keyp, val])  # Pass it as is to get the error from ArgumentParser.
+        elif any([i for i in keys_empty_values_not_pass if i in action.option_strings]):
+            # Some keys with empty values shouldn't be passed into args to use their defaults from ArgumentParser.
+            if val != '':
+                args.extend([keyp, val])
+        else:
+            args.extend([keyp, val])
+
+    return args

tests/config.py

@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
 from __future__ import print_function
+from argparse import Namespace
+import copy
 import os
 import sys
 
@@ -8,10 +10,11 @@
 from tzlocal import get_localzone
 
 from djangocms_installer import config
+from djangocms_installer.config.data import CMS_VERSION_MATRIX, DJANGO_VERSION_MATRIX
 from djangocms_installer.install import check_install
 from djangocms_installer.utils import less_than_version, supported_versions
 
-from .base import BaseTestClass
+from .base import unittest, BaseTestClass
 
 
 class TestConfig(BaseTestClass):
@@ -582,3 +585,129 @@ def test_show_requirements(self):
             config.show_requirements(conf_data)
         finally:
             sys.stdout = sys.__stdout__
+
+
+class TestBaseConfig(unittest.TestCase):
+    base_dir = os.path.dirname(os.path.dirname(__file__))
+    config_dir = os.path.join(base_dir, 'tests/fixtures/configs')
+    args = ['--config-file', '-s', '-q', 'example_prj']
+    config_fixture = Namespace(**{
+        'bootstrap': False,
+        'cms_version': CMS_VERSION_MATRIX['stable'],
+        'db': 'sqlite://localhost/project.db',
+        'django_version': DJANGO_VERSION_MATRIX['stable'],
+        'dump_reqs': False,
+        'extra_settings': None,
+        'filer': False,
+        'i18n': 'yes',
+        'languages': ['en'],
+        'no_db_driver': False,
+        'no_deps': False,
+        'noinput': True,
+        'no_sync': False,
+        'no_user': False,
+        'permissions': 'yes',
+        'plugins': False,
+        'project_directory': '.',
+        'project_name': 'example_prj',
+        'requirements_file': None,
+        'reversion': 'yes',
+        'skip_project_dir_check': True,
+        'starting_page': False,
+        'template': None,
+        'templates': False,
+        'timezone': get_localzone(),
+        'use_timezone': 'yes',
+        'utc': False
+    })
+
+    def __init__(self, *args, **kwargs):
+        self.config_not_exists = self.conf('config-dump.ini')
+
+        super(TestBaseConfig, self).__init__(*args, **kwargs)
+
+    def tearDown(self):
+        if os.path.isfile(self.config_not_exists):
+            os.remove(self.config_not_exists)
+
+    def conf(self, filename):
+        return os.path.join(self.config_dir, filename)
+
+    def unused(self, config_data):
+        """Remove not configurable keys."""
+        for attr in ('aldryn', 'config_dump', 'config_file', 'db_driver', 'db_parsed',
+                     'project_path', 'settings_path', 'urlconf_path'):
+            delattr(config_data, attr)
+        # When `requirements` arg is used then requirements attr isn't set.
+        if hasattr(config_data, 'requirements'):
+            delattr(config_data, 'requirements')
+
+    @patch('sys.stdout')
+    @patch('sys.stderr')
+    def test_parse_config_file(self, *args):
+        """Tests .config.__init__._parse_config_file function."""
+        with self.assertRaises(SystemExit) as error:
+            config_data = config.parse(self.args[0:1] + [self.conf('config-not-exists.ini')] + self.args[1:])
+            self.assertEqual(7, error.exception.code)
+
+        args = self.args[0:1] + [self.conf('config-01.ini')] + self.args[1:]
+        config_data = config.parse(args)
+        self.unused(config_data)
+        self.assertEqual(self.config_fixture, config_data)
+
+        fixture = copy.copy(self.config_fixture)
+        test_data = (
+            ('config-02.ini', 'db', 'postgres://user:pwd@host:54321/dbname'),
+            ('config-03.ini', 'i18n', 'no'),
+            ('config-04.ini', 'use_timezone', 'no'),
+            ('config-05.ini', 'timezone', 'Europe/London'),
+            ('config-06.ini', 'reversion', 'no'),
+            ('config-07.ini', 'permissions', 'no'),
+            ('config-08.ini', 'languages', ['en', 'ru']),
+            ('config-09.ini', 'django_version', 1.8),
+            ('config-10.ini', 'i18n', 'no'),
+            ('config-11.ini', 'project_directory', '/test/me'),
+            ('config-12.ini', 'bootstrap', True),
+            ('config-13.ini', 'templates', '.'),
+            ('config-14.ini', 'starting_page', True),
+            ('config-15.ini', 'plugins', True),
+            ('config-16.ini', 'dump_reqs', True),
+            ('config-17.ini', 'noinput', True),
+            ('config-18.ini', 'filer', True),
+            ('config-19.ini', 'requirements_file', '/test/reqs'),
+            ('config-20.ini', 'no_deps', True),
+            ('config-21.ini', 'no_db_driver', True),
+            ('config-22.ini', 'no_sync', True),
+            ('config-23.ini', 'no_user', True),
+            ('config-24.ini', 'template', '/test/template'),
+            ('config-25.ini', 'extra_settings', '/test/extra_settings'),
+            ('config-26.ini', 'skip_project_dir_check', True),
+            ('config-27.ini', 'utc', True),
+        )
+        for filename, key, val in test_data:
+            setattr(fixture, key, val)  # Change value.
+            args = self.args[0:1] + [self.conf(filename)] + self.args[1:]  # Load new config.
+            config_data = config.parse(args)
+            self.unused(config_data)
+            self.assertEqual(fixture, config_data)  # Check if config value and changed value equals.
+
+    @patch('sys.stdout')
+    @patch('sys.stderr')
+    def test_dump_config_file(self, *args):
+        """Tests .config.ini.dump_config_file function."""
+        config_exists = self.conf('config-01.ini')
+
+        with self.assertRaises(SystemExit) as error:
+            config_data = config.parse(['--config-dump', config_exists] + self.args[1:] + ['-p', '.'])
+            self.assertEqual(8, error.exception.code)
+
+        config_data = config.parse(['--config-dump', self.config_not_exists] + self.args[1:] + ['-p', '.'])
+        self.assertTrue(os.path.isfile(self.config_not_exists))
+
+        fixture = copy.copy(self.config_fixture)
+        setattr(fixture, 'timezone', get_localzone().zone)
+        # Load dumped config.
+        args = self.args[0:1] + [self.config_not_exists] + self.args[1:]
+        config_data = config.parse(args)
+        self.unused(config_data)
+        self.assertEqual(fixture, config_data)

tests/fixtures/configs/config-01.ini

@@ -0,0 +1,27 @@
+[djangocms_installer]
+db = sqlite://localhost/project.db
+i18n = yes
+use-tz = yes
+timezone =
+reversion = yes
+permissions = yes
+languages =
+django-version = stable
+cms-version = stable
+parent-dir = .
+bootstrap = no
+templates = no
+starting-page = no
+list-plugins = false
+dump-requirements = false
+no-input = false
+filer = false
+requirements =
+no-deps = false
+no-db-driver = false
+no-sync = false
+no-user = false
+template =
+extra-settings =
+skip-empty-check = false
+utc = false