factories.py 9.11 KB
Newer Older
Eliot Berriot's avatar
Eliot Berriot committed
1
2
import uuid

3
4
5
import factory
import requests
import requests_http_signature
Eliot Berriot's avatar
Eliot Berriot committed
6
from django.conf import settings
Eliot Berriot's avatar
Eliot Berriot committed
7
from django.utils import timezone
8
from django.utils.http import http_date
9

10
from funkwhale_api.factories import registry, NoUpdateOnCreate
11
from funkwhale_api.users import factories as user_factories
12

Eliot Berriot's avatar
Eliot Berriot committed
13
from . import keys, models
14

Eliot Berriot's avatar
Eliot Berriot committed
15
registry.register(keys.get_key_pair, name="federation.KeyPair")
16
17


Eliot Berriot's avatar
Eliot Berriot committed
18
@registry.register(name="federation.SignatureAuth")
19
class SignatureAuthFactory(factory.Factory):
Eliot Berriot's avatar
Eliot Berriot committed
20
    algorithm = "rsa-sha256"
21
    key = factory.LazyFunction(lambda: keys.get_key_pair()[0])
Eliot Berriot's avatar
Eliot Berriot committed
22
    key_id = factory.Faker("url")
23
    use_auth_header = False
24
    headers = ["(request-target)", "user-agent", "host", "date", "accept"]
Eliot Berriot's avatar
Eliot Berriot committed
25

26
27
28
29
    class Meta:
        model = requests_http_signature.HTTPSignatureAuth


Eliot Berriot's avatar
Eliot Berriot committed
30
@registry.register(name="federation.SignedRequest")
31
class SignedRequestFactory(factory.Factory):
Eliot Berriot's avatar
Eliot Berriot committed
32
33
    url = factory.Faker("url")
    method = "get"
34
35
36
37
    auth = factory.SubFactory(SignatureAuthFactory)

    class Meta:
        model = requests.Request
38
39
40
41

    @factory.post_generation
    def headers(self, create, extracted, **kwargs):
        default_headers = {
Eliot Berriot's avatar
Eliot Berriot committed
42
43
            "User-Agent": "Test",
            "Host": "test.host",
44
            "Date": http_date(timezone.now().timestamp()),
45
            "Accept": "application/activity+json",
46
47
48
49
50
51
        }
        if extracted:
            default_headers.update(extracted)
        self.headers.update(default_headers)


Eliot Berriot's avatar
Eliot Berriot committed
52
@registry.register(name="federation.Link")
Eliot Berriot's avatar
Eliot Berriot committed
53
class LinkFactory(factory.Factory):
Eliot Berriot's avatar
Eliot Berriot committed
54
55
56
    type = "Link"
    href = factory.Faker("url")
    mediaType = "text/html"
Eliot Berriot's avatar
Eliot Berriot committed
57
58
59
60
61

    class Meta:
        model = dict

    class Params:
Eliot Berriot's avatar
Eliot Berriot committed
62
        audio = factory.Trait(mediaType=factory.Iterator(["audio/mp3", "audio/ogg"]))
Eliot Berriot's avatar
Eliot Berriot committed
63
64


65
66
67
68
def create_user(actor):
    return user_factories.UserFactory(actor=actor)


69
@registry.register
70
class DomainFactory(NoUpdateOnCreate, factory.django.DjangoModelFactory):
71
    name = factory.Faker("domain_name")
Eliot Berriot's avatar
Eliot Berriot committed
72
    nodeinfo_fetch_date = factory.LazyFunction(lambda: timezone.now())
73
    allowed = None
74
75
76
77
78

    class Meta:
        model = "federation.Domain"
        django_get_or_create = ("name",)

Eliot Berriot's avatar
Eliot Berriot committed
79
80
81
82
83
84
85
86
87
    @factory.post_generation
    def with_service_actor(self, create, extracted, **kwargs):
        if not create or not extracted:
            return

        self.service_actor = ActorFactory(domain=self)
        self.save(update_fields=["service_actor"])
        return self.service_actor

