Skip to content

funfedi_parsing_test_cases.cases

ActivityTestCase dataclass

Activity test case

Parameters:

Name Type Description Default
activity dict
required
object_id str
required
Source code in funfedi_parsing_test_cases/cases/activity.py 
12
13
14
15
16
17
@dataclass
class ActivityTestCase:
    """Activity test case"""

    activity: dict
    object_id: str

ActivityTestCaseMaker dataclass

Creates an Activity test case

Parameters:

Name Type Description Default
object_maker Callable[list, dict]
<function default_object_maker at 0x7f199b829170>
activity_maker Callable[list, dict]
<function default_activity_maker at 0x7f199b829590>
Source code in funfedi_parsing_test_cases/cases/activity.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
@dataclass
class ActivityTestCaseMaker:
    """Creates an Activity test case"""

    object_maker: Callable[[Environment], dict] = default_object_maker
    activity_maker: Callable[[Environment, dict], dict] = default_activity_maker

    def activity_and_object(self, environment: Environment) -> tuple[dict, dict]:
        obj = self.object_maker(environment)
        activity = self.activity_maker(environment, obj)
        return activity, obj

    def to_send(self, environment: Environment) -> ActivityTestCase:
        #
        # Might want to return object_id instead of activity, as it is what is used
        # to lookup later
        #
        # Also activity might be a lie as one might have an activity in an activity
        #
        activity, obj = self.activity_and_object(environment)

        object_id = obj.get("id")
        if not isinstance(object_id, str):
            raise InvalidTestCaseException(
                "Only test cases where the object has an id are supported"
            )

        return ActivityTestCase(activity, object_id)

default_activity_maker 

default_activity_maker(
    environment: Environment, obj: dict
) -> dict

>>> from funfedi_parsing_test_cases.testing import default_env
>>> obj = default_object_maker(default_env)
>>> default_activity_maker(default_env, obj)
{'@context': ['https://www.w3.org/ns/activitystreams'],
    'actor': 'http://host.test/some/actor',
    'id': '...
    'object': ...
    'published': '...
    'to': ['https://www.w3.org/ns/activitystreams#Public', 'http://other.test/some/actor'],
    'cc': [],
    'type': 'Create'}
Source code in funfedi_parsing_test_cases/cases/defaults.py 
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
def default_activity_maker(environment: Environment, obj: dict) -> dict:
    """
    ```python
    >>> from funfedi_parsing_test_cases.testing import default_env
    >>> obj = default_object_maker(default_env)
    >>> default_activity_maker(default_env, obj)
    {'@context': ['https://www.w3.org/ns/activitystreams'],
        'actor': 'http://host.test/some/actor',
        'id': '...
        'object': ...
        'published': '...
        'to': ['https://www.w3.org/ns/activitystreams#Public', 'http://other.test/some/actor'],
        'cc': [],
        'type': 'Create'}

    ```
    """
    return {
        "@context": [
            "https://www.w3.org/ns/activitystreams",
        ],
        "actor": environment.sending_actor,
        "id": environment.id_maker("activities"),
        "object": obj,
        "published": now_isoformat(),
        "to": [
            "https://www.w3.org/ns/activitystreams#Public",
            environment.receiving_actor,
        ],
        "cc": [],
        "type": "Create",
    }

default_event_maker 

default_event_maker(environment: Environment) -> dict

>>> from funfedi_parsing_test_cases.testing import default_env
>>> default_event_maker(default_env)
{'@context': ['https://www.w3.org/ns/activitystreams'],
    'id': '...
    'type': 'Event',
    'attributedTo': 'http://host.test/some/actor',
    'to': ['https://www.w3.org/ns/activitystreams#Public', 'http://other.test/some/actor'],
    'cc': [],
    'published': '...
    'content': 'event content',
    'name': 'my event',
    'startTime': '...
    'endTime': '...
    'location': {'type': 'VirtualLocation', 'url': 'http://localhost'}}
