mock glob

Author: rickeylev

python/private/pypi/whl_library_targets.bzl

@@ -30,7 +30,7 @@ load(
     "WHEEL_FILE_IMPL_LABEL",
     "WHEEL_FILE_PUBLIC_LABEL",
 )
-load(":namespace_pkgs.bzl", "create_inits")
+load(":namespace_pkgs.bzl", _create_inits = "create_inits")
 load(":pep508_deps.bzl", "deps")
 
 def whl_library_targets_from_requires(
@@ -120,6 +120,7 @@ def whl_library_targets(
             py_binary = py_binary,
             py_library = py_library,
             env_marker_setting = env_marker_setting,
+            create_inits = _create_inits,
         )):
     """Create all of the whl_library targets.
 
@@ -334,7 +335,7 @@ def whl_library_targets(
         if not enable_implicit_namespace_pkgs:
             srcs = srcs + getattr(native, "select", select)({
                 Label("//python/config_settings:is_venvs_site_packages"): [],
-                "//conditions:default": create_inits(
+                "//conditions:default": rules.create_inits(
                     srcs = srcs + data + pyi_srcs,
                     ignored_dirnames = [],  # If you need to ignore certain folders, you can patch rules_python here to do so.
                     root = "site-packages",

tests/pypi/whl_library_targets/whl_library_targets_tests.bzl

@@ -16,18 +16,14 @@
 
 load("@rules_testing//lib:test_suite.bzl", "test_suite")
 load("//python/private:glob_excludes.bzl", "glob_excludes")  # buildifier: disable=bzl-visibility
-load("//python/private/pypi:whl_library_targets.bzl", _whl_library_targets = "whl_library_targets", _whl_library_targets_from_requires = "whl_library_targets_from_requires")  # buildifier: disable=bzl-visibility
+load(
+    "//python/private/pypi:whl_library_targets.bzl",
+    "whl_library_targets",
+    "whl_library_targets_from_requires",
+)  # buildifier: disable=bzl-visibility
 
 _tests = []
 
-def whl_library_targets(**kwargs):
-    # Let's skip testing this for now
-    _whl_library_targets(enable_implicit_namespace_pkgs = True, **kwargs)
-
-def whl_library_targets_from_requires(**kwargs):
-    # Let's skip testing this for now
-    _whl_library_targets_from_requires(enable_implicit_namespace_pkgs = True, **kwargs)
-
 def _test_filegroups(env):
     calls = []
 
@@ -190,6 +186,12 @@ def _test_whl_and_library_deps_from_requires(env):
     py_library_calls = []
     env_marker_setting_calls = []
 
+    mock_glob = _mock_glob()
+
+    mock_glob.results.append(["site-packages/foo/SRCS.py"])
+    mock_glob.results.append(["site-packages/foo/DATA.txt"])
+    mock_glob.results.append(["site-packages/foo/PYI.pyi"])
+
     whl_library_targets_from_requires(
         name = "foo-0-py3-none-any.whl",
         metadata_name = "Foo",
@@ -208,12 +210,13 @@ def _test_whl_and_library_deps_from_requires(env):
         native = struct(
             filegroup = lambda **kwargs: filegroup_calls.append(kwargs),
             config_setting = lambda **_: None,
-            glob = _glob,
+            glob = mock_glob.glob,
             select = _select,
         ),
         rules = struct(
             py_library = lambda **kwargs: py_library_calls.append(kwargs),
             env_marker_setting = lambda **kwargs: env_marker_setting_calls.append(kwargs),
+            create_inits = lambda *args, **kwargs: ["_create_inits_target"],
         ),
     )
 
@@ -228,34 +231,51 @@ def _test_whl_and_library_deps_from_requires(env):
             "visibility": ["//visibility:public"],
         },
     ])  # buildifier: @unsorted-dict-items
-    env.expect.that_collection(py_library_calls).contains_exactly([
-        {
-            "name": "pkg",
-            "srcs": _glob(
-                ["site-packages/**/*.py"],
-                exclude = [],
-                allow_empty = True,
-            ),
-            "pyi_srcs": _glob(["site-packages/**/*.pyi"], allow_empty = True),
-            "data": [] + _glob(
-                ["site-packages/**/*"],
-                exclude = [
-                    "**/*.py",
-                    "**/*.pyc",
-                    "**/*.pyc.*",
-                    "**/*.dist-info/RECORD",
-                ] + glob_excludes.version_dependent_exclusions(),
-            ),
-            "imports": ["site-packages"],
-            "deps": ["@pypi//bar:pkg"] + _select({
-                ":is_include_bar_baz_true": ["@pypi//bar_baz:pkg"],
-                "//conditions:default": [],
-            }),
-            "tags": ["pypi_name=Foo", "pypi_version=0"],
-            "visibility": ["//visibility:public"],
-            "experimental_venvs_site_packages": Label("//python/config_settings:venvs_site_packages"),
-        },
-    ])  # buildifier: @unsorted-dict-items
+
+    env.expect.that_collection(py_library_calls).has_size(1)
+    if len(py_library_calls) != 1:
+        return
+    py_library_call = py_library_calls[0]
+
+    env.expect.that_dict(py_library_call).contains_exactly({
+        "name": "pkg",
+        "srcs": ["site-packages/foo/SRCS.py"] + _select({
+            Label("//python/config_settings:is_venvs_site_packages"): [],
+            "//conditions:default": ["_create_inits_target"],
+        }),
+        "pyi_srcs": ["site-packages/foo/PYI.pyi"],
+        "data": ["site-packages/foo/DATA.txt"],
+        "imports": ["site-packages"],
+        "deps": ["@pypi//bar:pkg"] + _select({
+            ":is_include_bar_baz_true": ["@pypi//bar_baz:pkg"],
+            "//conditions:default": [],
+        }),
+        "tags": ["pypi_name=Foo", "pypi_version=0"],
+        "visibility": ["//visibility:public"],
+        "experimental_venvs_site_packages": Label("//python/config_settings:venvs_site_packages"),
+    })  # buildifier: @unsorted-dict-items
+
+    env.expect.that_collection(mock_glob.calls).contains_exactly([
+        # srcs call
+        _glob_call(
+            ["site-packages/**/*.py"],
+            exclude = [],
+            allow_empty = True,
+        ),
+        # data call
+        _glob_call(
+            ["site-packages/**/*"],
+            exclude = [
+                "**/*.py",
+                "**/*.pyc",
+                "**/*.pyc.*",
+                "**/*.dist-info/RECORD",
+            ] + glob_excludes.version_dependent_exclusions(),
+        ),
+        # pyi call
+        _glob_call(["site-packages/**/*.pyi"], allow_empty = True),
+    ])
+
     env.expect.that_collection(env_marker_setting_calls).contains_exactly([
         {
             "name": "include_bar_baz",
@@ -269,6 +289,10 @@ _tests.append(_test_whl_and_library_deps_from_requires)
 def _test_whl_and_library_deps(env):
     filegroup_calls = []
     py_library_calls = []
+    mock_glob = _mock_glob()
+    mock_glob.results.append(["site-packages/foo/SRCS.py"])
+    mock_glob.results.append(["site-packages/foo/DATA.txt"])
+    mock_glob.results.append(["site-packages/foo/PYI.pyi"])
 
     whl_library_targets(
         name = "foo.whl",
@@ -290,11 +314,12 @@ def _test_whl_and_library_deps(env):
         native = struct(
             filegroup = lambda **kwargs: filegroup_calls.append(kwargs),
             config_setting = lambda **_: None,
-            glob = _glob,
+            glob = mock_glob.glob,
             select = _select,
         ),
         rules = struct(
             py_library = lambda **kwargs: py_library_calls.append(kwargs),
+            create_inits = lambda **kwargs: ["_create_inits_target"],
         ),
     )
 
@@ -320,52 +345,50 @@ def _test_whl_and_library_deps(env):
             "visibility": ["//visibility:public"],
         },
     ])  # buildifier: @unsorted-dict-items
-    env.expect.that_collection(py_library_calls).contains_exactly([
-        {
-            "name": "pkg",
-            "srcs": _glob(
-                ["site-packages/**/*.py"],
-                exclude = [],
-                allow_empty = True,
-            ),
-            "pyi_srcs": _glob(["site-packages/**/*.pyi"], allow_empty = True),
-            "data": [] + _glob(
-                ["site-packages/**/*"],
-                exclude = [
-                    "**/*.py",
-                    "**/*.pyc",
-                    "**/*.pyc.*",
-                    "**/*.dist-info/RECORD",
-                ] + glob_excludes.version_dependent_exclusions(),
-            ),
-            "imports": ["site-packages"],
-            "deps": [
-                "@pypi_bar_baz//:pkg",
-                "@pypi_foo//:pkg",
-            ] + _select(
-                {
-                    Label("//python/config_settings:is_python_3.9"): ["@pypi_py39_dep//:pkg"],
-                    "@platforms//cpu:aarch64": ["@pypi_arm_dep//:pkg"],
-                    "@platforms//os:windows": ["@pypi_win_dep//:pkg"],
-                    ":is_python_3.10_linux_ppc64le": ["@pypi_py310_linux_ppc64le_dep//:pkg"],
-                    ":is_python_3.9_anyos_aarch64": ["@pypi_py39_arm_dep//:pkg"],
-                    ":is_python_3.9_linux_anyarch": ["@pypi_py39_linux_dep//:pkg"],
-                    ":is_linux_x86_64": ["@pypi_linux_intel_dep//:pkg"],
-                    "//conditions:default": [],
-                },
-            ),
-            "tags": ["tag1", "tag2"],
-            "visibility": ["//visibility:public"],
-            "experimental_venvs_site_packages": Label("//python/config_settings:venvs_site_packages"),
-        },
-    ])  # buildifier: @unsorted-dict-items
+
+    env.expect.that_collection(py_library_calls).has_size(1)
+    if len(py_library_calls) != 1:
+        return
+    env.expect.that_dict(py_library_calls[0]).contains_exactly({
+        "name": "pkg",
+        "srcs": ["site-packages/foo/SRCS.py"] + _select({
+            Label("//python/config_settings:is_venvs_site_packages"): [],
+            "//conditions:default": ["_create_inits_target"],
+        }),
+        "pyi_srcs": ["site-packages/foo/PYI.pyi"],
+        "data": ["site-packages/foo/DATA.txt"],
+        "imports": ["site-packages"],
+        "deps": [
+            "@pypi_bar_baz//:pkg",
+            "@pypi_foo//:pkg",
+        ] + _select(
+            {
+                Label("//python/config_settings:is_python_3.9"): ["@pypi_py39_dep//:pkg"],
+                "@platforms//cpu:aarch64": ["@pypi_arm_dep//:pkg"],
+                "@platforms//os:windows": ["@pypi_win_dep//:pkg"],
+                ":is_python_3.10_linux_ppc64le": ["@pypi_py310_linux_ppc64le_dep//:pkg"],
+                ":is_python_3.9_anyos_aarch64": ["@pypi_py39_arm_dep//:pkg"],
+                ":is_python_3.9_linux_anyarch": ["@pypi_py39_linux_dep//:pkg"],
+                ":is_linux_x86_64": ["@pypi_linux_intel_dep//:pkg"],
+                "//conditions:default": [],
+            },
+        ),
+        "tags": ["tag1", "tag2"],
+        "visibility": ["//visibility:public"],
+        "experimental_venvs_site_packages": Label("//python/config_settings:venvs_site_packages"),
+    })  # buildifier: @unsorted-dict-items
 
 _tests.append(_test_whl_and_library_deps)
 
 def _test_group(env):
     alias_calls = []
     py_library_calls = []
 
+    mock_glob = _mock_glob()
+    mock_glob.results.append(["site-packages/foo/srcs.py"])
+    mock_glob.results.append(["site-packages/foo/data.txt"])
+    mock_glob.results.append(["site-packages/foo/pyi.pyi"])
+
     whl_library_targets(
         name = "foo.whl",
         dep_template = "@pypi_{name}//:{target}",
@@ -384,52 +407,85 @@ def _test_group(env):
         filegroups = {},
         native = struct(
             config_setting = lambda **_: None,
-            glob = _glob,
+            glob = mock_glob.glob,
             alias = lambda **kwargs: alias_calls.append(kwargs),
             select = _select,
         ),
         rules = struct(
             py_library = lambda **kwargs: py_library_calls.append(kwargs),
+            create_inits = lambda **kwargs: ["_create_inits_target"],
         ),
     )
 
     env.expect.that_collection(alias_calls).contains_exactly([
         {"name": "pkg", "actual": "@pypi__groups//:qux_pkg", "visibility": ["//visibility:public"]},
         {"name": "whl", "actual": "@pypi__groups//:qux_whl", "visibility": ["//visibility:public"]},
     ])  # buildifier: @unsorted-dict-items
-    env.expect.that_collection(py_library_calls).contains_exactly([
-        {
-            "name": "_pkg",
-            "srcs": _glob(["site-packages/**/*.py"], exclude = [], allow_empty = True),
-            "pyi_srcs": _glob(["site-packages/**/*.pyi"], allow_empty = True),
-            "data": [] + _glob(
-                ["site-packages/**/*"],
-                exclude = [
-                    "**/*.py",
-                    "**/*.pyc",
-                    "**/*.pyc.*",
-                    "**/*.dist-info/RECORD",
-                ] + glob_excludes.version_dependent_exclusions(),
-            ),
-            "imports": ["site-packages"],
-            "deps": ["@pypi_bar_baz//:pkg"] + _select({
-                "@platforms//os:linux": ["@pypi_box//:pkg"],
-                ":is_linux_x86_64": ["@pypi_box//:pkg", "@pypi_box_amd64//:pkg"],
-                "//conditions:default": [],
-            }),
-            "tags": [],
-            "visibility": ["@pypi__groups//:__pkg__"],
-            "experimental_venvs_site_packages": Label("//python/config_settings:venvs_site_packages"),
-        },
-    ])  # buildifier: @unsorted-dict-items
+
+    env.expect.that_collection(py_library_calls).has_size(1)
+    if len(py_library_calls) != 1:
+        return
+
+    py_library_call = py_library_calls[0]
+    env.expect.where(case = "verify py library call").that_dict(
+        py_library_call,
+    ).contains_exactly({
+        "name": "_pkg",
+        "srcs": ["site-packages/foo/srcs.py"] + _select({
+            Label("//python/config_settings:is_venvs_site_packages"): [],
+            "//conditions:default": ["_create_inits_target"],
+        }),
+        "pyi_srcs": ["site-packages/foo/pyi.pyi"],
+        "data": ["site-packages/foo/data.txt"],
+        "imports": ["site-packages"],
+        "deps": ["@pypi_bar_baz//:pkg"] + _select({
+            "@platforms//os:linux": ["@pypi_box//:pkg"],
+            ":is_linux_x86_64": ["@pypi_box//:pkg", "@pypi_box_amd64//:pkg"],
+            "//conditions:default": [],
+        }),
+        "tags": [],
+        "visibility": ["@pypi__groups//:__pkg__"],
+        "experimental_venvs_site_packages": Label("//python/config_settings:venvs_site_packages"),
+    })  # buildifier: @unsorted-dict-items
+
+    env.expect.that_collection(mock_glob.calls, expr = "glob calls").contains_exactly([
+        _glob_call(["site-packages/**/*.py"], exclude = [], allow_empty = True),
+        _glob_call(["site-packages/**/*"], exclude = [
+            "**/*.py",
+            "**/*.pyc",
+            "**/*.pyc.*",
+            "**/*.dist-info/RECORD",
+        ]),
+        _glob_call(["site-packages/**/*.pyi"], allow_empty = True),
+    ])
 
 _tests.append(_test_group)
 
 def _glob(*args, **kwargs):
-    return [struct(
+    return [_glob_call(*args, **kwargs)]
+
+def _glob_call(*args, **kwargs):
+    return struct(
         glob = args,
         kwargs = kwargs,
-    )]
+    )
+
+def _mock_glob():
+    def glob(*args, **kwargs):
+        mock.calls.append(_glob_call(*args, **kwargs))
+        if not mock.results:
+            fail("Mock glob missing for invocation: args={} kwargs={}".format(
+                args,
+                kwargs,
+            ))
+        return mock.results.pop(0)
+
+    mock = struct(
+        calls = [],
+        results = [],
+        glob = glob,
+    )
+    return mock
 
 def _select(*args, **kwargs):
     """We need to have this mock select because we still need to support bazel 6."""