Remove old code import imp, old style trackers db/backend_name

Module imp is depricated. Removing that means rewriting old style
trackers that used imp to load schema and config files. So removed
code supporting old style trackers that have been depricated since
2008.

Added test to verify that existence of dbinit.py triggers alert that
tracker is old style and not supported.

Also remove support for depricated db/backend_name file for specifying
backend. It is now specified in config.ini's [rdbms] backend.

It looks like not specifying an [rdbms] backend key in config.ini
throws a config error. However I left in a check and throw an
exception with details if there is an empty backend value. But I don't
think it will ever be triggered.

Removed unused import of imp in a number of test files.

Author: rouilj

CHANGES.txt

@@ -54,8 +54,12 @@ Fixed:
   lmsteffan in irc)
 - removed run_tests.py. Newer pytest doesn't support generating
   stand alone testing bundles. Python 3.9 generates errors running
-  the current run_tests.py.
+  the current run_tests.py.  (reported by lmsteffan in irc)
 - issue2551104 - fix issue with markdown autolink next to punctuation (ced)
+- removed support for old style trackers that use dbinit.py and
+  config.py. Also remove all uses of depricated imp module. (John Rouillard)
+- removed support for setting database type using
+  <database>/backend_name. (John Rouillard)
 
 Features:
 - issue2550522 - Add 'filter' command to command-line

roundup/configuration.py

@@ -9,7 +9,6 @@
 # used here instead of try/except.
 import sys
 import getopt
-import imp
 import logging, logging.config
 import os
 import re
@@ -264,13 +263,6 @@ def load_ini(self, config):
         if config.has_option(self.section, self.setting):
             self.set(config.get(self.section, self.setting))
 
-    def load_pyconfig(self, config):
-        """Load value from old-style config (python module)"""
-        for _name in self.aliases:
-            if hasattr(config, _name):
-                self.set(getattr(config, _name))
-                break
-
 
 class BooleanOption(Option):
 
@@ -1850,7 +1842,7 @@ def load(self, home_dir):
         if os.path.isfile(os.path.join(home_dir, self.INI_FILE)):
             self.load_ini(home_dir)
         else:
-            self.load_pyconfig(home_dir)
+            raise NoConfigError(home_dir)
         self.init_logging()
         self.ext = UserConfig(os.path.join(home_dir, "extensions"))
         self.detectors = UserConfig(os.path.join(home_dir, "detectors"))
@@ -1862,34 +1854,6 @@ def load_ini(self, home_dir, defaults=None):
             config_defaults.update(defaults)
         Config.load_ini(self, home_dir, config_defaults)
 
-    def load_pyconfig(self, home_dir):
-        """Set options from config.py file in given home_dir directory"""
-        # try to locate and import the module
-        _mod_fp = None
-        try:
-            try:
-                _module = imp.find_module(self.PYCONFIG, [home_dir])
-                _mod_fp = _module[0]
-                _config = imp.load_module(self.PYCONFIG, *_module)
-            except ImportError:
-                raise NoConfigError(home_dir)
-        finally:
-            if _mod_fp is not None:
-                _mod_fp.close()
-        # module loaded ok.  set the options, starting from HOME
-        self.reset()
-        self.HOME = home_dir
-        for _option in self.items():
-            _option.load_pyconfig(_config)
-        # backward compatibility:
-        # SMTP login parameters were specified as a tuple in old style configs
-        # convert them to new plain string options
-        _mailuser = getattr(_config, "MAILUSER", ())
-        if len(_mailuser) > 0:
-            self.MAIL_USERNAME = _mailuser[0]
-        if len(_mailuser) > 1:
-            self.MAIL_PASSWORD = _mailuser[1]
-
     # in this config, HOME is also known as TRACKER_HOME
     def __getitem__(self, name):
         if name == "TRACKER_HOME":

roundup/instance.py

@@ -83,23 +83,13 @@ def __init__(self, tracker_home, optimize=0):
         # TODO: Remove in v1.7
         # Provide some backwards compatability for existing Roundup instances
         # that still define the backend type in 'db/backend_name' and warn the
-        # users they need to update their config.ini
+        # users they need to update their config.ini. Note that a missing
+        # rdbms backend causes the config to throw an error, so this may
+        # not be possible.
         if rdbms_backend == '':
-            filename = os.path.join(self.config.DATABASE, 'backend_name')
-            msg = """\n
-The 'backend_name' file is no longer used to configure the database backend
-used for the tracker.  Please read 'doc/upgrading.txt' to find out how to
-update your config.ini
-"""
-            try:
-                with open(filename) as backend_file:
-                    rdbms_backend = backend_file.readline().strip()
-
-                with warnings.catch_warnings():
-                    warnings.simplefilter("once", DeprecationWarning)
-                    warnings.warn(msg, DeprecationWarning, stacklevel=2)
-            except IOError:
-                pass
+            raise TrackerError("database backend not found in config.ini.\n"
+                   "Old style `backend_name` in db directory not supported\n"
+                   "See doc/upgrading.txt for required steps.")
 
         self.backend = backends.get_backend(rdbms_backend)
 