88

89
90
91
92
93
94
95
96
97
98
99
_CACHE = {}


def get_cached_key_pair():
    try:
        return _CACHE["keys"]
    except KeyError:
        _CACHE["keys"] = keys.get_key_pair()
    return _CACHE["keys"]


Eliot Berriot's avatar
Eliot Berriot committed
100
@registry.register
101
class ActorFactory(NoUpdateOnCreate, factory.DjangoModelFactory):
Eliot Berriot's avatar
Eliot Berriot committed
102
103
    public_key = None
    private_key = None
Eliot Berriot's avatar
Eliot Berriot committed
104
105
    preferred_username = factory.Faker("user_name")
    summary = factory.Faker("paragraph")
106
    domain = factory.SubFactory(DomainFactory)
107
    fid = factory.LazyAttribute(
108
        lambda o: "https://{}/users/{}".format(o.domain.name, o.preferred_username)
Eliot Berriot's avatar
Eliot Berriot committed
109
    )
Eliot Berriot's avatar
Eliot Berriot committed
110
    followers_url = factory.LazyAttribute(
111
112
113
        lambda o: "https://{}/users/{}followers".format(
            o.domain.name, o.preferred_username
        )
Eliot Berriot's avatar
Eliot Berriot committed
114
    )
Eliot Berriot's avatar
Eliot Berriot committed
115
    inbox_url = factory.LazyAttribute(
116
117
118
        lambda o: "https://{}/users/{}/inbox".format(
            o.domain.name, o.preferred_username
        )
Eliot Berriot's avatar
Eliot Berriot committed
119
120
    )
    outbox_url = factory.LazyAttribute(
121
122
123
        lambda o: "https://{}/users/{}/outbox".format(
            o.domain.name, o.preferred_username
        )
Eliot Berriot's avatar
Eliot Berriot committed
124
    )
125
    keys = factory.LazyFunction(get_cached_key_pair)
Eliot Berriot's avatar
Eliot Berriot committed
126
127
128
129

    class Meta:
        model = models.Actor

130
131
132
    class Params:
        with_real_keys = factory.Trait(keys=factory.LazyFunction(keys.get_key_pair),)

133
134
135
136
137
138
    @factory.post_generation
    def local(self, create, extracted, **kwargs):
        if not extracted and not kwargs:
            return
        from funkwhale_api.users.factories import UserFactory

139
140
141
        self.domain = models.Domain.objects.get_or_create(
            name=settings.FEDERATION_HOSTNAME
        )[0]
Eliot Berriot's avatar
Eliot Berriot committed
142
143
        self.fid = "https://{}/actors/{}".format(self.domain, self.preferred_username)
        self.save(update_fields=["domain", "fid"])
144
145
146
147
148
149
150
151
152
153
154
        if not create:
            if extracted and hasattr(extracted, "pk"):
                extracted.actor = self
            else:
                UserFactory.build(actor=self, **kwargs)
        if extracted and hasattr(extracted, "pk"):
            extracted.actor = self
            extracted.save(update_fields=["user"])
        else:
            self.user = UserFactory(actor=self, **kwargs)

155

Eliot Berriot's avatar
Eliot Berriot committed
156
@registry.register
157
class FollowFactory(NoUpdateOnCreate, factory.DjangoModelFactory):
Eliot Berriot's avatar
Eliot Berriot committed
158
159
160
161
162
163
    target = factory.SubFactory(ActorFactory)
    actor = factory.SubFactory(ActorFactory)

    class Meta:
        model = models.Follow

Eliot Berriot's avatar
Eliot Berriot committed
164
    class Params:
Eliot Berriot's avatar
Eliot Berriot committed
165
        local = factory.Trait(actor=factory.SubFactory(ActorFactory, local=True))
