Skip to content

Metadata API: Remove Signed.bump_expiration() method #1743

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 5, 2022
Merged

Metadata API: Remove Signed.bump_expiration() method #1743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f2c593
Metadata API: Remove Signed.bump_expiration()
lukpueh Dec 21, 2021
b754c37
doc: display inherited members on RTD
lukpueh Dec 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/api/tuf.api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,5 @@ Metadata API
tuf.api.serialization

.. automodule:: tuf.api.metadata
:no-members:
:no-members:
:no-inherited-members:
3 changes: 2 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,6 @@

autodoc_default_options = {
'members': True,
'inherited-members': 'Exception', # excl. members inherited from 'Exception'
'exclude-members': 'to_dict, from_dict'
}
}
6 changes: 1 addition & 5 deletions tests/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,10 +264,6 @@ def test_metadata_base(self) -> None:
md.signed.bump_version()
self.assertEqual(md.signed.version, 2)
self.assertEqual(md.signed.expires, datetime(2030, 1, 1, 0, 0))
md.signed.bump_expiration()
self.assertEqual(md.signed.expires, datetime(2030, 1, 2, 0, 0))
md.signed.bump_expiration(timedelta(days=365))
self.assertEqual(md.signed.expires, datetime(2031, 1, 2, 0, 0))

# Test is_expired with reference_time provided
is_expired = md.signed.is_expired(md.signed.expires)
Expand Down Expand Up @@ -329,7 +325,7 @@ def test_metadata_verify_delegate(self) -> None:

# verify fails when delegate content is modified
expires = snapshot.signed.expires
snapshot.signed.bump_expiration()
snapshot.signed.expires = expires + timedelta(days=1)
with self.assertRaises(exceptions.UnsignedMetadataError):
root.verify_delegate(Snapshot.type, snapshot)
snapshot.signed.expires = expires
Expand Down
12 changes: 6 additions & 6 deletions tuf/api/metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
import logging
import tempfile
from collections import OrderedDict
from datetime import datetime, timedelta
from datetime import datetime
from typing import (
IO,
Any,
Expand Down Expand Up @@ -409,6 +409,11 @@ def _type(self) -> str:

@property
def expires(self) -> datetime:
"""The metadata expiry date::

# Use 'datetime' module to e.g. expire in seven days from now
obj.expires = utcnow() + timedelta(days=7)
"""
return self._expires

@expires.setter
Expand Down Expand Up @@ -508,11 +513,6 @@ def is_expired(self, reference_time: Optional[datetime] = None) -> bool:

return reference_time >= self.expires

# Modification.
def bump_expiration(self, delta: timedelta = timedelta(days=1)) -> None:
"""Increments the expires attribute by the passed timedelta."""
self.expires += delta

def bump_version(self) -> None:
"""Increments the metadata version number by 1."""
self.version += 1
Expand Down