Feature/scan test coverage #603
Conversation
WalkthroughThe changes encompass the addition of several unit test files and modifications to existing test files within the Python ecosystem scanning module. New tests validate functionalities such as dependency management, vulnerability handling, file scanning, and decorator behavior. Additionally, abstract classes and file handler classes are tested to ensure proper implementation and error handling. The updates enhance overall test coverage and reliability of the codebase. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant TestRunner
participant EcosystemScanner
participant DependencyManager
participant FileHandler
User->>TestRunner: Run Tests
TestRunner->>EcosystemScanner: Validate Dependencies
EcosystemScanner->>DependencyManager: Check Versions
DependencyManager-->>EcosystemScanner: Return Results
EcosystemScanner->>FileHandler: Handle Files
FileHandler-->>EcosystemScanner: Return File Status
EcosystemScanner-->>TestRunner: Complete Tests
TestRunner-->>User: Test Results
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
Outside diff range and nitpick comments (2)
tests/scan/test_decorators.py (2)
1-7: Remove unused imports.The static analysis tool Ruff has reported several unused imports:
safety.errors.SafetyExceptionsafety.scan.models.SystemScanOutputsafety_schemas.models.ConfigModelsafety_schemas.models.ProjectModelsafety_schemas.models.PolicySourcesafety_schemas.models.MetadataModelsafety_schemas.models.ReportSchemaVersionPlease remove these unused imports to keep the code clean and maintainable.
Tools
Ruff
5-5:
safety.errors.SafetyExceptionimported but unusedRemove unused import:
safety.errors.SafetyException(F401)
6-6:
safety.scan.models.SystemScanOutputimported but unusedRemove unused import:
safety.scan.models.SystemScanOutput(F401)
7-7:
safety_schemas.models.ConfigModelimported but unusedRemove unused import
(F401)
7-7:
safety_schemas.models.ProjectModelimported but unusedRemove unused import
(F401)
7-7:
safety_schemas.models.PolicySourceimported but unusedRemove unused import
(F401)
7-7:
safety_schemas.models.MetadataModelimported but unusedRemove unused import
(F401)
7-7:
safety_schemas.models.ReportSchemaVersionimported but unusedRemove unused import
(F401)
9-14: Remove unused import.The static analysis tool Ruff has reported an unused import:
safety.scan.decorators.scan_system_command_initPlease remove this unused import to keep the code clean and maintainable.
Tools
Ruff
12-12:
safety.scan.decorators.scan_system_command_initimported but unusedRemove unused import:
safety.scan.decorators.scan_system_command_init(F401)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (9)
- tests/scan/ecosystems/python/test_dependencies.py (1 hunks)
- tests/scan/ecosystems/python/test_main.py (3 hunks)
- tests/scan/ecosystems/test_base.py (1 hunks)
- tests/scan/ecosystems/test_target.py (1 hunks)
- tests/scan/finder/test_file_finder.py (1 hunks)
- tests/scan/finder/test_handlers.py (1 hunks)
- tests/scan/test_decorators.py (1 hunks)
- tests/scan/test_main.py (1 hunks)
- tests/scan/test_models.py (1 hunks)
Additional context used
Ruff
tests/scan/ecosystems/python/test_dependencies.py
2-2:
unittest.mock.mock_openimported but unusedRemove unused import
(F401)
2-2:
unittest.mock.patchimported but unusedRemove unused import
(F401)
4-4:
collections.defaultdictimported but unusedRemove unused import:
collections.defaultdict(F401)
12-12:
safety.scan.ecosystems.python.dependencies.read_requirementsimported but unusedRemove unused import
(F401)
13-13:
safety.scan.ecosystems.python.dependencies.read_dependenciesimported but unusedRemove unused import
(F401)
13-13:
safety.scan.ecosystems.python.dependencies.read_virtual_environment_dependenciesimported but unusedRemove unused import
(F401)
14-14:
safety.scan.ecosystems.python.dependencies.get_dependenciesimported but unusedRemove unused import
(F401)
16-16:
safety_schemas.models.PythonDependencyimported but unusedRemove unused import
(F401)
16-16:
safety_schemas.models.FileTypeimported but unusedRemove unused import
(F401)
17-17:
safety.scan.ecosystems.base.InspectableFileimported but unusedRemove unused import:
safety.scan.ecosystems.base.InspectableFile(F401)
18-18:
dparse.filetypesimported but unusedRemove unused import:
dparse.filetypes(F401)
tests/scan/ecosystems/test_base.py
4-4:
safety_schemas.models.Ecosystemimported but unusedRemove unused import
(F401)
4-4:
safety_schemas.models.FileTypeimported but unusedRemove unused import
(F401)
tests/scan/test_main.py
4-4:
configparser.ConfigParserimported but unusedRemove unused import:
configparser.ConfigParser(F401)
5-5:
pydantic.ValidationErrorimported but unusedRemove unused import:
pydantic.ValidationError(F401)
6-6:
typing.Anyimported but unusedRemove unused import
(F401)
6-6:
typing.Dictimported but unusedRemove unused import
(F401)
6-6:
typing.Setimported but unusedRemove unused import
(F401)
8-8:
safety.auth.utils.SafetyAuthSessionimported but unusedRemove unused import:
safety.auth.utils.SafetyAuthSession(F401)
9-9:
safety.errors.SafetyErrorimported but unusedRemove unused import:
safety.errors.SafetyError(F401)
10-10:
safety.scan.ecosystems.target.InspectableFileContextimported but unusedRemove unused import:
safety.scan.ecosystems.target.InspectableFileContext(F401)
11-11:
safety.scan.models.ScanExportimported but unusedRemove unused import:
safety.scan.models.ScanExport(F401)
13-13:
safety.scan.main.download_policyimported but unusedRemove unused import
(F401)
16-16:
safety.scan.main.load_policy_fileimported but unusedRemove unused import
(F401)
18-18:
safety.scan.main.save_report_asimported but unusedRemove unused import
(F401)
21-21:
safety_schemas.models.PolicyFileModelimported but unusedRemove unused import
(F401)
21-21:
safety_schemas.models.PolicySourceimported but unusedRemove unused import
(F401)
21-21:
safety_schemas.models.ConfigModelimported but unusedRemove unused import
(F401)
21-21:
safety_schemas.models.Stageimported but unusedRemove unused import
(F401)
21-21:
safety_schemas.models.ScanTypeimported but unusedRemove unused import
(F401)
22-22:
importlibimported but unusedRemove unused import:
importlib(F401)
23-23:
timeimported but unusedRemove unused import:
time(F401)
tests/scan/test_models.py
3-3:
typing.Optionalimported but unusedRemove unused import:
typing.Optional(F401)
5-5:
pydantic.dataclasses.dataclassimported but unusedRemove unused import:
pydantic.dataclasses.dataclass(F401)
tests/scan/finder/test_file_finder.py
37-37: Undefined name
self(F821)
56-56: Undefined name
self(F821)
tests/scan/test_decorators.py
5-5:
safety.errors.SafetyExceptionimported but unusedRemove unused import:
safety.errors.SafetyException(F401)
6-6:
safety.scan.models.SystemScanOutputimported but unusedRemove unused import:
safety.scan.models.SystemScanOutput(F401)
7-7:
safety_schemas.models.ConfigModelimported but unusedRemove unused import
(F401)
7-7:
safety_schemas.models.ProjectModelimported but unusedRemove unused import
(F401)
7-7:
safety_schemas.models.PolicySourceimported but unusedRemove unused import
(F401)
7-7:
safety_schemas.models.MetadataModelimported but unusedRemove unused import
(F401)
7-7:
safety_schemas.models.ReportSchemaVersionimported but unusedRemove unused import
(F401)
12-12:
safety.scan.decorators.scan_system_command_initimported but unusedRemove unused import:
safety.scan.decorators.scan_system_command_init(F401)
tests/scan/ecosystems/python/test_main.py
3-3:
datetime.datetimeimported but unusedRemove unused import:
datetime.datetime(F401)
4-4:
packaging.specifiers.SpecifierSetimported but unusedRemove unused import:
packaging.specifiers.SpecifierSet(F401)
8-8:
safety.scan.ecosystems.python.main.get_vulnerabilityimported but unusedRemove unused import:
safety.scan.ecosystems.python.main.get_vulnerability(F401)
11-11:
safety_schemas.models.ConfigModelimported but unusedRemove unused import
(F401)
11-11:
safety_schemas.models.Vulnerabilityimported but unusedRemove unused import
(F401)
12-12:
safety_schemas.models.IgnoredItemsimported but unusedRemove unused import
(F401)
12-12:
safety_schemas.models.IgnoredItemDetailimported but unusedRemove unused import
(F401)
14-14:
safety.models.Severityimported but unusedRemove unused import:
safety.models.Severity(F401)
Additional comments not posted (33)
tests/scan/ecosystems/python/test_dependencies.py (5)
23-28: LGTM!The code changes are approved.
31-35: LGTM!The code changes are approved.
37-40: LGTM!The code changes are approved.
42-44: LGTM!The code changes are approved.
46-51: LGTM!The code changes are approved.
tests/scan/ecosystems/test_base.py (3)
7-23: LGTM!The
TestInspectableclass is well-implemented and covers the expected behavior of theInspectableabstract base class. The test methods are correctly named and use theunittestframework to assert the expected behavior.
25-40: LGTM!The
TestRemediableclass is well-implemented and covers the expected behavior of theRemediableabstract base class. The test methods are correctly named and use theunittestframework to assert the expected behavior.
43-53: LGTM!The
TestInspectableFileclass is well-implemented and covers the initialization of theInspectableFileabstract base class. The test method is correctly named and uses theunittestframework to assert the expected behavior.tests/scan/finder/test_handlers.py (5)
10-12: LGTM!The code changes are approved. The
TestableFileHandlerclass is a valid concrete subclass ofFileHandlerthat is used for testing purposes.
14-29: LGTM!The code changes are approved. The
TestFileHandlerclass correctly tests theFileHandlerclass.
32-41: LGTM!The code changes are approved. The
TestPythonFileHandlerclass correctly tests thePythonFileHandlerclass.
44-53: LGTM!The code changes are approved. The
TestSafetyProjectFileHandlerclass correctly tests theSafetyProjectFileHandlerclass.
56-60: LGTM!The code changes are approved. The
TestEcosystemHandlerMappingclass correctly tests theECOSYSTEM_HANDLER_MAPPINGdictionary.tests/scan/ecosystems/test_target.py (2)
9-33: LGTM!The test class
TestInspectableFileContextis well-structured and follows the AAA (Arrange-Act-Assert) pattern. The test methods cover the success and failure scenarios of the__enter__and__exit__methods of theInspectableFileContextclass and use appropriate assertions to verify the behavior.The code changes are approved.
34-50: LGTM!The test class
TestTargetFileis well-structured and follows the AAA (Arrange-Act-Assert) pattern. The test methods cover the success and failure scenarios of thecreatemethod of theTargetFileclass and use appropriate assertions to verify the behavior.The code changes are approved.
tests/scan/test_main.py (3)
26-41: LGTM!The test method
test_load_unverified_project_from_configis well-structured and properly tests theload_unverified_project_from_configfunction. It mocks the necessary dependencies, calls the function with the expected arguments, and makes appropriate assertions on the returnedUnverifiedProjectModelinstance.
42-52: LGTM!The test method
test_save_project_infoeffectively tests thesave_project_infofunction. It mocks the required dependencies, creates the necessary input objects, calls the function, and asserts the expected function calls were made with the correct arguments.
53-67: LGTM!The test method
test_resolve_policythoroughly tests theresolve_policyfunction by covering all the possible combinations oflocal_policyandcloud_policyarguments. The test cases are well-defined and the assertions verify the expected behavior of the function in each scenario.tests/scan/test_models.py (5)
8-19: LGTM!The code changes are approved. The unit tests for the
FormatMixinclass are well-written and cover various test cases.
30-39: LGTM!The code changes are approved. The unit test for the
ScanOutputenum is well-written and covers various test cases.
42-52: LGTM!The code changes are approved. The unit test for the
ScanExportenum is well-written and covers various test cases, including theValueErrorexception for an unsupported enum value.
55-59: LGTM!The code changes are approved. The unit test for the
SystemScanOutputenum is well-written and covers various test cases.
68-82: LGTM!The code changes are approved. The unit test for the
UnverifiedProjectModeldataclass is well-written and correctly tests the dataclass by creating an instance and asserting its attributes.tests/scan/finder/test_file_finder.py (2)
8-22: LGTM!The test class
TestShouldExcludeand its test methods are implemented correctly. The test methods cover the necessary scenarios and use appropriate assertions to validate the expected behavior of theshould_excludefunction.
24-80: LGTM, ignore the static analysis hints!The test class
TestFileFinderand its test methods are implemented correctly. The test methods cover the necessary scenarios, use appropriate assertions to validate the expected behavior, and correctly mock the external dependencies. The setup method is correctly initializing the necessary attributes for the test methods.Regarding the static analysis hints about undefined names
selfat lines 37 and 56, they can be ignored as false positives becauseselfis a valid reference within the context of a class method.Tools
Ruff
37-37: Undefined name
self(F821)
56-56: Undefined name
self(F821)
tests/scan/test_decorators.py (3)
16-26: LGTM!The code changes are approved.
27-69: LGTM!The code changes are approved.
71-94: LGTM!The code changes are approved.
tests/scan/ecosystems/python/test_main.py (5)
85-94: LGTM!The code changes are approved.
97-102: LGTM!The code changes are approved.
105-112: LGTM!The code changes are approved.
114-143: LGTM!The code changes are approved.
Line range hint
29-83: LGTM!The code changes are approved.
| import unittest | ||
| from unittest.mock import MagicMock, mock_open, patch | ||
| from pathlib import Path | ||
| from collections import defaultdict | ||
|
|
||
| from packaging.specifiers import SpecifierSet | ||
| from packaging.version import parse as parse_version | ||
|
|
||
| from safety.scan.ecosystems.python.main import ( | ||
| get_closest_ver, is_pinned_requirement) | ||
| from safety.scan.ecosystems.python.dependencies import ( | ||
| find_version,is_supported_by_parser, parse_requirement, read_requirements, | ||
| read_dependencies, read_virtual_environment_dependencies, | ||
| get_dependencies | ||
| ) | ||
| from safety_schemas.models import PythonDependency, PythonSpecification, FileType | ||
| from safety.scan.ecosystems.base import InspectableFile | ||
| from dparse import filetypes |
There was a problem hiding this comment.
Remove unused imports.
The static analysis tool has flagged several unused imports:
unittest.mock.mock_openunittest.mock.patchcollections.defaultdictsafety.scan.ecosystems.python.dependencies.read_requirementssafety.scan.ecosystems.python.dependencies.read_dependenciessafety.scan.ecosystems.python.dependencies.read_virtual_environment_dependenciessafety.scan.ecosystems.python.dependencies.get_dependenciessafety_schemas.models.PythonDependencysafety_schemas.models.FileTypesafety.scan.ecosystems.base.InspectableFiledparse.filetypes
Please remove these unused imports to improve the code quality.
Tools
Ruff
2-2:
unittest.mock.mock_openimported but unusedRemove unused import
(F401)
2-2:
unittest.mock.patchimported but unusedRemove unused import
(F401)
4-4:
collections.defaultdictimported but unusedRemove unused import:
collections.defaultdict(F401)
12-12:
safety.scan.ecosystems.python.dependencies.read_requirementsimported but unusedRemove unused import
(F401)
13-13:
safety.scan.ecosystems.python.dependencies.read_dependenciesimported but unusedRemove unused import
(F401)
13-13:
safety.scan.ecosystems.python.dependencies.read_virtual_environment_dependenciesimported but unusedRemove unused import
(F401)
14-14:
safety.scan.ecosystems.python.dependencies.get_dependenciesimported but unusedRemove unused import
(F401)
16-16:
safety_schemas.models.PythonDependencyimported but unusedRemove unused import
(F401)
16-16:
safety_schemas.models.FileTypeimported but unusedRemove unused import
(F401)
17-17:
safety.scan.ecosystems.base.InspectableFileimported but unusedRemove unused import:
safety.scan.ecosystems.base.InspectableFile(F401)
18-18:
dparse.filetypesimported but unusedRemove unused import:
dparse.filetypes(F401)
| import unittest | ||
| from unittest.mock import MagicMock | ||
| from typer import FileTextWrite | ||
| from safety_schemas.models import ConfigModel, DependencyResultModel, Ecosystem, FileType |
There was a problem hiding this comment.
Remove unused imports.
The imports Ecosystem and FileType from safety_schemas.models are not used in the code. Please remove them to improve code readability and maintainability.
Apply this diff to remove the unused imports:
-from safety_schemas.models import ConfigModel, DependencyResultModel, Ecosystem, FileType
+from safety_schemas.models import ConfigModel, DependencyResultModelCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| from safety_schemas.models import ConfigModel, DependencyResultModel, Ecosystem, FileType | |
| from safety_schemas.models import ConfigModel, DependencyResultModel |
Tools
Ruff
4-4:
safety_schemas.models.Ecosystemimported but unusedRemove unused import
(F401)
4-4:
safety_schemas.models.FileTypeimported but unusedRemove unused import
(F401)
| import unittest | ||
| from unittest.mock import MagicMock, patch, mock_open | ||
| from pathlib import Path | ||
| from configparser import ConfigParser | ||
| from pydantic import ValidationError | ||
| from typing import Any, Dict, Set, Tuple | ||
|
|
||
| from safety.auth.utils import SafetyAuthSession | ||
| from safety.errors import SafetyError | ||
| from safety.scan.ecosystems.target import InspectableFileContext | ||
| from safety.scan.models import ScanExport, UnverifiedProjectModel | ||
| from safety.scan.main import ( | ||
| download_policy, | ||
| load_unverified_project_from_config, | ||
| save_project_info, | ||
| load_policy_file, | ||
| resolve_policy, | ||
| save_report_as, | ||
| process_files | ||
| ) | ||
| from safety_schemas.models import FileType, PolicyFileModel, PolicySource, ConfigModel, Stage, ProjectModel, ScanType | ||
| import importlib | ||
| import time |
There was a problem hiding this comment.
Remove unused imports.
The following imports are unused in the file and should be removed to keep the code clean and maintainable:
configparser.ConfigParserpydantic.ValidationErrortyping.Anytyping.Dicttyping.Setsafety.auth.utils.SafetyAuthSessionsafety.errors.SafetyErrorsafety.scan.ecosystems.target.InspectableFileContextsafety.scan.models.ScanExportsafety.scan.main.download_policysafety.scan.main.load_policy_filesafety.scan.main.save_report_assafety_schemas.models.PolicyFileModelsafety_schemas.models.PolicySourcesafety_schemas.models.ConfigModelsafety_schemas.models.Stagesafety_schemas.models.ScanTypeimportlibtime
Tools
Ruff
4-4:
configparser.ConfigParserimported but unusedRemove unused import:
configparser.ConfigParser(F401)
5-5:
pydantic.ValidationErrorimported but unusedRemove unused import:
pydantic.ValidationError(F401)
6-6:
typing.Anyimported but unusedRemove unused import
(F401)
6-6:
typing.Dictimported but unusedRemove unused import
(F401)
6-6:
typing.Setimported but unusedRemove unused import
(F401)
8-8:
safety.auth.utils.SafetyAuthSessionimported but unusedRemove unused import:
safety.auth.utils.SafetyAuthSession(F401)
9-9:
safety.errors.SafetyErrorimported but unusedRemove unused import:
safety.errors.SafetyError(F401)
10-10:
safety.scan.ecosystems.target.InspectableFileContextimported but unusedRemove unused import:
safety.scan.ecosystems.target.InspectableFileContext(F401)
11-11:
safety.scan.models.ScanExportimported but unusedRemove unused import:
safety.scan.models.ScanExport(F401)
13-13:
safety.scan.main.download_policyimported but unusedRemove unused import
(F401)
16-16:
safety.scan.main.load_policy_fileimported but unusedRemove unused import
(F401)
18-18:
safety.scan.main.save_report_asimported but unusedRemove unused import
(F401)
21-21:
safety_schemas.models.PolicyFileModelimported but unusedRemove unused import
(F401)
21-21:
safety_schemas.models.PolicySourceimported but unusedRemove unused import
(F401)
21-21:
safety_schemas.models.ConfigModelimported but unusedRemove unused import
(F401)
21-21:
safety_schemas.models.Stageimported but unusedRemove unused import
(F401)
21-21:
safety_schemas.models.ScanTypeimported but unusedRemove unused import
(F401)
22-22:
importlibimported but unusedRemove unused import:
importlib(F401)
23-23:
timeimported but unusedRemove unused import:
time(F401)
| @@ -0,0 +1,86 @@ | |||
| import unittest | |||
| from pathlib import Path | |||
| from typing import Optional | |||
There was a problem hiding this comment.
Remove unused imports.
The following imports are unused and can be removed:
Optionalfromtypingdataclassfrompydantic.dataclasses
Apply this diff to remove the unused imports:
-from typing import Optional
-from pydantic.dataclasses import dataclassAlso applies to: 5-5
Tools
Ruff
3-3:
typing.Optionalimported but unusedRemove unused import:
typing.Optional(F401)
| from datetime import datetime | ||
| from packaging.specifiers import SpecifierSet | ||
|
|
||
| from safety.scan.ecosystems.python.main import ( | ||
| should_fail, VulnerabilitySeverityLabels, | ||
| ignore_vuln_if_needed, get_vulnerability, PythonFile | ||
| ) | ||
| from safety_schemas.models import ( | ||
| ConfigModel, Vulnerability, PythonDependency, PythonSpecification, | ||
| FileType, IgnoredItems, IgnoredItemDetail, IgnoreCodes | ||
| ) | ||
| from safety.models import Severity |
There was a problem hiding this comment.
Remove unused imports.
The code changes are approved. However, please remove the following unused imports to improve code quality:
datetime.datetime(line 3)packaging.specifiers.SpecifierSet(line 4)safety.scan.ecosystems.python.main.get_vulnerability(line 8)safety_schemas.models.ConfigModel(line 11)safety_schemas.models.Vulnerability(line 11)safety_schemas.models.IgnoredItems(line 12)safety_schemas.models.IgnoredItemDetail(line 12)safety.models.Severity(line 14)
Tools
Ruff
3-3:
datetime.datetimeimported but unusedRemove unused import:
datetime.datetime(F401)
4-4:
packaging.specifiers.SpecifierSetimported but unusedRemove unused import:
packaging.specifiers.SpecifierSet(F401)
8-8:
safety.scan.ecosystems.python.main.get_vulnerabilityimported but unusedRemove unused import:
safety.scan.ecosystems.python.main.get_vulnerability(F401)
11-11:
safety_schemas.models.ConfigModelimported but unusedRemove unused import
(F401)
11-11:
safety_schemas.models.Vulnerabilityimported but unusedRemove unused import
(F401)
12-12:
safety_schemas.models.IgnoredItemsimported but unusedRemove unused import
(F401)
12-12:
safety_schemas.models.IgnoredItemDetailimported but unusedRemove unused import
(F401)
14-14:
safety.models.Severityimported but unusedRemove unused import:
safety.models.Severity(F401)
This PR begins on increasing the test coverage on
safety scanSummary by CodeRabbit
New Features
Bug Fixes
Documentation