Skip to content

Fix up event-construction in tests ahead of the Rust event port #19781

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
erikjohnston merged 17 commits into from
May 15, 2026
Merged

Fix up event-construction in tests ahead of the Rust event port #19781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
8c80b86
tests: add make_test_event helper for stricter event construction
erikjohnston May 14, 2026
34eea0a
tests: migrate event construction in tests to make_test_event
erikjohnston May 14, 2026
b24e9c3
tests: add missing required event fields in tests that build dicts di…
erikjohnston May 14, 2026
a505bb5
Newsfile
erikjohnston May 14, 2026
3bf170e
Remove unncessary MockEvent
erikjohnston May 14, 2026
f85b41a
Use empty hashes
erikjohnston May 14, 2026
f9937af
Replace MockEvent in tests/api/test_filtering.py as well
erikjohnston May 14, 2026
3d94323
Use empty hashes mk2
erikjohnston May 14, 2026
25ade8b
Comment that we don't have to have valid values
erikjohnston May 14, 2026
56b5596
Remove "hashes.sha256"
erikjohnston May 14, 2026
2e0e005
Revert spurious depth change
erikjohnston May 14, 2026
14d0c84
Use empty hashes mk3
erikjohnston May 14, 2026
7a73aef
Annotate **fields with a TypedDict
erikjohnston May 14, 2026
4e09f2e
Lint
erikjohnston May 14, 2026
2fcfef1
Better _EventFields
erikjohnston May 14, 2026
01057bb
Better _EventFields mk2
erikjohnston May 14, 2026
8f21d2a
Merge remote-tracking branch 'origin/develop' into erikj/fixup_event_…
erikjohnston May 15, 2026
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
1 change: 1 addition & 0 deletions changelog.d/19781.misc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix up event-construction in tests ahead of the Rust event port.
86 changes: 49 additions & 37 deletions tests/api/test_filtering.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
from synapse.util.frozenutils import freeze

from tests import unittest
from tests.events.test_utils import MockEvent
from tests.test_utils.event_builders import make_test_event

user_id = UserID.from_string("@test_user:test")
user2_id = UserID.from_string("@test_user2:test")
Expand Down Expand Up @@ -134,18 +134,22 @@ def test_limits_are_applied(self) -> None:

def test_definition_types_works_with_literals(self) -> None:
definition = {"types": ["m.room.message", "org.matrix.foo.bar"]}
event = MockEvent(sender="@foo:bar", type="m.room.message", room_id="!foo:bar")
event = make_test_event(
sender="@foo:bar", type="m.room.message", room_id="!foo:bar"
)

self.assertTrue(Filter(self.hs, definition)._check(event))

def test_definition_types_works_with_wildcards(self) -> None:
definition = {"types": ["m.*", "org.matrix.foo.bar"]}
event = MockEvent(sender="@foo:bar", type="m.room.message", room_id="!foo:bar")
event = make_test_event(
sender="@foo:bar", type="m.room.message", room_id="!foo:bar"
)
self.assertTrue(Filter(self.hs, definition)._check(event))

