Merge pull request #848 from LalatenduMohanty/add_return_annotaions_to_tests

test: add return type annotations to all test functions

Author: mergify[bot]

tests/test_bootstrap.py

@@ -12,17 +12,17 @@
 from fromager.commands import bootstrap
 
 
-def test_get_requirements_single_arg():
+def test_get_requirements_single_arg() -> None:
     requirements = bootstrap._get_requirements_from_args(["a"], [])
     assert [Requirement("a")] == requirements
 
 
-def test_get_requirements_multiple_args():
+def test_get_requirements_multiple_args() -> None:
     requirements = bootstrap._get_requirements_from_args(["a", "b"], [])
     assert [Requirement("a"), Requirement("b")] == requirements
 
 
-def test_get_requirements_args_and_file(tmp_path: pathlib.Path):
+def test_get_requirements_args_and_file(tmp_path: pathlib.Path) -> None:
     requirements_file = tmp_path / "requirements.txt"
     requirements_file.write_text("c\n")
     requirements = bootstrap._get_requirements_from_args(
@@ -35,14 +35,14 @@ def test_get_requirements_args_and_file(tmp_path: pathlib.Path):
     ] == requirements
 
 
-def test_ignore_based_on_marker():
+def test_ignore_based_on_marker() -> None:
     requirements = bootstrap._get_requirements_from_args(
         ['foo; python_version<"3.9"'], []
     )
     assert [] == requirements
 
 
