Add tests

Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>

Author: TG1999

src/python_inspector/resolution.py

@@ -36,13 +36,19 @@
 
 
 def get_response(url):
+    """
+    Return a response for the given url.
+    """
     resp = requests.get(url)
     if resp.status_code == 200:
         return resp.json()
     return None
 
 
 def is_valid_version(parsed_version, requirements, identifier, bad_versions):
+    """
+    Return True if the parsed_version is valid for the given identifier.
+    """
     if (
         any(parsed_version not in r.specifier for r in requirements[identifier])
         or parsed_version in bad_versions
@@ -52,7 +58,7 @@ def is_valid_version(parsed_version, requirements, identifier, bad_versions):
 
 
 class PythonInputProvider(AbstractProvider):
-    def __init__(self, environment, repos):
+    def __init__(self, environment=None, repos=[]):
         self.environment = environment
         self.repos = repos
         self.versions_by_package = {}
@@ -81,7 +87,7 @@ def get_versions_for_package(self, name, repo=None):
         Return a list of versions for a package.
         """
         versions = []
-        if repo:
+        if repo and self.environment:
             for version, package in repo._get_package_versions_map(name).items():
                 wheels = package.get_supported_wheels(environment=self.environment)
                 if list(wheels):
@@ -99,9 +105,9 @@ def get_versions_for_package(self, name, repo=None):
 
     def get_requirements_for_package(self, purl, candidate):
         """
-        Generate requirements for a package.
+        Yield requirements for a package.
         """
-        if self.repos:
+        if self.repos and self.environment:
             wheels = download_wheel(
                 name=candidate.name,
                 version=str(candidate.version),
@@ -157,9 +163,6 @@ def _iter_matches(self, identifier, requirements, incompatibilities):
                 )
 
     def find_matches(self, identifier, requirements, incompatibilities):
-        """
-        Return a sorted list of candidates for the given identifier.
-        """
         candidates = sorted(
             self._iter_matches(identifier, requirements, incompatibilities),
             key=operator.attrgetter("version"),
@@ -168,9 +171,6 @@ def find_matches(self, identifier, requirements, incompatibilities):
         return candidates
 
     def is_satisfied_by(self, requirement, candidate):
-        """
-        Return True if the given requirement is satisfied by the given candidate.
-        """
         return candidate.version in requirement.specifier
 
     def _iter_dependencies(self, candidate):
@@ -194,9 +194,6 @@ def _iter_dependencies(self, candidate):
                     yield r
 
     def get_dependencies(self, candidate):
-        """
-        Return a list of dependencies for the given candidate.
-        """
         return list(self._iter_dependencies(candidate))
 
 
@@ -228,7 +225,7 @@ def dfs(mapping, graph, src):
     )
 
 
-def _format_resolution(result):
+def format_resolution(result):
     """
     Return a formatted resolution.
     """
@@ -289,19 +286,20 @@ def pypi_simple_repo_in_repos(repos: PypiSimpleRepository):
 
 def resolution(
     requirements: List[Requirement],
-    environment: Environment,
+    environment: Environment = None,
     repos: List[PypiSimpleRepository] = [],
     return_as_parent_children: bool = True,
     return_as_tree: bool = False,
     return_as_list: bool = False,
 ):
     """
     Return a resolution for the given requirements.
+    If environment is not None, it is used to resolve the requirements.
     """
     if repos and not pypi_simple_repo_in_repos(repos):
         repos.append(PYPI_PUBLIC_REPO)
     resolver = Resolver(PythonInputProvider(environment, repos), BaseReporter())
-    as_list, as_parent_children, as_tree = _format_resolution(resolver.resolve(requirements))
+    as_list, as_parent_children, as_tree = format_resolution(resolver.resolve(requirements))
     if return_as_parent_children:
         return as_parent_children
     if return_as_tree:

src/python_inspector/resolve_cli.py

@@ -117,6 +117,19 @@ def resolve_dependencies(
     Download from the provided PyPI simple --index-url INDEX(s) URLs.
     Error and progress are printed to stderr.
 
+    Default environment is the Python version - 3.8 and OS - linux.
+
+    1) If no index_url is provided, the PyPI JSON API is used and environment will be ignored in that case.
+
+    For example:
+        dad --spec "flask==2.1.2" --json -
+
+    2) If an index_url is provided, the environment will be used to resolve the dependencies.
+    (If no environment is provided default environment will be used.)
+
+    For example:
+        dad --spec "flask==2.1.2" --index-url https://pypi.org/simple --json -
+
     For example::
         dad --spec "flask" --requirement etc/scripts/requirements.txt --json -
     """

tests/test_cli.py

@@ -36,13 +36,13 @@ def test_cli_with_single_index_url():
 
 
 @pytest.mark.online
-def test_cli_with_multiple_index_url():
+def test_cli_with_multiple_index_url_and_tilde_req():
     runner = CliRunner()
     result = runner.invoke(
         cli,
         [
             "--spec",
-            "zipp==3.8.0",
+            "zipp~=3.8.0",
             "--index-url",
             "https://pypi.org/simple",
             "--index-url",

tests/test_resolution.py

@@ -8,9 +8,12 @@
 # See https://github.com/nexB/python-inspector for support or download.
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
+import packaging
 import pytest
 from packaging.requirements import Requirement
 
+from python_inspector.resolution import is_valid_version
+from python_inspector.resolution import pypi_simple_repo_in_repos
 from python_inspector.resolution import resolution
 from python_inspector.utils_pypi import PYPI_PUBLIC_REPO
 from python_inspector.utils_pypi import Environment
@@ -29,7 +32,7 @@ def test_resolvelib_with_flask_and_python_310():
         return_as_parent_children=False,
         return_as_list=True,
     )
-    assert [
+    assert as_list == [
         "pkg:pypi/click@8.1.3",
         "pkg:pypi/flask@2.1.2",
         "pkg:pypi/importlib-metadata@4.11.4",
@@ -38,7 +41,7 @@ def test_resolvelib_with_flask_and_python_310():
         "pkg:pypi/markupsafe@2.1.1",
         "pkg:pypi/werkzeug@2.1.2",
         "pkg:pypi/zipp@3.8.0",
-    ] == as_list
+    ]
 
 
 @pytest.mark.online
@@ -55,7 +58,7 @@ def test_resolvelib_with_flask_and_python_36():
         return_as_list=True,
     )
 
-    assert [
+    assert as_list == [
         "pkg:pypi/click@8.1.3",
         "pkg:pypi/flask@2.1.2",
         "pkg:pypi/importlib-metadata@4.11.4",
@@ -64,4 +67,41 @@ def test_resolvelib_with_flask_and_python_36():
         "pkg:pypi/markupsafe@2.0.1",
         "pkg:pypi/werkzeug@2.1.2",
         "pkg:pypi/zipp@3.8.0",
-    ] == as_list
+    ]
+
+
+@pytest.mark.online
+def test_resolvelib_with_tilde_requirement_using_json_api():
+    req = [Requirement("flask~=2.1.2")]
+    as_list = resolution(
+        requirements=req,
+        return_as_parent_children=False,
+        return_as_list=True,
+    )
+
+    assert as_list == [
+        "pkg:pypi/click@8.1.3",
+        "pkg:pypi/flask@2.1.2",
+        "pkg:pypi/importlib-metadata@4.11.4",
+        "pkg:pypi/itsdangerous@2.1.2",
+        "pkg:pypi/jinja2@3.1.2",
+        "pkg:pypi/markupsafe@2.1.1",
+        "pkg:pypi/werkzeug@2.1.2",
+        "pkg:pypi/zipp@3.8.0",
+    ]
+
+
+def test_pypi_simple_repo_in_repos():
+    assert pypi_simple_repo_in_repos(repos=[PYPI_PUBLIC_REPO]) == True
+
+
+def test_pypi_simple_repo_in_repos_not_present():
+    assert pypi_simple_repo_in_repos(repos=[]) == False
+
+
+def test_is_valid_version():
+    parsed_version = packaging.version.parse("2.1.2")
+    requirements = {"flask": [Requirement("flask>2.0.0")]}
+    bad_versions = []
+    identifier = "flask"
+    assert is_valid_version(parsed_version, requirements, identifier, bad_versions) == True