diff --git a/docs/source/interface.rst b/docs/source/interface.rst
index 74da5a897666f800948ed2863b44cc0f98ce9923..d899f5451e189313737baeccaa11ff82fd9049db 100644
--- a/docs/source/interface.rst
+++ b/docs/source/interface.rst
@@ -32,10 +32,20 @@ If the voucher is not known then the response is **NOT FOUND**.
For any voucher which has previously been submitted,
the response is **OK** with an ``application/json`` content-type response body like::
- {"value": <string>}
+ {"value": <string>, "created": <iso8601 timestamp>, "redeemed": <boolean>, "token-count": <number>, "version": 1}
The ``value`` property merely indicates the voucher which was requested.
-Further properties will be added to this response in the near future.
+The ``created`` property indicates when the voucher was first added to the node.
+The ``redeemed`` property indicates whether or not the voucher has successfully been redeemed with a payment server yet.
+The ``token-count`` property gives the number of blinded token signatures the client received in exchange for redemption of the voucher
+(each blinded token signature can be used to construct a one ZKAP),
+if it has been redeemed.
+If it has not been redeemed then it is ``null``.
+
+The ``version`` property indicates the semantic version of the data being returned.
+When properties are removed or the meaning of a property is changed,
+the value of the ``version`` property will be incremented.
+The addition of new properties is **not** accompanied by a bumped version number.
``GET /storage-plugins/privatestorageio-zkapauthz-v1/voucher``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/src/_zkapauthorizer/_plugin.py b/src/_zkapauthorizer/_plugin.py
index 355642dbf1ae232099ae802fba3520b573b555a1..0711f2c7a1fe9091050d05738ed4fdb1c9471846 100644
--- a/src/_zkapauthorizer/_plugin.py
+++ b/src/_zkapauthorizer/_plugin.py
@@ -20,6 +20,9 @@ Tahoe-LAFS.
from weakref import (
WeakValueDictionary,
)
+from datetime import (
+ datetime,
+)
import attr
@@ -93,7 +96,7 @@ class ZKAPAuthorizer(object):
try:
s = self._stores[key]
except KeyError:
- s = VoucherStore.from_node_config(node_config)
+ s = VoucherStore.from_node_config(node_config, datetime.now)
self._stores[key] = s
return s
diff --git a/src/_zkapauthorizer/model.py b/src/_zkapauthorizer/model.py
index cf61f82421c81d3c7765bad53f9d95700050bec8..308947daf520c647c60959daab1341adbc020eff 100644
--- a/src/_zkapauthorizer/model.py
+++ b/src/_zkapauthorizer/model.py
@@ -24,7 +24,9 @@ from json import (
loads,
dumps,
)
-
+from datetime import (
+ datetime,
+)
from sqlite3 import (
OperationalError,
connect as _connect,
@@ -32,6 +34,9 @@ from sqlite3 import (
import attr
+from aniso8601 import (
+ parse_datetime,
+)
from twisted.python.filepath import (
FilePath,
)
@@ -117,7 +122,10 @@ def open_and_initialize(path, required_schema_version, connect=None):
"""
CREATE TABLE IF NOT EXISTS [vouchers] (
[number] text,
- [redeemed] num DEFAULT 0,
+ [created] text, -- An ISO8601 date+time string.
+ [redeemed] num DEFAULT 0, -- 0 if the voucher has not been redeemed, 1 otherwise.
+ [token-count] num DEFAULT NULL, -- NULL if the voucher has not been redeemed,
+ -- a number of tokens received on its redemption otherwise.
PRIMARY KEY([number])
)
@@ -168,12 +176,17 @@ class VoucherStore(object):
:ivar allmydata.node._Config node_config: The Tahoe-LAFS node configuration object for
the node that owns the persisted vouchers.
+
+ :ivar now: A no-argument callable that returns the time of the call as a
+ ``datetime`` instance.
"""
database_path = attr.ib(validator=attr.validators.instance_of(FilePath))
+ now = attr.ib()
+
_connection = attr.ib()
@classmethod
- def from_node_config(cls, node_config, connect=None):
+ def from_node_config(cls, node_config, now, connect=None):
"""
Create or open the ``VoucherStore`` for a given node.
@@ -181,6 +194,8 @@ class VoucherStore(object):
configuration object for the node for which we want to open a
store.
+ :param now: See ``VoucherStore.now``.
+
:param connect: An alternate database connection function. This is
primarily for the purposes of the test suite.
"""
@@ -192,6 +207,7 @@ class VoucherStore(object):
)
return cls(
db_path,
+ now,
conn,
)
@@ -205,7 +221,7 @@ class VoucherStore(object):
cursor.execute(
"""
SELECT
- [number], [redeemed]
+ [number], [created], [redeemed], [token-count]
FROM
[vouchers]
WHERE
@@ -216,7 +232,7 @@ class VoucherStore(object):
refs = cursor.fetchall()
if len(refs) == 0:
raise KeyError(voucher)
- return Voucher(refs[0][0], bool(refs[0][1]))
+ return Voucher.from_row(refs[0])
@with_cursor
def add(self, cursor, voucher, tokens):
@@ -228,11 +244,15 @@ class VoucherStore(object):
:param list[RandomToken]: The tokens to add alongside the voucher.
"""
+ now = self.now()
+ if not isinstance(now, datetime):
+ raise TypeError("{} returned {}, expected datetime".format(self.now, now))
+
cursor.execute(
"""
- INSERT OR IGNORE INTO [vouchers] ([number]) VALUES (?)
+ INSERT OR IGNORE INTO [vouchers] ([number], [created]) VALUES (?, ?)
""",
- (voucher,)
+ (voucher, self.now())
)
if cursor.rowcount:
# Something was inserted. Insert the tokens, too. It's okay to
@@ -259,14 +279,14 @@ class VoucherStore(object):
"""
cursor.execute(
"""
- SELECT [number], [redeemed] FROM [vouchers]
+ SELECT [number], [created], [redeemed], [token-count] FROM [vouchers]
""",
)
refs = cursor.fetchall()
return list(
- Voucher(number, bool(redeemed))
- for (number, redeemed)
+ Voucher.from_row(row)
+ for row
in refs
)
@@ -294,9 +314,12 @@ class VoucherStore(object):
)
cursor.execute(
"""
- UPDATE [vouchers] SET [redeemed] = 1 WHERE [number] = ?
+ UPDATE [vouchers]
+ SET [redeemed] = 1
+ , [token-count] = ?
+ WHERE [number] = ?
""",
- (voucher,),
+ (len(unblinded_tokens), voucher),
)
@with_cursor
@@ -395,8 +418,38 @@ class RandomToken(object):
@attr.s
class Voucher(object):
+ """
+ :ivar unicode number: The text string which gives this voucher its
+ identity.
+
+ :ivar datetime created: The time at which this voucher was added to this
+ node.
+
+ :ivar bool redeemed: ``True`` if this voucher has successfully been
+ redeemed with a payment server, ``False`` otherwise.
+
+ :ivar int token_count: A number of tokens received from the redemption of
+ this voucher if it has been redeemed, ``None`` if it has not been
+ redeemed.
+ """
number = attr.ib()
+ created = attr.ib(default=None, validator=attr.validators.optional(attr.validators.instance_of(datetime)))
redeemed = attr.ib(default=False, validator=attr.validators.instance_of(bool))
+ token_count = attr.ib(default=None, validator=attr.validators.optional(attr.validators.instance_of((int, long))))
+
+ @classmethod
+ def from_row(cls, row):
+ return cls(
+ row[0],
+ # All Python datetime-based date/time libraries fail to handle
+ # leap seconds. This parse call might raise an exception of the
+ # value represents a leap second. However, since we also use
+ # Python to generate the data in the first place, it should never
+ # represent a leap second... I hope.
+ parse_datetime(row[1], delimiter=u" "),
+ bool(row[2]),
+ row[3],
+ )
@classmethod
def from_json(cls, json):
@@ -407,7 +460,12 @@ class Voucher(object):
@classmethod
def from_json_v1(cls, values):
- return cls(**values)
+ return cls(
+ number=values[u"number"],
+ created=None if values[u"created"] is None else parse_datetime(values[u"created"]),
+ redeemed=values[u"redeemed"],
+ token_count=values[u"token-count"],
+ )
def to_json(self):
@@ -419,6 +477,10 @@ class Voucher(object):
def to_json_v1(self):
- result = attr.asdict(self)
- result[u"version"] = 1
- return result
+ return {
+ u"number": self.number,
+ u"created": None if self.created is None else self.created.isoformat(),
+ u"redeemed": self.redeemed,
+ u"token-count": self.token_count,
+ u"version": 1,
+ }
diff --git a/src/_zkapauthorizer/tests/strategies.py b/src/_zkapauthorizer/tests/strategies.py
index c9c7ec226b7df5be6a4065850fa3fe07edd2280a..9f9e254f170517e1e06c932aca9db391c4aca517 100644
--- a/src/_zkapauthorizer/tests/strategies.py
+++ b/src/_zkapauthorizer/tests/strategies.py
@@ -25,6 +25,8 @@ import attr
from hypothesis.strategies import (
one_of,
just,
+ none,
+ booleans,
binary,
characters,
text,
@@ -35,6 +37,7 @@ from hypothesis.strategies import (
dictionaries,
fixed_dictionaries,
builds,
+ datetimes,
)
from twisted.web.test.requesthelper import (
@@ -52,7 +55,8 @@ from allmydata.client import (
from ..model import (
Pass,
RandomToken,
- UnblindedToken
+ UnblindedToken,
+ Voucher,
)
@@ -216,6 +220,19 @@ def vouchers():
)
+def voucher_objects():
+ """
+ Build ``Voucher`` instances.
+ """
+ return builds(
+ Voucher,
+ number=vouchers(),
+ created=one_of(none(), datetimes()),
+ redeemed=booleans(),
+ token_count=one_of(none(), integers(min_value=1)),
+ )
+
+
def random_tokens():
"""
Build random tokens as unicode strings.
diff --git a/src/_zkapauthorizer/tests/test_client_resource.py b/src/_zkapauthorizer/tests/test_client_resource.py
index c456f3242be4b4fcbde254470ae52a8766af7054..1df93936c70090dc31f36ac5db75b93b1365458f 100644
--- a/src/_zkapauthorizer/tests/test_client_resource.py
+++ b/src/_zkapauthorizer/tests/test_client_resource.py
@@ -27,6 +27,9 @@ from .._base64 import (
urlsafe_b64decode,
)
+from datetime import (
+ datetime,
+)
from json import (
dumps,
loads,
@@ -50,6 +53,7 @@ from testtools.matchers import (
IsInstance,
ContainsDict,
AfterPreprocessing,
+ Is,
Equals,
Always,
GreaterThan,
@@ -78,6 +82,7 @@ from hypothesis.strategies import (
integers,
binary,
text,
+ datetimes,
)
from twisted.internet.defer import (
@@ -201,18 +206,22 @@ def invalid_bodies():
)
-def root_from_config(config):
+def root_from_config(config, now):
"""
Create a client root resource from a Tahoe-LAFS configuration.
:param _Config config: The Tahoe-LAFS configuration.
+ :param now: A no-argument callable that returns the time of the call as a
+ ``datetime`` instance.
+
:return IResource: The root client resource.
"""
return from_configuration(
config,
VoucherStore.from_node_config(
config,
+ now,
memory_connect,
),
)
@@ -230,7 +239,7 @@ class ResourceTests(TestCase):
"""
tempdir = self.useFixture(TempDir())
config = get_config(tempdir.join(b"tahoe"), b"tub.port")
- root = root_from_config(config)
+ root = root_from_config(config, datetime.now)
self.assertThat(
getChildForRequest(root, request),
Provides([IResource]),
@@ -256,7 +265,7 @@ class UnblindedTokenTests(TestCase):
"""
tempdir = self.useFixture(TempDir())
config = get_config(tempdir.join(b"tahoe"), b"tub.port")
- root = root_from_config(config)
+ root = root_from_config(config, datetime.now)
if num_tokens:
# Put in a number of tokens with which to test.
@@ -290,7 +299,7 @@ class UnblindedTokenTests(TestCase):
"""
tempdir = self.useFixture(TempDir())
config = get_config(tempdir.join(b"tahoe"), b"tub.port")
- root = root_from_config(config)
+ root = root_from_config(config, datetime.now)
if num_tokens:
# Put in a number of tokens with which to test.
@@ -324,7 +333,7 @@ class UnblindedTokenTests(TestCase):
"""
tempdir = self.useFixture(TempDir())
config = get_config(tempdir.join(b"tahoe"), b"tub.port")
- root = root_from_config(config)
+ root = root_from_config(config, datetime.now)
if num_tokens:
# Put in a number of tokens with which to test.
@@ -389,7 +398,7 @@ class UnblindedTokenTests(TestCase):
tempdir = self.useFixture(TempDir())
config = get_config(tempdir.join(b"tahoe"), b"tub.port")
- root = root_from_config(config)
+ root = root_from_config(config, datetime.now)
# Put in a number of tokens with which to test.
redeeming = root.controller.redeem(voucher, num_tokens)
@@ -481,7 +490,7 @@ class VoucherTests(TestCase):
"""
tempdir = self.useFixture(TempDir())
config = get_config(tempdir.join(b"tahoe"), b"tub.port")
- root = root_from_config(config)
+ root = root_from_config(config, datetime.now)
agent = RequestTraversalAgent(root)
producer = FileBodyProducer(
BytesIO(dumps({u"voucher": voucher})),
@@ -512,7 +521,7 @@ class VoucherTests(TestCase):
"""
tempdir = self.useFixture(TempDir())
config = get_config(tempdir.join(b"tahoe"), b"tub.port")
- root = root_from_config(config)
+ root = root_from_config(config, datetime.now)
agent = RequestTraversalAgent(root)
producer = FileBodyProducer(
BytesIO(body),
@@ -542,7 +551,7 @@ class VoucherTests(TestCase):
"""
tempdir = self.useFixture(TempDir())
config = get_config(tempdir.join(b"tahoe"), b"tub.port")
- root = root_from_config(config)
+ root = root_from_config(config, datetime.now)
agent = RequestTraversalAgent(root)
url = u"http://127.0.0.1/voucher/{}".format(
quote(
@@ -571,7 +580,7 @@ class VoucherTests(TestCase):
"""
tempdir = self.useFixture(TempDir())
config = get_config(tempdir.join(b"tahoe"), b"tub.port")
- root = root_from_config(config)
+ root = root_from_config(config, datetime.now)
agent = RequestTraversalAgent(root)
requesting = agent.request(
b"GET",
@@ -584,25 +593,25 @@ class VoucherTests(TestCase):
),
)
- @given(tahoe_configs(client_nonredeemer_configurations()), vouchers())
- def test_get_known_voucher_unredeemed(self, get_config, voucher):
+ @given(tahoe_configs(client_nonredeemer_configurations()), datetimes(), vouchers())
+ def test_get_known_voucher_unredeemed(self, get_config, now, voucher):
"""
When a voucher is first ``PUT`` and then later a ``GET`` is issued for the
same voucher then the response code is **OK** and details about the
voucher are included in a json-encoded response body.
"""
- return self._test_get_known_voucher(get_config, voucher, False)
+ return self._test_get_known_voucher(get_config, now, voucher, False)
- @given(tahoe_configs(client_dummyredeemer_configurations()), vouchers())
- def test_get_known_voucher_redeemed(self, get_config, voucher):
+ @given(tahoe_configs(client_dummyredeemer_configurations()), datetimes(), vouchers())
+ def test_get_known_voucher_redeemed(self, get_config, now, voucher):
"""
When a voucher is first ``PUT`` and then later a ``GET`` is issued for the
same voucher then the response code is **OK** and details about the
voucher are included in a json-encoded response body.
"""
- return self._test_get_known_voucher(get_config, voucher, True)
+ return self._test_get_known_voucher(get_config, now, voucher, True)
- def _test_get_known_voucher(self, get_config, voucher, redeemed):
+ def _test_get_known_voucher(self, get_config, now, voucher, redeemed):
"""
Assert that a voucher that is ``PUT`` and then ``GET`` is represented in
the JSON response.
@@ -612,7 +621,7 @@ class VoucherTests(TestCase):
"""
tempdir = self.useFixture(TempDir())
config = get_config(tempdir.join(b"tahoe"), b"tub.port")
- root = root_from_config(config)
+ root = root_from_config(config, lambda: now)
agent = RequestTraversalAgent(root)
producer = FileBodyProducer(
@@ -640,6 +649,12 @@ class VoucherTests(TestCase):
).decode("utf-8"),
).encode("ascii"),
)
+ if redeemed:
+ # Value duplicated from PaymentController.redeem default. Should
+ # do this better.
+ token_count_comparison = Equals(100)
+ else:
+ token_count_comparison = Is(None)
self.assertThat(
getting,
@@ -647,17 +662,25 @@ class VoucherTests(TestCase):
MatchesAll(
ok_response(headers=application_json()),
AfterPreprocessing(
- json_content,
+ readBody,
succeeded(
- Equals(Voucher(voucher, redeemed=redeemed).marshal()),
+ AfterPreprocessing(
+ Voucher.from_json,
+ MatchesStructure(
+ number=Equals(voucher),
+ created=Equals(now),
+ redeemed=Equals(redeemed),
+ token_count=token_count_comparison,
+ ),
+ ),
),
),
),
),
)
- @given(tahoe_configs(), lists(vouchers(), unique=True))
- def test_list_vouchers(self, get_config, vouchers):
+ @given(tahoe_configs(), datetimes(), lists(vouchers(), unique=True))
+ def test_list_vouchers(self, get_config, now, vouchers):
"""
A ``GET`` to the ``VoucherCollection`` itself returns a list of existing
vouchers.
@@ -668,7 +691,7 @@ class VoucherTests(TestCase):
# state behind that invalidates future iterations.
tempdir = self.useFixture(TempDir())
config = get_config(tempdir.join(b"tahoe"), b"tub.port")
- root = root_from_config(config)
+ root = root_from_config(config, lambda: now)
agent = RequestTraversalAgent(root)
note("{} vouchers".format(len(vouchers)))
@@ -705,7 +728,15 @@ class VoucherTests(TestCase):
succeeded(
Equals({
u"vouchers": list(
- Voucher(voucher, redeemed=True).marshal()
+ Voucher(
+ voucher,
+ created=now,
+ redeemed=True,
+ # Value duplicated from
+ # PaymentController.redeem default.
+ # Should do this better.
+ token_count=100,
+ ).marshal()
for voucher
in vouchers
),
diff --git a/src/_zkapauthorizer/tests/test_controller.py b/src/_zkapauthorizer/tests/test_controller.py
index 6001b29a5d0f824d655c6f24d9fa039e70645577..032ed0962b286bac7c7125452a1254c685599d72 100644
--- a/src/_zkapauthorizer/tests/test_controller.py
+++ b/src/_zkapauthorizer/tests/test_controller.py
@@ -58,6 +58,7 @@ from hypothesis import (
)
from hypothesis.strategies import (
integers,
+ datetimes,
)
from twisted.python.url import (
URL,
@@ -116,8 +117,8 @@ class PaymentControllerTests(TestCase):
"""
Tests for ``PaymentController``.
"""
- @given(tahoe_configs(), vouchers())
- def test_not_redeemed_while_redeeming(self, get_config, voucher):
+ @given(tahoe_configs(), datetimes(), vouchers())
+ def test_not_redeemed_while_redeeming(self, get_config, now, voucher):
"""
A ``Voucher`` is not marked redeemed before ``IRedeemer.redeem``
completes.
@@ -128,6 +129,7 @@ class PaymentControllerTests(TestCase):
tempdir.join(b"node"),
b"tub.port",
),
+ now=lambda: now,
connect=memory_connect,
)
controller = PaymentController(
@@ -142,14 +144,15 @@ class PaymentControllerTests(TestCase):
Equals(False),
)
- @given(tahoe_configs(), vouchers())
- def test_redeemed_after_redeeming(self, get_config, voucher):
+ @given(tahoe_configs(), datetimes(), vouchers())
+ def test_redeemed_after_redeeming(self, get_config, now, voucher):
tempdir = self.useFixture(TempDir())
store = VoucherStore.from_node_config(
get_config(
tempdir.join(b"node"),
b"tub.port",
),
+ now=lambda: now,
connect=memory_connect,
)
controller = PaymentController(
diff --git a/src/_zkapauthorizer/tests/test_model.py b/src/_zkapauthorizer/tests/test_model.py
index 282e3c35ca5fe8b5569a52aa33c32bb73947e541..925f464fe664fe85d0a18ef0b16bd98f65d59ccc 100644
--- a/src/_zkapauthorizer/tests/test_model.py
+++ b/src/_zkapauthorizer/tests/test_model.py
@@ -48,8 +48,12 @@ from fixtures import (
from hypothesis import (
given,
)
+
from hypothesis.strategies import (
+ data,
lists,
+ datetimes,
+ integers,
)
from twisted.python.filepath import (
@@ -68,6 +72,7 @@ from ..model import (
from .strategies import (
tahoe_configs,
vouchers,
+ voucher_objects,
random_tokens,
unblinded_tokens,
)
@@ -93,8 +98,8 @@ class VoucherStoreTests(TestCase):
)
- @given(tahoe_configs(), vouchers())
- def test_get_missing(self, get_config, voucher):
+ @given(tahoe_configs(), datetimes(), vouchers())
+ def test_get_missing(self, get_config, now, voucher):
"""
``VoucherStore.get`` raises ``KeyError`` when called with a
voucher not previously added to the store.
@@ -103,6 +108,7 @@ class VoucherStoreTests(TestCase):
config = get_config(tempdir.join(b"node"), b"tub.port")
store = VoucherStore.from_node_config(
config,
+ lambda: now,
memory_connect,
)
self.assertThat(
@@ -110,8 +116,8 @@ class VoucherStoreTests(TestCase):
raises(KeyError),
)
- @given(tahoe_configs(), vouchers(), lists(random_tokens(), unique=True))
- def test_add(self, get_config, voucher, tokens):
+ @given(tahoe_configs(), vouchers(), lists(random_tokens(), unique=True), datetimes())
+ def test_add(self, get_config, voucher, tokens, now):
"""
``VoucherStore.get`` returns a ``Voucher`` representing a voucher
previously added to the store with ``VoucherStore.add``.
@@ -120,6 +126,7 @@ class VoucherStoreTests(TestCase):
config = get_config(tempdir.join(b"node"), b"tub.port")
store = VoucherStore.from_node_config(
config,
+ lambda: now,
memory_connect,
)
store.add(voucher, tokens)
@@ -128,11 +135,12 @@ class VoucherStoreTests(TestCase):
MatchesStructure(
number=Equals(voucher),
redeemed=Equals(False),
+ created=Equals(now),
),
)
- @given(tahoe_configs(), vouchers(), lists(random_tokens(), unique=True))
- def test_add_idempotent(self, get_config, voucher, tokens):
+ @given(tahoe_configs(), vouchers(), datetimes(), lists(random_tokens(), unique=True))
+ def test_add_idempotent(self, get_config, voucher, now, tokens):
"""
More than one call to ``VoucherStore.add`` with the same argument results
in the same state as a single call.
@@ -141,6 +149,7 @@ class VoucherStoreTests(TestCase):
config = get_config(tempdir.join(b"node"), b"tub.port")
store = VoucherStore.from_node_config(
config,
+ lambda: now,
memory_connect,
)
store.add(voucher, tokens)
@@ -149,12 +158,15 @@ class VoucherStoreTests(TestCase):
store.get(voucher),
MatchesStructure(
number=Equals(voucher),
+ created=Equals(now),
+ redeemed=Equals(False),
+ token_count=Equals(None),
),
)
- @given(tahoe_configs(), lists(vouchers(), unique=True))
- def test_list(self, get_config, vouchers):
+ @given(tahoe_configs(), datetimes(), lists(vouchers(), unique=True))
+ def test_list(self, get_config, now, vouchers):
"""
``VoucherStore.list`` returns a ``list`` containing a ``Voucher`` object
for each voucher previously added.
@@ -164,6 +176,7 @@ class VoucherStoreTests(TestCase):
config = get_config(nodedir, b"tub.port")
store = VoucherStore.from_node_config(
config,
+ lambda: now,
memory_connect,
)
@@ -173,14 +186,14 @@ class VoucherStoreTests(TestCase):
self.assertThat(
store.list(),
Equals(list(
- Voucher(number)
+ Voucher(number, created=now)
for number
in vouchers
)),
)
- @given(tahoe_configs())
- def test_uncreateable_store_directory(self, get_config):
+ @given(tahoe_configs(), datetimes())
+ def test_uncreateable_store_directory(self, get_config, now):
"""
If the underlying directory in the node configuration cannot be created
then ``VoucherStore.from_node_config`` raises ``StoreOpenError``.
@@ -197,6 +210,7 @@ class VoucherStoreTests(TestCase):
self.assertThat(
lambda: VoucherStore.from_node_config(
config,
+ lambda: now,
memory_connect,
),
Raises(
@@ -218,8 +232,8 @@ class VoucherStoreTests(TestCase):
)
- @given(tahoe_configs())
- def test_unopenable_store(self, get_config):
+ @given(tahoe_configs(), datetimes())
+ def test_unopenable_store(self, get_config, now):
"""
If the underlying database file cannot be opened then
``VoucherStore.from_node_config`` raises ``StoreOpenError``.
@@ -230,7 +244,7 @@ class VoucherStoreTests(TestCase):
config = get_config(nodedir, b"tub.port")
# Create the underlying database file.
- store = VoucherStore.from_node_config(config)
+ store = VoucherStore.from_node_config(config, lambda: now)
# Prevent further access to it.
store.database_path.chmod(0o000)
@@ -238,6 +252,7 @@ class VoucherStoreTests(TestCase):
self.assertThat(
lambda: VoucherStore.from_node_config(
config,
+ lambda: now,
),
raises(StoreOpenError),
)
@@ -247,15 +262,14 @@ class VoucherTests(TestCase):
"""
Tests for ``Voucher``.
"""
- @given(vouchers())
- def test_json_roundtrip(self, voucher):
+ @given(voucher_objects())
+ def test_json_roundtrip(self, reference):
"""
``Voucher.to_json . Voucher.from_json → id``
"""
- ref = Voucher(voucher)
self.assertThat(
- Voucher.from_json(ref.to_json()),
- Equals(ref),
+ Voucher.from_json(reference.to_json()),
+ Equals(reference),
)
@@ -263,8 +277,8 @@ class UnblindedTokenStoreTests(TestCase):
"""
Tests for ``UnblindedToken``-related functionality of ``VoucherStore``.
"""
- @given(tahoe_configs(), vouchers(), lists(unblinded_tokens(), unique=True))
- def test_unblinded_tokens_round_trip(self, get_config, voucher_value, tokens):
+ @given(tahoe_configs(), datetimes(), vouchers(), lists(unblinded_tokens(), unique=True))
+ def test_unblinded_tokens_round_trip(self, get_config, now, voucher_value, tokens):
"""
Unblinded tokens that are added to the store can later be retrieved.
"""
@@ -272,6 +286,7 @@ class UnblindedTokenStoreTests(TestCase):
config = get_config(tempdir.join(b"node"), b"tub.port")
store = VoucherStore.from_node_config(
config,
+ lambda: now,
memory_connect,
)
store.insert_unblinded_tokens_for_voucher(voucher_value, tokens)
@@ -282,19 +297,49 @@ class UnblindedTokenStoreTests(TestCase):
more_unblinded_tokens = store.extract_unblinded_tokens(1)
self.expectThat([], Equals(more_unblinded_tokens))
- @given(tahoe_configs(), vouchers(), random_tokens(), unblinded_tokens())
- def test_mark_vouchers_redeemed(self, get_config, voucher_value, token, one_token):
+ @given(
+ tahoe_configs(),
+ datetimes(),
+ vouchers(),
+ integers(min_value=1, max_value=100),
+ data(),
+ )
+ def test_mark_vouchers_redeemed(self, get_config, now, voucher_value, num_tokens, data):
"""
The voucher for unblinded tokens that are added to the store is marked as
redeemed.
"""
+ random = data.draw(
+ lists(
+ random_tokens(),
+ min_size=num_tokens,
+ max_size=num_tokens,
+ unique=True,
+ ),
+ )
+ unblinded = data.draw(
+ lists(
+ unblinded_tokens(),
+ min_size=num_tokens,
+ max_size=num_tokens,
+ unique=True,
+ ),
+ )
+
tempdir = self.useFixture(TempDir())
config = get_config(tempdir.join(b"node"), b"tub.port")
store = VoucherStore.from_node_config(
config,
+ lambda: now,
memory_connect,
)
- store.add(voucher_value, [token])
- store.insert_unblinded_tokens_for_voucher(voucher_value, [one_token])
+ store.add(voucher_value, random)
+ store.insert_unblinded_tokens_for_voucher(voucher_value, unblinded)
loaded_voucher = store.get(voucher_value)
- self.assertThat(loaded_voucher.redeemed, Equals(True))
+ self.assertThat(
+ loaded_voucher,
+ MatchesStructure(
+ redeemed=Equals(True),
+ token_count=Equals(num_tokens),
+ ),
+ )
diff --git a/src/_zkapauthorizer/tests/test_plugin.py b/src/_zkapauthorizer/tests/test_plugin.py
index ae958bc8056fda36d1ddaea454262365a6133082..9c97ea7dc597f672aa4f417d9673100df76e2a38 100644
--- a/src/_zkapauthorizer/tests/test_plugin.py
+++ b/src/_zkapauthorizer/tests/test_plugin.py
@@ -52,6 +52,7 @@ from hypothesis import (
)
from hypothesis.strategies import (
just,
+ datetimes,
)
from foolscap.broker import (
Broker,
@@ -97,6 +98,7 @@ from ..controller import (
from .strategies import (
minimal_tahoe_configs,
tahoe_configs,
+ client_dummyredeemer_configurations,
server_configurations,
announcements,
vouchers,
@@ -246,9 +248,7 @@ class ServerPluginTests(TestCase):
)
-tahoe_configs_with_dummy_redeemer = minimal_tahoe_configs({
- u"privatestorageio-zkapauthz-v1": just({u"redeemer": u"dummy"}),
-})
+tahoe_configs_with_dummy_redeemer = tahoe_configs(client_dummyredeemer_configurations())
tahoe_configs_with_mismatched_issuer = minimal_tahoe_configs({
u"privatestorageio-zkapauthz-v1": just({u"ristretto-issuer-root-url": u"https://another-issuer.example.invalid/"}),
@@ -310,6 +310,7 @@ class ClientPluginTests(TestCase):
@given(
tahoe_configs_with_dummy_redeemer,
+ datetimes(),
announcements(),
vouchers(),
random_tokens(),
@@ -323,6 +324,7 @@ class ClientPluginTests(TestCase):
def test_unblinded_tokens_extracted(
self,
get_config,
+ now,
announcement,
voucher,
token,
@@ -343,7 +345,7 @@ class ClientPluginTests(TestCase):
b"tub.port",
)
- store = VoucherStore.from_node_config(node_config)
+ store = VoucherStore.from_node_config(node_config, lambda: now)
store.add(voucher, [token])
store.insert_unblinded_tokens_for_voucher(voucher, [unblinded_token])
diff --git a/zkapauthorizer.nix b/zkapauthorizer.nix
index fb54924d419c80e94fcb45b4713d97f4fef5e4aa..77bbf6657c479b9daab7c133286c0c626efdb104 100644
--- a/zkapauthorizer.nix
+++ b/zkapauthorizer.nix
@@ -1,5 +1,5 @@
{ buildPythonPackage, sphinx, circleci-cli
-, attrs, zope_interface, twisted, tahoe-lafs, privacypass
+, attrs, zope_interface, aniso8601, twisted, tahoe-lafs, privacypass
, fixtures, testtools, hypothesis, pyflakes, treq, coverage
, hypothesisProfile ? null
, collectCoverage ? false
@@ -27,6 +27,7 @@ buildPythonPackage rec {
propagatedBuildInputs = [
attrs
zope_interface
+ aniso8601
twisted
tahoe-lafs
privacypass