EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

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

"""Tests for 'site'.\r
\r
Tests assume the initial paths in sys.path once the interpreter has begun\r
executing have not been removed.\r
\r
"""\r
import unittest\r
from test.test_support import run_unittest, TESTFN, EnvironmentVarGuard\r
from test.test_support import captured_output\r
import __builtin__\r
import os\r
import sys\r
import re\r
import encodings\r
import subprocess\r
import sysconfig\r
from copy import copy\r
\r
# Need to make sure to not import 'site' if someone specified ``-S`` at the\r
# command-line.  Detect this by just making sure 'site' has not been imported\r
# already.\r
if "site" in sys.modules:\r
    import site\r
else:\r
    raise unittest.SkipTest("importation of site.py suppressed")\r
\r
if not os.path.isdir(site.USER_SITE):\r
    # need to add user site directory for tests\r
    os.makedirs(site.USER_SITE)\r
    site.addsitedir(site.USER_SITE)\r
\r
class HelperFunctionsTests(unittest.TestCase):\r
    """Tests for helper functions.\r
\r
    The setting of the encoding (set using sys.setdefaultencoding) used by\r
    the Unicode implementation is not tested.\r
\r
    """\r
\r
    def setUp(self):\r
        """Save a copy of sys.path"""\r
        self.sys_path = sys.path[:]\r
        self.old_base = site.USER_BASE\r
        self.old_site = site.USER_SITE\r
        self.old_prefixes = site.PREFIXES\r
        self.old_vars = copy(sysconfig._CONFIG_VARS)\r
\r
    def tearDown(self):\r
        """Restore sys.path"""\r
        sys.path[:] = self.sys_path\r
        site.USER_BASE = self.old_base\r
        site.USER_SITE = self.old_site\r
        site.PREFIXES = self.old_prefixes\r
        sysconfig._CONFIG_VARS = self.old_vars\r
\r
    def test_makepath(self):\r
        # Test makepath() have an absolute path for its first return value\r
        # and a case-normalized version of the absolute path for its\r
        # second value.\r
        path_parts = ("Beginning", "End")\r
        original_dir = os.path.join(*path_parts)\r
        abs_dir, norm_dir = site.makepath(*path_parts)\r
        self.assertEqual(os.path.abspath(original_dir), abs_dir)\r
        if original_dir == os.path.normcase(original_dir):\r
            self.assertEqual(abs_dir, norm_dir)\r
        else:\r
            self.assertEqual(os.path.normcase(abs_dir), norm_dir)\r
\r
    def test_init_pathinfo(self):\r
        dir_set = site._init_pathinfo()\r
        for entry in [site.makepath(path)[1] for path in sys.path\r
                        if path and os.path.isdir(path)]:\r
            self.assertIn(entry, dir_set,\r
                          "%s from sys.path not found in set returned "\r
                          "by _init_pathinfo(): %s" % (entry, dir_set))\r
\r
    def pth_file_tests(self, pth_file):\r
        """Contain common code for testing results of reading a .pth file"""\r
        self.assertIn(pth_file.imported, sys.modules,\r
                      "%s not in sys.modules" % pth_file.imported)\r
        self.assertIn(site.makepath(pth_file.good_dir_path)[0], sys.path)\r
        self.assertFalse(os.path.exists(pth_file.bad_dir_path))\r
\r
    def test_addpackage(self):\r
        # Make sure addpackage() imports if the line starts with 'import',\r
        # adds directories to sys.path for any line in the file that is not a\r
        # comment or import that is a valid directory name for where the .pth\r
        # file resides; invalid directories are not added\r
        pth_file = PthFile()\r
        pth_file.cleanup(prep=True)  # to make sure that nothing is\r
                                      # pre-existing that shouldn't be\r
        try:\r
            pth_file.create()\r
            site.addpackage(pth_file.base_dir, pth_file.filename, set())\r
            self.pth_file_tests(pth_file)\r
        finally:\r
            pth_file.cleanup()\r
\r
    def make_pth(self, contents, pth_dir='.', pth_name=TESTFN):\r
        # Create a .pth file and return its (abspath, basename).\r
        pth_dir = os.path.abspath(pth_dir)\r
        pth_basename = pth_name + '.pth'\r
        pth_fn = os.path.join(pth_dir, pth_basename)\r
        pth_file = open(pth_fn, 'w')\r
        self.addCleanup(lambda: os.remove(pth_fn))\r
        pth_file.write(contents)\r
        pth_file.close()\r
        return pth_dir, pth_basename\r
