lib: uuid: alignment error in gen_rand_uuid()

[oweals/u-boot.git] / test / py / conftest.py

diff --git a/test/py/conftest.py b/test/py/conftest.py
index e1674dfce053512be1dccd923371604db6bceb37..00d8ef8ba99ce76ce4a48df0d81773ef10237892 100644 (file)
--- a/test/py/conftest.py
+++ b/test/py/conftest.py
@@ -1,7 +1,6 @@
+# SPDX-License-Identifier: GPL-2.0

 # Copyright (c) 2015 Stephen Warren
 # Copyright (c) 2015-2016, NVIDIA CORPORATION. All rights reserved.
 # Copyright (c) 2015 Stephen Warren
 # Copyright (c) 2015-2016, NVIDIA CORPORATION. All rights reserved.

-#
-# SPDX-License-Identifier: GPL-2.0

 
 # Implementation of pytest run-time hook functions. These are invoked by
 # pytest at certain points during operation, e.g. startup, for each executed
 
 # Implementation of pytest run-time hook functions. These are invoked by
 # pytest at certain points during operation, e.g. startup, for each executed


@@ -17,19 +16,23 @@ import atexit
 import errno
 import os
 import os.path
 import errno
 import os
 import os.path

-import pexpect

 import pytest
 from _pytest.runner import runtestprotocol
 import pytest
 from _pytest.runner import runtestprotocol

-import ConfigParser
+import re

 import StringIO
 import sys
 
 import StringIO
 import sys
 

+try:
+    import configparser
+except:
+    import ConfigParser as configparser
+

 # Globals: The HTML log file, and the connection to the U-Boot console.
 log = None
 console = None
 
 def mkdir_p(path):
 # Globals: The HTML log file, and the connection to the U-Boot console.
 log = None
 console = None
 
 def mkdir_p(path):

-    '''Create a directory path.
+    """Create a directory path.

 
     This includes creating any intermediate/parent directories. Any errors
     caused due to already extant directories are ignored.
 
     This includes creating any intermediate/parent directories. Any errors
     caused due to already extant directories are ignored.


@@ -39,7 +42,7 @@ def mkdir_p(path):
 
     Returns:
         Nothing.
 
     Returns:
         Nothing.

-    '''
+    """

 
     try:
         os.makedirs(path)
 
     try:
         os.makedirs(path)


@@ -50,14 +53,14 @@ def mkdir_p(path):
             raise
 
 def pytest_addoption(parser):
             raise
 
 def pytest_addoption(parser):

-    '''pytest hook: Add custom command-line options to the cmdline parser.
+    """pytest hook: Add custom command-line options to the cmdline parser.

 
     Args:
         parser: The pytest command-line parser.
 
     Returns:
         Nothing.
 
     Args:
         parser: The pytest command-line parser.
 
     Returns:
         Nothing.

-    '''
+    """

 
     parser.addoption('--build-dir', default=None,
         help='U-Boot build directory (O=)')
 
     parser.addoption('--build-dir', default=None,
         help='U-Boot build directory (O=)')


@@ -71,16 +74,19 @@ def pytest_addoption(parser):
         help='U-Boot board identity/instance')
     parser.addoption('--build', default=False, action='store_true',
         help='Compile U-Boot before running tests')
         help='U-Boot board identity/instance')
     parser.addoption('--build', default=False, action='store_true',
         help='Compile U-Boot before running tests')

+    parser.addoption('--gdbserver', default=None,
+        help='Run sandbox under gdbserver. The argument is the channel '+
+        'over which gdbserver should communicate, e.g. localhost:1234')

 
 def pytest_configure(config):
 
 def pytest_configure(config):

-    '''pytest hook: Perform custom initialization at startup time.
+    """pytest hook: Perform custom initialization at startup time.

 
     Args:
         config: The pytest configuration.
 
     Returns:
         Nothing.
 
     Args:
         config: The pytest configuration.
 
     Returns:
         Nothing.

-    '''
+    """

 
     global log
     global console
 
     global log
     global console


@@ -110,6 +116,10 @@ def pytest_configure(config):
         persistent_data_dir = build_dir + '/persistent-data'
     mkdir_p(persistent_data_dir)
 
         persistent_data_dir = build_dir + '/persistent-data'
     mkdir_p(persistent_data_dir)
 

