git.squeep.com Git - akkoma/blob - test/support/factory.ex

   1 # Pleroma: A lightweight social networking server
   2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
   3 # SPDX-License-Identifier: AGPL-3.0-only
   4
   5 defmodule Pleroma.Factory do
   6   use ExMachina.Ecto, repo: Pleroma.Repo
   7
   8   require Pleroma.Constants
   9
  10   alias Pleroma.Object
  11   alias Pleroma.User
  12
  13   def participation_factory do
  14     conversation = insert(:conversation)
  15     user = insert(:user)
  16
  17     %Pleroma.Conversation.Participation{
  18       conversation: conversation,
  19       user: user,
  20       read: false
  21     }
  22   end
  23
  24   def conversation_factory do
  25     %Pleroma.Conversation{
  26       ap_id: sequence(:ap_id, &"https://some_conversation/#{&1}")
  27     }
  28   end
  29
  30   def user_factory(attrs \\ %{}) do
  31     user = %User{
  32       name: sequence(:name, &"Test テスト User #{&1}"),
  33       email: sequence(:email, &"user#{&1}@example.com"),
  34       nickname: sequence(:nickname, &"nick#{&1}"),
  35       password_hash: Pleroma.Password.Pbkdf2.hash_pwd_salt("test"),
  36       bio: sequence(:bio, &"Tester Number #{&1}"),
  37       is_discoverable: true,
  38       last_digest_emailed_at: NaiveDateTime.utc_now(),
  39       last_refreshed_at: NaiveDateTime.utc_now(),
  40       notification_settings: %Pleroma.User.NotificationSetting{},
  41       multi_factor_authentication_settings: %Pleroma.MFA.Settings{},
  42       ap_enabled: true
  43     }
  44
  45     urls =
  46       if attrs[:local] == false do
  47         base_domain = attrs[:domain] || Enum.random(["domain1.com", "domain2.com", "domain3.com"])
  48
  49         ap_id = "https://#{base_domain}/users/#{user.nickname}"
  50
  51         %{
  52           ap_id: ap_id,
  53           follower_address: ap_id <> "/followers",
  54           following_address: ap_id <> "/following",
  55           featured_address: ap_id <> "/collections/featured"
  56         }
  57       else
  58         %{
  59           ap_id: User.ap_id(user),
  60           follower_address: User.ap_followers(user),
  61           following_address: User.ap_following(user),
  62           featured_address: User.ap_featured_collection(user)
  63         }
  64       end
  65
  66     attrs = Map.delete(attrs, :domain)
  67
  68     user
  69     |> Map.put(:raw_bio, user.bio)
  70     |> Map.merge(urls)
  71     |> merge_attributes(attrs)
  72   end
  73
  74   def user_relationship_factory(attrs \\ %{}) do
  75     source = attrs[:source] || insert(:user)
  76     target = attrs[:target] || insert(:user)
  77     relationship_type = attrs[:relationship_type] || :block
  78
  79     %Pleroma.UserRelationship{
  80       source_id: source.id,
  81       target_id: target.id,
  82       relationship_type: relationship_type
  83     }
  84   end
  85
  86   def note_factory(attrs \\ %{}) do
  87     text = sequence(:text, &"This is :moominmamma: note #{&1}")
  88
  89     user = attrs[:user] || insert(:user)
  90
  91     data = %{
  92       "type" => "Note",
  93       "content" => text,
  94       "source" => text,
  95       "id" => Pleroma.Web.ActivityPub.Utils.generate_object_id(),
  96       "actor" => user.ap_id,
  97       "to" => ["https://www.w3.org/ns/activitystreams#Public"],
  98       "published" => DateTime.utc_now() |> DateTime.to_iso8601(),
  99       "likes" => [],
 100       "like_count" => 0,
 101       "context" => "2hu",
 102       "summary" => "2hu",
 103       "tag" => ["2hu"],
 104       "emoji" => %{
 105         "2hu" => "corndog.png"
 106       }
 107     }
 108
 109     %Pleroma.Object{
 110       data: merge_attributes(data, Map.get(attrs, :data, %{}))
 111     }
 112   end
 113
 114   def attachment_note_factory(attrs \\ %{}) do
 115     user = attrs[:user] || insert(:user)
 116     {length, attrs} = Map.pop(attrs, :length, 1)
 117
 118     data = %{
 119       "attachment" =>
 120         Stream.repeatedly(fn -> attachment_data(user.ap_id, attrs[:href]) end)
 121         |> Enum.take(length)
 122     }
 123
 124     build(:note, Map.put(attrs, :data, data))
 125   end
 126
 127   defp attachment_data(ap_id, href) do
 128     href = href || sequence(:href, &"#{Pleroma.Web.Endpoint.url()}/media/#{&1}.jpg")
 129
 130     %{
 131       "url" => [
 132         %{
 133           "href" => href,
 134           "type" => "Link",
 135           "mediaType" => "image/jpeg"
 136         }
 137       ],
 138       "name" => "some name",
 139       "type" => "Document",
 140       "actor" => ap_id,
 141       "mediaType" => "image/jpeg"
 142     }
 143   end
 144
 145   def followers_only_note_factory(attrs \\ %{}) do
 146     %Pleroma.Object{data: data} = note_factory(attrs)
 147     %Pleroma.Object{data: Map.merge(data, %{"to" => [data["actor"] <> "/followers"]})}
 148   end
 149
 150   def audio_factory(attrs \\ %{}) do
 151     text = sequence(:text, &"lain radio episode #{&1}")
 152
 153     user = attrs[:user] || insert(:user)
 154
 155     data = %{
 156       "type" => "Audio",
 157       "id" => Pleroma.Web.ActivityPub.Utils.generate_object_id(),
 158       "artist" => "lain",
 159       "title" => text,
 160       "album" => "lain radio",
 161       "to" => ["https://www.w3.org/ns/activitystreams#Public"],
 162       "published" => DateTime.utc_now() |> DateTime.to_iso8601(),
 163       "actor" => user.ap_id,
 164       "length" => 180_000
 165     }
 166
 167     %Pleroma.Object{
 168       data: merge_attributes(data, Map.get(attrs, :data, %{}))
 169     }
 170   end
 171
 172   def listen_factory do
 173     audio = insert(:audio)
 174
 175     data = %{
 176       "id" => Pleroma.Web.ActivityPub.Utils.generate_activity_id(),
 177       "type" => "Listen",
 178       "actor" => audio.data["actor"],
 179       "to" => audio.data["to"],
 180       "object" => audio.data,
 181       "published" => audio.data["published"]
 182     }
 183
 184     %Pleroma.Activity{
 185       data: data,
 186       actor: data["actor"],
 187       recipients: data["to"]
 188     }
 189   end
 190
 191   def direct_note_factory do
 192     user2 = insert(:user)
 193
 194     %Pleroma.Object{data: data} = note_factory()
 195     %Pleroma.Object{data: Map.merge(data, %{"to" => [user2.ap_id]})}
 196   end
 197
 198   def article_factory do
 199     %Pleroma.Object{data: data} = note_factory()
 200     %Pleroma.Object{data: Map.merge(data, %{"type" => "Article"})}
 201   end
 202
 203   def tombstone_factory do
 204     data = %{
 205       "type" => "Tombstone",
 206       "id" => Pleroma.Web.ActivityPub.Utils.generate_object_id(),
 207       "formerType" => "Note",
 208       "deleted" => DateTime.utc_now() |> DateTime.to_iso8601()
 209     }
 210
 211     %Pleroma.Object{
 212       data: data
 213     }
 214   end
 215
 216   def direct_note_activity_factory do
 217     dm = insert(:direct_note)
 218
 219     data = %{
 220       "id" => Pleroma.Web.ActivityPub.Utils.generate_activity_id(),
 221       "type" => "Create",
 222       "actor" => dm.data["actor"],
 223       "to" => dm.data["to"],
 224       "object" => dm.data,
 225       "published" => DateTime.utc_now() |> DateTime.to_iso8601(),
 226       "context" => dm.data["context"]
 227     }
 228
 229     %Pleroma.Activity{
 230       data: data,
 231       actor: data["actor"],
 232       recipients: data["to"]
 233     }
 234   end
 235
 236   def add_activity_factory(attrs \\ %{}) do
 237     featured_collection_activity(attrs, "Add")
 238   end
 239
 240   def remove_activity_factor(attrs \\ %{}) do
 241     featured_collection_activity(attrs, "Remove")
 242   end
 243
 244   defp featured_collection_activity(attrs, type) do
 245     user = attrs[:user] || insert(:user)
 246     note = attrs[:note] || insert(:note, user: user)
 247
 248     data_attrs =
 249       attrs
 250       |> Map.get(:data_attrs, %{})
 251       |> Map.put(:type, type)
 252
 253     attrs = Map.drop(attrs, [:user, :note, :data_attrs])
 254
 255     data =
 256       %{
 257         "id" => Pleroma.Web.ActivityPub.Utils.generate_activity_id(),
 258         "target" => user.featured_address,
 259         "object" => note.data["object"],
 260         "actor" => note.data["actor"],
 261         "type" => "Add",
 262         "to" => [Pleroma.Constants.as_public()],
 263         "cc" => [user.follower_address]
 264       }
 265       |> Map.merge(data_attrs)
 266
 267     %Pleroma.Activity{
 268       data: data,
 269       actor: data["actor"],
 270       recipients: data["to"]
 271     }
 272     |> Map.merge(attrs)
 273   end
 274
 275   def followers_only_note_activity_factory(attrs \\ %{}) do
 276     user = attrs[:user] || insert(:user)
 277     note = insert(:followers_only_note, user: user)
 278
 279     data_attrs = attrs[:data_attrs] || %{}
 280     attrs = Map.drop(attrs, [:user, :note, :data_attrs])
 281
 282     data =
 283       %{
 284         "id" => Pleroma.Web.ActivityPub.Utils.generate_activity_id(),
 285         "type" => "Create",
 286         "actor" => note.data["actor"],
 287         "to" => note.data["to"],
 288         "object" => note.data,
 289         "published" => DateTime.utc_now() |> DateTime.to_iso8601(),
 290         "context" => note.data["context"]
 291       }
 292       |> Map.merge(data_attrs)
 293
 294     %Pleroma.Activity{
 295       data: data,
 296       actor: data["actor"],
 297       recipients: data["to"]
 298     }
 299     |> Map.merge(attrs)
 300   end
 301
 302   def note_activity_factory(attrs \\ %{}) do
 303     user = attrs[:user] || insert(:user)
 304     note = attrs[:note] || insert(:note, user: user)
 305
 306     data_attrs = attrs[:data_attrs] || %{}
 307     attrs = Map.drop(attrs, [:user, :note, :data_attrs])
 308
 309     data =
 310       %{
 311         "id" => Pleroma.Web.ActivityPub.Utils.generate_activity_id(),
 312         "type" => "Create",
 313         "actor" => note.data["actor"],
 314         "to" => note.data["to"],
 315         "object" => note.data["id"],
 316         "published" => DateTime.utc_now() |> DateTime.to_iso8601(),
 317         "context" => note.data["context"]
 318       }
 319       |> Map.merge(data_attrs)
 320
 321     %Pleroma.Activity{
 322       data: data,
 323       actor: data["actor"],
 324       recipients: data["to"]
 325     }
 326     |> Map.merge(attrs)
 327   end
 328
 329   def article_activity_factory do
 330     article = insert(:article)
 331
 332     data = %{
 333       "id" => Pleroma.Web.ActivityPub.Utils.generate_activity_id(),
 334       "type" => "Create",
 335       "actor" => article.data["actor"],
 336       "to" => article.data["to"],
 337       "object" => article.data,
 338       "published" => DateTime.utc_now() |> DateTime.to_iso8601(),
 339       "context" => article.data["context"]
 340     }
 341
 342     %Pleroma.Activity{
 343       data: data,
 344       actor: data["actor"],
 345       recipients: data["to"]
 346     }
 347   end
 348
 349   def announce_activity_factory(attrs \\ %{}) do
 350     note_activity = attrs[:note_activity] || insert(:note_activity)
 351     user = attrs[:user] || insert(:user)
 352
 353     data = %{
 354       "type" => "Announce",
 355       "actor" => note_activity.actor,
 356       "object" => note_activity.data["id"],
 357       "to" => [user.follower_address, note_activity.data["actor"]],
 358       "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
 359       "context" => note_activity.data["context"]
 360     }
 361
 362     %Pleroma.Activity{
 363       data: data,
 364       actor: user.ap_id,
 365       recipients: data["to"]
 366     }
 367   end
 368
 369   def like_activity_factory(attrs \\ %{}) do
 370     note_activity = attrs[:note_activity] || insert(:note_activity)
 371     object = Object.normalize(note_activity, fetch: false)
 372     user = insert(:user)
 373
 374     data =
 375       %{
 376         "id" => Pleroma.Web.ActivityPub.Utils.generate_activity_id(),
 377         "actor" => user.ap_id,
 378         "type" => "Like",
 379         "object" => object.data["id"],
 380         "published_at" => DateTime.utc_now() |> DateTime.to_iso8601()
 381       }
 382       |> Map.merge(attrs[:data_attrs] || %{})
 383
 384     %Pleroma.Activity{
 385       data: data
 386     }
 387   end
 388
 389   def follow_activity_factory do
 390     follower = insert(:user)
 391     followed = insert(:user)
 392
 393     data = %{
 394       "id" => Pleroma.Web.ActivityPub.Utils.generate_activity_id(),
 395       "actor" => follower.ap_id,
 396       "type" => "Follow",
 397       "object" => followed.ap_id,
 398       "published_at" => DateTime.utc_now() |> DateTime.to_iso8601()
 399     }
 400
 401     %Pleroma.Activity{
 402       data: data,
 403       actor: follower.ap_id
 404     }
 405   end
 406
 407   def report_activity_factory(attrs \\ %{}) do
 408     user = attrs[:user] || insert(:user)
 409     activity = attrs[:activity] || insert(:note_activity)
 410     state = attrs[:state] || "open"
 411
 412     data = %{
 413       "id" => Pleroma.Web.ActivityPub.Utils.generate_activity_id(),
 414       "actor" => user.ap_id,
 415       "type" => "Flag",
 416       "object" => [activity.actor, activity.data["id"]],
 417       "published" => DateTime.utc_now() |> DateTime.to_iso8601(),
 418       "to" => [],
 419       "cc" => [activity.actor],
 420       "context" => activity.data["context"],
 421       "state" => state
 422     }
 423
 424     %Pleroma.Activity{
 425       data: data,
 426       actor: data["actor"],
 427       recipients: data["to"] ++ data["cc"]
 428     }
 429   end
 430
 431   def oauth_app_factory do
 432     %Pleroma.Web.OAuth.App{
 433       client_name: sequence(:client_name, &"Some client #{&1}"),
 434       redirect_uris: "https://example.com/callback",
 435       scopes: ["read", "write", "follow", "push", "admin"],
 436       website: "https://example.com",
 437       client_id: Ecto.UUID.generate(),
 438       client_secret: "aaa;/&bbb"
 439     }
 440   end
 441
 442   def instance_factory do
 443     %Pleroma.Instances.Instance{
 444       host: "domain.com",
 445       unreachable_since: nil
 446     }
 447   end
 448
 449   def oauth_token_factory(attrs \\ %{}) do
 450     scopes = Map.get(attrs, :scopes, ["read"])
 451     oauth_app = Map.get_lazy(attrs, :app, fn -> insert(:oauth_app, scopes: scopes) end)
 452     user = Map.get_lazy(attrs, :user, fn -> build(:user) end)
 453
 454     valid_until =
 455       Map.get(attrs, :valid_until, NaiveDateTime.add(NaiveDateTime.utc_now(), 60 * 10))
 456
 457     %Pleroma.Web.OAuth.Token{
 458       token: :crypto.strong_rand_bytes(32) |> Base.url_encode64(),
 459       refresh_token: :crypto.strong_rand_bytes(32) |> Base.url_encode64(),
 460       scopes: scopes,
 461       user: user,
 462       app: oauth_app,
 463       valid_until: valid_until
 464     }
 465   end
 466
 467   def oauth_admin_token_factory(attrs \\ %{}) do
 468     user = Map.get_lazy(attrs, :user, fn -> build(:user, is_admin: true) end)
 469
 470     scopes =
 471       attrs
 472       |> Map.get(:scopes, ["admin"])
 473       |> Kernel.++(["admin"])
 474       |> Enum.uniq()
 475
 476     attrs = Map.merge(attrs, %{user: user, scopes: scopes})
 477     oauth_token_factory(attrs)
 478   end
 479
 480   def oauth_authorization_factory do
 481     %Pleroma.Web.OAuth.Authorization{
 482       token: :crypto.strong_rand_bytes(32) |> Base.url_encode64(padding: false),
 483       scopes: ["read", "write", "follow", "push"],
 484       valid_until: NaiveDateTime.add(NaiveDateTime.utc_now(), 60 * 10),
 485       user: build(:user),
 486       app: build(:oauth_app)
 487     }
 488   end
 489
 490   def push_subscription_factory do
 491     %Pleroma.Web.Push.Subscription{
 492       user: build(:user),
 493       token: build(:oauth_token),
 494       endpoint: "https://example.com/example/1234",
 495       key_auth: "8eDyX_uCN0XRhSbY5hs7Hg==",
 496       key_p256dh:
 497         "BCIWgsnyXDv1VkhqL2P7YRBvdeuDnlwAPT2guNhdIoW3IP7GmHh1SMKPLxRf7x8vJy6ZFK3ol2ohgn_-0yP7QQA=",
 498       data: %{}
 499     }
 500   end
 501
 502   def notification_factory do
 503     %Pleroma.Notification{
 504       user: build(:user)
 505     }
 506   end
 507
 508   def scheduled_activity_factory do
 509     %Pleroma.ScheduledActivity{
 510       user: build(:user),
 511       scheduled_at: NaiveDateTime.add(NaiveDateTime.utc_now(), :timer.minutes(60), :millisecond),
 512       params: build(:note) |> Map.from_struct() |> Map.get(:data)
 513     }
 514   end
 515
 516   def registration_factory do
 517     user = insert(:user)
 518
 519     %Pleroma.Registration{
 520       user: user,
 521       provider: "twitter",
 522       uid: "171799000",
 523       info: %{
 524         "name" => "John Doe",
 525         "email" => "john@doe.com",
 526         "nickname" => "johndoe",
 527         "description" => "My bio"
 528       }
 529     }
 530   end
 531
 532   def config_factory(attrs \\ %{}) do
 533     %Pleroma.ConfigDB{
 534       key: sequence(:key, &String.to_atom("some_key_#{&1}")),
 535       group: :pleroma,
 536       value:
 537         sequence(
 538           :value,
 539           &%{another_key: "#{&1}somevalue", another: "#{&1}somevalue"}
 540         )
 541     }
 542     |> merge_attributes(attrs)
 543   end
 544
 545   def marker_factory do
 546     %Pleroma.Marker{
 547       user: build(:user),
 548       timeline: "notifications",
 549       lock_version: 0,
 550       last_read_id: "1"
 551     }
 552   end
 553
 554   def mfa_token_factory do
 555     %Pleroma.MFA.Token{
 556       token: :crypto.strong_rand_bytes(32) |> Base.url_encode64(padding: false),
 557       authorization: build(:oauth_authorization),
 558       valid_until: NaiveDateTime.add(NaiveDateTime.utc_now(), 60 * 10),
 559       user: build(:user)
 560     }
 561   end
 562
 563   def filter_factory do
 564     %Pleroma.Filter{
 565       user: build(:user),
 566       filter_id: sequence(:filter_id, & &1),
 567       phrase: "cofe",
 568       context: ["home"]
 569     }
 570   end
 571 end