def test_definition_types_works_with_unknowns(self) -> None:
definition = {"types": ["m.room.message", "org.matrix.foo.bar"]}
event = MockEvent(
event = make_test_event(
sender="@foo:bar",
type="now.for.something.completely.different",
room_id="!foo:bar",
Expand All @@ -154,53 +158,59 @@ def test_definition_types_works_with_unknowns(self) -> None:

def test_definition_not_types_works_with_literals(self) -> None:
definition = {"not_types": ["m.room.message", "org.matrix.foo.bar"]}
event = MockEvent(sender="@foo:bar", type="m.room.message", room_id="!foo:bar")
event = make_test_event(
sender="@foo:bar", type="m.room.message", room_id="!foo:bar"
)
self.assertFalse(Filter(self.hs, definition)._check(event))

def test_definition_not_types_works_with_wildcards(self) -> None:
definition = {"not_types": ["m.room.message", "org.matrix.*"]}
event = MockEvent(
event = make_test_event(
sender="@foo:bar", type="org.matrix.custom.event", room_id="!foo:bar"
)
self.assertFalse(Filter(self.hs, definition)._check(event))

def test_definition_not_types_works_with_unknowns(self) -> None:
definition = {"not_types": ["m.*", "org.*"]}
event = MockEvent(sender="@foo:bar", type="com.nom.nom.nom", room_id="!foo:bar")
event = make_test_event(
sender="@foo:bar", type="com.nom.nom.nom", room_id="!foo:bar"
)
self.assertTrue(Filter(self.hs, definition)._check(event))

def test_definition_not_types_takes_priority_over_types(self) -> None:
definition = {
"not_types": ["m.*", "org.*"],
"types": ["m.room.message", "m.room.topic"],
}
event = MockEvent(sender="@foo:bar", type="m.room.topic", room_id="!foo:bar")
event = make_test_event(
sender="@foo:bar", type="m.room.topic", room_id="!foo:bar"
)
self.assertFalse(Filter(self.hs, definition)._check(event))

def test_definition_senders_works_with_literals(self) -> None:
definition = {"senders": ["@flibble:wibble"]}
event = MockEvent(
event = make_test_event(
sender="@flibble:wibble", type="com.nom.nom.nom", room_id="!foo:bar"
)
self.assertTrue(Filter(self.hs, definition)._check(event))

def test_definition_senders_works_with_unknowns(self) -> None:
definition = {"senders": ["@flibble:wibble"]}
event = MockEvent(
event = make_test_event(
sender="@challenger:appears", type="com.nom.nom.nom", room_id="!foo:bar"
)
self.assertFalse(Filter(self.hs, definition)._check(event))

def test_definition_not_senders_works_with_literals(self) -> None:
definition = {"not_senders": ["@flibble:wibble"]}
event = MockEvent(
event = make_test_event(
sender="@flibble:wibble", type="com.nom.nom.nom", room_id="!foo:bar"
)
self.assertFalse(Filter(self.hs, definition)._check(event))

def test_definition_not_senders_works_with_unknowns(self) -> None:
definition = {"not_senders": ["@flibble:wibble"]}
event = MockEvent(
event = make_test_event(
sender="@challenger:appears", type="com.nom.nom.nom", room_id="!foo:bar"
)
self.assertTrue(Filter(self.hs, definition)._check(event))
Expand All @@ -210,21 +220,21 @@ def test_definition_not_senders_takes_priority_over_senders(self) -> None:
"not_senders": ["@misspiggy:muppets"],
"senders": ["@kermit:muppets", "@misspiggy:muppets"],
}
event = MockEvent(
event = make_test_event(
sender="@misspiggy:muppets", type="m.room.topic", room_id="!foo:bar"
)
self.assertFalse(Filter(self.hs, definition)._check(event))

def test_definition_rooms_works_with_literals(self) -> None:
definition = {"rooms": ["!secretbase:unknown"]}
event = MockEvent(
event = make_test_event(
sender="@foo:bar", type="m.room.message", room_id="!secretbase:unknown"
)
self.assertTrue(Filter(self.hs, definition)._check(event))

def test_definition_rooms_works_with_unknowns(self) -> None:
definition = {"rooms": ["!secretbase:unknown"]}
event = MockEvent(
event = make_test_event(
sender="@foo:bar",
type="m.room.message",
room_id="!anothersecretbase:unknown",
Expand All @@ -233,7 +243,7 @@ def test_definition_rooms_works_with_unknowns(self) -> None:

def test_definition_not_rooms_works_with_literals(self) -> None:
definition = {"not_rooms": ["!anothersecretbase:unknown"]}
event = MockEvent(
event = make_test_event(
sender="@foo:bar",
type="m.room.message",
room_id="!anothersecretbase:unknown",
Expand All @@ -242,7 +252,7 @@ def test_definition_not_rooms_works_with_literals(self) -> None:

def test_definition_not_rooms_works_with_unknowns(self) -> None:
definition = {"not_rooms": ["!secretbase:unknown"]}
event = MockEvent(
event = make_test_event(
sender="@foo:bar",
type="m.room.message",
room_id="!anothersecretbase:unknown",
Expand All @@ -254,7 +264,7 @@ def test_definition_not_rooms_takes_priority_over_rooms(self) -> None:
"not_rooms": ["!secretbase:unknown"],
"rooms": ["!secretbase:unknown"],
}
event = MockEvent(
event = make_test_event(
sender="@foo:bar", type="m.room.message", room_id="!secretbase:unknown"
)
self.assertFalse(Filter(self.hs, definition)._check(event))
Expand All @@ -268,7 +278,7 @@ def test_definition_combined_event(self) -> None:
"types": ["m.room.message", "muppets.kermit.*"],
"not_types": ["muppets.misspiggy.*"],
}
event = MockEvent(
event = make_test_event(
sender="@kermit:muppets", # yup
type="m.room.message", # yup
room_id="!stage:unknown", # yup
Expand All @@ -284,7 +294,7 @@ def test_definition_combined_event_bad_sender(self) -> None:
"types": ["m.room.message", "muppets.kermit.*"],
"not_types": ["muppets.misspiggy.*"],
}
event = MockEvent(
event = make_test_event(
sender="@misspiggy:muppets", # nope
type="m.room.message", # yup
room_id="!stage:unknown", # yup
Expand All @@ -300,7 +310,7 @@ def test_definition_combined_event_bad_room(self) -> None:
"types": ["m.room.message", "muppets.kermit.*"],
"not_types": ["muppets.misspiggy.*"],
}
event = MockEvent(
event = make_test_event(
sender="@kermit:muppets", # yup
type="m.room.message", # yup
room_id="!piggyshouse:muppets", # nope
Expand All @@ -316,7 +326,7 @@ def test_definition_combined_event_bad_type(self) -> None:
"types": ["m.room.message", "muppets.kermit.*"],
"not_types": ["muppets.misspiggy.*"],
}
event = MockEvent(
event = make_test_event(
sender="@kermit:muppets", # yup
type="muppets.misspiggy.kisses", # nope
room_id="!stage:unknown", # yup
Expand All @@ -325,7 +335,7 @@ def test_definition_combined_event_bad_type(self) -> None:

def test_filter_labels(self) -> None:
definition = {"org.matrix.labels": ["#fun"]}
event = MockEvent(
event = make_test_event(
sender="@foo:bar",
type="m.room.message",
room_id="!secretbase:unknown",
Expand All @@ -334,7 +344,7 @@ def test_filter_labels(self) -> None:

self.assertTrue(Filter(self.hs, definition)._check(event))

event = MockEvent(
event = make_test_event(
sender="@foo:bar",
type="m.room.message",
room_id="!secretbase:unknown",
Expand All @@ -344,7 +354,7 @@ def test_filter_labels(self) -> None:
self.assertFalse(Filter(self.hs, definition)._check(event))

# check it works with frozen dictionaries too
event = MockEvent(
event = make_test_event(
sender="@foo:bar",
type="m.room.message",
room_id="!secretbase:unknown",
Expand All @@ -354,7 +364,7 @@ def test_filter_labels(self) -> None:

def test_filter_not_labels(self) -> None:
definition = {"org.matrix.not_labels": ["#fun"]}
event = MockEvent(
event = make_test_event(
sender="@foo:bar",
type="m.room.message",
room_id="!secretbase:unknown",
Expand All @@ -363,7 +373,7 @@ def test_filter_not_labels(self) -> None:

self.assertFalse(Filter(self.hs, definition)._check(event))

event = MockEvent(
event = make_test_event(
sender="@foo:bar",
type="m.room.message",
room_id="!secretbase:unknown",
Expand All @@ -375,7 +385,7 @@ def test_filter_not_labels(self) -> None:
@unittest.override_config({"experimental_features": {"msc3874_enabled": True}})
def test_filter_rel_type(self) -> None:
definition = {"org.matrix.msc3874.rel_types": ["m.thread"]}
event = MockEvent(
event = make_test_event(
sender="@foo:bar",
type="m.room.message",
room_id="!secretbase:unknown",
Expand All @@ -384,7 +394,7 @@ def test_filter_rel_type(self) -> None:

self.assertFalse(Filter(self.hs, definition)._check(event))

event = MockEvent(
event = make_test_event(
sender="@foo:bar",
type="m.room.message",
room_id="!secretbase:unknown",
Expand All @@ -393,7 +403,7 @@ def test_filter_rel_type(self) -> None:

self.assertFalse(Filter(self.hs, definition)._check(event))

event = MockEvent(
event = make_test_event(
sender="@foo:bar",
type="m.room.message",
room_id="!secretbase:unknown",
Expand All @@ -405,7 +415,7 @@ def test_filter_rel_type(self) -> None:
@unittest.override_config({"experimental_features": {"msc3874_enabled": True}})
def test_filter_not_rel_type(self) -> None:
definition = {"org.matrix.msc3874.not_rel_types": ["m.thread"]}
event = MockEvent(
event = make_test_event(
sender="@foo:bar",
type="m.room.message",
room_id="!secretbase:unknown",
Expand All @@ -414,7 +424,7 @@ def test_filter_not_rel_type(self) -> None:

self.assertFalse(Filter(self.hs, definition)._check(event))

event = MockEvent(
event = make_test_event(
sender="@foo:bar",
type="m.room.message",
room_id="!secretbase:unknown",
Expand All @@ -423,7 +433,7 @@ def test_filter_not_rel_type(self) -> None:

self.assertTrue(Filter(self.hs, definition)._check(event))

event = MockEvent(
event = make_test_event(
sender="@foo:bar",
type="m.room.message",
room_id="!secretbase:unknown",
Expand Down Expand Up @@ -494,7 +504,9 @@ def test_filter_room_state_match(self) -> None:
user_id=user_id, user_filter=user_filter_json
)
)
event = MockEvent(sender="@foo:bar", type="m.room.topic", room_id="!foo:bar")
event = make_test_event(
sender="@foo:bar", type="m.room.topic", room_id="!foo:bar"
)
events = [event]

user_filter = self.get_success(
Expand All @@ -511,7 +523,7 @@ def test_filter_room_state_no_match(self) -> None:
user_id=user_id, user_filter=user_filter_json
)
)
event = MockEvent(
event = make_test_event(
sender="@foo:bar", type="org.matrix.custom.event", room_id="!foo:bar"
)
events = [event]
Expand Down Expand Up @@ -542,14 +554,14 @@ def test_filter_rooms(self) -> None:
def test_filter_relations(self) -> None:
events = [
# An event without a relation.
MockEvent(
make_test_event(
event_id="$no_relation",
sender="@foo:bar",
type="org.matrix.custom.event",
room_id="!foo:bar",
),
# An event with a relation.
MockEvent(
make_test_event(
event_id="$with_relation",
sender="@foo:bar",
type="org.matrix.custom.event",
Expand Down
Loading
Loading