Commit cbf36771 authored by Mike Hommey's avatar Mike Hommey
Browse files

Bug 1257516 - Make check_prog opt-in to the queued debug log messages. r=ted

parent 97ea49f1

build/moz.configure/checks.configure

+38 −14
Original line number Diff line number Diff line
@@ -5,6 +5,25 @@ 
# file, You can obtain one at http://mozilla.org/MPL/2.0/.



# Templates implementing some generic checks.

# ==============================================================



# Declare some exceptions. This is cumbersome, but since we shouldn't need a

# lot of them, let's stack them all here. When adding a new one, put it in the

# _declare_exceptions template, and add it to the return statement. Then

# destructure in the assignment below the function declaration.

@template

@advanced

def _declare_exceptions():

    class FatalCheckError(Exception):

        '''An exception to throw from a function decorated with @checking.

        It will result in calling die() with the given message.

        Debugging messages emitted from the decorated function will also be

        printed out.'''

    return (FatalCheckError,)



(FatalCheckError,) = _declare_exceptions()



del _declare_exceptions



# Helper to display "checking" messages

#   @checking('for foo')
@@ -28,7 +47,12 @@ def checking(what, callback=None): 
    def decorator(func):

        def wrapped(*args, **kwargs):

            log.info('checking %s... ', what)

            with log.queue_debug():

                error, ret = None, None

                try:

                    ret = func(*args, **kwargs)

                except FatalCheckError as e:

                    error = e.message

                if callback:

                    log.info(callback(ret))

                elif ret is True:
@@ -37,6 +61,8 @@ def checking(what, callback=None): 
                    log.info('no')

                else:

                    log.info(ret)

                if error:

                    die(error)

            return ret

        return wrapped

    return decorator
@@ -64,15 +90,13 @@ def check_prog(var, progs, allow_missing=False): 
        if value:

            progs[:] = value

        for prog in progs:

            log.debug('%s: Trying %s', var.lower(), quote(prog))

            result = find_program(prog)

            if result:

                return result



    @depends(check, var)

    def postcheck(value, raw_value):

        if value is None and (not allow_missing or raw_value):

            die('Cannot find %s (tried: %s)', var.lower(),

                ', '.join(quote(p) for p in progs))

        if not allow_missing or value:

            raise FatalCheckError('Cannot find %s' % var.lower())



    @depends(check)

    def normalized_for_config(value):

python/mozbuild/mozbuild/test/configure/test_checks_configure.py

+10 −6
Original line number Diff line number Diff line
@@ -92,15 +92,18 @@ class TestChecksConfigure(unittest.TestCase): 
        self.assertEqual(status, 1)

        self.assertEqual(config, {})

        self.assertEqual(out, 'checking for foo... not found\n'

                              'ERROR: Cannot find foo (tried: unknown)\n')

                              'DEBUG: foo: Trying unknown\n'

                              'ERROR: Cannot find foo\n')



        config, out, status = self.get_result(

            'check_prog("FOO", ("unknown", "unknown-2", "unknown 3"))')

        self.assertEqual(status, 1)

        self.assertEqual(config, {})

        self.assertEqual(out, 'checking for foo... not found\n'

                              'ERROR: Cannot find foo '

                              "(tried: unknown, unknown-2, 'unknown 3')\n")

                              'DEBUG: foo: Trying unknown\n'

                              'DEBUG: foo: Trying unknown-2\n'

                              "DEBUG: foo: Trying 'unknown 3'\n"

                              'ERROR: Cannot find foo\n')



        config, out, status = self.get_result(

            'check_prog("FOO", ("unknown", "unknown-2", "unknown 3"), '
@@ -130,8 +133,8 @@ class TestChecksConfigure(unittest.TestCase): 
        self.assertEqual(status, 1)

        self.assertEqual(config, {})

        self.assertEqual(out, 'checking for foo... not found\n'

                              'ERROR: Cannot find foo '

                              '(tried: /usr/local/bin/known-a)\n')

                              'DEBUG: foo: Trying /usr/local/bin/known-a\n'

                              'ERROR: Cannot find foo\n')



        config, out, status = self.get_result(

            'check_prog("FOO", ("unknown",))',
@@ -146,7 +149,8 @@ class TestChecksConfigure(unittest.TestCase): 
        self.assertEqual(status, 1)

        self.assertEqual(config, {})

        self.assertEqual(out, 'checking for foo... not found\n'

                              'ERROR: Cannot find foo (tried: unknown)\n')

                              'DEBUG: foo: Trying unknown\n'

                              'ERROR: Cannot find foo\n')



    def test_check_prog_configure_error(self):

        with self.assertRaises(ConfigureError) as e: