slidge 0.1.0__py3-none-any.whl

slidge/util/test.py

@@ -0,0 +1,295 @@
+# type:ignore
+import tempfile
+import types
+from pathlib import Path
+from typing import Optional, Union
+from xml.dom.minidom import parseString
+
+import xmldiff.main
+from slixmpp import (
+    ElementBase,
+    Iq,
+    MatcherId,
+    MatchXMLMask,
+    MatchXPath,
+    Message,
+    Presence,
+    StanzaPath,
+)
+from slixmpp.stanza.error import Error
+from slixmpp.test import SlixTest, TestTransport
+from slixmpp.xmlstream import highlight, tostring
+from slixmpp.xmlstream.matcher import MatchIDSender
+
+from slidge import (
+    BaseGateway,
+    BaseSession,
+    LegacyBookmarks,
+    LegacyContact,
+    LegacyMUC,
+    LegacyParticipant,
+    LegacyRoster,
+    user_store,
+)
+
+from ..command import Command
+from ..core import config
+from ..core.config import _TimedeltaSeconds
+
+
+class SlixTestPlus(SlixTest):
+    def setUp(self):
+        super().setUp()
+        Error.namespace = "jabber:component:accept"
+
+    def check(self, stanza, criteria, method="exact", defaults=None, use_values=True):
+        """
+        Create and compare several stanza objects to a correct XML string.
+
+        If use_values is False, tests using stanza.values will not be used.
+
+        Some stanzas provide default values for some interfaces, but
+        these defaults can be problematic for testing since they can easily
+        be forgotten when supplying the XML string. A list of interfaces that
+        use defaults may be provided and the generated stanzas will use the
+        default values for those interfaces if needed.
+
+        However, correcting the supplied XML is not possible for interfaces
+        that add or remove XML elements. Only interfaces that map to XML
+        attributes may be set using the defaults parameter. The supplied XML
+        must take into account any extra elements that are included by default.
+
+        Arguments:
+            stanza       -- The stanza object to test.
+            criteria     -- An expression the stanza must match against.
+            method       -- The type of matching to use; one of:
+                            'exact', 'mask', 'id', 'xpath', and 'stanzapath'.
+                            Defaults to the value of self.match_method.
+            defaults     -- A list of stanza interfaces that have default
+                            values. These interfaces will be set to their
+                            defaults for the given and generated stanzas to
+                            prevent unexpected test failures.
+            use_values   -- Indicates if testing using stanza.values should
+                            be used. Defaults to True.
+        """
+        if method is None and hasattr(self, "match_method"):
+            method = getattr(self, "match_method")
+
+        if method != "exact":
+            matchers = {
+                "stanzapath": StanzaPath,
+                "xpath": MatchXPath,
+                "mask": MatchXMLMask,
+                "idsender": MatchIDSender,
+                "id": MatcherId,
+            }
+            Matcher = matchers.get(method, None)
+            if Matcher is None:
+                raise ValueError("Unknown matching method.")
+            test = Matcher(criteria)
+            self.assertTrue(
+                test.match(stanza),
+                "Stanza did not match using %s method:\n" % method
+                + "Criteria:\n%s\n" % str(criteria)
+                + "Stanza:\n%s" % str(stanza),
+            )
+        else:
+            stanza_class = stanza.__class__
+            # Hack to preserve namespaces instead of having jabber:client
+            # everywhere.
+            old_ns = stanza_class.namespace
+            stanza_class.namespace = stanza.namespace
+            if not isinstance(criteria, ElementBase):
+                xml = self.parse_xml(criteria)
+            else:
+                xml = criteria.xml
+
+            # Ensure that top level namespaces are used, even if they
+            # were not provided.
+            self.fix_namespaces(stanza.xml)
+            self.fix_namespaces(xml)
+
+            stanza2 = stanza_class(xml=xml)
+
+            if use_values:
+                # Using stanza.values will add XML for any interface that
+                # has a default value. We need to set those defaults on
+                # the existing stanzas and XML so that they will compare
+                # correctly.
+                default_stanza = stanza_class()
+                if defaults is None:
+                    known_defaults = {Message: ["type"], Presence: ["priority"]}
+                    defaults = known_defaults.get(stanza_class, [])
+                for interface in defaults:
+                    stanza[interface] = stanza[interface]
+                    stanza2[interface] = stanza2[interface]
+                    # Can really only automatically add defaults for top
+                    # level attribute values. Anything else must be accounted
+                    # for in the provided XML string.
+                    if interface not in xml.attrib:
+                        if interface in default_stanza.xml.attrib:
+                            value = default_stanza.xml.attrib[interface]
+                            xml.attrib[interface] = value
+
+                values = stanza2.values
+                stanza3 = stanza_class()
+                stanza3.values = values
+
+                debug = "Three methods for creating stanzas do not match.\n"
+                debug += "Given XML:\n%s\n" % highlight(tostring(xml))
+                debug += "Given stanza:\n%s\n" % format_stanza(stanza)
+                debug += "Generated stanza:\n%s\n" % highlight(tostring(stanza2.xml))
+                debug += "Second generated stanza:\n%s\n" % highlight(
+                    tostring(stanza3.xml)
+                )
+                result = self.compare(xml, stanza.xml, stanza2.xml, stanza3.xml)
+            else:
+                debug = "Two methods for creating stanzas do not match.\n"
+                debug += "Given XML:\n%s\n" % highlight(tostring(xml))
+                debug += "Given stanza:\n%s\n" % format_stanza(stanza)
+                debug += "Generated stanza:\n%s\n" % highlight(tostring(stanza2.xml))
+                result = self.compare(xml, stanza.xml, stanza2.xml)
+            stanza_class.namespace = old_ns
+
+            if not result:
+                debug += str(
+                    xmldiff.main.diff_texts(tostring(xml), tostring(stanza.xml))
+                )
+                if use_values:
+                    debug += str(
+                        xmldiff.main.diff_texts(tostring(xml), tostring(stanza2.xml))
+                    )
+            self.assertTrue(result, debug)
+
+    def next_sent(self, timeout=0.05) -> Optional[Union[Message, Iq, Presence]]:
+        self.wait_for_send_queue()
+        sent = self.xmpp.socket.next_sent(timeout=timeout)
+        if sent is None:
+            return None
+        xml = self.parse_xml(sent)
+        self.fix_namespaces(xml, "jabber:component:accept")
+        sent = self.xmpp._build_stanza(xml, "jabber:component:accept")
+        return sent
+
+
+class SlidgeTest(SlixTestPlus):
+    plugin: Union[types.ModuleType, dict]
+
+    class Config:
+        jid = "aim.shakespeare.lit"
+        secret = "test"
+        server = "shakespeare.lit"
+        port = 5222
+        upload_service = "upload.test"
+        home_dir = Path(tempfile.mkdtemp())
+        user_jid_validator = ".*"
+        admins: list[str] = []
+        no_roster_push = False
+        upload_requester = None
+        ignore_delay_threshold = _TimedeltaSeconds("300")
+
+    @classmethod
+    def setUpClass(cls):
+        user_store.set_file(Path(tempfile.mkdtemp()) / "test.db")
+        for k, v in vars(cls.Config).items():
+            setattr(config, k.upper(), v)
+
+    def setUp(self):
+        if hasattr(self, "plugin"):
+            BaseGateway._subclass = find_subclass(self.plugin, BaseGateway)
+            BaseSession._subclass = find_subclass(self.plugin, BaseSession)
+            LegacyRoster._subclass = find_subclass(
+                self.plugin, LegacyRoster, base_ok=True
+            )
+            LegacyContact._subclass = find_subclass(
+                self.plugin, LegacyContact, base_ok=True
+            )
+            LegacyMUC._subclass = find_subclass(self.plugin, LegacyMUC, base_ok=True)
+            LegacyBookmarks._subclass = find_subclass(
+                self.plugin, LegacyBookmarks, base_ok=True
+            )
+
+        self.xmpp = BaseGateway.get_self_or_unique_subclass()()
+
+        self.xmpp._always_send_everything = True
+
+        self.xmpp.connection_made(TestTransport(self.xmpp))
+        self.xmpp.session_bind_event.set()
+        # Remove unique ID prefix to make it easier to test
+        self.xmpp._id_prefix = ""
+        self.xmpp.default_lang = None
+        self.xmpp.peer_default_lang = None
+
+        def new_id():
+            self.xmpp._id += 1
+            return str(self.xmpp._id)
+
+        self.xmpp._id = 0
+        self.xmpp.new_id = new_id
+
+        # Must have the stream header ready for xmpp.process() to work.
+        header = self.xmpp.stream_header
+
+        self.xmpp.data_received(header)
+        self.wait_for_send_queue()
+
+        self.xmpp.socket.next_sent()
+        self.xmpp.socket.next_sent()
+
+        # Some plugins require messages to have ID values. Set
+        # this to True in tests related to those plugins.
+        self.xmpp.use_message_ids = False
+        self.xmpp.use_presence_ids = False
+        Error.namespace = "jabber:component:accept"
+
+    @classmethod
+    def tearDownClass(cls):
+        reset_subclasses()
+        user_store._users = None
+
+
+def format_stanza(stanza):
+    return highlight(
+        "\n".join(parseString(tostring(stanza.xml)).toprettyxml().split("\n")[1:])
+    )
+
+
+def find_subclass(o, parent, base_ok=False):
+    try:
+        vals = vars(o).values()
+    except TypeError:
+        vals = o.values()
+    for x in vals:
+        try:
+            if issubclass(x, parent) and x is not parent:
+                return x
+        except TypeError:
+            pass
+    else:
+        if base_ok:
+            return parent
+        else:
+            raise RuntimeError
+
+
+def reset_subclasses():
+    """
+    Reset registered subclasses between test classes.
+
+    Needed because these classes are meant to only be subclassed once and raise
+    exceptions otherwise.
+    """
+    BaseSession.reset_subclass()
+    BaseGateway.reset_subclass()
+    LegacyRoster.reset_subclass()
+    LegacyContact.reset_subclass()
+    LegacyMUC.reset_subclass()
+    LegacyBookmarks.reset_subclass()
+    LegacyParticipant.reset_subclass()
+    # reset_commands()
+
+
+def reset_commands():
+    Command.subclasses = [
+        c for c in Command.subclasses if str(c).startswith("<class 'slidge.core")
+    ]