\r
    def test_addpackage_import_bad_syntax(self):\r
        # Issue 10642\r
        pth_dir, pth_fn = self.make_pth("import bad)syntax\n")\r
        with captured_output("stderr") as err_out:\r
            site.addpackage(pth_dir, pth_fn, set())\r
        self.assertRegexpMatches(err_out.getvalue(), "line 1")\r
        self.assertRegexpMatches(err_out.getvalue(),\r
            re.escape(os.path.join(pth_dir, pth_fn)))\r
        # XXX: the previous two should be independent checks so that the\r
        # order doesn't matter.  The next three could be a single check\r
        # but my regex foo isn't good enough to write it.\r
        self.assertRegexpMatches(err_out.getvalue(), 'Traceback')\r
        self.assertRegexpMatches(err_out.getvalue(), r'import bad\)syntax')\r
        self.assertRegexpMatches(err_out.getvalue(), 'SyntaxError')\r
\r
    def test_addpackage_import_bad_exec(self):\r
        # Issue 10642\r
        pth_dir, pth_fn = self.make_pth("randompath\nimport nosuchmodule\n")\r
        with captured_output("stderr") as err_out:\r
            site.addpackage(pth_dir, pth_fn, set())\r
        self.assertRegexpMatches(err_out.getvalue(), "line 2")\r
        self.assertRegexpMatches(err_out.getvalue(),\r
            re.escape(os.path.join(pth_dir, pth_fn)))\r
        # XXX: ditto previous XXX comment.\r
        self.assertRegexpMatches(err_out.getvalue(), 'Traceback')\r
        self.assertRegexpMatches(err_out.getvalue(), 'ImportError')\r
\r
    @unittest.skipIf(sys.platform == "win32", "Windows does not raise an "\r
                      "error for file paths containing null characters")\r
    def test_addpackage_import_bad_pth_file(self):\r
        # Issue 5258\r
        pth_dir, pth_fn = self.make_pth("abc\x00def\n")\r
        with captured_output("stderr") as err_out:\r
            site.addpackage(pth_dir, pth_fn, set())\r
        self.assertRegexpMatches(err_out.getvalue(), "line 1")\r
        self.assertRegexpMatches(err_out.getvalue(),\r
            re.escape(os.path.join(pth_dir, pth_fn)))\r
        # XXX: ditto previous XXX comment.\r
        self.assertRegexpMatches(err_out.getvalue(), 'Traceback')\r
        self.assertRegexpMatches(err_out.getvalue(), 'TypeError')\r
\r
    def test_addsitedir(self):\r
        # Same tests for test_addpackage since addsitedir() essentially just\r
        # calls addpackage() for every .pth file in the directory\r
        pth_file = PthFile()\r
        pth_file.cleanup(prep=True) # Make sure that nothing is pre-existing\r
                                    # that is tested for\r
        try:\r
            pth_file.create()\r
            site.addsitedir(pth_file.base_dir, set())\r
            self.pth_file_tests(pth_file)\r
        finally:\r
            pth_file.cleanup()\r
\r
    def test_s_option(self):\r
        usersite = site.USER_SITE\r
        self.assertIn(usersite, sys.path)\r
\r
        env = os.environ.copy()\r
        rc = subprocess.call([sys.executable, '-c',\r
            'import sys; sys.exit(%r in sys.path)' % usersite],\r
            env=env)\r
        self.assertEqual(rc, 1, "%r is not in sys.path (sys.exit returned %r)"\r
                % (usersite, rc))\r
\r
        env = os.environ.copy()\r
        rc = subprocess.call([sys.executable, '-s', '-c',\r
            'import sys; sys.exit(%r in sys.path)' % usersite],\r
            env=env)\r
        self.assertEqual(rc, 0)\r
\r
        env = os.environ.copy()\r
        env["PYTHONNOUSERSITE"] = "1"\r
        rc = subprocess.call([sys.executable, '-c',\r
            'import sys; sys.exit(%r in sys.path)' % usersite],\r
            env=env)\r
        self.assertEqual(rc, 0)\r