Source code in funfedi_parsing_test_cases/cases/defaults.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def default_event_maker(environment: Environment) -> dict:
    """
    ```python
    >>> from funfedi_parsing_test_cases.testing import default_env
    >>> default_event_maker(default_env)
    {'@context': ['https://www.w3.org/ns/activitystreams'],
        'id': '...
        'type': 'Event',
        'attributedTo': 'http://host.test/some/actor',
        'to': ['https://www.w3.org/ns/activitystreams#Public', 'http://other.test/some/actor'],
        'cc': [],
        'published': '...
        'content': 'event content',
        'name': 'my event',
        'startTime': '...
        'endTime': '...
        'location': {'type': 'VirtualLocation', 'url': 'http://localhost'}}

    ```
    """

    return {
        **base_object(environment, "Event"),
        "content": "event content",
        "name": "my event",
        "startTime": to_iso(
            datetime.datetime.now(tz=datetime.timezone.utc) + datetime.timedelta(days=4)
        ),
        "endTime": to_iso(
            datetime.datetime.now(tz=datetime.timezone.utc)
            + datetime.timedelta(days=4, hours=3)
        ),
        "location": {"type": "VirtualLocation", "url": "http://localhost"},
    }

default_object_maker 

default_object_maker(environment: Environment) -> dict

>>> from funfedi_parsing_test_cases.testing import default_env
>>> default_object_maker(default_env)
{'@context': ['https://www.w3.org/ns/activitystreams'],
    'id': '...
    'type': 'Note',
    'attributedTo': 'http://host.test/some/actor',
    'to': ['https://www.w3.org/ns/activitystreams#Public', 'http://other.test/some/actor'],
    'cc': [],
    'published': '...
    'content': 'text',
    'tag': [{'type': 'Mention', 'href': 'http://other.test/some/actor'}]}
Source code in funfedi_parsing_test_cases/cases/defaults.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def default_object_maker(environment: Environment) -> dict:
    """
    ```python
    >>> from funfedi_parsing_test_cases.testing import default_env
    >>> default_object_maker(default_env)
    {'@context': ['https://www.w3.org/ns/activitystreams'],
        'id': '...
        'type': 'Note',
        'attributedTo': 'http://host.test/some/actor',
        'to': ['https://www.w3.org/ns/activitystreams#Public', 'http://other.test/some/actor'],
        'cc': [],
        'published': '...
        'content': 'text',
        'tag': [{'type': 'Mention', 'href': 'http://other.test/some/actor'}]}

    ```
    """
    return {
        **base_object(environment, "Note"),
        "content": "text",
        "tag": [{"type": "Mention", "href": environment.receiving_actor}],
    }

default_poll_maker 

default_poll_maker(environment: Environment) -> dict

>>> from funfedi_parsing_test_cases.testing import default_env
>>> default_poll_maker(default_env)
{'@context': ['https://www.w3.org/ns/activitystreams'],
    'id': '...
    'type': 'Question',
    'attributedTo': 'http://host.test/some/actor',
    'to': ['https://www.w3.org/ns/activitystreams#Public', 'http://other.test/some/actor'],
    'cc': [],
    'published': '...
    'content': '<p>Question</p>',
    'endTime': '...
    'updated': '...
    'oneOf': [{'type': 'Note', 'name': 'Answer 1', 'replies': {'type': 'Collection', 'totalItems': 0}},
        {'type': 'Note', 'name': 'Answer 2', 'replies': {'type': 'Collection', 'totalItems': 0}}]}
Source code in funfedi_parsing_test_cases/cases/defaults.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
def default_poll_maker(environment: Environment) -> dict:
    """
    ```python
    >>> from funfedi_parsing_test_cases.testing import default_env
    >>> default_poll_maker(default_env)
    {'@context': ['https://www.w3.org/ns/activitystreams'],
        'id': '...
        'type': 'Question',
        'attributedTo': 'http://host.test/some/actor',
        'to': ['https://www.w3.org/ns/activitystreams#Public', 'http://other.test/some/actor'],
        'cc': [],
        'published': '...
        'content': '<p>Question</p>',
        'endTime': '...
        'updated': '...
        'oneOf': [{'type': 'Note', 'name': 'Answer 1', 'replies': {'type': 'Collection', 'totalItems': 0}},
            {'type': 'Note', 'name': 'Answer 2', 'replies': {'type': 'Collection', 'totalItems': 0}}]}

    ```
    """

    return {
        **base_object(environment, "Question"),
        "content": "<p>Question</p>",
        "endTime": to_iso(
            datetime.datetime.now() + datetime.timedelta(days=4, hours=3)
        ),
        "updated": to_iso(datetime.datetime.now()),
        "oneOf": [
            {
                "type": "Note",
                "name": "Answer 1",
                "replies": {"type": "Collection", "totalItems": 0},
            },
            {
                "type": "Note",
                "name": "Answer 2",
                "replies": {"type": "Collection", "totalItems": 0},
            },
        ],
    }