Add resolving enviroment variables in Pipfile URL. (#178)

* Add resolving enviroment variables in Pipfile URL.

* Update micropipenv.py

Co-authored-by: Fridolín Pokorný <[email protected]>

* squash! Add resolving enviroment variables in Pipfile URL.

* Added tests.

* test env vars not working

* Test for env variables changed.

* Update tests/test_micropipenv.py

Co-authored-by: Lumír 'Frenzy' Balhar <[email protected]>

* Resolve env variables also in _get_index_entry_str

* Fix tests

* Fixed format

* Fix end of files

Co-authored-by: Fridolín Pokorný <[email protected]>
Co-authored-by: Lumír 'Frenzy' Balhar <[email protected]>
Co-authored-by: Lumir Balhar <[email protected]>

Author: 3 people

micropipenv.py

@@ -109,6 +109,8 @@
         ("requirements.txt", "requirements"),
     ]
 )
+__re_nested_vars = re.compile(r"\$\{(?P<name>[^\}:]*)(?::-(?P<default>[^\}]*))?\}")
+__re_sub_vars = re.compile(r"\$\{[^}]*\}")
 
 
 class MicropipenvException(Exception):
@@ -949,20 +951,21 @@ def _get_index_entry_str(sections, package_info=None):  # type: (Dict[str, Any],
 
     result = ""
     for idx, source in enumerate(sections.get("sources", [])):
+        url = _resolve_nested_variables(source["url"])
         if index_name is None:
             if idx == 0:
-                result += "--index-url {}\n".format(source["url"])
+                result += "--index-url {}\n".format(url)
             else:
-                result += "--extra-index-url {}\n".format(source["url"])
+                result += "--extra-index-url {}\n".format(url)
 
             if not source["verify_ssl"]:
-                result += "--trusted-host {}\n".format(urlparse(source["url"]).netloc)
+                result += "--trusted-host {}\n".format(urlparse(url).netloc)
         else:
             if index_name == source["name"]:
-                result += "--index-url {}\n".format(source["url"])
+                result += "--index-url {}\n".format(url)
 
                 if not source["verify_ssl"]:
-                    result += "--trusted-host {}\n".format(urlparse(source["url"]).netloc)
+                    result += "--trusted-host {}\n".format(urlparse(url).netloc)
 
                 break
 
@@ -974,6 +977,19 @@ def _get_index_entry_str(sections, package_info=None):  # type: (Dict[str, Any],
     return result
 
 
+def _resolve_nested_variables(url):
+    # type: (str) -> str
+    while True:
+        variable = __re_nested_vars.search(url)
+        if not variable:
+            break
+        value = os.getenv(variable["name"])
+        if not value:
+            value = variable["default"] if variable["default"] else ""
+        url = __re_sub_vars.sub(value, url, count=1)
+    return url
+
+
 def _iter_index_entry_str(
     sections, package_info
 ):  # type: (Dict[str, Any], Optional[Dict[str, Any]]) -> Generator[str, None, None]
@@ -987,6 +1003,7 @@ def _iter_index_entry_str(
         return None
 
     for source in sections["sources"]:
+        source["url"] = _resolve_nested_variables(source["url"])
         result = "--index-url {}\n".format(source["url"])
         if not source["verify_ssl"]:
             result += "--trusted-host {}\n".format(urlparse(source["url"]).netloc)

tests/data/install/pipenv_env_vars/Pipfile

@@ -0,0 +1,7 @@
+[[source]]
+name = "pypi"
+url = "${URL}"
+verify_ssl = true
+
+[packages]
+daiquiri = "==2.0.0"

tests/data/install/pipenv_env_vars/Pipfile.lock

@@ -0,0 +1,7 @@
+[[source]]
+name = "pypi"
+url = "${URL:-https://pypi.org/simple}"
+verify_ssl = true
+
+[packages]
+daiquiri = "==2.0.0"

tests/data/install/pipenv_env_vars_default/Pipfile

@@ -196,6 +196,35 @@ def test_install_poetry_vcs(venv):
         check_generated_pipfile_lock(os.path.join(work_dir, "Pipfile.lock"), os.path.join(work_dir, "_Pipfile.lock"))
 
 
+@pytest.mark.online
+def test_install_pipenv_env_vars(venv):
+    """Test installation using enviroment variables in source URL."""
+    cmd = [os.path.join(venv.path, BIN_DIR, "python"), micropipenv.__file__, "install", "--method", "pipenv"]
+    with cwd(os.path.join(_DATA_DIR, "install", "pipenv_env_vars")):
+        subprocess.run(cmd, check=True, env={**get_updated_env(venv), **{"URL": "https://pypi.org/simple"}})
+        assert str(venv.get_version("daiquiri")) == "2.0.0"
+        assert str(venv.get_version("python-json-logger")) == "0.1.11"
+
+
+@pytest.mark.online
+def test_install_pipenv_env_vars_undefined(venv):
+    """Test installation using enviroment variables without setting them."""
+    cmd = [os.path.join(venv.path, BIN_DIR, "python"), micropipenv.__file__, "install", "--method", "pipenv"]
+    with cwd(os.path.join(_DATA_DIR, "install", "pipenv_env_vars")):
+        with pytest.raises(subprocess.CalledProcessError):
+            subprocess.check_call(cmd, env=get_updated_env(venv))
+
+
+@pytest.mark.online
+def test_install_pipenv_env_vars_default(venv):
+    """Test installation using default values of environment variables."""
+    cmd = [os.path.join(venv.path, BIN_DIR, "python"), micropipenv.__file__, "install", "--method", "pipenv"]
+    with cwd(os.path.join(_DATA_DIR, "install", "pipenv_env_vars_default")):
+        subprocess.run(cmd, check=True, env=get_updated_env(venv))
+        assert str(venv.get_version("daiquiri")) == "2.0.0"
+        assert str(venv.get_version("python-json-logger")) == "0.1.11"
+
+
 @pytest.mark.online
 def test_install_pip_tools_print_lock(venv):
     """Test invoking installation when pip-tools style requirements.txt are used.