slidge/util/types.py

@@ -0,0 +1,180 @@
+"""
+Typing stuff
+"""
+
+from dataclasses import dataclass
+from enum import IntEnum
+from pathlib import Path
+from typing import (
+    IO,
+    TYPE_CHECKING,
+    Any,
+    Generic,
+    Hashable,
+    Literal,
+    NamedTuple,
+    Optional,
+    TypedDict,
+    TypeVar,
+    Union,
+)
+
+from slixmpp import Message, Presence
+from slixmpp.types import PresenceShows
+
+if TYPE_CHECKING:
+    from ..contact import LegacyContact
+    from ..core.pubsub import PepItem
+    from ..core.session import BaseSession
+    from ..group.participant import LegacyMUC, LegacyParticipant
+    from .db import GatewayUser
+
+    AnyBaseSession = BaseSession[Any, Any]
+else:
+    AnyBaseSession = None
+
+
+class URL(str):
+    pass
+
+
+LegacyGroupIdType = TypeVar("LegacyGroupIdType", bound=Hashable)
+"""
+Type of the unique identifier for groups, usually a str or an int,
+but anything hashable should work.
+"""
+LegacyMessageType = TypeVar("LegacyMessageType", bound=Hashable)
+LegacyThreadType = TypeVar("LegacyThreadType", bound=Hashable)
+LegacyUserIdType = TypeVar("LegacyUserIdType", bound=Hashable)
+
+LegacyContactType = TypeVar("LegacyContactType", bound="LegacyContact")
+LegacyMUCType = TypeVar("LegacyMUCType", bound="LegacyMUC")
+LegacyParticipantType = TypeVar("LegacyParticipantType", bound="LegacyParticipant")
+
+PepItemType = TypeVar("PepItemType", bound="PepItem")
+
+Recipient = Union["LegacyMUC", "LegacyContact"]
+RecipientType = TypeVar("RecipientType", bound=Recipient)
+Sender = Union["LegacyContact", "LegacyParticipant"]
+AvatarType = Union[bytes, str, Path]
+LegacyFileIdType = Union[int, str]
+AvatarIdType = Union[LegacyFileIdType, URL]
+
+ChatState = Literal["active", "composing", "gone", "inactive", "paused"]
+ProcessingHint = Literal["no-store", "markable", "store"]
+Marker = Literal["acknowledged", "received", "displayed"]
+FieldType = Literal[
+    "boolean",
+    "fixed",
+    "text-single",
+    "jid-single",
+    "jid-multi",
+    "list-single",
+    "list-multi",
+    "text-private",
+]
+MucAffiliation = Literal["owner", "admin", "member", "outcast", "none"]
+MucRole = Literal["visitor", "participant", "moderator", "none"]
+
+
+@dataclass
+class MessageReference(Generic[LegacyMessageType]):
+    """
+    A "message reply", ie a "quoted message" (:xep:`0461`)
+
+    At the very minimum, the legacy message ID attribute must be set, but to
+    ensure that the quote is displayed in all XMPP clients, the author must also
+    be set.
+    The body is used as a fallback for XMPP clients that do not support :xep:`0461`
+    of that failed to find the referenced message.
+    """
+
+    legacy_id: LegacyMessageType
+    author: Optional[Union["GatewayUser", "LegacyParticipant", "LegacyContact"]] = None
+    body: Optional[str] = None
+
+
+@dataclass
+class LegacyAttachment:
+    """
+    A file attachment to a message
+
+    At the minimum, one of the ``path``, ``steam``, ``data`` or ``url`` attribute
+    has to be set
+
+    To be used with :meth:`.LegacyContact.send_files` or
+    :meth:`.LegacyParticipant.send_files`
+    """
+
+    path: Optional[Union[Path, str]] = None
+    name: Optional[Union[str]] = None
+    stream: Optional[IO[bytes]] = None
+    data: Optional[bytes] = None
+    content_type: Optional[str] = None
+    legacy_file_id: Optional[Union[str, int]] = None
+    url: Optional[str] = None
+    caption: Optional[str] = None
+    """
+    A caption for this specific image. For a global caption for a list of attachments,
+    use the ``body`` parameter of :meth:`.AttachmentMixin.send_files`
+    """
+
+    def __post_init__(self):
+        if not any(
+            x is not None for x in (self.path, self.stream, self.data, self.url)
+        ):
+            raise TypeError("There is not data in this attachment", self)
+
+
+class MucType(IntEnum):
+    """
+    The type of group, private, public, anonymous or not.
+    """
+
+    GROUP = 0
+    """
+    A private group, members-only and non-anonymous, eg a family group.
+    """
+    CHANNEL = 1
+    """
+    A public group, aka an anonymous channel.
+    """
+    CHANNEL_NON_ANONYMOUS = 2
+    """
+    A public group where participants' legacy IDs are visible to everybody.
+    """
+
+
+PseudoPresenceShow = Union[PresenceShows, Literal[""]]
+
+
+class ResourceDict(TypedDict):
+    show: PseudoPresenceShow
+    status: str
+    priority: int
+
+
+MessageOrPresenceTypeVar = TypeVar(
+    "MessageOrPresenceTypeVar", bound=Union[Message, Presence]
+)
+
+
+class LinkPreview(NamedTuple):
+    about: str
+    title: Optional[str]
+    description: Optional[str]
+    url: Optional[str]
+    image: Optional[str]
+    type: Optional[str]
+    site_name: Optional[str]
+
+
+class Mention(NamedTuple):
+    contact: "LegacyContact"
+    start: int
+    end: int
+
+
+class Hat(NamedTuple):
+    uri: str
+    title: str