TracError: Unknown trac-admin command "copystatic"

[Ryan J Ollos]

From the logs:

[pid 23657 140015545095936] 2016-02-16 02:44:34,470 Trac[formatter] ERROR: Macro TracAdminHelp(copystatic) failed:
Traceback (most recent call last):
  File "/usr/local/virtualenv/1.1dev/lib/python2.7/site-packages/trac/wiki/formatter.py", line 798, in _macro_formatter
    return macro.ensure_inline(macro.process(args))
  File "/usr/local/virtualenv/1.1dev/lib/python2.7/site-packages/trac/wiki/formatter.py", line 375, in process
    text = self.processor(text)
  File "/usr/local/virtualenv/1.1dev/lib/python2.7/site-packages/trac/wiki/formatter.py", line 347, in _macro_processor
    text)
  File "/usr/local/virtualenv/1.1dev/lib/python2.7/site-packages/trac/admin/console.py", line 588, in expand_macro
    command=content))
TracError: Unknown trac-admin command "copystatic"

Previously there was a copystatic command: [6894].

[Ryan J Ollos]

Proposed change is to return a system_message rather than raising a TracError:

trac/admin/console.py

@@ -37 +37 @@
 from trac.versioncontrol.api import RepositoryManager
 from trac.wiki.admin import WikiAdmin
 from trac.wiki.macros import WikiMacroBase
+from trac.wiki.formatter import system_message
 
 
 TRAC_VERSION = pkg_resources.get_distribution('Trac').version
@@ -550 +551 @@
                 cmd_mgr = AdminCommandManager(self.env)
                 doc = cmd_mgr.get_command_help(arg)
             if not doc:
-                raise TracError(_('Unknown trac-admin command "%(command)s"',
-                                  command=content))
+                return system_message(_('Unknown trac-admin command '
+                                        '"%(command)s"', command=content))
         else:
             doc = TracAdmin.all_docs(self.env)
         buf = StringIO.StringIO()

trac/admin/tests/console.py

@@ -1399 +1399 @@
         help = unicode(macro.expand_macro(None, None, 'unicode-help'))
         self.assertTrue(unicode_help in help)
 
+    def test_invalid_command(self):
+        macro = TracAdminHelpMacro(self.env)
+
+        help = unicode(macro.expand_macro(None, None, 'copystatic'))
+        self.assertIn('Unknown trac-admin command "copystatic"', help)
+
+
 
 def suite():
     suite = unittest.TestSuite()

[Jun Omae]

Another solution is that expand_macro() raises ProcessorError (or new MacroError exception) for incorrect arguments, etc. and Formatter renders the exception as system_message.

trac/admin/console.py

@@ -36 +36 @@
 from trac.util.translation import _, ngettext, has_babel, cleandoc_
 from trac.versioncontrol.api import RepositoryManager
 from trac.wiki.admin import WikiAdmin
+from trac.wiki.formatter import ProcessorError
 from trac.wiki.macros import WikiMacroBase
 
 
@@ -550 +551 @@
                 cmd_mgr = AdminCommandManager(self.env)
                 doc = cmd_mgr.get_command_help(arg)
             if not doc:
-                raise TracError(_('Unknown trac-admin command "%(command)s"',
-                                  command=content))
+                raise ProcessorError(_('Unknown trac-admin command '
+                                       '"%(command)s"', command=content))
         else:
             doc = TracAdmin.all_docs(self.env)
         buf = StringIO.StringIO()

trac/admin/tests/console.py

@@ -53 +53 @@
                               get_datetime_format_hint
 from trac.util.translation import get_available_locales, has_babel
 from trac.web.tests.session import _prep_session_table
+from trac.wiki.formatter import ProcessorError
 
 STRIP_TRAILING_SPACE = re.compile(r'( +)$', re.MULTILINE)
 
@@ -1399 +1400 @@
         help = unicode(macro.expand_macro(None, None, 'unicode-help'))
         self.assertTrue(unicode_help in help)
 
+    def test_invalid_command(self):
+        macro = TracAdminHelpMacro(self.env)
+        try:
+            macro.expand_macro(None, None, 'copystatic')
+            self.fail('ProcessorError not raised')
+        except ProcessorError, e:
+            self.assertEqual('Unknown trac-admin command "copystatic"',
+                             unicode(e))
+
 
 def suite():
     suite = unittest.TestSuite()

trac/wiki/formatter.py

@@ -787 +787 @@
             args = fullmatch.group('macroargs')
         try:
             return macro.ensure_inline(macro.process(args))
+        except ProcessorError, e:
+            return system_message(e)
         except Exception, e:
             self.env.log.error('Macro %s(%s) failed:%s', name, args,
                                exception_to_unicode(e, traceback=True))

[Ryan J Ollos]

Thanks, I didn't know about ProcessorError. I'll push your changes.

[Ryan J Ollos]

Committed to 1.0-stable in [14563], merged to trunk in [14564]. MacroError documented in TracDev/Exceptions@14.

[Ryan J Ollos]

Added documentation for ProcessorError (r9106) and MacroError (r14563) in r16407.