File: test_file_path_provider.py

package info (click to toggle)
python-libcst 1.8.6-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,240 kB
  • sloc: python: 78,096; makefile: 15; sh: 2
file content (145 lines) | stat: -rw-r--r-- 5,153 bytes parent folder | download | duplicates (2)
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# Copyright (c) Meta Platforms, Inc. and affiliates.
#
# This source code is licensed under the MIT license found in the
# LICENSE file in the root directory of this source tree.

from pathlib import Path
from tempfile import TemporaryDirectory
from typing import Set

import libcst
from libcst._visitors import CSTVisitor
from libcst.helpers.paths import chdir
from libcst.metadata import FilePathProvider, FullRepoManager, MetadataWrapper
from libcst.testing.utils import UnitTest


class FilePathProviderTest(UnitTest):
    def setUp(self) -> None:
        self.td = TemporaryDirectory()
        self.tdp = Path(self.td.name).resolve()
        self.addCleanup(self.td.cleanup)

    def test_provider_cache(self) -> None:
        pkg = self.tdp / "pkg"
        pkg.mkdir()
        files = [Path(pkg / name) for name in ("file1.py", "file2.py", "file3.py")]
        [file.write_text("print('hello')\n") for file in files]

        with self.subTest("absolute paths"):
            repo_manager = FullRepoManager(
                self.tdp, [f.as_posix() for f in files], {FilePathProvider}
            )
            repo_manager.resolve_cache()

            expected = {
                FilePathProvider: {f.as_posix(): f for f in files},
            }
            self.assertDictEqual(expected, repo_manager.cache)

        with self.subTest("repo relative paths"):
            repo_manager = FullRepoManager(
                self.tdp,
                [f.relative_to(self.tdp).as_posix() for f in files],
                {FilePathProvider},
            )
            repo_manager.resolve_cache()

            expected = {
                FilePathProvider: {
                    f.relative_to(self.tdp).as_posix(): f for f in files
                },
            }
            self.assertDictEqual(expected, repo_manager.cache)

        with self.subTest("dot relative paths"):
            with chdir(self.tdp):
                repo_manager = FullRepoManager(
                    ".",
                    [f.relative_to(self.tdp).as_posix() for f in files],
                    {FilePathProvider},
                )
                repo_manager.resolve_cache()

                expected = {
                    FilePathProvider: {
                        f.relative_to(self.tdp).as_posix(): f for f in files
                    },
                }
                self.assertDictEqual(expected, repo_manager.cache)

    def test_visitor(self) -> None:
        pkg = self.tdp / "pkg"
        pkg.mkdir()
        files = [Path(pkg / name) for name in ("file1.py", "file2.py", "file3.py")]
        [file.write_text("print('hello')\n") for file in files]

        seen: Set[Path] = set()

        class FakeVisitor(CSTVisitor):
            METADATA_DEPENDENCIES = [FilePathProvider]

            def visit_Module(self, node: libcst.Module) -> None:
                seen.add(self.get_metadata(FilePathProvider, node))

        with self.subTest("absolute paths"):
            seen.clear()
            repo_manager = FullRepoManager(
                self.tdp, [f.as_posix() for f in files], {FilePathProvider}
            )
            repo_manager.resolve_cache()

            for file in files:
                module = libcst.parse_module(file.read_bytes())
                wrapper = MetadataWrapper(
                    module, cache=repo_manager.get_cache_for_path(file.as_posix())
                )
                wrapper.visit(FakeVisitor())

            expected = set(files)
            self.assertSetEqual(expected, seen)

        with self.subTest("repo relative paths"):
            seen.clear()
            repo_manager = FullRepoManager(
                self.tdp,
                [f.relative_to(self.tdp).as_posix() for f in files],
                {FilePathProvider},
            )
            repo_manager.resolve_cache()

            for file in files:
                module = libcst.parse_module(file.read_bytes())
                wrapper = MetadataWrapper(
                    module,
                    cache=repo_manager.get_cache_for_path(
                        file.relative_to(self.tdp).as_posix()
                    ),
                )
                wrapper.visit(FakeVisitor())

            expected = set(files)
            self.assertSetEqual(expected, seen)

        with self.subTest("dot relative paths"):
            with chdir(self.tdp):
                seen.clear()
                repo_manager = FullRepoManager(
                    ".",
                    [f.relative_to(self.tdp).as_posix() for f in files],
                    {FilePathProvider},
                )
                repo_manager.resolve_cache()

                for file in files:
                    module = libcst.parse_module(file.read_bytes())
                    wrapper = MetadataWrapper(
                        module,
                        cache=repo_manager.get_cache_for_path(
                            file.relative_to(self.tdp).as_posix()
                        ),
                    )
                    wrapper.visit(FakeVisitor())

                expected = set(files)
                self.assertSetEqual(expected, seen)