issue2551029: Jinja2 template install error.

Issue where template's config.ini not getting updated.

Change do_install in admin.py to load config_ini.ini from template
before writing tracker's config.ini. This generates an updated
config file for the user on install preserving values required tomake
tracker work.

Added config_ini.ini files to jinja2 and responsive templates to set
required values (template_engine and static_files; static_files
resp.).

Documented new file in doc/tracker_templates.txt and added tests for
new admin.py code.

Author: rouilj

CHANGES.txt

@@ -34,7 +34,11 @@ Fixed:
 - issue2551029: Jinja2 template install error. Remove config.ini
   from templates to make sure that roundup-admin install writes a new
   default config.ini based on configuration.py.
-
+- issue2551029: Jinja2 template install error. Handle issue with
+  template's config.ini not getting updated. Provide an alternate
+  file: config_ini.ini for required config settings that are merged
+  into the default values producing an up to date config.ini on
+  install.
 
 2018-07-13 1.6.0
 

doc/tracker_templates.txt

@@ -25,6 +25,12 @@ Templates contain:
 - modules ``schema.py`` and ``initial_data.py``
 - directories ``html``, ``detectors`` and ``extensions``
   (with appropriate contents)
+- optional ``config_ini.ini`` file. It is structured like a tracker's
+  ``config.ini`` but contains only headers (e.g. ``[main]``) and
+  *required* parameters that are different from defaults:
+  e.g. ``template_engine = jinja2`` and ``static_files =
+  static``. These settings override the default values saved to the
+  tracker's ``config.ini``.
 - template "marker" file ``TEMPLATE-INFO.txt``, which contains
   the name of the template, a description of the template
   and its intended audience.

roundup/admin.py

@@ -28,7 +28,7 @@
 from roundup import date, hyperdb, roundupdb, init, password, token
 from roundup import __version__ as roundup_version
 import roundup.instance
-from roundup.configuration import CoreConfig, NoConfigError
+from roundup.configuration import CoreConfig, NoConfigError, UserConfig
 from roundup.i18n import _
 from roundup.exceptions import UsageError
 
@@ -429,9 +429,31 @@ def do_install(self, tracker_home, args):
             defns = {}
 
         defns['rdbms_backend'] = backend
+
+        # load config_ini.ini from template if it exists.
+        # it sets parameters like template_engine that are
+        # template specific.
+        template_config=UserConfig(templates[template]['path'] +
+                                   "/config_ini.ini")
+        for k in template_config.keys():
+            if k == 'HOME': # ignore home. It is a default param.
+                continue
+            defns[k] = template_config[k]
+
         # install!
         init.install(tracker_home, templates[template]['path'], settings=defns)
 
+        # Remove config_ini.ini file from tracker_home (not template dir).
+        # Ignore file not found - not all templates have
+        #   config_ini.ini files.
+        try:
+            os.remove(tracker_home + "/config_ini.ini")
+        except OSError as e:  # FileNotFound exception under py3
+            if e.errno == 2:
+                pass
+            else:
+                raise
+
         print(_("""
 ---------------------------------------------------------------------------
  You should now edit the tracker configuration file:

share/roundup/templates/jinja2/config_ini.ini

@@ -0,0 +1,4 @@
+[main]
+template_engine = jinja2
+
+static_files = static

share/roundup/templates/responsive/config_ini.ini

@@ -0,0 +1,2 @@
+[main]
+static_files = static

test/test_admin.py

@@ -0,0 +1,89 @@
+#
+# Copyright (C) 2007 Stefan Seefeld
+# All rights reserved.
+# For license terms see the file COPYING.txt.
+#
+
+from __future__ import print_function
+import unittest, os, shutil, errno, sys, difflib, cgi, re
+
+from roundup.admin import AdminTool
+
+from . import db_test_base
+from .test_mysql import skip_mysql
+from .test_postgresql import skip_postgresql
+
+
+class AdminTest(object):
+
+    backend = None
+
+    def setUp(self):
+        self.dirname = '_test_admin'
+
+    def tearDown(self):
+        try:
+            shutil.rmtree(self.dirname)
+        except OSError as error:
+            if error.errno not in (errno.ENOENT, errno.ESRCH): raise
+
+    def testInit(self):
+        import sys
+        self.admin=AdminTool()
+        sys.argv=['main', '-i', '_test_admin', 'install', 'classic', self.backend]
+        ret = self.admin.main()
+        print(ret)
+        self.assertTrue(ret == 0)
+        self.assertTrue(os.path.isfile(self.dirname + "/config.ini"))
+        self.assertTrue(os.path.isfile(self.dirname + "/schema.py"))
+
+    def testInitWithConfig_ini(self):
+        import sys
+        from roundup.configuration import CoreConfig
+        self.admin=AdminTool()
+        sys.argv=['main', '-i', '_test_admin', 'install', 'classic', self.backend]
+        # create a config_ini.ini file in classic template
+        templates=self.admin.listTemplates()
+        config_ini_content = "[mail]\n# comment\ndebug = SendMail.LOG\n"
+        config_ini_path = templates['classic']['path'] + '/config_ini.ini'
+        config_ini_file = open(config_ini_path, "w")
+        config_ini_file.write(config_ini_content)
+        config_ini_file.close()
+
+        try:
+            ret = self.admin.main()
+        finally:
+            try:
+                # ignore file not found
+                os.remove(config_ini_path)
+            except OSError as e:  # FileNotFound exception under py3
+                if e.errno == 2:
+                    pass
+                else:
+                    raise
+
+        print(ret)
+        self.assertTrue(ret == 0)
+        self.assertTrue(os.path.isfile(self.dirname + "/config.ini"))
+        self.assertTrue(os.path.isfile(self.dirname + "/schema.py"))
+        config=CoreConfig(self.dirname)
+        self.assertEqual(config['MAIL_DEBUG'], self.dirname + "/SendMail.LOG")
+        
+
+
+class anydbmAdminTest(AdminTest, unittest.TestCase):
+    backend = 'anydbm'
+
+
+@skip_mysql
+class mysqlAdminTest(AdminTest, unittest.TestCase):
+    backend = 'mysql'
+
+
+class sqliteAdminTest(AdminTest, unittest.TestCase):
+    backend = 'sqlite'
+
+
+@skip_postgresql
+class postgresqlAdminTest(AdminTest, unittest.TestCase):
+    backend = 'postgresql'