Eliot Berriot's avatar
Eliot Berriot committed
166

Eliot Berriot's avatar
Eliot Berriot committed
167

168
@registry.register
169
class MusicLibraryFactory(NoUpdateOnCreate, factory.django.DjangoModelFactory):
170
171
172
173
    actor = factory.SubFactory(ActorFactory)
    privacy_level = "me"
    name = factory.Faker("sentence")
    description = factory.Faker("sentence")
Eliot Berriot's avatar
Eliot Berriot committed
174
175
    uploads_count = 0
    fid = factory.Faker("federation_url")
176
177
178
    followers_url = factory.LazyAttribute(
        lambda o: o.fid + "/followers" if o.fid else None
    )
179
180
181
182

    class Meta:
        model = "music.Library"

183
    class Params:
Eliot Berriot's avatar
Eliot Berriot committed
184
185
186
        local = factory.Trait(
            fid=None, actor=factory.SubFactory(ActorFactory, local=True)
        )
187

188
189

@registry.register
190
class LibraryScanFactory(NoUpdateOnCreate, factory.django.DjangoModelFactory):
191
192
    library = factory.SubFactory(MusicLibraryFactory)
    actor = factory.SubFactory(ActorFactory)
Eliot Berriot's avatar
Eliot Berriot committed
193
    total_files = factory.LazyAttribute(lambda o: o.library.uploads_count)
194
195
196
197
198

    class Meta:
        model = "music.LibraryScan"


199
200
201
202
203
204
205
206
@registry.register
class FetchFactory(NoUpdateOnCreate, factory.django.DjangoModelFactory):
    actor = factory.SubFactory(ActorFactory)

    class Meta:
        model = "federation.Fetch"


207
@registry.register
208
class ActivityFactory(NoUpdateOnCreate, factory.django.DjangoModelFactory):
209
    actor = factory.SubFactory(ActorFactory)
Eliot Berriot's avatar
Eliot Berriot committed
210
    url = factory.Faker("federation_url")
211
    payload = factory.LazyFunction(lambda: {"type": "Create"})
212
213

    class Meta:
214
215
216
217
        model = "federation.Activity"


@registry.register
218
class InboxItemFactory(NoUpdateOnCreate, factory.django.DjangoModelFactory):
Eliot Berriot's avatar
Eliot Berriot committed
219
    actor = factory.SubFactory(ActorFactory, local=True)
220
221
222
223
224
225
226
    activity = factory.SubFactory(ActivityFactory)
    type = "to"

    class Meta:
        model = "federation.InboxItem"


Eliot Berriot's avatar
Eliot Berriot committed
227
@registry.register
228
class DeliveryFactory(NoUpdateOnCreate, factory.django.DjangoModelFactory):
Eliot Berriot's avatar
Eliot Berriot committed
229
230
231
232
233
234
235
    activity = factory.SubFactory(ActivityFactory)
    inbox_url = factory.Faker("url")

    class Meta:
        model = "federation.Delivery"


236
@registry.register
237
class LibraryFollowFactory(NoUpdateOnCreate, factory.DjangoModelFactory):
238
239
240
241
242
    target = factory.SubFactory(MusicLibraryFactory)
    actor = factory.SubFactory(ActorFactory)

    class Meta:
        model = "federation.LibraryFollow"
243
244


245
class ArtistMetadataFactory(factory.Factory):
Eliot Berriot's avatar
Eliot Berriot committed
246
    name = factory.Faker("name")
247
248
249
250
251

    class Meta:
        model = dict

    class Params:
Eliot Berriot's avatar
Eliot Berriot committed
252
        musicbrainz = factory.Trait(musicbrainz_id=factory.Faker("uuid4"))
253
254
255


class ReleaseMetadataFactory(factory.Factory):
Eliot Berriot's avatar
Eliot Berriot committed
256
    title = factory.Faker("sentence")