\r
        env = os.environ.copy()\r
        env["PYTHONUSERBASE"] = "/tmp"\r
        rc = subprocess.call([sys.executable, '-c',\r
            'import sys, site; sys.exit(site.USER_BASE.startswith("/tmp"))'],\r
            env=env)\r
        self.assertEqual(rc, 1)\r
\r
    def test_getuserbase(self):\r
        site.USER_BASE = None\r
        user_base = site.getuserbase()\r
\r
        # the call sets site.USER_BASE\r
        self.assertEqual(site.USER_BASE, user_base)\r
\r
        # let's set PYTHONUSERBASE and see if it uses it\r
        site.USER_BASE = None\r
        import sysconfig\r
        sysconfig._CONFIG_VARS = None\r
\r
        with EnvironmentVarGuard() as environ:\r
            environ['PYTHONUSERBASE'] = 'xoxo'\r
            self.assertTrue(site.getuserbase().startswith('xoxo'),\r
                            site.getuserbase())\r
\r
    def test_getusersitepackages(self):\r
        site.USER_SITE = None\r
        site.USER_BASE = None\r
        user_site = site.getusersitepackages()\r
\r
        # the call sets USER_BASE *and* USER_SITE\r
        self.assertEqual(site.USER_SITE, user_site)\r
        self.assertTrue(user_site.startswith(site.USER_BASE), user_site)\r
\r
    def test_getsitepackages(self):\r
        site.PREFIXES = ['xoxo']\r
        dirs = site.getsitepackages()\r
\r
        if sys.platform in ('os2emx', 'riscos'):\r
            self.assertEqual(len(dirs), 1)\r
            wanted = os.path.join('xoxo', 'Lib', 'site-packages')\r
            self.assertEqual(dirs[0], wanted)\r
        elif os.sep == '/':\r
            self.assertEqual(len(dirs), 2)\r
            wanted = os.path.join('xoxo', 'lib', 'python' + sys.version[:3],\r
                                  'site-packages')\r
            self.assertEqual(dirs[0], wanted)\r
            wanted = os.path.join('xoxo', 'lib', 'site-python')\r
            self.assertEqual(dirs[1], wanted)\r
        else:\r
            self.assertEqual(len(dirs), 2)\r
            self.assertEqual(dirs[0], 'xoxo')\r
            wanted = os.path.join('xoxo', 'lib', 'site-packages')\r
            self.assertEqual(dirs[1], wanted)\r
\r
        # let's try the specific Apple location\r
        if (sys.platform == "darwin" and\r
            sysconfig.get_config_var("PYTHONFRAMEWORK")):\r
            site.PREFIXES = ['Python.framework']\r
            dirs = site.getsitepackages()\r
            self.assertEqual(len(dirs), 4)\r
            wanted = os.path.join('~', 'Library', 'Python',\r
                                  sys.version[:3], 'site-packages')\r
            self.assertEqual(dirs[2], os.path.expanduser(wanted))\r
            wanted = os.path.join('/Library', 'Python', sys.version[:3],\r
                                  'site-packages')\r
            self.assertEqual(dirs[3], wanted)\r
\r
class PthFile(object):\r
    """Helper class for handling testing of .pth files"""\r
\r
    def __init__(self, filename_base=TESTFN, imported="time",\r
                    good_dirname="__testdir__", bad_dirname="__bad"):\r
        """Initialize instance variables"""\r
        self.filename = filename_base + ".pth"\r
        self.base_dir = os.path.abspath('')\r
        self.file_path = os.path.join(self.base_dir, self.filename)\r
        self.imported = imported\r
        self.good_dirname = good_dirname\r
        self.bad_dirname = bad_dirname\r
        self.good_dir_path = os.path.join(self.base_dir, self.good_dirname)\r
        self.bad_dir_path = os.path.join(self.base_dir, self.bad_dirname)\r
\r
    def create(self):\r
        """Create a .pth file with a comment, blank lines, an ``import\r
        <self.imported>``, a line with self.good_dirname, and a line with\r
        self.bad_dirname.\r
\r
        Creation of the directory for self.good_dir_path (based off of\r
        self.good_dirname) is also performed.\r
\r
        Make sure to call self.cleanup() to undo anything done by this method.\r
\r
        """\r
        FILE = open(self.file_path, 'w')\r
        try:\r
            print>>FILE, "#import @bad module name"\r
            print>>FILE, "\n"\r
            print>>FILE, "import %s" % self.imported\r
            print>>FILE, self.good_dirname\r
            print>>FILE, self.bad_dirname\r
        finally:\r
            FILE.close()\r
        os.mkdir(self.good_dir_path)\r
