issue2551179 Load config_ini.ini ... recognize minimal template demo.py

Mostly taken from patch by John Kristensen (jerrykan).

Tests for python3 and 2 created for minimal and jinja2 templates.

Removed FIXME for special case config settings for jinja and
responsive templates. config_ini.ini mechanism makes it obsolete.

Demo removes config_ini.ini file in home directory.

Also remove encoding of utf-8 from initial_data.py to remove

   SyntaxError: encoding declaration in Unicode string

under python2.

Author: rouilj

CHANGES.txt

@@ -52,6 +52,10 @@ Fixed:
   the data per rfc7232. Properly validate any form of ETag suffixed or
   non-suffixed for If-Match.
 - issue2551178 - fix Traceback in Apache WSGI - during file upload
+- issue2551179 - make roundup-demo initialize templates using
+  config_ini.ini overrides. Needed for jinja to set template lang etc.
+  Recognize minimal template when presented with a full
+  path. (John Kristensen (jerrykan) and John Rouillard)
 
 Features:
 

roundup/demo.py

@@ -39,7 +39,13 @@ def install_demo(home, backend, template):
     from roundup import init, instance, password
 
     # set up the config for this tracker
-    config = configuration.CoreConfig()
+    template_dir = os.path.join('share', 'roundup', 'templates', template)
+
+    # Load optional override ini file. Missing ini file is ignored.
+    template_cfg = configuration.UserConfig(template_dir + "/config_ini.ini")
+    config = configuration.CoreConfig(settings={
+        i.name: i.get() for i in template_cfg.items()
+    })
     config['TRACKER_HOME'] = home
     config['MAIL_DOMAIN'] = 'localhost'
     config['DATABASE'] = 'db'
@@ -64,8 +70,18 @@ def install_demo(home, backend, template):
             print("    %s" % home)
             sys.exit(1)
 
-    template_dir = os.path.join('share', 'roundup', 'templates', template)
     init.install(home, template_dir)
+    # 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(home + "/config_ini.ini")
+    except OSError as e:  # FileNotFound exception under py3
+        if e.errno == 2:
+            pass
+        else:
+            raise
+
     # don't have email flying around
     nosyreaction = os.path.join(home, 'detectors', 'nosyreaction.py')
     if os.path.exists(nosyreaction):
@@ -97,12 +113,6 @@ def install_demo(home, backend, template):
 
     # write the config
     config['INSTANT_REGISTRATION'] = 1
-    # FIXME: Move template-specific demo initialization into the templates.
-    if template == 'responsive':
-        config['STATIC_FILES'] = "static"
-    if template == 'jinja2':
-        config['TEMPLATE_ENGINE'] = 'jinja2'
-        config['STATIC_FILES'] = "static"
     config.save(os.path.join(home, config.INI_FILE))
 
     # open the tracker and initialise
@@ -113,7 +123,7 @@ def install_demo(home, backend, template):
     db = tracker.open('admin')
     # FIXME: Move tracker-specific demo initialization into the tracker
     # templates.
-    if template == 'minimal':
+    if os.path.basename(template) == 'minimal':
         db.user.create(username='demo', password=password.Password('demo'),
                        roles='User')
     else:

share/roundup/templates/jinja2/initial_data.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 from roundup import password, date
 
 pri = db.getclass('priority')

test/test_demo.py

@@ -33,7 +33,7 @@ def tearDown(self):
         except FileNotFoundError:
             pass
 
-    def testDemo(self):
+    def testDemoClassic(self):
         with captured_output() as (out, err):
             install_demo(self.home, 'anydbm', 'classic')
         output = out.getvalue().strip()
@@ -61,4 +61,71 @@ def test_get_server(self):
         # last line in the output.
         self.assertIn("Keyboard Interrupt: exiting", output.split('\n'))
 
+    def testDemoMinimal(self):
+        with captured_output() as (out, err):
+            # use a modified path that resolves when 
+            install_demo(self.home, 'sqlite', '../templates/minimal')
+        output = out.getvalue().strip()
+        print(output)
+
+        # verify that db was set properly by reading config
+        with open(self.home + "/config.ini", "r") as f:
+            config_lines = f.readlines()
+
+        self.assertIn("backend = sqlite\n", config_lines)
+
+        # dummy up the return of get_server so the serve_forever method
+        # raises keyboard interrupt exiting the server so the test exits.
+        gs = roundup.scripts.roundup_server.ServerConfig.get_server
+        def raise_KeyboardInterrupt():
+            raise KeyboardInterrupt
+
+        def test_get_server(self):
+            httpd = gs(self)
+            httpd.serve_forever = raise_KeyboardInterrupt
+            return httpd
+
+        roundup.scripts.roundup_server.ServerConfig.get_server = test_get_server
+
+        # Run under context manager to capture output of startup text.
+        with captured_output() as (out, err):
+            run_demo(self.home)
+        output = out.getvalue().strip()
+        print(output)
+        # if the server installed and started this will be the
+        # last line in the output.
+        self.assertIn("Keyboard Interrupt: exiting", output.split('\n'))
 
+    def testDemoJinja(self):
+        with captured_output() as (out, err):
+            install_demo(self.home, 'anydbm', 'jinja2')
+        output = out.getvalue().strip()
+        print(output)
+
+        # verify that template was set to jinja2 by reading config
+        with open(self.home + "/config.ini", "r") as f:
+            config_lines = f.readlines()
+
+        self.assertIn("template_engine = jinja2\n", config_lines)
+
+        # dummy up the return of get_server so the serve_forever method
+        # raises keyboard interrupt exiting the server so the test exits.
+        gs = roundup.scripts.roundup_server.ServerConfig.get_server
+        def raise_KeyboardInterrupt():
+            raise KeyboardInterrupt
+
+        def test_get_server(self):
+            httpd = gs(self)
+            httpd.serve_forever = raise_KeyboardInterrupt
+            return httpd
+
+        roundup.scripts.roundup_server.ServerConfig.get_server = test_get_server
+
+        # Run under context manager to capture output of startup text.
+        with captured_output() as (out, err):
+            run_demo(self.home)
+        output = out.getvalue().strip()
+        print(output)
+        # if the server installed and started this will be the
+        # last line in the output.
+        self.assertIn("Keyboard Interrupt: exiting", output.split('\n'))