rules_python/tests/runfiles/pathlib_test.py at 1bc33b083b8d1f8f41edc46983c3287c0094124d · rickeylev/rules_python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
import os
import pathlib
import tempfile
import unittest

from python.runfiles import runfiles


class PathlibTest(unittest.TestCase):
    def setUp(self) -> None:
        self.tmpdir = tempfile.TemporaryDirectory(dir=os.environ.get("TEST_TMPDIR"))
        # Runfiles paths are expected to be posix paths internally when we construct the strings for assertions
        self.root_dir = pathlib.Path(self.tmpdir.name).as_posix()

    def tearDown(self) -> None:
        self.tmpdir.cleanup()

    def testPathApi(self) -> None:
        r = runfiles.Create({"RUNFILES_DIR": self.root_dir})
        assert r is not None
        root = r.root()

        # Test basic joining
        p = root / "repo/pkg/file.txt"
        self.assertEqual(str(p), f"{self.root_dir}/repo/pkg/file.txt")

        # Test PurePath API
        self.assertEqual(p.name, "file.txt")
        self.assertEqual(p.suffix, ".txt")
        self.assertEqual(p.parent.name, "pkg")
        self.assertEqual(p.parts, ("repo", "pkg", "file.txt"))
        self.assertEqual(p.stem, "file")
        self.assertEqual(p.suffixes, [".txt"])

        # Test multiple joins
        p2 = root / "repo" / "pkg" / "file.txt"
        self.assertEqual(p, p2)

        # Test joins with pathlib objects
        p3 = root / pathlib.PurePath("repo/pkg/file.txt")
        self.assertEqual(p, p3)

    def testRoot(self) -> None:
        r = runfiles.Create({"RUNFILES_DIR": self.root_dir})
        assert r is not None
        self.assertEqual(str(r.root()), self.root_dir)

    def testRunfilesRootMethod(self) -> None:
        r = runfiles.Create({"RUNFILES_DIR": self.root_dir})
        assert r is not None
        p = r.root() / "foo/bar"
        self.assertEqual(p.runfiles_root(), r.root())
        self.assertEqual(str(p.runfiles_root()), self.root_dir)

    def testOsPathLike(self) -> None:
        r = runfiles.Create({"RUNFILES_DIR": self.root_dir})
        assert r is not None
        p = r.root() / "foo"
        self.assertEqual(os.fspath(p), f"{self.root_dir}/foo")

    def testEqualityAndHash(self) -> None:
        r = runfiles.Create({"RUNFILES_DIR": self.root_dir})
        assert r is not None
        p1 = r.root() / "foo"
        p2 = r.root() / "foo"
        p3 = r.root() / "bar"

        self.assertEqual(p1, p2)
        self.assertNotEqual(p1, p3)
        self.assertEqual(hash(p1), hash(p2))

    def testJoinPath(self) -> None:
        r = runfiles.Create({"RUNFILES_DIR": self.root_dir})
        assert r is not None
        p = r.root().joinpath("repo", "file")
        self.assertEqual(str(p), f"{self.root_dir}/repo/file")

    def testParents(self) -> None:
        r = runfiles.Create({"RUNFILES_DIR": self.root_dir})
        assert r is not None
        p = r.root() / "a/b/c"
        parents = list(p.parents)
        self.assertEqual(len(parents), 3)
        self.assertEqual(str(parents[0]), f"{self.root_dir}/a/b")
        self.assertEqual(str(parents[1]), f"{self.root_dir}/a")
        self.assertEqual(str(parents[2]), self.root_dir)

    def testWithMethods(self) -> None:
        r = runfiles.Create({"RUNFILES_DIR": self.root_dir})
        assert r is not None
        p = r.root() / "foo/bar.txt"
        self.assertEqual(str(p.with_name("baz.py")), f"{self.root_dir}/foo/baz.py")
        self.assertEqual(str(p.with_suffix(".dat")), f"{self.root_dir}/foo/bar.dat")

    def testMatch(self) -> None:
        r = runfiles.Create({"RUNFILES_DIR": self.root_dir})
        assert r is not None
        p = r.root() / "foo/bar.txt"
        self.assertTrue(p.match("*.txt"))
        self.assertTrue(p.match("foo/*.txt"))
        self.assertFalse(p.match("bar/*.txt"))


if __name__ == "__main__":
    unittest.main()