Change: Allow to set request parameters and headers for download

Extend the download context manager function to allow setting the http
request parameters and headers. This will be required for downloading a
file from a private GitHub URL.

pontos/helper.py

@@ -19,7 +19,7 @@
 import subprocess
 from contextlib import contextmanager
 from pathlib import Path
-from typing import Generator, Iterable, Iterator, Optional, Union
+from typing import Any, Dict, Generator, Iterable, Iterator, Optional, Union
 
 import httpx
 
@@ -88,6 +88,8 @@ def download(
     url: str,
     destination: Optional[Union[Path, str]] = None,
     *,
+    headers: Dict[str, Any] = None,
+    params: Dict[str, Any] = None,
     chunk_size: int = DEFAULT_CHUNK_SIZE,
     timeout: int = DEFAULT_TIMEOUT,
 ) -> Generator[DownloadProgressIterable, None, None]:
@@ -97,6 +99,8 @@ def download(
         url: The url of the file we want to download
         destination: Path of the file to store the download in. If set it will
                      be derived from the passed URL.
+        headers: HTTP headers to use for the download
+        params: HTTP request parameters to use for the download
         chunk_size: Download file in chunks of this size
         timeout: Connection timeout
 
@@ -118,7 +122,12 @@ def download(
     )
 
     with httpx.stream(
-        "GET", url, timeout=timeout, follow_redirects=True
+        "GET",
+        url,
+        timeout=timeout,
+        follow_redirects=True,
+        headers=headers,
+        params=params,
     ) as response:
         response.raise_for_status()
 

tests/github/test_api.py

@@ -270,6 +270,8 @@ def test_download_release_tarball(
             requests_mock.assert_called_once_with(
                 "GET",
                 "https://github.com/greenbone/pontos/archive/refs/tags/v21.11.0.tar.gz",  # pylint: disable=line-too-long
+                headers=None,
+                params=None,
                 follow_redirects=True,
                 timeout=DEFAULT_TIMEOUT,
             )
@@ -310,6 +312,8 @@ def test_download_release_tarball_with_content_length(
             requests_mock.assert_called_once_with(
                 "GET",
                 "https://github.com/greenbone/pontos/archive/refs/tags/v21.11.0.tar.gz",  # pylint: disable=line-too-long
+                params=None,
+                headers=None,
                 follow_redirects=True,
                 timeout=DEFAULT_TIMEOUT,
             )
@@ -351,6 +355,8 @@ def test_download_release_zip(
                 "GET",
                 "https://github.com/greenbone/pontos/archive/refs/tags/v21.11.0.zip",  # pylint: disable=line-too-long
                 follow_redirects=True,
+                headers=None,
+                params=None,
                 timeout=DEFAULT_TIMEOUT,
             )
             response_headers.get.assert_called_once_with("content-length")