\r
    def cleanup(self, prep=False):\r
        """Make sure that the .pth file is deleted, self.imported is not in\r
        sys.modules, and that both self.good_dirname and self.bad_dirname are\r
        not existing directories."""\r
        if os.path.exists(self.file_path):\r
            os.remove(self.file_path)\r
        if prep:\r
            self.imported_module = sys.modules.get(self.imported)\r
            if self.imported_module:\r
                del sys.modules[self.imported]\r
        else:\r
            if self.imported_module:\r
                sys.modules[self.imported] = self.imported_module\r
        if os.path.exists(self.good_dir_path):\r
            os.rmdir(self.good_dir_path)\r
        if os.path.exists(self.bad_dir_path):\r
            os.rmdir(self.bad_dir_path)\r
\r
class ImportSideEffectTests(unittest.TestCase):\r
    """Test side-effects from importing 'site'."""\r
\r
    def setUp(self):\r
        """Make a copy of sys.path"""\r
        self.sys_path = sys.path[:]\r
\r
    def tearDown(self):\r
        """Restore sys.path"""\r
        sys.path[:] = self.sys_path\r
\r
    def test_abs__file__(self):\r
        # Make sure all imported modules have their __file__ attribute\r
        # as an absolute path.\r
        # Handled by abs__file__()\r
        site.abs__file__()\r
        for module in (sys, os, __builtin__):\r
            try:\r
                self.assertTrue(os.path.isabs(module.__file__), repr(module))\r
            except AttributeError:\r
                continue\r
        # We could try everything in sys.modules; however, when regrtest.py\r
        # runs something like test_frozen before test_site, then we will\r
        # be testing things loaded *after* test_site did path normalization\r
\r
    def test_no_duplicate_paths(self):\r
        # No duplicate paths should exist in sys.path\r
        # Handled by removeduppaths()\r
        site.removeduppaths()\r
        seen_paths = set()\r
        for path in sys.path:\r
            self.assertNotIn(path, seen_paths)\r
            seen_paths.add(path)\r
\r
    def test_add_build_dir(self):\r
        # Test that the build directory's Modules directory is used when it\r
        # should be.\r
        # XXX: implement\r
        pass\r
\r
    def test_setting_quit(self):\r
        # 'quit' and 'exit' should be injected into __builtin__\r
        self.assertTrue(hasattr(__builtin__, "quit"))\r
        self.assertTrue(hasattr(__builtin__, "exit"))\r
\r
    def test_setting_copyright(self):\r
        # 'copyright' and 'credits' should be in __builtin__\r
        self.assertTrue(hasattr(__builtin__, "copyright"))\r
        self.assertTrue(hasattr(__builtin__, "credits"))\r
\r
    def test_setting_help(self):\r
        # 'help' should be set in __builtin__\r
        self.assertTrue(hasattr(__builtin__, "help"))\r
\r
    def test_aliasing_mbcs(self):\r
        if sys.platform == "win32":\r
            import locale\r
            if locale.getdefaultlocale()[1].startswith('cp'):\r
                for value in encodings.aliases.aliases.itervalues():\r
                    if value == "mbcs":\r
                        break\r
                else:\r
                    self.fail("did not alias mbcs")\r
\r
    def test_setdefaultencoding_removed(self):\r
        # Make sure sys.setdefaultencoding is gone\r
        self.assertTrue(not hasattr(sys, "setdefaultencoding"))\r
\r
    def test_sitecustomize_executed(self):\r
        # If sitecustomize is available, it should have been imported.\r
        if "sitecustomize" not in sys.modules:\r
            try:\r
                import sitecustomize\r
            except ImportError:\r
                pass\r
            else:\r
                self.fail("sitecustomize not imported automatically")\r
\r
def test_main():\r
    run_unittest(HelperFunctionsTests, ImportSideEffectTests)\r
\r
if __name__ == "__main__":\r
    test_main()\r