Files
pretix_cgo/src/tests/base/test_shredders.py
Raphael Michel 0cc8e59bb0 Webhooks: Add vouchers (Z#23203072) (#5360)
* Webhooks: Add vouchers (Z#23203072)

This also requires more consistent usage of webhook types to avoid
vouchers not being known to the external system.

* Update src/pretix/api/webhooks.py

Co-authored-by: luelista <weller@rami.io>

* Fix shredder test

---------

Co-authored-by: luelista <weller@rami.io>
2025-08-19 13:04:22 +02:00

497 lines
15 KiB
Python

#
# 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/>.
#
import json
import os
from datetime import timedelta
from decimal import Decimal
import pytest
from django.core.files.base import ContentFile
from django.utils.timezone import now
from django_scopes import scope
from pretix.base.models import (
CachedCombinedTicket, CachedTicket, Event, InvoiceAddress, Order,
OrderPayment, OrderPosition, Organizer, QuestionAnswer,
)
from pretix.base.services.invoices import generate_invoice, invoice_pdf_task
from pretix.base.services.tickets import generate
from pretix.base.shredder import (
AttendeeInfoShredder, CachedTicketShredder, EmailAddressShredder,
InvoiceAddressShredder, InvoiceShredder, PaymentInfoShredder,
QuestionAnswerShredder, WaitingListShredder, shred_constraints,
shred_log_fields,
)
@pytest.fixture
def event():
o = Organizer.objects.create(name='Dummy', slug='dummy')
event = Event.objects.create(
organizer=o, name='Dummy', slug='dummy',
date_from=now(), plugins='pretix.plugins.banktransfer,pretix.plugins.ticketoutputpdf'
)
with scope(organizer=o):
yield event
@pytest.fixture
def item(event):
return event.items.create(
name='Early-bird ticket',
category=None, default_price=23,
admission=True
)
@pytest.fixture
def order(event, item):
o = Order.objects.create(
code='FOO', event=event, email='dummy@dummy.test',
status=Order.STATUS_PENDING,
datetime=now(), expires=now() + timedelta(days=10),
sales_channel=event.organizer.sales_channels.get(identifier="web"),
total=14, locale='en'
)
event.settings.set('attendee_names_asked', True)
event.settings.set('locales', ['en', 'de'])
OrderPosition.objects.create(
order=o,
item=item,
variation=None,
price=Decimal("14"),
attendee_name_parts={'full_name': "Peter", "_scheme": "full"},
attendee_email="foo@example.org",
company='Foobar',
)
return o
@pytest.fixture
def question(event, item):
q = event.questions.create(question="T-Shirt size", type="C", identifier="ABC")
q.items.add(item)
q.options.create(answer="XL", identifier="LVETRWVU")
return q
@pytest.mark.django_db
def test_email_shredder(event, order):
l1 = order.log_action(
'pretix.event.order.email.expired',
data={
'recipient': 'dummy@dummy.test',
'message': 'Hello Peter@,',
'subject': 'Foo'
}
)
l2 = order.log_action(
'pretix.event.order.contact.changed',
data={
'old_email': 'dummy@dummy.test',
'new_email': 'foo@bar.com',
}
)
s = EmailAddressShredder(event)
f = list(s.generate_files())
assert json.loads(f[0][2]) == {
order.code: 'dummy@dummy.test'
}
assert json.loads(f[1][2]) == {
'{}-{}'.format(order.code, 1): 'foo@example.org'
}
s.shred_data()
order.refresh_from_db()
assert order.email is None
assert order.positions.first().attendee_email is None
l1.refresh_from_db()
assert '@' not in l1.data
assert 'Foo' not in l1.data
l2.refresh_from_db()
assert '@' not in l2.data
@pytest.mark.django_db
def test_waitinglist_shredder(event, item):
q = event.quotas.create(size=5)
q.items.add(item)
wle = event.waitinglistentries.create(
item=item, email='foo@example.org', name_parts={'_legacy': 'Peter'}, phone='+49891234567'
)
wle.send_voucher()
assert '@' in wle.voucher.comment
assert '@' in wle.voucher.all_logentries().get(action_type="pretix.voucher.added.waitinglist").data
s = WaitingListShredder(event)
f = list(s.generate_files())
assert json.loads(f[0][2]) == [
{
'id': wle.pk,
'item': item.pk,
'variation': None,
'subevent': None,
'voucher': wle.voucher.pk,
'created': wle.created.isoformat().replace('+00:00', 'Z'),
'locale': 'en',
'priority': 0,
'name': 'Peter',
'name_parts': {'_legacy': 'Peter'},
'email': 'foo@example.org',
'phone': '+49891234567'
}
]
s.shred_data()
wle.refresh_from_db()
wle.voucher.refresh_from_db()
assert 'Richard' not in wle.name
assert '@' not in wle.email
assert '+49' not in str(wle.phone)
assert '@' not in wle.voucher.comment
assert '@' not in wle.voucher.all_logentries().get(action_type="pretix.voucher.added.waitinglist").data
@pytest.mark.django_db
def test_attendee_name_shredder(event, order):
l1 = order.log_action(
'pretix.event.order.modified',
data={
"data": [{"attendee_name": "Peter", "question_1": "Test", "company": "Foobar"}],
"invoice_data": {"name": "Foo"}
}
)
s = AttendeeInfoShredder(event)
f = list(s.generate_files())
assert json.loads(f[0][2]) == {
'{}-{}'.format(order.code, 1): {
'name': 'Peter',
'company': 'Foobar',
'street': None,
'zipcode': None,
'city': None,
'country': None,
'state': None
}
}
s.shred_data()
order.refresh_from_db()
assert not order.positions.first().attendee_name
l1.refresh_from_db()
assert 'Hans' not in l1.data
assert 'Foo' in l1.data
assert 'Foobar' not in l1.data
assert 'Test' in l1.data
@pytest.mark.django_db
def test_invoice_address_shredder(event, order):
l1 = order.log_action(
'pretix.event.order.modified',
data={
"data": [{"attendee_name": "Hans", "question_1": "Test"}],
"invoice_data": {"name": "Peter", "country": "DE", "is_business": False, "internal_reference": "",
"state": "",
"company": "ACME", "street": "Sesam Street", "city": "Sample City", "zipcode": "12345"}
}
)
ia = InvoiceAddress.objects.create(company='Acme Company', street='221B Baker Street',
zipcode='12345', city='London', country='UK',
order=order)
s = InvoiceAddressShredder(event)
f = list(s.generate_files())
assert json.loads(f[0][2]) == {
order.code: {
'city': 'London',
'company': 'Acme Company',
'country': 'UK',
'internal_reference': '',
'custom_field': None,
'is_business': False,
'last_modified': ia.last_modified.isoformat().replace('+00:00', 'Z'),
'name': '',
'name_parts': {},
'state': '',
'street': '221B Baker Street',
'vat_id': '',
'vat_id_validated': False,
'zipcode': '12345'
}
}
s.shred_data()
order.refresh_from_db()
assert not InvoiceAddress.objects.filter(order=order).exists()
l1.refresh_from_db()
assert l1.parsed_data == {
"data": [{"attendee_name": "Hans", "question_1": "Test"}],
"invoice_data": {"name": "", "country": "", "is_business": False, "internal_reference": "", "company": "",
"street": "", "city": "", "zipcode": "", "state": ""}
}
@pytest.mark.django_db
def test_question_answer_shredder(event, order, question):
opt = question.options.first()
q2 = event.questions.create(question="Photo", type="F", identifier="DEF")
l1 = order.log_action(
'pretix.event.order.modified',
data={
"data": [
{
"attendee_name": "Hans",
"question_%d" % question.pk: [{"id": opt.pk, "type": "QuestionOption"}]
}
],
}
)
qa = QuestionAnswer.objects.create(
orderposition=order.positions.first(),
question=question,
answer='S'
)
qa2 = QuestionAnswer.objects.create(
orderposition=order.positions.first(),
question=q2,
answer='file:///foo.pdf'
)
qa.file.save('foo.pdf', ContentFile('foo'))
fname = qa.file.path
assert os.path.exists(fname)
qa.options.add(opt)
s = QuestionAnswerShredder(event)
f = list(s.generate_files())
assert json.loads(f[-1][2]) == {
'{}-1'.format(order.code): [{
'question': question.pk,
'answer': 'S',
'question_identifier': question.identifier,
'options': [opt.pk],
'option_identifiers': [opt.identifier],
}, {
'question': q2.pk,
'answer': f'/api/v1/organizers/dummy/events/dummy/orderpositions/{qa2.orderposition_id}/answer/{qa2.question_id}/',
'question_identifier': q2.identifier,
'options': [],
'option_identifiers': [],
}]
}
assert f[0][0].endswith('.pdf')
s.shred_data()
order.refresh_from_db()
assert not os.path.exists(fname)
assert not QuestionAnswer.objects.filter(pk=qa.pk).exists()
l1.refresh_from_db()
assert l1.parsed_data == {
"data": [{"attendee_name": "Hans", "question_%d" % question.pk: ""}],
}
@pytest.mark.django_db
def test_invoice_shredder(event, order):
InvoiceAddress.objects.create(company='Acme Company', street='221B Baker Street',
zipcode='12345', city='London', country='UK',
order=order)
inv = generate_invoice(order)
invoice_pdf_task.apply(args=(inv.pk,))
inv.refresh_from_db()
assert inv.invoice_to == "Acme Company\n221B Baker Street\n12345 London"
assert inv.file
fname = inv.file.path
assert os.path.exists(fname)
s = InvoiceShredder(event)
f = list(s.generate_files())
assert len(f) == 1
s.shred_data()
inv.refresh_from_db()
assert "Acme" not in inv.invoice_to
assert "icket" not in inv.lines.first().description
assert not inv.file
assert not os.path.exists(fname)
@pytest.mark.django_db
def test_cached_tickets(event, order):
generate('orderposition', order.positions.first().pk, 'pdf')
generate('order', order.pk, 'pdf')
ct = CachedTicket.objects.get(order_position=order.positions.first(), provider='pdf')
cct = CachedCombinedTicket.objects.get(order=order, provider='pdf')
assert ct.file
assert cct.file
ct_fname = ct.file.path
cct_fname = cct.file.path
assert os.path.exists(ct_fname)
assert os.path.exists(cct_fname)
s = CachedTicketShredder(event)
assert s.generate_files() is None
s.shred_data()
assert not CachedTicket.objects.filter(order_position=order.positions.first(), provider='pdf').exists()
assert not CachedCombinedTicket.objects.filter(order=order, provider='pdf').exists()
assert not os.path.exists(ct_fname)
assert not os.path.exists(cct_fname)
@pytest.mark.django_db
def test_payment_info_shredder(event, order):
order.payments.create(info=json.dumps({
'reference': 'Verwendungszweck 1',
'date': '2018-05-01',
'payer': 'Hans',
'trans_id': 12
}), provider='banktransfer', amount=order.total, state=OrderPayment.PAYMENT_STATE_PENDING)
order.save()
s = PaymentInfoShredder(event)
assert s.generate_files() is None
s.shred_data()
order.refresh_from_db()
assert order.payments.first().info_data == {
'_shredded': True,
'reference': '',
'date': '2018-05-01',
'payer': '',
'trans_id': 12
}
@pytest.mark.django_db
def test_shred_constraint_offline(event):
event.live = True
event.date_from = now() - timedelta(days=365)
assert shred_constraints(event)
@pytest.mark.django_db
def test_shred_constraint_after_event(event):
event.live = False
now_dt = now()
event.date_from = now_dt - timedelta(hours=1)
event.date_to = now_dt - timedelta(hours=1)
assert shred_constraints(event) is None
event.date_from = now_dt - timedelta(hours=1)
event.date_to = now_dt - timedelta(hours=1)
assert shred_constraints(event) is None
event.date_from = now_dt - timedelta(hours=1)
event.date_to = now_dt + timedelta(hours=1)
assert shred_constraints(event)
@pytest.mark.django_db
def test_shred_constraint_after_event_subevents(event):
event.has_subevents = True
event.live = False
now_dt = now()
event.subevents.create(
date_from=now_dt - timedelta(hours=2),
date_to=now_dt - timedelta(hours=1)
)
assert shred_constraints(event) is None
event.subevents.create(
date_from=now_dt - timedelta(hours=1),
date_to=now_dt + timedelta(hours=1)
)
assert shred_constraints(event)
@pytest.mark.django_db
def test_shred_log_fields_banlist(event):
le = event.log_action("foo.bar", data={
"dict": {
"subdict": {
"foo": "bar",
"empty": None,
}
},
"list": [
{
"foo": "bar",
},
"baz",
],
"string": "foo",
"bool": True,
"int": 0,
})
shred_log_fields(le, banlist=["dict", "list", "int", "bool"])
assert le.shredded
assert le.parsed_data == {
"dict": {
"subdict": {
"foo": "",
"empty": None,
}
},
"list": [
{
"foo": "",
},
"",
],
"string": "foo",
"bool": "",
"int": 0,
}
@pytest.mark.django_db
def test_shred_log_fields_whitelist(event):
le = event.log_action("foo.bar", data={
"dict": {
"subdict": {
"foo": "bar",
"empty": None,
}
},
"list": [
{
"foo": "bar",
},
"baz",
],
"string": "foo",
"bool": True,
"int": 0,
})
shred_log_fields(le, whitelist=["string"])
assert le.shredded
assert le.parsed_data == {
"dict": {
"subdict": {
"foo": "",
"empty": None,
}
},
"list": [
{
"foo": "",
},
"",
],
"string": "foo",
"bool": "",
"int": 0,
}