@@ -276,71 +266,11 @@ class TrackerError(RoundupException):
     pass
 
 
-class OldStyleTrackers:
-    def __init__(self):
-        self.number = 0
-        self.trackers = {}
-
-    def open(self, tracker_home, optimize=0):
-        """Open the tracker.
-
-        Parameters:
-            tracker_home:
-                tracker home directory
-            optimize:
-                if set, precompile html templates
-
-        Raise ValueError if the tracker home doesn't exist.
-
-        """
-        import imp
-        # sanity check existence of tracker home
-        if not os.path.exists(tracker_home):
-            raise ValueError('no such directory: "%s"' % tracker_home)
-
-        # sanity check tracker home contents
-        for reqd in 'config dbinit select_db interfaces'.split():
-            if not os.path.exists(os.path.join(tracker_home, '%s.py' % reqd)):
-                raise TrackerError('File "%s.py" missing from tracker '
-                                   'home "%s"' % (reqd, tracker_home))
-
-        if tracker_home in self.trackers:
-            return imp.load_package(self.trackers[tracker_home],
-                                    tracker_home)
-        # register all available backend modules
-        backends.list_backends()
-        self.number = self.number + 1
-        modname = '_roundup_tracker_%s' % self.number
-        self.trackers[tracker_home] = modname
-
-        # load the tracker
-        tracker = imp.load_package(modname, tracker_home)
-
-        # ensure the tracker has all the required bits
-        for required in 'open init Client MailGW'.split():
-            if not hasattr(tracker, required):
-                raise TrackerError('Required tracker attribute "%s" missing' %
-                                   required)
-
-        # load and apply the config
-        tracker.config = configuration.CoreConfig(tracker_home)
-        tracker.dbinit.config = tracker.config
-
-        tracker.optimize = optimize
-        tracker.templates = templating.get_loader(tracker.config["TEMPLATES"])
-        if optimize:
-            tracker.templates.precompile()
-
-        return tracker
-
-
-OldStyleTrackers = OldStyleTrackers()
-
-
 def open(tracker_home, optimize=0):
     if os.path.exists(os.path.join(tracker_home, 'dbinit.py')):
         # user should upgrade...
-        return OldStyleTrackers.open(tracker_home, optimize=optimize)
+        raise TrackerError("Old style trackers using dbinit.py "
+                           "are not supported after release 2.0")
 
     return Tracker(tracker_home, optimize=optimize)
 

test/db_test_base.py

@@ -16,7 +16,7 @@
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 
 from __future__ import print_function
-import unittest, os, shutil, errno, imp, sys, time, pprint, os.path
+import unittest, os, shutil, errno, sys, time, pprint, os.path
 
 try:
     from base64 import encodebytes as base64_encode  # python3 only

test/test_instance.py

@@ -0,0 +1,50 @@
+#
+# Copyright (C) 2020 John Rouillard
+# All rights reserved.
+# For license terms see the file COPYING.txt.
+#
+
+from __future__ import print_function
+import unittest, os, shutil, errno, sys, difflib
+
+from roundup import instance
+from roundup.instance import TrackerError
+
+try:
+  # python2
+  import pathlib2 as pathlib
+except ImportError:
+  # python3
+  import pathlib
+
+from . import db_test_base
+
+class InstanceTest(unittest.TestCase):
+
+    backend = 'anydbm'
+
+    def setUp(self):
+        self.dirname = '_test_instance'
+        # set up and open a tracker
+        self.instance = db_test_base.setupTracker(self.dirname, self.backend)
+
+        # open the database
+        self.db = self.instance.open('admin')
+
+        self.db.commit()
+        self.db.close()
+
+    def tearDown(self):
+        if self.db:
+            self.db.close()
+        try:
+            shutil.rmtree(self.dirname)
+        except OSError as error:
+            if error.errno not in (errno.ENOENT, errno.ESRCH): raise
+
+
+    def testOpenOldStyle(self):
+        pathlib.Path(os.path.join(self.dirname, "dbinit.py")).touch()
+        # no longer support old style tracker configs
+        self.assertRaises(TrackerError, instance.open, self.dirname)
+

test/test_mailgw.py

@@ -13,7 +13,7 @@
 
 import email
 from . import gpgmelib
-import unittest, tempfile, os, shutil, errno, imp, sys, difflib, time, io
+import unittest, tempfile, os, shutil, errno, sys, difflib, time, io
 
 import pytest
 

test/test_mysql.py

@@ -15,7 +15,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 
-import unittest, os, shutil, time, imp
+import unittest, os, shutil, time
 
 import pytest
 from roundup.hyperdb import DatabaseError