EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

[mirror_edk2.git] / AppPkg / Applications / Python / Python-2.7.2 / Lib / test / script_helper.py

# Common utility functions used by various script execution tests\r
#  e.g. test_cmd_line, test_cmd_line_script and test_runpy\r
\r
import sys\r
import os\r
import re\r
import os.path\r
import tempfile\r
import subprocess\r
import py_compile\r
import contextlib\r
import shutil\r
import zipfile\r
\r
from test.test_support import strip_python_stderr\r
\r
# Executing the interpreter in a subprocess\r
def _assert_python(expected_success, *args, **env_vars):\r
    cmd_line = [sys.executable]\r
    if not env_vars:\r
        cmd_line.append('-E')\r
    cmd_line.extend(args)\r
    # Need to preserve the original environment, for in-place testing of\r
    # shared library builds.\r
    env = os.environ.copy()\r
    env.update(env_vars)\r
    p = subprocess.Popen(cmd_line, stdin=subprocess.PIPE,\r
                         stdout=subprocess.PIPE, stderr=subprocess.PIPE,\r
                         env=env)\r
    try:\r
        out, err = p.communicate()\r
    finally:\r
        subprocess._cleanup()\r
        p.stdout.close()\r
        p.stderr.close()\r
    rc = p.returncode\r
    err =  strip_python_stderr(err)\r
    if (rc and expected_success) or (not rc and not expected_success):\r
        raise AssertionError(\r
            "Process return code is %d, "\r
            "stderr follows:\n%s" % (rc, err.decode('ascii', 'ignore')))\r
    return rc, out, err\r
\r
def assert_python_ok(*args, **env_vars):\r
    """\r
    Assert that running the interpreter with `args` and optional environment\r
    variables `env_vars` is ok and return a (return code, stdout, stderr) tuple.\r
    """\r
    return _assert_python(True, *args, **env_vars)\r
\r
def assert_python_failure(*args, **env_vars):\r
    """\r
    Assert that running the interpreter with `args` and optional environment\r
    variables `env_vars` fails and return a (return code, stdout, stderr) tuple.\r
    """\r
    return _assert_python(False, *args, **env_vars)\r
\r
def python_exit_code(*args):\r
    cmd_line = [sys.executable, '-E']\r
    cmd_line.extend(args)\r
    with open(os.devnull, 'w') as devnull:\r
        return subprocess.call(cmd_line, stdout=devnull,\r
                                stderr=subprocess.STDOUT)\r
\r
def spawn_python(*args, **kwargs):\r
    cmd_line = [sys.executable, '-E']\r
    cmd_line.extend(args)\r
    return subprocess.Popen(cmd_line, stdin=subprocess.PIPE,\r
                            stdout=subprocess.PIPE, stderr=subprocess.STDOUT,\r
                            **kwargs)\r
\r
def kill_python(p):\r
    p.stdin.close()\r
    data = p.stdout.read()\r
    p.stdout.close()\r
    # try to cleanup the child so we don't appear to leak when running\r
    # with regrtest -R.\r
    p.wait()\r
    subprocess._cleanup()\r
    return data\r
\r
def run_python(*args, **kwargs):\r
    if __debug__:\r
        p = spawn_python(*args, **kwargs)\r
    else:\r
        p = spawn_python('-O', *args, **kwargs)\r
    stdout_data = kill_python(p)\r
    return p.wait(), stdout_data\r
\r
# Script creation utilities\r
@contextlib.contextmanager\r
def temp_dir():\r
    dirname = tempfile.mkdtemp()\r
    dirname = os.path.realpath(dirname)\r
    try:\r
        yield dirname\r
    finally:\r
        shutil.rmtree(dirname)\r
\r
def make_script(script_dir, script_basename, source):\r
    script_filename = script_basename+os.extsep+'py'\r
    script_name = os.path.join(script_dir, script_filename)\r
    script_file = open(script_name, 'w')\r
    script_file.write(source)\r
    script_file.close()\r
    return script_name\r
\r
def compile_script(script_name):\r
    py_compile.compile(script_name, doraise=True)\r
    if __debug__:\r
        compiled_name = script_name + 'c'\r
    else:\r
        compiled_name = script_name + 'o'\r
    return compiled_name\r
\r
def make_zip_script(zip_dir, zip_basename, script_name, name_in_zip=None):\r
    zip_filename = zip_basename+os.extsep+'zip'\r
    zip_name = os.path.join(zip_dir, zip_filename)\r
    zip_file = zipfile.ZipFile(zip_name, 'w')\r
    if name_in_zip is None:\r
        name_in_zip = os.path.basename(script_name)\r
    zip_file.write(script_name, name_in_zip)\r
    zip_file.close()\r
    #if test.test_support.verbose:\r
    #    zip_file = zipfile.ZipFile(zip_name, 'r')\r
    #    print 'Contents of %r:' % zip_name\r
    #    zip_file.printdir()\r
    #    zip_file.close()\r
    return zip_name, os.path.join(zip_name, name_in_zip)\r
\r
def make_pkg(pkg_dir):\r
    os.mkdir(pkg_dir)\r
    make_script(pkg_dir, '__init__', '')\r
\r
def make_zip_pkg(zip_dir, zip_basename, pkg_name, script_basename,\r
                 source, depth=1, compiled=False):\r
    unlink = []\r
    init_name = make_script(zip_dir, '__init__', '')\r
    unlink.append(init_name)\r
    init_basename = os.path.basename(init_name)\r
    script_name = make_script(zip_dir, script_basename, source)\r
    unlink.append(script_name)\r
    if compiled:\r
        init_name = compile_script(init_name)\r
        script_name = compile_script(script_name)\r
        unlink.extend((init_name, script_name))\r
    pkg_names = [os.sep.join([pkg_name]*i) for i in range(1, depth+1)]\r
    script_name_in_zip = os.path.join(pkg_names[-1], os.path.basename(script_name))\r
    zip_filename = zip_basename+os.extsep+'zip'\r
    zip_name = os.path.join(zip_dir, zip_filename)\r
    zip_file = zipfile.ZipFile(zip_name, 'w')\r
    for name in pkg_names:\r
        init_name_in_zip = os.path.join(name, init_basename)\r
        zip_file.write(init_name, init_name_in_zip)\r
    zip_file.write(script_name, script_name_in_zip)\r
    zip_file.close()\r
    for name in unlink:\r
        os.unlink(name)\r
    #if test.test_support.verbose:\r
    #    zip_file = zipfile.ZipFile(zip_name, 'r')\r
    #    print 'Contents of %r:' % zip_name\r
    #    zip_file.printdir()\r
    #    zip_file.close()\r
    return zip_name, os.path.join(zip_name, script_name_in_zip)\r