Add testing interactive mode to roundup_admin. remove redundant imports

Author: rouilj

roundup/admin.py

@@ -83,6 +83,12 @@ class AdminTool:
 
         Additional help may be supplied by help_*() methods.
     """
+
+    # Make my_input a property to allow overriding in testing.
+    # my_input is imported in other places, so just set it from
+    # the imported value rather than moving def here.
+    my_input = my_input
+
     def __init__(self):
         self.commands = CommandDict()
         for k in AdminTool.__dict__:
@@ -442,7 +448,7 @@ def do_install(self, tracker_home, args):
         if list(filter(os.path.exists, [config_ini_file,
                 os.path.join(tracker_home, 'config.py')])):
             if not self.force:
-                ok = my_input(_(
+                ok = self.my_input(_(
 """WARNING: There appears to be a tracker in "%(tracker_home)s"!
 If you re-install it, you will lose all the data!
 Erase it? Y/N: """) % locals())  # noqa: E122
@@ -548,7 +554,7 @@ def _get_choice(self, list_name, prompt, options, argument, default=None):
             return default
         sys.stdout.write('%s: %s\n' % (list_name, ', '.join(options)))
         while argument not in options:
-            argument = my_input('%s [%s]: ' % (prompt, default))
+            argument = self.my_input('%s [%s]: ' % (prompt, default))
             if not argument:
                 return default
         return argument
@@ -605,7 +611,7 @@ def do_initialise(self, tracker_home, args):
         # is there already a database?
         if tracker.exists():
             if not self.force:
-                ok = my_input(_(
+                ok = self.my_input(_(
 """WARNING: The database is already initialised!
 If you re-initialise it, you will lose all the data!
 Erase it? Y/N: """))  # noqa: E122
@@ -1017,7 +1023,7 @@ def do_create(self, args):
                     if value:
                         props[key] = value
                 else:
-                    value = my_input(_('%(propname)s (%(proptype)s): ') % {
+                    value = self.my_input(_('%(propname)s (%(proptype)s): ') % {
                         'propname': key.capitalize(), 'proptype': name})
                     if value:
                         props[key] = value
@@ -1751,7 +1757,7 @@ def run_command(self, args):
         # make sure we have a tracker_home
         while not self.tracker_home:
             if not self.force:
-                self.tracker_home = my_input(_('Enter tracker home: ')).strip()
+                self.tracker_home = self.my_input(_('Enter tracker home: ')).strip()
             else:
                 self.tracker_home = os.curdir
 
@@ -1825,7 +1831,7 @@ def interactive(self):
 
         while 1:
             try:
-                command = my_input('roundup> ')
+                command = self.my_input('roundup> ')
             except EOFError:
                 print(_('exit...'))
                 break
@@ -1840,7 +1846,7 @@ def interactive(self):
 
         # exit.. check for transactions
         if self.db and self.db_uncommitted:
-            commit = my_input(_('There are unsaved changes. Commit them (y/N)? '))
+            commit = self.my_input(_('There are unsaved changes. Commit them (y/N)? '))
             if commit and commit[0].lower() == 'y':
                 self.db.commit()
         return 0

test/test_admin.py

@@ -94,13 +94,50 @@ def install_init(self, type="classic",
         self.assertEqual(ret, 0)
 
 
+    def testBasicInteractive(self):
+        # first command is an error that should be handled
+        inputs = iter(["'quit", "quit"])
+
+        orig_input = AdminTool.my_input
+
+        AdminTool.my_input = lambda _self, _prompt: next(inputs)
+
+        self.install_init()
+        self.admin=AdminTool()
+        sys.argv=['main', '-i', self.dirname]
+
+        with captured_output() as (out, err):
+            ret = self.admin.main()
+
+        out = out.getvalue().strip()
+        
+        print(ret)
+        self.assertTrue(ret == 0)
+        expected = 'ready for input.\nType "help" for help.'
+        self.assertEqual(expected, out[-1*len(expected):])
+
+        inputs = iter(["list user", "quit"])
+
+        AdminTool.my_input = lambda _self, _prompt: next(inputs)
+
+        with captured_output() as (out, err):
+            ret = self.admin.main()
+
+        out = out.getvalue().strip()
+        
+        print(ret)
+        self.assertTrue(ret == 0)
+        expected = 'help.\n   1: admin\n   2: anonymous'
+        self.assertEqual(expected, out[-1*len(expected):])
+
+
+        AdminTool.my_input = orig_input
+
     def testGet(self):
         ''' Note the tests will fail if you run this under pdb.
             the context managers capture the pdb prompts and this screws
             up the stdout strings with (pdb) prefixed to the line.
         '''
-        import sys
-
         self.install_init()
         self.admin=AdminTool()
 
@@ -187,7 +224,6 @@ def testGet(self):
         self.assertEqual(len(err), 0)
 
     def testInit(self):
-        import sys
         self.admin=AdminTool()
         sys.argv=['main', '-i', self.dirname, 'install', 'classic', self.backend]
         ret = self.admin.main()
@@ -197,7 +233,6 @@ def testInit(self):
         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', self.dirname, 'install', 'classic', self.backend]
@@ -233,8 +268,6 @@ def testFind(self):
             the context managers capture the pdb prompts and this screws
             up the stdout strings with (pdb) prefixed to the line.
         '''
-        import sys
-
         self.admin=AdminTool()
         self.install_init()
 
@@ -304,7 +337,7 @@ def testGenconfigUpdate(self):
             the context managers capture the pdb prompts and this screws
             up the stdout strings with (pdb) prefixed to the line.
         '''
-        import sys, filecmp
+        import filecmp
 
         self.admin=AdminTool()
         self.install_init()
@@ -369,8 +402,6 @@ def testCliParse(self):
             the context managers capture the pdb prompts and this screws
             up the stdout strings with (pdb) prefixed to the line.
         '''
-        import sys
-
         self.admin=AdminTool()
         self.install_init()
 
@@ -443,8 +474,6 @@ def testFilter(self):
             the context managers capture the pdb prompts and this screws
             up the stdout strings with (pdb) prefixed to the line.
         '''
-        import sys
-
         self.admin=AdminTool()
         self.install_init()
 
@@ -664,8 +693,6 @@ def disabletestHelpInitopts(self):
             the context managers capture the pdb prompts and this screws
             up the stdout strings with (pdb) prefixed to the line.
         '''
-        import sys
-
         self.install_init()
         self.admin=AdminTool()
 
@@ -687,8 +714,6 @@ def testSecurity(self):
             the context managers capture the pdb prompts and this screws
             up the stdout strings with (pdb) prefixed to the line.
         '''
-        import sys
-
         self.install_init()
         self.admin=AdminTool()
 
@@ -759,8 +784,6 @@ def testSecurityInvalidAttribute(self):
             the context managers capture the pdb prompts and this screws
             up the stdout strings with (pdb) prefixed to the line.
         '''
-        import sys
-
         self.maxDiff = None # we want full diff
 
         self.install_init()
@@ -838,8 +861,6 @@ def testSet(self):
             the context managers capture the pdb prompts and this screws
             up the stdout strings with (pdb) prefixed to the line.
         '''
-        import sys
-
         self.install_init()
         self.admin=AdminTool()
 
@@ -945,8 +966,6 @@ def testSetOnClass(self):
             the context managers capture the pdb prompts and this screws
             up the stdout strings with (pdb) prefixed to the line.
         '''
-        import sys
-
         self.install_init()
 
         self.admin=AdminTool()
@@ -1018,8 +1037,6 @@ def testSpecification(self):
             the context managers capture the pdb prompts and this screws
             up the stdout strings with (pdb) prefixed to the line.
         '''
-        import sys
-
         self.install_init()
         self.admin=AdminTool()
 
@@ -1048,8 +1065,6 @@ def testRetireRestore(self):
             the context managers capture the pdb prompts and this screws
             up the stdout strings with (pdb) prefixed to the line.
         '''
-        import sys
-
         # create user1 at id 3
         self.install_init()
         self.admin=AdminTool()
@@ -1136,8 +1151,6 @@ def testTable(self):
             the context managers capture the pdb prompts and this screws
             up the stdout strings with (pdb) prefixed to the line.
         '''
-        import sys
-
         self.install_init()
         self.admin=AdminTool()