Merge branch 'theupdateframework:develop' into metaclass-fix

Author: aditya-shrivastavv

.github/workflows/dependency-review.yml

@@ -17,4 +17,4 @@ jobs:
       - name: 'Checkout Repository'
         uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@11310527b429536e263dc6cc47873e608189ba21
+        uses: actions/dependency-review-action@0ff3da6f81b812d4ec3cf37a04e2308c7a723730

requirements-test.txt

@@ -4,7 +4,7 @@
 -r requirements-pinned.txt
 
 # additional test tools for linting and coverage measurement
-coverage==6.5.0
+coverage==7.0.1
 black==22.12.0
 isort==5.11.4
 pylint==2.15.9

tuf/api/metadata.py

@@ -7,3 +7,9 @@
 from tuf.ngclient.config import UpdaterConfig
 from tuf.ngclient.fetcher import FetcherInterface
 from tuf.ngclient.updater import Updater
+
+__all__ = [
+    FetcherInterface.__name__,
+    Updater.__name__,
+    UpdaterConfig.__name__,
+]

tuf/ngclient/__init__.py

@@ -50,7 +50,7 @@ def __init__(self) -> None:
         self.chunk_size: int = 400000  # bytes
 
     def _fetch(self, url: str) -> Iterator[bytes]:
-        """Fetches the contents of HTTP/HTTPS url from a remote server
+        """Fetch the contents of HTTP/HTTPS url from a remote server
 
         Args:
             url: URL string that represents a file location.
@@ -108,7 +108,7 @@ def _chunks(self, response: "requests.Response") -> Iterator[bytes]:
             response.close()
 
     def _get_session(self, url: str) -> requests.Session:
-        """Returns a different customized requests.Session per schema+hostname
+        """Return a different customized requests.Session per schema+hostname
         combination.
 
         Raises:

tuf/ngclient/_internal/requests_fetcher.py

@@ -99,41 +99,41 @@ def __init__(self, root_data: bytes):
         self._load_trusted_root(root_data)
 
     def __getitem__(self, role: str) -> Metadata:
-        """Returns current ``Metadata`` for ``role``"""
+        """Return current ``Metadata`` for ``role``"""
         return self._trusted_set[role]
 
     def __len__(self) -> int:
-        """Returns number of ``Metadata`` objects in ``TrustedMetadataSet``"""
+        """Return number of ``Metadata`` objects in ``TrustedMetadataSet``"""
         return len(self._trusted_set)
 
     def __iter__(self) -> Iterator[Metadata]:
-        """Returns iterator over ``Metadata`` objects in ``TrustedMetadataSet``"""
+        """Return iterator over ``Metadata`` objects in ``TrustedMetadataSet``"""
         return iter(self._trusted_set.values())
 
     # Helper properties for top level metadata
     @property
     def root(self) -> Metadata[Root]:
-        """Current root ``Metadata``"""
+        """Get current root ``Metadata``"""
         return self._trusted_set[Root.type]
 
     @property
     def timestamp(self) -> Optional[Metadata[Timestamp]]:
-        """Current timestamp ``Metadata`` or ``None``"""
+        """Get current timestamp ``Metadata`` or ``None``"""
         return self._trusted_set.get(Timestamp.type)
 
     @property
     def snapshot(self) -> Optional[Metadata[Snapshot]]:
-        """Current snapshot ``Metadata`` or ``None``"""
+        """Get current snapshot ``Metadata`` or ``None``"""
         return self._trusted_set.get(Snapshot.type)
 
     @property
     def targets(self) -> Optional[Metadata[Targets]]:
-        """Current targets ``Metadata`` or ``None``"""
+        """Get current targets ``Metadata`` or ``None``"""
         return self._trusted_set.get(Targets.type)
 
     # Methods for updating metadata
     def update_root(self, data: bytes) -> Metadata[Root]:
-        """Verifies and loads ``data`` as new root metadata.
+        """Verify and load ``data`` as new root metadata.
 
         Note that an expired intermediate root is considered valid: expiry is
         only checked for the final root in ``update_timestamp()``.
@@ -173,12 +173,12 @@ def update_root(self, data: bytes) -> Metadata[Root]:
         new_root.verify_delegate(Root.type, new_root)
 
         self._trusted_set[Root.type] = new_root
-        logger.info("Updated root v%d", new_root.signed.version)
+        logger.debug("Updated root v%d", new_root.signed.version)
 
         return new_root
 
     def update_timestamp(self, data: bytes) -> Metadata[Timestamp]:
-        """Verifies and loads ``data`` as new timestamp metadata.
+        """Verify and load ``data`` as new timestamp metadata.
 
         Note that an intermediate timestamp is allowed to be expired:
         ``TrustedMetadataSet`` will throw an ``ExpiredMetadataError`` in
@@ -243,7 +243,7 @@ def update_timestamp(self, data: bytes) -> Metadata[Timestamp]:
         # protection of new timestamp: expiry is checked in update_snapshot()
 
         self._trusted_set[Timestamp.type] = new_timestamp
-        logger.info("Updated timestamp v%d", new_timestamp.signed.version)
+        logger.debug("Updated timestamp v%d", new_timestamp.signed.version)
 
         # timestamp is loaded: raise if it is not valid _final_ timestamp
         self._check_final_timestamp()
@@ -260,7 +260,7 @@ def _check_final_timestamp(self) -> None:
     def update_snapshot(
         self, data: bytes, trusted: Optional[bool] = False
     ) -> Metadata[Snapshot]:
