Time machine mode [Z#23129725] (#3961)

Allows organizers to test their shop as if it were a different date and time.

Implemented using a time_machine_now() function which is used instead of regular now(), which can overlay the real date time with a value from a ContextVar, assigned from a session value in EventMiddleware.

For more information, see doc/development/implementation/timemachine.rst

---------

Co-authored-by: Richard Schreiber <schreiber@rami.io>
Co-authored-by: Raphael Michel <michel@rami.io>
This commit is contained in:
Mira
2024-05-17 10:52:17 +02:00
committed by GitHub
parent bfcca7046a
commit b638c00952
38 changed files with 789 additions and 142 deletions

View File

@@ -41,6 +41,8 @@ def env():
TEMPLATE_FRONT_PAGE = Template("{% load eventurl %} {% eventurl event 'presale:event.index' %}")
TEMPLATE_KWARGS = Template("{% load eventurl %} {% eventurl event 'presale:event.checkout' step='payment' %}")
TEMPLATE_ABSEVENTURL = Template("{% load eventurl %} {% abseventurl event 'presale:event.checkout' step='payment' %}")
TEMPLATE_ABSMAINURL = Template("{% load eventurl %} {% absmainurl 'control:event.settings' organizer=event.organizer.slug event=event.slug %}")
@pytest.mark.django_db
@@ -77,6 +79,40 @@ def test_event_custom_domain_kwargs(env):
assert rendered == 'http://foobar/2015/checkout/payment/'
@pytest.mark.django_db
def test_abseventurl_event_main_domain(env):
rendered = TEMPLATE_ABSEVENTURL.render(Context({
'event': env[1]
})).strip()
assert rendered == 'http://example.com/mrmcd/2015/checkout/payment/'
@pytest.mark.django_db
def test_abseventurl_event_custom_domain(env):
KnownDomain.objects.create(domainname='foobar', organizer=env[0])
rendered = TEMPLATE_ABSEVENTURL.render(Context({
'event': env[1]
})).strip()
assert rendered == 'http://foobar/2015/checkout/payment/'
@pytest.mark.django_db
def test_absmainurl_main_domain(env):
rendered = TEMPLATE_ABSMAINURL.render(Context({
'event': env[1]
})).strip()
assert rendered == 'http://example.com/control/event/mrmcd/2015/settings/'
@pytest.mark.django_db
def test_absmainurl_custom_domain(env):
KnownDomain.objects.create(domainname='foobar', organizer=env[0])
rendered = TEMPLATE_ABSMAINURL.render(Context({
'event': env[1]
})).strip()
assert rendered == 'http://example.com/control/event/mrmcd/2015/settings/'
@pytest.mark.django_db
def test_only_kwargs(env):
with pytest.raises(TemplateSyntaxError):

View File

@@ -58,6 +58,8 @@ from pretix.base.services.cart import CartError, CartManager, error_messages
from pretix.testutils.scope import classscope
from pretix.testutils.sessions import get_cart_session_key
from .test_timemachine import TimemachineTestMixin
class CartTestMixin:
@scopes_disabled()
@@ -4274,3 +4276,89 @@ class CartSeatingTest(CartTestMixin, TestCase):
self.cm.commit()
assert not CartPosition.objects.filter(cart_id=self.session_key).exists()
class CartTimemachineTest(CartTestMixin, TimemachineTestMixin, TestCase):
def test_before_presale_timemachine(self):
self._login_with_permission(self.orga)
self.event.presale_start = now() + timedelta(days=1)
self.event.testmode = True
self.event.save()
self._set_time_machine_now(now() + timedelta(days=2))
response = self.client.post('/%s/%s/cart/add' % (self.orga.slug, self.event.slug), {
'item_%d' % self.ticket.id: '1'
}, follow=True)
self.assertRedirects(response, '/%s/%s/?require_cookie=true' % (self.orga.slug, self.event.slug),
target_status_code=200)
assert 'alert-success' in response.rendered_content
with scopes_disabled():
objs = list(CartPosition.objects.filter(cart_id=self.session_key, event=self.event))
self.assertEqual(len(objs), 1)
self.assertEqual(objs[0].item, self.ticket)
self.assertIsNone(objs[0].variation)
self.assertEqual(objs[0].price, 23)
self.assertLessEqual(objs[0].expires, now() + timedelta(
minutes=self.event.settings.get('reservation_time', as_type=int)))
def test_after_presale_timemachine(self):
self._login_with_permission(self.orga)
self.event.presale_end = now() - timedelta(days=1)
self.event.testmode = True
self.event.save()
self._set_time_machine_now(now() - timedelta(days=2))
response = self.client.post('/%s/%s/cart/add' % (self.orga.slug, self.event.slug), {
'item_%d' % self.ticket.id: '1'
}, follow=True)
self.assertRedirects(response, '/%s/%s/?require_cookie=true' % (self.orga.slug, self.event.slug),
target_status_code=200)
assert 'alert-success' in response.rendered_content
with scopes_disabled():
objs = list(CartPosition.objects.filter(cart_id=self.session_key, event=self.event))
self.assertEqual(len(objs), 1)
self.assertEqual(objs[0].item, self.ticket)
self.assertIsNone(objs[0].variation)
self.assertEqual(objs[0].price, 23)
self.assertLessEqual(objs[0].expires, now() + timedelta(
minutes=self.event.settings.get('reservation_time', as_type=int)))
def test_not_yet_available_with_timemachine_in_time(self):
self._login_with_permission(self.orga)
self._enable_test_mode()
self.ticket.available_from = now() + timedelta(days=2)
self.ticket.available_until = now() + timedelta(days=4)
self.ticket.save()
self._set_time_machine_now(now() + timedelta(days=3))
self.client.post('/%s/%s/cart/add' % (self.orga.slug, self.event.slug), {
'item_%d' % self.ticket.id: '1',
}, follow=True)
with scopes_disabled():
self.assertEqual(CartPosition.objects.filter(cart_id=self.session_key, event=self.event).count(), 1)
def test_variation_no_longer_available_with_timemachine_in_time(self):
self._login_with_permission(self.orga)
self._enable_test_mode()
self.shirt_blue.available_from = now() - timedelta(days=4)
self.shirt_blue.available_until = now() - timedelta(days=2)
self.shirt_blue.save()
self._set_time_machine_now(now() - timedelta(days=3))
self.client.post('/%s/%s/cart/add' % (self.orga.slug, self.event.slug), {
'variation_%d_%d' % (self.shirt.id, self.shirt_blue.id): '1',
}, follow=True)
with scopes_disabled():
self.assertEqual(CartPosition.objects.filter(cart_id=self.session_key, event=self.event).count(), 1)
def test_variation_no_longer_available_with_timemachine_before(self):
self._login_with_permission(self.orga)
self._enable_test_mode()
self.shirt_blue.available_from = now() - timedelta(days=4)
self.shirt_blue.available_until = now() - timedelta(days=2)
self.shirt_blue.save()
self._set_time_machine_now(now() - timedelta(days=5))
self.client.post('/%s/%s/cart/add' % (self.orga.slug, self.event.slug), {
'variation_%d_%d' % (self.shirt.id, self.shirt_blue.id): '1',
}, follow=True)
with scopes_disabled():
self.assertEqual(CartPosition.objects.filter(cart_id=self.session_key, event=self.event).count(), 0)

View File

@@ -53,9 +53,12 @@ from pretix.base.models.items import (
from pretix.base.services.cart import CartManager
from pretix.base.services.orders import OrderError, _perform_order
from pretix.base.services.tax import VATIDFinalError, VATIDTemporaryError
from pretix.base.timemachine import time_machine_now_assigned
from pretix.testutils.scope import classscope
from pretix.testutils.sessions import get_cart_session_key
from .test_timemachine import TimemachineTestMixin
class BaseCheckoutTestCase:
@scopes_disabled()
@@ -122,7 +125,7 @@ class BaseCheckoutTestCase:
}]
class CheckoutTestCase(BaseCheckoutTestCase, TestCase):
class CheckoutTestCase(BaseCheckoutTestCase, TimemachineTestMixin, TestCase):
def _enable_reverse_charge(self):
self.tr19.eu_reverse_charge = True
@@ -2545,6 +2548,98 @@ class CheckoutTestCase(BaseCheckoutTestCase, TestCase):
assert op.valid_from.isoformat() == '2023-01-20T11:00:00+00:00'
assert op.valid_until.isoformat() == '2023-01-20T13:00:00+00:00'
@freeze_time("2023-01-18 10:00:00+00:00")
def test_validity_requested_with_time_machine(self):
self._login_with_permission(self.orga)
self._enable_test_mode()
self._set_time_machine_now(now() - timedelta(days=10))
self.ticket.available_from = now() - timedelta(days=11)
self.ticket.available_until = now() - timedelta(days=9)
self.ticket.validity_mode = Item.VALIDITY_MODE_DYNAMIC
self.ticket.validity_dynamic_duration_days = 1
self.ticket.validity_dynamic_start_choice = True
self.ticket.validity_dynamic_start_choice_day_limit = 5
self.ticket.save()
with scopes_disabled():
cr1 = CartPosition.objects.create(
event=self.event, cart_id=self.session_key, item=self.ticket,
price=42, listed_price=42, price_after_voucher=42, expires=now() + timedelta(minutes=10)
)
# Date too far in the future, expected to fail
response = self.client.post('/%s/%s/checkout/questions/' % (self.orga.slug, self.event.slug), {
'%s-requested_valid_from' % cr1.id: '2024-01-17',
'email': 'admin@localhost'
}, follow=True)
doc = BeautifulSoup(response.content.decode(), "lxml")
self.assertGreaterEqual(len(doc.select('.has-error')), 1)
# Corrected request
response = self.client.post('/%s/%s/checkout/questions/' % (self.orga.slug, self.event.slug), {
'%s-requested_valid_from' % cr1.id: '2023-01-10',
'email': 'admin@localhost'
}, follow=True)
self.assertRedirects(response, '/%s/%s/checkout/payment/' % (self.orga.slug, self.event.slug),
target_status_code=200)
cr1.refresh_from_db()
assert cr1.requested_valid_from.isoformat() == '2023-01-10T00:00:00+00:00'
self._set_payment()
response = self.client.post('/%s/%s/checkout/confirm/' % (self.orga.slug, self.event.slug), follow=True)
doc = BeautifulSoup(response.content.decode(), "lxml")
with scopes_disabled():
self.assertEqual(len(doc.select(".thank-you")), 1)
self.assertFalse(CartPosition.objects.filter(id=cr1.id).exists())
self.assertEqual(Order.objects.count(), 1)
self.assertEqual(OrderPosition.objects.count(), 1)
op = OrderPosition.objects.get()
assert op.valid_from.isoformat() == '2023-01-10T00:00:00+00:00'
assert op.valid_until.isoformat() == '2023-01-10T23:59:59+00:00'
@freeze_time("2023-01-18 10:00:00+00:00")
def test_dynamic_validity_with_time_machine(self):
self._login_with_permission(self.orga)
self._enable_test_mode()
self._set_time_machine_now(now() + timedelta(days=10))
self.ticket.available_from = now() + timedelta(days=3)
self.ticket.validity_mode = Item.VALIDITY_MODE_DYNAMIC
self.ticket.validity_dynamic_duration_days = 1
self.ticket.validity_dynamic_start_choice = False
self.ticket.save()
with scopes_disabled():
cr1 = CartPosition.objects.create(
event=self.event, cart_id=self.session_key, item=self.ticket,
price=42, listed_price=42, price_after_voucher=42, expires=now() + timedelta(minutes=10)
)
response = self.client.post('/%s/%s/checkout/questions/' % (self.orga.slug, self.event.slug), {
'email': 'admin@localhost'
}, follow=True)
self.assertRedirects(response, '/%s/%s/checkout/payment/' % (self.orga.slug, self.event.slug),
target_status_code=200)
cr1.refresh_from_db()
with time_machine_now_assigned(now() + timedelta(days=10)):
assert cr1.predicted_validity[0].isoformat() == '2023-01-28T10:00:00+00:00'
assert cr1.predicted_validity[1].isoformat() == '2023-01-28T23:59:59+00:00'
self._set_payment()
response = self.client.post('/%s/%s/checkout/confirm/' % (self.orga.slug, self.event.slug), follow=True)
doc = BeautifulSoup(response.content.decode(), "lxml")
with scopes_disabled():
self.assertEqual(len(doc.select(".thank-you")), 1)
self.assertFalse(CartPosition.objects.filter(id=cr1.id).exists())
self.assertEqual(Order.objects.count(), 1)
self.assertEqual(OrderPosition.objects.count(), 1)
op = OrderPosition.objects.get()
assert op.valid_from.isoformat() == '2023-01-28T10:00:00+00:00'
assert op.valid_until.isoformat() == '2023-01-28T23:59:59+00:00'
def test_voucher(self):
with scopes_disabled():
v = Voucher.objects.create(item=self.ticket, value=Decimal('12.00'), event=self.event, price_mode='set',
@@ -3486,6 +3581,28 @@ class CheckoutTestCase(BaseCheckoutTestCase, TestCase):
doc = BeautifulSoup(response.content.decode(), "lxml")
self.assertEqual(len(doc.select(".thank-you")), 1)
def test_before_presale_timemachine(self):
self._login_with_permission(self.orga)
self._enable_test_mode()
self._set_time_machine_now(now() + timedelta(days=4))
self.event.presale_start = now() + timedelta(days=3)
self.event.save()
with scopes_disabled():
CartPosition.objects.create(
event=self.event, cart_id=self.session_key, item=self.ticket,
price=23, expires=now() + timedelta(minutes=10)
)
self._set_payment()
response = self.client.get('/%s/%s/checkout/confirm/' % (self.orga.slug, self.event.slug), follow=True)
assert "test mode" in response.content.decode()
response = self.client.post('/%s/%s/checkout/confirm/' % (self.orga.slug, self.event.slug), follow=True)
doc = BeautifulSoup(response.content.decode(), "lxml")
self.assertEqual(len(doc.select(".thank-you")), 1)
with scopes_disabled():
assert Order.objects.last().testmode
assert Order.objects.last().code[1] == "0"
def test_create_testmode_order_in_testmode(self):
self.event.testmode = True
self.event.save()

View File

@@ -0,0 +1,43 @@
#
# This file is part of pretix (Community Edition).
#
# Copyright (C) 2014-2020 Raphael Michel and contributors
# Copyright (C) 2020-2021 rami.io GmbH and contributors
#
# This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General
# Public License as published by the Free Software Foundation in version 3 of the License.
#
# ADDITIONAL TERMS APPLY: Pursuant to Section 7 of the GNU Affero General Public License, additional terms are
# applicable granting you additional permissions and placing additional restrictions on your usage of this software.
# Please refer to the pretix LICENSE file to obtain the full terms applicable to this work. If you did not receive
# this file, see <https://pretix.eu/about/en/license>.
#
# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along with this program. If not, see
# <https://www.gnu.org/licenses/>.
#
from django_scopes.state import scopes_disabled
from pretix.base.models import Team, User
class TimemachineTestMixin:
@scopes_disabled()
def _login_with_permission(self, orga):
self.user = User.objects.create_user('dummy@dummy.dummy', 'dummy')
self.team1 = Team.objects.create(organizer=orga, can_create_events=True, can_change_event_settings=True,
can_change_items=True, all_events=True)
self.team1.members.add(self.user)
self.client.login(email='dummy@dummy.dummy', password='dummy')
def _set_time_machine_now(self, dt):
session = self.client.session
session[f'timemachine_now_dt:{self.event.pk}'] = str(dt)
session.save()
def _enable_test_mode(self):
self.event.testmode = True
self.event.save()