+    gdbserver = config.getoption('gdbserver')
+    if gdbserver and not board_type.startswith('sandbox'):
+        raise Exception('--gdbserver only supported with sandbox targets')
+

     import multiplexed_log
     log = multiplexed_log.Logfile(result_dir + '/test-log.html')
 
     import multiplexed_log
     log = multiplexed_log.Logfile(result_dir + '/test-log.html')
 


@@ -122,10 +132,12 @@ def pytest_configure(config):
             ['make', o_opt, '-s', board_type + '_defconfig'],
             ['make', o_opt, '-s', '-j8'],
         )
             ['make', o_opt, '-s', board_type + '_defconfig'],
             ['make', o_opt, '-s', '-j8'],
         )

-        runner = log.get_runner('make', sys.stdout)
-        for cmd in cmds:
-            runner.run(cmd, cwd=source_dir)
-        runner.close()
+        with log.section('make'):
+            runner = log.get_runner('make', sys.stdout)
+            for cmd in cmds:
+                runner.run(cmd, cwd=source_dir)
+            runner.close()
+            log.status_pass('OK')

 
     class ArbitraryAttributeContainer(object):
         pass
 
     class ArbitraryAttributeContainer(object):
         pass


@@ -158,7 +170,7 @@ def pytest_configure(config):
         with open(dot_config, 'rt') as f:
             ini_str = '[root]\n' + f.read()
             ini_sio = StringIO.StringIO(ini_str)
         with open(dot_config, 'rt') as f:
             ini_str = '[root]\n' + f.read()
             ini_sio = StringIO.StringIO(ini_str)

-            parser = ConfigParser.RawConfigParser()
+            parser = configparser.RawConfigParser()

             parser.readfp(ini_sio)
             ubconfig.buildconfig.update(parser.items('root'))
 
             parser.readfp(ini_sio)
             ubconfig.buildconfig.update(parser.items('root'))
 


@@ -169,6 +181,8 @@ def pytest_configure(config):
     ubconfig.persistent_data_dir = persistent_data_dir
     ubconfig.board_type = board_type
     ubconfig.board_identity = board_identity
     ubconfig.persistent_data_dir = persistent_data_dir
     ubconfig.board_type = board_type
     ubconfig.board_identity = board_identity

