-
Notifications
You must be signed in to change notification settings - Fork 5
fix: Properly annotate check_dependencies's selector_method arg
#287
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| from pathlib import Path | ||
| from typing import Any, Union | ||
| from unittest.mock import Mock, patch | ||
|
|
||
| import pytest | ||
|
|
@@ -93,10 +95,10 @@ class TestCheckDependencies: | |
| ) | ||
| def test_options_priorities_assignation( | ||
| self, | ||
| cli_config, | ||
| file_config, | ||
| expected_resolved_config, | ||
| ): | ||
| cli_config: dict[str, Any], | ||
| file_config: dict[str, Any], | ||
| expected_resolved_config: TwynConfiguration, | ||
| ) -> None: | ||
| """ | ||
| Checks that the configuration values are picked accordingly to the priority they have. | ||
|
|
||
|
|
@@ -133,7 +135,12 @@ def test_options_priorities_assignation( | |
| (AvailableLoggingLevels.none, "debug", AvailableLoggingLevels.debug), | ||
| ], | ||
| ) | ||
| def test_logging_level(self, passed_logging_level, config, logging_level): | ||
| def test_logging_level( | ||
| self, | ||
| passed_logging_level: AvailableLoggingLevels, | ||
| config: Union[str, None], | ||
| logging_level: AvailableLoggingLevels, | ||
| ) -> None: | ||
| log_level = _get_logging_level( | ||
| cli_verbosity=passed_logging_level, | ||
| config_logging_level=config, | ||
|
|
@@ -143,8 +150,8 @@ def test_logging_level(self, passed_logging_level, config, logging_level): | |
| @patch("twyn.main.get_parsed_dependencies_from_file") | ||
| @patch("twyn.trusted_packages.references.TopPyPiReference._get_packages_from_cache") | ||
| def test_check_dependencies_detects_typosquats( | ||
| self, mock_get_packages_from_cache, mock_get_parsed_dependencies_from_file | ||
| ): | ||
| self, mock_get_packages_from_cache: Mock, mock_get_parsed_dependencies_from_file: Mock | ||
| ) -> None: | ||
| mock_get_parsed_dependencies_from_file.return_value = {"my-package"} | ||
| mock_get_packages_from_cache.return_value = {"mypackage"} | ||
| error = check_dependencies( | ||
|
|
@@ -159,7 +166,9 @@ def test_check_dependencies_detects_typosquats( | |
| ) | ||
|
|
||
| @patch("twyn.trusted_packages.references.TopPyPiReference._get_packages_from_cache") | ||
| def test_check_dependencies_with_input_from_cli_detects_typosquats(self, mock_get_packages_from_cache): | ||
| def test_check_dependencies_with_input_from_cli_detects_typosquats( | ||
| self, mock_get_packages_from_cache: Mock | ||
| ) -> None: | ||
| mock_get_packages_from_cache.return_value = {"mypackage"} | ||
| error = check_dependencies( | ||
| config_file=None, | ||
|
|
@@ -174,10 +183,9 @@ def test_check_dependencies_with_input_from_cli_detects_typosquats(self, mock_ge | |
|
|
||
| @patch("twyn.trusted_packages.references.TopPyPiReference._get_packages_from_cache") | ||
| def test_check_dependencies_with_input_loads_file_from_different_location( | ||
| self, mock_get_packages_from_cache, tmp_path, tmpdir | ||
| self, mock_get_packages_from_cache: Mock, tmp_path: Path | ||
| ) -> None: | ||
| mock_get_packages_from_cache.return_value = {"mypackage"} | ||
| tmpdir.mkdir("fake-dir") | ||
| tmp_file = tmp_path / "fake-dir" / "requirements.txt" | ||
| with create_tmp_file(tmp_file, "mypackag"): | ||
| error = check_dependencies( | ||
|
|
@@ -192,7 +200,9 @@ def test_check_dependencies_with_input_loads_file_from_different_location( | |
| ) | ||
|
|
||
| @patch("twyn.trusted_packages.references.TopPyPiReference._get_packages_from_cache") | ||
| def test_check_dependencies_with_input_from_cli_accepts_multiple_dependencies(self, mock_get_packages_from_cache): | ||
| def test_check_dependencies_with_input_from_cli_accepts_multiple_dependencies( | ||
| self, mock_get_packages_from_cache: Mock | ||
| ) -> None: | ||
| mock_get_packages_from_cache.return_value = {"requests", "mypackage"} | ||
|
|
||
| error = check_dependencies( | ||
|
|
@@ -209,8 +219,8 @@ def test_check_dependencies_with_input_from_cli_accepts_multiple_dependencies(se | |
| @patch("twyn.main.TopPyPiReference") | ||
| @patch("twyn.main.get_parsed_dependencies_from_file") | ||
| def test_check_dependencies_ignores_package_in_allowlist( | ||
| self, mock_get_parsed_dependencies_from_file, mock_top_pypi_reference | ||
| ): | ||
| self, mock_get_parsed_dependencies_from_file: Mock, mock_top_pypi_reference: Mock | ||
| ) -> None: | ||
| mock_top_pypi_reference.return_value.get_packages.return_value = {"mypackage"} | ||
| mock_get_parsed_dependencies_from_file.return_value = {"my-package"} | ||
|
|
||
|
|
@@ -255,7 +265,7 @@ def test_check_dependencies_ignores_package_in_allowlist( | |
| ], | ||
| ) | ||
| @patch("twyn.trusted_packages.references.TopPyPiReference._get_packages_from_cache") | ||
| def test_normalize_package(self, mock_get_packages_from_cache, package_name): | ||
| def test_normalize_package(self, mock_get_packages_from_cache: Mock, package_name: Mock) -> None: | ||
| mock_get_packages_from_cache.return_value = {"requests", "mypackage"} | ||
| error = check_dependencies( | ||
| config_file=None, | ||
|
|
@@ -274,8 +284,8 @@ def test_normalize_package(self, mock_get_packages_from_cache, package_name): | |
| @patch("twyn.main.get_parsed_dependencies_from_file") | ||
| @patch("twyn.trusted_packages.references.TopPyPiReference._get_packages_from_cache") | ||
| def test_check_dependencies_does_not_error_on_same_package( | ||
| self, mock_get_packages_from_cache, mock_get_parsed_dependencies_from_file, package_name | ||
| ): | ||
| self, mock_get_packages_from_cache: Mock, mock_get_parsed_dependencies_from_file: Mock, package_name: Mock | ||
| ) -> None: | ||
| mock_get_parsed_dependencies_from_file.return_value = {package_name} | ||
| mock_get_packages_from_cache.return_value = {"my-package"} | ||
| error = check_dependencies( | ||
|
|
@@ -289,7 +299,7 @@ def test_check_dependencies_does_not_error_on_same_package( | |
|
|
||
| @patch("twyn.dependency_parser.dependency_selector.DependencySelector.get_dependency_parser") | ||
| @patch("twyn.dependency_parser.requirements_txt_parser.RequirementsTxtParser.parse") | ||
| def test_get_parsed_dependencies_from_file(self, mock_parse: Mock, mock_get_dependency_parser: Mock): | ||
| def test_get_parsed_dependencies_from_file(self, mock_parse: Mock, mock_get_dependency_parser: Mock) -> None: | ||
| mock_get_dependency_parser.return_value = RequirementsTxtParser() | ||
| mock_parse.return_value = {"boto3"} | ||
| assert get_parsed_dependencies_from_file() == {"boto3"} | ||
|
|
@@ -302,14 +312,16 @@ def test_track_is_disabled_by_default_when_used_as_package( | |
| mock_top_pypi_reference.return_value.get_packages.return_value = {"mypackage"} | ||
| mock_get_parsed_dependencies_from_file.return_value = {"my-package"} | ||
| with patch("twyn.main.track") as m_track: | ||
| check_dependencies("all") | ||
| check_dependencies() | ||
| assert m_track.call_count == 0 | ||
|
|
||
| @patch("twyn.main.TopPyPiReference") | ||
| @patch("twyn.main.get_parsed_dependencies_from_file") | ||
| def test_track_is_shown_when_enabled(self, mock_get_parsed_dependencies_from_file, mock_top_pypi_reference) -> None: | ||
| def test_track_is_shown_when_enabled( | ||
| self, mock_get_parsed_dependencies_from_file: Mock, mock_top_pypi_reference: Mock | ||
| ) -> None: | ||
| mock_top_pypi_reference.return_value.get_packages.return_value = {"mypackage"} | ||
| mock_get_parsed_dependencies_from_file.return_value = {"my-package"} | ||
| with patch("twyn.main.track") as m_track: | ||
| check_dependencies("all", use_track=True) | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This proves it is still working after the new changes |
||
| check_dependencies(use_track=True) | ||
| assert m_track.call_count == 1 | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.