upstream/mercurial-mirror Files · tests/logexceptions.py

run-tests: mechanism to report exceptions during test execution...

run-tests: mechanism to report exceptions during test execution Sometimes when running tests you introduce a ton of exceptions. The most extreme example of this is running Mercurial with Python 3, which currently spews thousands of exceptions when running the test harness. This commit adds an opt-in feature to run-tests.py to aggregate exceptions encountered by `hg` when running tests. When --exceptions is used, the test harness enables the "logexceptions" extension in the test environment. This extension wraps the Mercurial function to handle exceptions and writes information about the exception to a random filename in a directory defined by the test harness via an environment variable. At the end of the test harness, these files are parsed, aggregated, and a list of all unique Mercurial frames triggering exceptions is printed in order of frequency. This feature is intended to aid Python 3 development. I've only really tested it on Python 3. There is no shortage of improvements that could be made. e.g. we could write a separate file containing the exception report - maybe even an HTML report. We also don't capture which tests demonstrate the exceptions, so there's no turnkey way to test whether a code change made an exception disappear. Perfect is the enemy of good. I think the current patch is useful enough to land. Whoever uses it can send patches to imprve its usefulness. Differential Revision: https://phab.mercurial-scm.org/D1477

Gregory Szorc - - Load All Authors

File last commit:

r35191:bd8875b6 default


                r35191:bd8875b6

default

Download file

             logexceptions.py
        
                    73 lines
            
             | 1.8 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / tests / logexceptions.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # logexceptions.py - Write files containing info about Mercurial exceptions

      #

      # Copyright 2017 Matt Mackall <mpm@selenic.com>

      #

      # This software may be used and distributed according to the terms of the

      # GNU General Public License version 2 or any later version.

      from __future__ import absolute_import

      import inspect

      import os

      import sys

      import traceback

      import uuid

      from mercurial import (

          dispatch,

          extensions,

      )

      def handleexception(orig, ui):

          res = orig(ui)

          if not ui.environ.get(b'HGEXCEPTIONSDIR'):

              return res

          dest = os.path.join(ui.environ[b'HGEXCEPTIONSDIR'],

                              str(uuid.uuid4()).encode('ascii'))

          exc_type, exc_value, exc_tb = sys.exc_info()

          stack = []

          tb = exc_tb

          while tb:

              stack.append(tb)

              tb = tb.tb_next

          stack.reverse()

          hgframe = 'unknown'

          hgline = 'unknown'

          # Find the first Mercurial frame in the stack.

          for tb in stack:

              mod = inspect.getmodule(tb)

              if not mod.__name__.startswith(('hg', 'mercurial')):

                  continue

              frame = tb.tb_frame

              try:

                  with open(inspect.getsourcefile(tb), 'r') as fh:

                      hgline = fh.readlines()[frame.f_lineno - 1].strip()

              except (IndexError, OSError):

                  pass

              hgframe = '%s:%d' % (frame.f_code.co_filename, frame.f_lineno)

              break

          primary = traceback.extract_tb(exc_tb)[-1]

          primaryframe = '%s:%d' % (primary.filename, primary.lineno)

          with open(dest, 'wb') as fh:

              parts = [

                  str(exc_value),

                  primaryframe,

                  hgframe,

                  hgline,

              ]

              fh.write(b'\0'.join(p.encode('utf-8', 'replace') for p in parts))

      def extsetup(ui):

          extensions.wrapfunction(dispatch, 'handlecommandexception',

                                  handleexception)

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				# logexceptions.py - Write files containing info about Mercurial exceptions
				#
				# Copyright 2017 Matt Mackall <mpm@selenic.com>
				#
				# This software may be used and distributed according to the terms of the
				# GNU General Public License version 2 or any later version.

				from __future__ import absolute_import

				import inspect
				import os
				import sys
				import traceback
				import uuid

				from mercurial import (
				dispatch,
				extensions,
				)

				def handleexception(orig, ui):
				res = orig(ui)

				if not ui.environ.get(b'HGEXCEPTIONSDIR'):
				return res

				dest = os.path.join(ui.environ[b'HGEXCEPTIONSDIR'],
				str(uuid.uuid4()).encode('ascii'))

				exc_type, exc_value, exc_tb = sys.exc_info()

				stack = []
				tb = exc_tb
				while tb:
				stack.append(tb)
				tb = tb.tb_next
				stack.reverse()

				hgframe = 'unknown'
				hgline = 'unknown'

				# Find the first Mercurial frame in the stack.
				for tb in stack:
				mod = inspect.getmodule(tb)
				if not mod.__name__.startswith(('hg', 'mercurial')):
				continue

				frame = tb.tb_frame

				try:
				with open(inspect.getsourcefile(tb), 'r') as fh:
				hgline = fh.readlines()[frame.f_lineno - 1].strip()
				except (IndexError, OSError):
				pass

				hgframe = '%s:%d' % (frame.f_code.co_filename, frame.f_lineno)
				break

				primary = traceback.extract_tb(exc_tb)[-1]
				primaryframe = '%s:%d' % (primary.filename, primary.lineno)

				with open(dest, 'wb') as fh:
				parts = [
				str(exc_value),
				primaryframe,
				hgframe,
				hgline,
				]
				fh.write(b'\0'.join(p.encode('utf-8', 'replace') for p in parts))

				def extsetup(ui):
				extensions.wrapfunction(dispatch, 'handlecommandexception',
				handleexception)