+    ubconfig.gdbserver = gdbserver
+    ubconfig.dtb = build_dir + '/arch/sandbox/dts/test.dtb'

 
     env_vars = (
         'board_type',
 
     env_vars = (
         'board_type',


@@ -182,15 +196,49 @@ def pytest_configure(config):
     for v in env_vars:
         os.environ['U_BOOT_' + v.upper()] = getattr(ubconfig, v)
 
     for v in env_vars:
         os.environ['U_BOOT_' + v.upper()] = getattr(ubconfig, v)
 

-    if board_type == 'sandbox':
+    if board_type.startswith('sandbox'):

         import u_boot_console_sandbox
         console = u_boot_console_sandbox.ConsoleSandbox(log, ubconfig)
     else:
         import u_boot_console_exec_attach
         console = u_boot_console_exec_attach.ConsoleExecAttach(log, ubconfig)
 
         import u_boot_console_sandbox
         console = u_boot_console_sandbox.ConsoleSandbox(log, ubconfig)
     else:
         import u_boot_console_exec_attach
         console = u_boot_console_exec_attach.ConsoleExecAttach(log, ubconfig)
 

-def pytest_generate_tests(metafunc):
-    '''pytest hook: parameterize test functions based on custom rules.
+re_ut_test_list = re.compile(r'_u_boot_list_2_(.*)_test_2_\1_test_(.*)\s*$')
+def generate_ut_subtest(metafunc, fixture_name):
+    """Provide parametrization for a ut_subtest fixture.
+
+    Determines the set of unit tests built into a U-Boot binary by parsing the
+    list of symbols generated by the build process. Provides this information
+    to test functions by parameterizing their ut_subtest fixture parameter.
+
+    Args:
+        metafunc: The pytest test function.
+        fixture_name: The fixture name to test.
+
+    Returns:
+        Nothing.
+    """
+
+    fn = console.config.build_dir + '/u-boot.sym'
+    try:
+        with open(fn, 'rt') as f:
+            lines = f.readlines()
+    except:
+        lines = []
+    lines.sort()
+
+    vals = []
+    for l in lines:
+        m = re_ut_test_list.search(l)
+        if not m:
+            continue
+        vals.append(m.group(1) + ' ' + m.group(2))
+
+    ids = ['ut_' + s.replace(' ', '_') for s in vals]
+    metafunc.parametrize(fixture_name, vals, ids=ids)
+
+def generate_config(metafunc, fixture_name):
+    """Provide parametrization for {env,brd}__ fixtures.

 
     If a test function takes parameter(s) (fixture names) of the form brd__xxx
     or env__xxx, the brd and env configuration dictionaries are consulted to
 
     If a test function takes parameter(s) (fixture names) of the form brd__xxx
     or env__xxx, the brd and env configuration dictionaries are consulted to


@@ -199,54 +247,111 @@ def pytest_generate_tests(metafunc):
 
     Args:
         metafunc: The pytest test function.
 
     Args:
         metafunc: The pytest test function.

+        fixture_name: The fixture name to test.

 
     Returns:
         Nothing.
 
     Returns:
         Nothing.

-    '''
+    """

 
     subconfigs = {
         'brd': console.config.brd,
         'env': console.config.env,
     }
 
     subconfigs = {
         'brd': console.config.brd,
         'env': console.config.env,
     }

+    parts = fixture_name.split('__')
+    if len(parts) < 2:
+        return
+    if parts[0] not in subconfigs:
+        return
+    subconfig = subconfigs[parts[0]]
+    vals = []
+    val = subconfig.get(fixture_name, [])
+    # If that exact name is a key in the data source:
+    if val:
+        # ... use the dict value as a single parameter value.
+        vals = (val, )
+    else:
+        # ... otherwise, see if there's a key that contains a list of
+        # values to use instead.
+        vals = subconfig.get(fixture_name+ 's', [])
+    def fixture_id(index, val):
+        try:
+            return val['fixture_id']
+        except:
+            return fixture_name + str(index)
+    ids = [fixture_id(index, val) for (index, val) in enumerate(vals)]
+    metafunc.parametrize(fixture_name, vals, ids=ids)
+
+def pytest_generate_tests(metafunc):
+    """pytest hook: parameterize test functions based on custom rules.
+
+    Check each test function parameter (fixture name) to see if it is one of
+    our custom names, and if so, provide the correct parametrization for that
+    parameter.
+
+    Args:
+        metafunc: The pytest test function.
+
+    Returns:
+        Nothing.
+    """
+

     for fn in metafunc.fixturenames:
     for fn in metafunc.fixturenames:

-        parts = fn.split('__')
-        if len(parts) < 2:
-            continue
-        if parts[0] not in subconfigs:
+        if fn == 'ut_subtest':
+            generate_ut_subtest(metafunc, fn)

             continue
             continue

-        subconfig = subconfigs[parts[0]]
-        vals = []
-        val = subconfig.get(fn, [])
-        # If that exact name is a key in the data source:
-        if val:
-            # ... use the dict value as a single parameter value.
-            vals = (val, )
-        else:
-            # ... otherwise, see if there's a key that contains a list of
-            # values to use instead.
-            vals = subconfig.get(fn + 's', [])
-        metafunc.parametrize(fn, vals)
+        generate_config(metafunc, fn)

 
 @pytest.fixture(scope='session')
 
 @pytest.fixture(scope='session')

+def u_boot_log(request):
+     """Generate the value of a test's log fixture.
+
+     Args:
+         request: The pytest request.
+
+     Returns:
+         The fixture value.
+     """
+
+     return console.log
+
+@pytest.fixture(scope='session')
+def u_boot_config(request):
+     """Generate the value of a test's u_boot_config fixture.
+
+     Args:
+         request: The pytest request.
+
+     Returns:
+         The fixture value.
+     """
+
+     return console.config
+
+@pytest.fixture(scope='function')

 def u_boot_console(request):
 def u_boot_console(request):

-    '''Generate the value of a test's u_boot_console fixture.
+    """Generate the value of a test's u_boot_console fixture.

 
     Args:
         request: The pytest request.
 
     Returns:
         The fixture value.
 
     Args:
         request: The pytest request.
 
     Returns:
         The fixture value.

-    '''
+    """

 
 

+    console.ensure_spawned()

     return console
 
     return console
 

-tests_not_run = set()
-tests_failed = set()
-tests_skipped = set()
-tests_passed = set()
+anchors = {}
+tests_not_run = []
+tests_failed = []
+tests_xpassed = []
+tests_xfailed = []
+tests_skipped = []
+tests_warning = []
+tests_passed = []

 
 def pytest_itemcollected(item):
 
 def pytest_itemcollected(item):

-    '''pytest hook: Called once for each test found during collection.
+    """pytest hook: Called once for each test found during collection.

 
     This enables our custom result analysis code to see the list of all tests
     that should eventually be run.
 
     This enables our custom result analysis code to see the list of all tests
     that should eventually be run.


@@ -256,12 +361,12 @@ def pytest_itemcollected(item):
 
     Returns:
         Nothing.
 
     Returns:
         Nothing.

-    '''
+    """

 
 

-    tests_not_run.add(item.name)
+    tests_not_run.append(item.name)

 
 def cleanup():
 
 def cleanup():

-    '''Clean up all global state.
+    """Clean up all global state.

 
     Executed (via atexit) once the entire test process is complete. This
     includes logging the status of all tests, and the identity of any failed
 
     Executed (via atexit) once the entire test process is complete. This
     includes logging the status of all tests, and the identity of any failed


@@ -272,29 +377,48 @@ def cleanup():
 
     Returns:
         Nothing.
 
     Returns:
         Nothing.

-    '''
+    """

 
     if console:
         console.close()
     if log:
 
     if console:
         console.close()
     if log:

-        log.status_pass('%d passed' % len(tests_passed))
-        if tests_skipped:
-            log.status_skipped('%d skipped' % len(tests_skipped))
-            for test in tests_skipped:
-                log.status_skipped('... ' + test)
-        if tests_failed:
-            log.status_fail('%d failed' % len(tests_failed))
-            for test in tests_failed:
-                log.status_fail('... ' + test)
-        if tests_not_run:
-            log.status_fail('%d not run' % len(tests_not_run))
-            for test in tests_not_run:
-                log.status_fail('... ' + test)
+        with log.section('Status Report', 'status_report'):
+            log.status_pass('%d passed' % len(tests_passed))
+            if tests_warning:
+                log.status_warning('%d passed with warning' % len(tests_warning))
+                for test in tests_warning:
+                    anchor = anchors.get(test, None)
+                    log.status_warning('... ' + test, anchor)
+            if tests_skipped:
+                log.status_skipped('%d skipped' % len(tests_skipped))
+                for test in tests_skipped:
+                    anchor = anchors.get(test, None)
+                    log.status_skipped('... ' + test, anchor)
+            if tests_xpassed:
+                log.status_xpass('%d xpass' % len(tests_xpassed))
+                for test in tests_xpassed:
+                    anchor = anchors.get(test, None)
+                    log.status_xpass('... ' + test, anchor)
+            if tests_xfailed:
+                log.status_xfail('%d xfail' % len(tests_xfailed))
+                for test in tests_xfailed:
+                    anchor = anchors.get(test, None)
+                    log.status_xfail('... ' + test, anchor)
+            if tests_failed:
+                log.status_fail('%d failed' % len(tests_failed))
+                for test in tests_failed:
+                    anchor = anchors.get(test, None)
+                    log.status_fail('... ' + test, anchor)
+            if tests_not_run:
+                log.status_fail('%d not run' % len(tests_not_run))
+                for test in tests_not_run:
+                    anchor = anchors.get(test, None)
+                    log.status_fail('... ' + test, anchor)

         log.close()
 atexit.register(cleanup)
 
 def setup_boardspec(item):
         log.close()
 atexit.register(cleanup)
 
 def setup_boardspec(item):

-    '''Process any 'boardspec' marker for a test.
+    """Process any 'boardspec' marker for a test.

 
     Such a marker lists the set of board types that a test does/doesn't
     support. If tests are being executed on an unsupported board, the test is
 
     Such a marker lists the set of board types that a test does/doesn't
     support. If tests are being executed on an unsupported board, the test is


@@ -305,7 +429,7 @@ def setup_boardspec(item):
 
     Returns:
         Nothing.
 
     Returns:
         Nothing.

-    '''
+    """

 
     mark = item.get_marker('boardspec')
     if not mark:
 
     mark = item.get_marker('boardspec')
     if not mark:


@@ -314,15 +438,15 @@ def setup_boardspec(item):
     for board in mark.args:
         if board.startswith('!'):
             if ubconfig.board_type == board[1:]:
     for board in mark.args:
         if board.startswith('!'):
             if ubconfig.board_type == board[1:]:

-                pytest.skip('board not supported')
+                pytest.skip('board "%s" not supported' % ubconfig.board_type)

                 return
         else:
             required_boards.append(board)
     if required_boards and ubconfig.board_type not in required_boards:
                 return
         else:
             required_boards.append(board)
     if required_boards and ubconfig.board_type not in required_boards:

-        pytest.skip('board not supported')
+        pytest.skip('board "%s" not supported' % ubconfig.board_type)

 
 def setup_buildconfigspec(item):
 
 def setup_buildconfigspec(item):

-    '''Process any 'buildconfigspec' marker for a test.
+    """Process any 'buildconfigspec' marker for a test.

 
     Such a marker lists some U-Boot configuration feature that the test
     requires. If tests are being executed on an U-Boot build that doesn't
 
     Such a marker lists some U-Boot configuration feature that the test
     requires. If tests are being executed on an U-Boot build that doesn't


@@ -333,17 +457,52 @@ def setup_buildconfigspec(item):
 
     Returns:
         Nothing.
 
     Returns:
         Nothing.

-    '''
+    """

 
     mark = item.get_marker('buildconfigspec')
 
     mark = item.get_marker('buildconfigspec')

+    if mark:
+        for option in mark.args:
+            if not ubconfig.buildconfig.get('config_' + option.lower(), None):
+                pytest.skip('.config feature "%s" not enabled' % option.lower())
+    notmark = item.get_marker('notbuildconfigspec')
+    if notmark:
+        for option in notmark.args:
+            if ubconfig.buildconfig.get('config_' + option.lower(), None):
+                pytest.skip('.config feature "%s" enabled' % option.lower())
+
+def tool_is_in_path(tool):
+    for path in os.environ["PATH"].split(os.pathsep):
+        fn = os.path.join(path, tool)
+        if os.path.isfile(fn) and os.access(fn, os.X_OK):
+            return True
+    return False
+
+def setup_requiredtool(item):
+    """Process any 'requiredtool' marker for a test.
+
+    Such a marker lists some external tool (binary, executable, application)
+    that the test requires. If tests are being executed on a system that
+    doesn't have the required tool, the test is marked to be skipped.
+
+    Args:
+        item: The pytest test item.
+
+    Returns:
+        Nothing.
+    """
+
+    mark = item.get_marker('requiredtool')

     if not mark:
         return
     if not mark:
         return

-    for option in mark.args:
-        if not ubconfig.buildconfig.get('config_' + option.lower(), None):
-            pytest.skip('.config feature not enabled')
+    for tool in mark.args:
+        if not tool_is_in_path(tool):
+            pytest.skip('tool "%s" not in $PATH' % tool)
+
+def start_test_section(item):
+    anchors[item.name] = log.start_section(item.name)

 
 def pytest_runtest_setup(item):
 
 def pytest_runtest_setup(item):

-    '''pytest hook: Configure (set up) a test item.
+    """pytest hook: Configure (set up) a test item.

 
     Called once for each test to perform any custom configuration. This hook
     is used to skip the test if certain conditions apply.
 
     Called once for each test to perform any custom configuration. This hook
     is used to skip the test if certain conditions apply.


@@ -353,14 +512,15 @@ def pytest_runtest_setup(item):
 
     Returns:
         Nothing.
 
     Returns:
         Nothing.

-    '''
+    """

 
 

-    log.start_section(item.name)
+    start_test_section(item)

     setup_boardspec(item)
     setup_buildconfigspec(item)
     setup_boardspec(item)
     setup_buildconfigspec(item)

+    setup_requiredtool(item)

 
 def pytest_runtest_protocol(item, nextitem):
 
 def pytest_runtest_protocol(item, nextitem):

-    '''pytest hook: Called to execute a test.
+    """pytest hook: Called to execute a test.

 
     This hook wraps the standard pytest runtestprotocol() function in order
     to acquire visibility into, and record, each test function's result.
 
     This hook wraps the standard pytest runtestprotocol() function in order
     to acquire visibility into, and record, each test function's result.


@@ -371,36 +531,60 @@ def pytest_runtest_protocol(item, nextitem):
 
     Returns:
         A list of pytest reports (test result data).
 
     Returns:
         A list of pytest reports (test result data).

-    '''
+    """

 
 

+    log.get_and_reset_warning()

     reports = runtestprotocol(item, nextitem=nextitem)
     reports = runtestprotocol(item, nextitem=nextitem)

-    failed = None
-    skipped = None
+    was_warning = log.get_and_reset_warning()
+
+    # In pytest 3, runtestprotocol() may not call pytest_runtest_setup() if
+    # the test is skipped. That call is required to create the test's section
+    # in the log file. The call to log.end_section() requires that the log
+    # contain a section for this test. Create a section for the test if it
+    # doesn't already exist.
+    if not item.name in anchors:
+        start_test_section(item)
+
+    failure_cleanup = False
+    if not was_warning:
+        test_list = tests_passed
+        msg = 'OK'
+        msg_log = log.status_pass
+    else:
+        test_list = tests_warning
+        msg = 'OK (with warning)'
+        msg_log = log.status_warning

     for report in reports:
         if report.outcome == 'failed':
     for report in reports:
         if report.outcome == 'failed':

-            failed = report
+            if hasattr(report, 'wasxfail'):
+                test_list = tests_xpassed
+                msg = 'XPASSED'
+                msg_log = log.status_xpass
+            else:
+                failure_cleanup = True
+                test_list = tests_failed
+                msg = 'FAILED:\n' + str(report.longrepr)
+                msg_log = log.status_fail

             break
         if report.outcome == 'skipped':
             break
         if report.outcome == 'skipped':

-            if not skipped:
-                skipped = report
-
-    if failed:
-        tests_failed.add(item.name)
-    elif skipped:
-        tests_skipped.add(item.name)
-    else:
-        tests_passed.add(item.name)
+            if hasattr(report, 'wasxfail'):
+                failure_cleanup = True
+                test_list = tests_xfailed
+                msg = 'XFAILED:\n' + str(report.longrepr)
+                msg_log = log.status_xfail
+                break
+            test_list = tests_skipped
+            msg = 'SKIPPED:\n' + str(report.longrepr)
+            msg_log = log.status_skipped
+
+    if failure_cleanup:
+        console.drain_console()
+
+    test_list.append(item.name)

     tests_not_run.remove(item.name)
 
     try:
     tests_not_run.remove(item.name)
 
     try:

-        if failed:
-            msg = 'FAILED:\n' + str(failed.longrepr)
-            log.status_fail(msg)
-        elif skipped:
-            msg = 'SKIPPED:\n' + str(skipped.longrepr)
-            log.status_skipped(msg)
-        else:
-            log.status_pass('OK')
+        msg_log(msg)

     except:
         # If something went wrong with logging, it's better to let the test
         # process continue, which may report other exceptions that triggered
     except:
         # If something went wrong with logging, it's better to let the test
         # process continue, which may report other exceptions that triggered


@@ -410,13 +594,13 @@ def pytest_runtest_protocol(item, nextitem):
         # is fixed, if this exception still exists, it will then be logged as
         # part of the test's stdout.
         import traceback
         # is fixed, if this exception still exists, it will then be logged as
         # part of the test's stdout.
         import traceback

-        print 'Exception occurred while logging runtest status:'
+        print('Exception occurred while logging runtest status:')

         traceback.print_exc()
         # FIXME: Can we force a test failure here?
 
     log.end_section(item.name)
 
         traceback.print_exc()
         # FIXME: Can we force a test failure here?
 
     log.end_section(item.name)
 

-    if failed:
+    if failure_cleanup:

         console.cleanup_spawn()
 
     return reports
         console.cleanup_spawn()
 
     return reports