-        """Verifies and loads ``data`` as new snapshot metadata.
+        """Verify and load ``data`` as new snapshot metadata.
 
         Note that an intermediate snapshot is allowed to be expired and version
         is allowed to not match timestamp meta version: ``TrustedMetadataSet``
@@ -338,7 +338,7 @@ def update_snapshot(
         # protection of new snapshot: it is checked when targets is updated
 
         self._trusted_set[Snapshot.type] = new_snapshot
-        logger.info("Updated snapshot v%d", new_snapshot.signed.version)
+        logger.debug("Updated snapshot v%d", new_snapshot.signed.version)
 
         # snapshot is loaded, but we raise if it's not valid _final_ snapshot
         self._check_final_snapshot()
@@ -360,7 +360,7 @@ def _check_final_snapshot(self) -> None:
             )
 
     def update_targets(self, data: bytes) -> Metadata[Targets]:
-        """Verifies and loads ``data`` as new top-level targets metadata.
+        """Verify and load ``data`` as new top-level targets metadata.
 
         Args:
             data: Unverified new targets metadata as bytes
@@ -377,7 +377,7 @@ def update_targets(self, data: bytes) -> Metadata[Targets]:
     def update_delegated_targets(
         self, data: bytes, role_name: str, delegator_name: str
     ) -> Metadata[Targets]:
-        """Verifies and loads ``data`` as new metadata for target ``role_name``.
+        """Verify and load ``data`` as new metadata for target ``role_name``.
 
         Args:
             data: Unverified new metadata as bytes
@@ -433,12 +433,12 @@ def update_delegated_targets(
             raise exceptions.ExpiredMetadataError(f"New {role_name} is expired")
 
         self._trusted_set[role_name] = new_delegate
-        logger.info("Updated %s v%d", role_name, version)
+        logger.debug("Updated %s v%d", role_name, version)
 
         return new_delegate
 
     def _load_trusted_root(self, data: bytes) -> None:
-        """Verifies and loads ``data`` as trusted root metadata.
+        """Verify and load ``data`` as trusted root metadata.
 
         Note that an expired initial root is considered valid: expiry is
         only checked for the final root in ``update_timestamp()``.
@@ -453,4 +453,4 @@ def _load_trusted_root(self, data: bytes) -> None:
         new_root.verify_delegate(Root.type, new_root)
 
         self._trusted_set[Root.type] = new_root
-        logger.info("Loaded trusted root v%d", new_root.signed.version)
+        logger.debug("Loaded trusted root v%d", new_root.signed.version)

tuf/ngclient/_internal/trusted_metadata_set.py

@@ -30,7 +30,7 @@ class FetcherInterface(metaclass=abc.ABCMeta):
 
     @abc.abstractmethod
     def _fetch(self, url: str) -> Iterator[bytes]:
-        """Fetches the contents of HTTP/HTTPS ``url`` from a remote server.
+        """Fetch the contents of HTTP/HTTPS ``url`` from a remote server.
 
         Implementations must raise ``DownloadHTTPError`` if they receive
         an HTTP error code.
@@ -51,7 +51,7 @@ def _fetch(self, url: str) -> Iterator[bytes]:
         raise NotImplementedError  # pragma: no cover
 
     def fetch(self, url: str) -> Iterator[bytes]:
-        """Fetches the contents of HTTP/HTTPS ``url`` from a remote server.
+        """Fetch the contents of HTTP/HTTPS ``url`` from a remote server.
 
         Args:
             url: URL string that represents a file location.

tuf/ngclient/fetcher.py

@@ -106,7 +106,7 @@ def __init__(
         self.config = config or UpdaterConfig()
 
     def refresh(self) -> None:
-        """Refreshes top-level metadata.
+        """Refresh top-level metadata.
 
         Downloads, verifies, and loads metadata for the top-level roles in the
         specified order (root -> timestamp -> snapshot -> targets) implementing
@@ -143,7 +143,7 @@ def _generate_target_file_path(self, targetinfo: TargetFile) -> str:
         return os.path.join(self.target_dir, filename)
 
     def get_targetinfo(self, target_path: str) -> Optional[TargetFile]:
-        """Returns ``TargetFile`` instance with information for ``target_path``.
+        """Return ``TargetFile`` instance with information for ``target_path``.
 
         The return value can be used as an argument to
         ``download_target()`` and ``find_cached_target()``.
@@ -177,7 +177,7 @@ def find_cached_target(
         targetinfo: TargetFile,
         filepath: Optional[str] = None,
     ) -> Optional[str]:
-        """Checks whether a local file is an up to date target
+        """Check whether a local file is an up to date target
 
         Args:
             targetinfo: ``TargetFile`` from ``get_targetinfo()``.
@@ -208,7 +208,7 @@ def download_target(
         filepath: Optional[str] = None,
         target_base_url: Optional[str] = None,
     ) -> str:
-        """Downloads the target file specified by ``targetinfo``.
+        """Download the target file specified by ``targetinfo``.
 
         Args:
             targetinfo: ``TargetFile`` from ``get_targetinfo()``.
@@ -260,7 +260,7 @@ def download_target(
             with open(filepath, "wb") as destination_file:
                 shutil.copyfileobj(target_file, destination_file)
 
-        logger.info("Downloaded target %s", targetinfo.path)
+        logger.debug("Downloaded target %s", targetinfo.path)
         return filepath
 
     def _download_metadata(