-def test_write_constraints_file_simple():
+def test_write_constraints_file_simple() -> None:
     buffer = io.StringIO()
     raw_graph = {
         "": {
@@ -87,7 +87,7 @@ def test_write_constraints_file_simple():
     assert expected == buffer.getvalue()
 
 
-def test_write_constraints_file_resolvable_duplicate():
+def test_write_constraints_file_resolvable_duplicate() -> None:
     buffer = io.StringIO()
     raw_graph = {
         "": {
@@ -140,7 +140,7 @@ def test_write_constraints_file_resolvable_duplicate():
     assert expected == buffer.getvalue()
 
 
-def test_write_constraints_file_unresolvable_duplicate():
+def test_write_constraints_file_unresolvable_duplicate() -> None:
     """Test that unresolvable duplicates cause the function to return False and not write conflicting constraints.
 
     This test has conflicting requirements for package 'c':
@@ -203,7 +203,7 @@ def test_write_constraints_file_unresolvable_duplicate():
     assert "c==" not in output  # No conflicting c versions should be written
 
 
-def test_write_constraints_file_duplicates():
+def test_write_constraints_file_duplicates() -> None:
     buffer = io.StringIO()
     raw_graph = {
         "": {
@@ -283,7 +283,7 @@ def test_write_constraints_file_duplicates():
     assert "b==" not in output_content
 
 
-def test_write_constraints_file_multiples():
+def test_write_constraints_file_multiples() -> None:
     buffer = io.StringIO()
     raw_graph = {
         "": {
@@ -342,7 +342,7 @@ def test_write_constraints_file_multiples():
     assert expected == buffer.getvalue()
 
 
-def test_write_constraints_file_prevents_false_resolution():
+def test_write_constraints_file_prevents_false_resolution() -> None:
     """Test that packages marked as unresolvable in early iterations stay unresolvable.
 
     This test validates the fix for the bug where a package could appear unresolvable
@@ -452,7 +452,7 @@ def test_write_constraints_file_prevents_false_resolution():
     assert "conflicted==" not in output_content
 
 
-def test_to_constraints_command_no_file_on_failure(tmp_path):
+def test_to_constraints_command_no_file_on_failure(tmp_path: pathlib.Path) -> None:
     """Test that the to-constraints logic doesn't create output files when there are constraint conflicts.
 
     This is a regression test for the bug where constraint resolution would write partial
@@ -531,7 +531,7 @@ def test_to_constraints_command_no_file_on_failure(tmp_path):
     )
 
 
-def test_skip_constraints_cli_option():
+def test_skip_constraints_cli_option() -> None:
     """Test that the --skip-constraints option is available in the CLI"""
     runner = CliRunner()
     result = runner.invoke(bootstrap.bootstrap, ["--help"])
@@ -545,7 +545,7 @@ def test_skip_constraints_cli_option():
 def test_resolve_version_from_git_url_with_submodules_enabled(
     mock_git_clone: Mock,
     tmp_context: context.WorkContext,
-):
+) -> None:
     """Test that git_clone is called with submodules=True when configured."""
     req = Requirement("test-pkg @ git+https://github.com/example/repo.git")
 
@@ -582,7 +582,7 @@ def test_resolve_version_from_git_url_with_submodules_enabled(
 def test_resolve_version_from_git_url_with_specific_submodule_paths(
     mock_git_clone: Mock,
     tmp_context: context.WorkContext,
-):
+) -> None:
     """Test that git_clone is called with specific submodule paths when configured."""
     req = Requirement("test-pkg @ git+https://github.com/example/repo.git")
 
@@ -618,7 +618,7 @@ def test_resolve_version_from_git_url_with_specific_submodule_paths(
 def test_resolve_version_from_git_url_with_submodules_disabled(
     mock_git_clone: Mock,
     tmp_context: context.WorkContext,
-):
+) -> None:
     """Test that git_clone is called with submodules=False by default."""
     req = Requirement("test-pkg @ git+https://github.com/example/repo.git")
 
@@ -645,7 +645,7 @@ def test_resolve_version_from_git_url_with_submodules_disabled(
 def test_resolve_version_from_git_url_with_git_ref(
     mock_git_clone: Mock,
     tmp_context: context.WorkContext,
-):
+) -> None:
     """Test that git_clone is called with the correct ref when URL includes @ref."""
     req = Requirement("test-pkg @ git+https://github.com/example/repo.git@v1.2.3")
 
@@ -677,7 +677,9 @@ def test_resolve_version_from_git_url_with_git_ref(
     assert call_args.kwargs["ref"] == "v1.2.3"
 
 
-def test_resolve_version_from_git_url_invalid_scheme(tmp_context: context.WorkContext):
+def test_resolve_version_from_git_url_invalid_scheme(
+    tmp_context: context.WorkContext,
+) -> None:
     """Test that non-git URLs raise ValueError."""
     req = Requirement("test-pkg @ https://github.com/example/repo.git")
 

tests/test_bootstrapper.py

@@ -60,7 +60,7 @@
 )
 
 
-def test_resolve_from_graph_no_changes(tmp_context: WorkContext):
+def test_resolve_from_graph_no_changes(tmp_context: WorkContext) -> None:
     bt = bootstrapper.Bootstrapper(tmp_context, None, old_graph)
     bt.why = [(RequirementType.TOP_LEVEL, Requirement("foo"), Version("1.0.0"))]
 
@@ -98,7 +98,7 @@ def test_resolve_from_graph_no_changes(tmp_context: WorkContext):
     ) == ("", Version("5"))
 
 
-def test_resolve_from_graph_install_dep_upgrade(tmp_context: WorkContext):
+def test_resolve_from_graph_install_dep_upgrade(tmp_context: WorkContext) -> None:
     bt = bootstrapper.Bootstrapper(tmp_context, None, old_graph)
 
     # simulating new bootstrap with a toplevel requirement of pbr==8
@@ -135,7 +135,7 @@ def test_resolve_from_graph_install_dep_upgrade(tmp_context: WorkContext):
     ) == ("", Version("5"))
 
 
-def test_resolve_from_graph_install_dep_downgrade(tmp_context: WorkContext):
+def test_resolve_from_graph_install_dep_downgrade(tmp_context: WorkContext) -> None:
     bt = bootstrapper.Bootstrapper(tmp_context, None, old_graph)
 
     # simulating new bootstrap with a toplevel requirement of pbr<=6
@@ -172,7 +172,7 @@ def test_resolve_from_graph_install_dep_downgrade(tmp_context: WorkContext):
     ) == ("", Version("5"))
 
 
-def test_resolve_from_graph_toplevel_dep(tmp_context: WorkContext):
+def test_resolve_from_graph_toplevel_dep(tmp_context: WorkContext) -> None:
     bt = bootstrapper.Bootstrapper(tmp_context, None, old_graph)
 
     # simulating new bootstrap with a toplevel requirement for foo
@@ -226,19 +226,19 @@ def test_resolve_from_graph_toplevel_dep(tmp_context: WorkContext):
     ) == ("", Version("6"))
 
 
-def test_seen(tmp_context):
+def test_seen(tmp_context: WorkContext) -> None:
     bt = bootstrapper.Bootstrapper(tmp_context)
     req = Requirement("testdist")
-    version = "1.2"
+    version = Version("1.2")
     assert not bt._has_been_seen(req, version)
     bt._mark_as_seen(req, version)
     assert bt._has_been_seen(req, version)
 
 
-def test_seen_extras(tmp_context):
+def test_seen_extras(tmp_context: WorkContext) -> None:
     req1 = Requirement("testdist")
     req2 = Requirement("testdist[extra]")
-    version = "1.2"
+    version = Version("1.2")
     bt = bootstrapper.Bootstrapper(tmp_context)
     assert not bt._has_been_seen(req1, version)
     bt._mark_as_seen(req1, version)
@@ -249,19 +249,19 @@ def test_seen_extras(tmp_context):
     assert bt._has_been_seen(req2, version)
 
 
-def test_seen_name_canonicalization(tmp_context):
+def test_seen_name_canonicalization(tmp_context: WorkContext) -> None:
     req = Requirement("flit_core")
-    version = "1.2"
+    version = Version("1.2")
     bt = bootstrapper.Bootstrapper(tmp_context)
     assert not bt._has_been_seen(req, version)
     bt._mark_as_seen(req, version)
     assert bt._has_been_seen(req, version)
 
 
-def test_seen_requirements_sdist(tmp_context):
+def test_seen_requirements_sdist(tmp_context: WorkContext) -> None:
     bt = bootstrapper.Bootstrapper(tmp_context)
     req = Requirement("testdist")
-    version = "1.2"
+    version = Version("1.2")
     assert not bt._has_been_seen(req, version, sdist_only=False)
     assert not bt._has_been_seen(req, version, sdist_only=True)
     # sdist only does not affect wheel status
@@ -282,17 +282,17 @@ def test_seen_requirements_sdist(tmp_context):
     assert bt._has_been_seen(req2, version, sdist_only=False)
 
 
-def test_build_order(tmp_context):
+def test_build_order(tmp_context: WorkContext) -> None:
     bt = bootstrapper.Bootstrapper(tmp_context)
     bt._add_to_build_order(
         req=Requirement("buildme>1.0"),
-        version="6.0",
+        version=Version("6.0"),
         source_url="url",
         source_url_type="sdist",
     )
     bt._add_to_build_order(
         req=Requirement("testdist>1.0"),
-        version="1.2",
+        version=Version("1.2"),
         source_url="url",
         source_url_type="sdist",
     )
@@ -321,23 +321,23 @@ def test_build_order(tmp_context):
     assert expected == contents
 
 
-def test_build_order_repeats(tmp_context):
+def test_build_order_repeats(tmp_context: WorkContext) -> None:
     bt = bootstrapper.Bootstrapper(tmp_context)
     bt._add_to_build_order(
         Requirement("buildme>1.0"),
-        "6.0",
+        Version("6.0"),
         "url",
         "sdist",
     )
     bt._add_to_build_order(
         Requirement("buildme>1.0"),
-        "6.0",
+        Version("6.0"),
         "url",
         "sdist",
     )
     bt._add_to_build_order(
         Requirement("buildme[extra]>1.0"),
-        "6.0",
+        Version("6.0"),
         "url",
         "sdist",
     )
@@ -357,17 +357,17 @@ def test_build_order_repeats(tmp_context):
     assert expected == contents
 
 
-def test_build_order_name_canonicalization(tmp_context):
+def test_build_order_name_canonicalization(tmp_context: WorkContext) -> None:
     bt = bootstrapper.Bootstrapper(tmp_context)
     bt._add_to_build_order(
         Requirement("flit-core>1.0"),
-        "3.9.0",
+        Version("3.9.0"),
         "url",
         "sdist",
     )
     bt._add_to_build_order(
         Requirement("flit_core>1.0"),
-        "3.9.0",
+        Version("3.9.0"),
         "url",
         "sdist",
     )
@@ -387,7 +387,7 @@ def test_build_order_name_canonicalization(tmp_context):
     assert expected == contents
 
 
-def test_explain(tmp_context: WorkContext):
+def test_explain(tmp_context: WorkContext) -> None:
     bt = bootstrapper.Bootstrapper(tmp_context, None, old_graph)
     bt.why = [(RequirementType.TOP_LEVEL, Requirement("foo"), Version("1.0.0"))]
     assert bt._explain == f"{RequirementType.TOP_LEVEL} dependency foo (1.0.0)"
@@ -405,7 +405,7 @@ def test_explain(tmp_context: WorkContext):
     )
 
 
-def test_is_build_requirement(tmp_context: WorkContext):
+def test_is_build_requirement(tmp_context: WorkContext) -> None:
     bt = bootstrapper.Bootstrapper(tmp_context, None, old_graph)
     bt.why = []
     assert not bt._processing_build_requirement(RequirementType.TOP_LEVEL)

tests/test_build_environment.py

@@ -13,7 +13,7 @@
 def test_missing_dependency_format(
     resolve_dist: Mock,
     tmp_context: WorkContext,
-):
+) -> None:
     resolutions = {
         "flit_core": "3.9.0",
         "setuptools": "69.5.1",
@@ -40,7 +40,7 @@ def test_missing_dependency_format(
     assert "flit_core -> 3.9.0" in s
 
 
-def test_missing_dependency_pattern():
+def test_missing_dependency_pattern() -> None:
     msg = textwrap.dedent("""
         DEBUG uv 0.8.4
         DEBUG Searching for default Python interpreter in virtual environments
@@ -62,7 +62,7 @@ def test_missing_dependency_pattern():
     assert match is not None
 
 
-def test_missing_dependency_pattern_resolution_impossible():
+def test_missing_dependency_pattern_resolution_impossible() -> None:
     msg = textwrap.dedent("""
         DEBUG uv 0.8.4
         DEBUG Searching for default Python interpreter in virtual environments

tests/test_commands.py

@@ -9,7 +9,7 @@ def get_option_names(cmd: click.Command) -> typing.Iterable[str]:
     return [o.name for o in cmd.params if o.name]
 
 
-def test_bootstrap_pallel_options() -> None:
+def test_bootstrap_parallel_options() -> None:
     expected: set[str] = set()
     expected.update(get_option_names(bootstrap.bootstrap))
     expected.update(get_option_names(build.build_parallel))