257
258
259
260
261

    class Meta:
        model = dict

    class Params:
Eliot Berriot's avatar
Eliot Berriot committed
262
        musicbrainz = factory.Trait(musicbrainz_id=factory.Faker("uuid4"))
263
264
265


class RecordingMetadataFactory(factory.Factory):
Eliot Berriot's avatar
Eliot Berriot committed
266
    title = factory.Faker("sentence")
267
268
269
270
271

    class Meta:
        model = dict

    class Params:
Eliot Berriot's avatar
Eliot Berriot committed
272
        musicbrainz = factory.Trait(musicbrainz_id=factory.Faker("uuid4"))
273
274


Eliot Berriot's avatar
Eliot Berriot committed
275
@registry.register(name="federation.LibraryTrackMetadata")
276
277
278
279
280
281
282
283
284
class LibraryTrackMetadataFactory(factory.Factory):
    artist = factory.SubFactory(ArtistMetadataFactory)
    recording = factory.SubFactory(RecordingMetadataFactory)
    release = factory.SubFactory(ReleaseMetadataFactory)

    class Meta:
        model = dict


Eliot Berriot's avatar
Eliot Berriot committed
285
@registry.register(name="federation.Note")
286
class NoteFactory(factory.Factory):
Eliot Berriot's avatar
Eliot Berriot committed
287
288
289
    type = "Note"
    id = factory.Faker("url")
    published = factory.LazyFunction(lambda: timezone.now().isoformat())
290
    inReplyTo = None
Eliot Berriot's avatar
Eliot Berriot committed
291
    content = factory.Faker("sentence")
292
293
294

    class Meta:
        model = dict
Eliot Berriot's avatar
Eliot Berriot committed
295
296


Eliot Berriot's avatar
Eliot Berriot committed
297
@registry.register(name="federation.AudioMetadata")
Eliot Berriot's avatar
Eliot Berriot committed
298
299
class AudioMetadataFactory(factory.Factory):
    recording = factory.LazyAttribute(
Eliot Berriot's avatar
Eliot Berriot committed
300
        lambda o: "https://musicbrainz.org/recording/{}".format(uuid.uuid4())
Eliot Berriot's avatar
Eliot Berriot committed
301
302
    )
    artist = factory.LazyAttribute(
Eliot Berriot's avatar
Eliot Berriot committed
303
        lambda o: "https://musicbrainz.org/artist/{}".format(uuid.uuid4())
Eliot Berriot's avatar
Eliot Berriot committed
304
305
    )
    release = factory.LazyAttribute(
Eliot Berriot's avatar
Eliot Berriot committed
306
        lambda o: "https://musicbrainz.org/release/{}".format(uuid.uuid4())
Eliot Berriot's avatar
Eliot Berriot committed
307
    )
308
309
310
    bitrate = 42
    length = 43
    size = 44
Eliot Berriot's avatar
Eliot Berriot committed
311
312
313
314
315

    class Meta:
        model = dict


Eliot Berriot's avatar
Eliot Berriot committed
316
@registry.register(name="federation.Audio")
Eliot Berriot's avatar
Eliot Berriot committed
317
class AudioFactory(factory.Factory):
Eliot Berriot's avatar
Eliot Berriot committed
318
    type = "Audio"
Eliot Berriot's avatar
Eliot Berriot committed
319
    id = factory.Faker("federation_url")
Eliot Berriot's avatar
Eliot Berriot committed
320
    published = factory.LazyFunction(lambda: timezone.now().isoformat())
Eliot Berriot's avatar
Eliot Berriot committed
321
    actor = factory.Faker("federation_url")
Eliot Berriot's avatar
Eliot Berriot committed
322
    url = factory.SubFactory(LinkFactory, audio=True)
323
    metadata = factory.SubFactory(LibraryTrackMetadataFactory)
Eliot Berriot's avatar
Eliot Berriot committed
324
325
326

    class Meta:
        model = dict