git.squeep.com Git - akkoma/blob - test/mix/tasks/pleroma/config_test.exs

   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 Mix.Tasks.Pleroma.ConfigTest do
   6   use Pleroma.DataCase
   7
   8   import Pleroma.Factory
   9
  10   alias Mix.Tasks.Pleroma.Config, as: MixTask
  11   alias Pleroma.ConfigDB
  12   alias Pleroma.Repo
  13
  14   setup_all do
  15     Mix.shell(Mix.Shell.Process)
  16
  17     on_exit(fn ->
  18       Mix.shell(Mix.Shell.IO)
  19       Application.delete_env(:pleroma, :first_setting)
  20       Application.delete_env(:pleroma, :second_setting)
  21     end)
  22
  23     :ok
  24   end
  25
  26   defp config_records do
  27     ConfigDB
  28     |> Repo.all()
  29     |> Enum.sort()
  30   end
  31
  32   defp insert_config_record(group, key, value) do
  33     insert(:config,
  34       group: group,
  35       key: key,
  36       value: value
  37     )
  38   end
  39
  40   test "error if file with custom settings doesn't exist" do
  41     MixTask.migrate_to_db("config/non_existent_config_file.exs")
  42
  43     msg =
  44       "To migrate settings, you must define custom settings in config/non_existent_config_file.exs."
  45
  46     assert_receive {:mix_shell, :info, [^msg]}, 15
  47   end
  48
  49   describe "migrate_to_db/1" do
  50     setup do
  51       clear_config(:configurable_from_database, true)
  52     end
  53
  54     @tag capture_log: true
  55     test "config migration refused when deprecated settings are found" do
  56       clear_config([:media_proxy, :whitelist], ["domain_without_scheme.com"])
  57       assert config_records() == []
  58
  59       MixTask.migrate_to_db("test/fixtures/config/temp.secret.exs")
  60
  61       assert_received {:mix_shell, :error, [message]}
  62
  63       assert message =~
  64                "Migration is not allowed until all deprecation warnings have been resolved."
  65     end
  66
  67     test "filtered settings are migrated to db" do
  68       assert config_records() == []
  69
  70       MixTask.migrate_to_db("test/fixtures/config/temp.secret.exs")
  71
  72       config1 = ConfigDB.get_by_params(%{group: ":pleroma", key: ":first_setting"})
  73       config2 = ConfigDB.get_by_params(%{group: ":pleroma", key: ":second_setting"})
  74       refute ConfigDB.get_by_params(%{group: ":pleroma", key: "Pleroma.Repo"})
  75       refute ConfigDB.get_by_params(%{group: ":postgrex", key: ":json_library"})
  76       refute ConfigDB.get_by_params(%{group: ":pleroma", key: ":database"})
  77
  78       assert config1.value == [key: "value", key2: [Repo]]
  79       assert config2.value == [key: "value2", key2: ["Activity"]]
  80     end
  81
  82     test "config table is truncated before migration" do
  83       insert_config_record(:pleroma, :first_setting, key: "value", key2: ["Activity"])
  84       assert length(config_records()) == 1
  85
  86       MixTask.migrate_to_db("test/fixtures/config/temp.secret.exs")
  87
  88       config = ConfigDB.get_by_params(%{group: ":pleroma", key: ":first_setting"})
  89       assert config.value == [key: "value", key2: [Repo]]
  90     end
  91   end
  92
  93   describe "with deletion of temp file" do
  94     setup do
  95       clear_config(:configurable_from_database, true)
  96       temp_file = "config/temp.exported_from_db.secret.exs"
  97
  98       on_exit(fn ->
  99         :ok = File.rm(temp_file)
 100       end)
 101
 102       {:ok, temp_file: temp_file}
 103     end
 104
 105     test "settings are migrated to file and deleted from db", %{temp_file: temp_file} do
 106       insert_config_record(:pleroma, :setting_first, key: "value", key2: ["Activity"])
 107       insert_config_record(:pleroma, :setting_second, key: "value2", key2: [Repo])
 108
 109       MixTask.run(["migrate_from_db", "--env", "temp", "-d"])
 110
 111       assert config_records() == []
 112
 113       file = File.read!(temp_file)
 114       assert file =~ "config :pleroma, :setting_first,"
 115       assert file =~ "config :pleroma, :setting_second,"
 116     end
 117
 118     test "load a settings with large values and pass to file", %{temp_file: temp_file} do
 119       insert(:config,
 120         key: :instance,
 121         value: [
 122           name: "Pleroma",
 123           email: "example@example.com",
 124           notify_email: "noreply@example.com",
 125           description: "A Pleroma instance, an alternative fediverse server",
 126           limit: 5_000,
 127           remote_limit: 100_000,
 128           upload_limit: 16_000_000,
 129           avatar_upload_limit: 2_000_000,
 130           background_upload_limit: 4_000_000,
 131           banner_upload_limit: 4_000_000,
 132           poll_limits: %{
 133             max_options: 20,
 134             max_option_chars: 200,
 135             min_expiration: 0,
 136             max_expiration: 365 * 24 * 60 * 60
 137           },
 138           registrations_open: true,
 139           federating: true,
 140           federation_incoming_replies_max_depth: 100,
 141           federation_reachability_timeout_days: 7,
 142           federation_publisher_modules: [Pleroma.Web.ActivityPub.Publisher],
 143           allow_relay: true,
 144           public: true,
 145           quarantined_instances: [],
 146           managed_config: true,
 147           static_dir: "instance/static/",
 148           allowed_post_formats: ["text/plain", "text/html", "text/markdown", "text/bbcode"],
 149           autofollowed_nicknames: [],
 150           max_pinned_statuses: 1,
 151           attachment_links: false,
 152           max_report_comment_size: 1000,
 153           safe_dm_mentions: false,
 154           healthcheck: false,
 155           remote_post_retention_days: 90,
 156           skip_thread_containment: true,
 157           limit_to_local_content: :unauthenticated,
 158           user_bio_length: 5000,
 159           user_name_length: 100,
 160           max_account_fields: 10,
 161           max_remote_account_fields: 20,
 162           account_field_name_length: 512,
 163           account_field_value_length: 2048,
 164           external_user_synchronization: true,
 165           extended_nickname_format: true,
 166           multi_factor_authentication: [
 167             totp: [
 168               digits: 6,
 169               period: 30
 170             ],
 171             backup_codes: [
 172               number: 2,
 173               length: 6
 174             ]
 175           ]
 176         ]
 177       )
 178
 179       MixTask.run(["migrate_from_db", "--env", "temp", "-d"])
 180
 181       assert config_records() == []
 182       assert File.exists?(temp_file)
 183       {:ok, file} = File.read(temp_file)
 184
 185       assert file ==
 186                "import Config\n\nconfig :pleroma, :instance,\n  name: \"Pleroma\",\n  email: \"example@example.com\",\n  notify_email: \"noreply@example.com\",\n  description: \"A Pleroma instance, an alternative fediverse server\",\n  limit: 5000,\n  remote_limit: 100_000,\n  upload_limit: 16_000_000,\n  avatar_upload_limit: 2_000_000,\n  background_upload_limit: 4_000_000,\n  banner_upload_limit: 4_000_000,\n  poll_limits: %{\n    max_expiration: 31_536_000,\n    max_option_chars: 200,\n    max_options: 20,\n    min_expiration: 0\n  },\n  registrations_open: true,\n  federating: true,\n  federation_incoming_replies_max_depth: 100,\n  federation_reachability_timeout_days: 7,\n  federation_publisher_modules: [Pleroma.Web.ActivityPub.Publisher],\n  allow_relay: true,\n  public: true,\n  quarantined_instances: [],\n  managed_config: true,\n  static_dir: \"instance/static/\",\n  allowed_post_formats: [\"text/plain\", \"text/html\", \"text/markdown\", \"text/bbcode\"],\n  autofollowed_nicknames: [],\n  max_pinned_statuses: 1,\n  attachment_links: false,\n  max_report_comment_size: 1000,\n  safe_dm_mentions: false,\n  healthcheck: false,\n  remote_post_retention_days: 90,\n  skip_thread_containment: true,\n  limit_to_local_content: :unauthenticated,\n  user_bio_length: 5000,\n  user_name_length: 100,\n  max_account_fields: 10,\n  max_remote_account_fields: 20,\n  account_field_name_length: 512,\n  account_field_value_length: 2048,\n  external_user_synchronization: true,\n  extended_nickname_format: true,\n  multi_factor_authentication: [\n    totp: [digits: 6, period: 30],\n    backup_codes: [number: 2, length: 6]\n  ]\n"
 187     end
 188   end
 189
 190   describe "migrate_from_db/1" do
 191     setup do: clear_config(:configurable_from_database, true)
 192
 193     setup do
 194       insert_config_record(:pleroma, :setting_first, key: "value", key2: ["Activity"])
 195       insert_config_record(:pleroma, :setting_second, key: "value2", key2: [Repo])
 196
 197       path = "test/instance_static"
 198       file_path = Path.join(path, "temp.exported_from_db.secret.exs")
 199
 200       on_exit(fn -> File.rm!(file_path) end)
 201
 202       [file_path: file_path]
 203     end
 204
 205     test "with path parameter", %{file_path: file_path} do
 206       MixTask.run(["migrate_from_db", "--env", "temp", "--path", Path.dirname(file_path)])
 207
 208       file = File.read!(file_path)
 209       assert file =~ "config :pleroma, :setting_first,"
 210       assert file =~ "config :pleroma, :setting_second,"
 211     end
 212
 213     test "release", %{file_path: file_path} do
 214       clear_config(:release, true)
 215       clear_config(:config_path, file_path)
 216
 217       MixTask.run(["migrate_from_db", "--env", "temp"])
 218
 219       file = File.read!(file_path)
 220       assert file =~ "config :pleroma, :setting_first,"
 221       assert file =~ "config :pleroma, :setting_second,"
 222     end
 223   end
 224
 225   describe "operations on database config" do
 226     setup do: clear_config(:configurable_from_database, true)
 227
 228     test "dumping a specific group" do
 229       insert_config_record(:pleroma, :instance, name: "Pleroma Test")
 230
 231       insert_config_record(:web_push_encryption, :vapid_details,
 232         subject: "mailto:administrator@example.com",
 233         public_key:
 234           "BOsPL-_KjNnjj_RMvLeR3dTOrcndi4TbMR0cu56gLGfGaT5m1gXxSfRHOcC4Dd78ycQL1gdhtx13qgKHmTM5xAI",
 235         private_key: "Ism6FNdS31nLCA94EfVbJbDdJXCxAZ8cZiB1JQPN_t4"
 236       )
 237
 238       MixTask.run(["dump", "pleroma"])
 239
 240       assert_receive {:mix_shell, :info,
 241                       ["config :pleroma, :instance, [name: \"Pleroma Test\"]\r\n\r\n"]}
 242
 243       refute_receive {
 244         :mix_shell,
 245         :info,
 246         [
 247           "config :web_push_encryption, :vapid_details, [subject: \"mailto:administrator@example.com\", public_key: \"BOsPL-_KjNnjj_RMvLeR3dTOrcndi4TbMR0cu56gLGfGaT5m1gXxSfRHOcC4Dd78ycQL1gdhtx13qgKHmTM5xAI\", private_key: \"Ism6FNdS31nLCA94EfVbJbDdJXCxAZ8cZiB1JQPN_t4\"]\r\n\r\n"
 248         ]
 249       }
 250
 251       # Ensure operations work when using atom syntax
 252       MixTask.run(["dump", ":pleroma"])
 253
 254       assert_receive {:mix_shell, :info,
 255                       ["config :pleroma, :instance, [name: \"Pleroma Test\"]\r\n\r\n"]}
 256     end
 257
 258     test "dumping a specific key in a group" do
 259       insert_config_record(:pleroma, :instance, name: "Pleroma Test")
 260       insert_config_record(:pleroma, Pleroma.Captcha, enabled: false)
 261
 262       MixTask.run(["dump", "pleroma", "Pleroma.Captcha"])
 263
 264       refute_receive {:mix_shell, :info,
 265                       ["config :pleroma, :instance, [name: \"Pleroma Test\"]\r\n\r\n"]}
 266
 267       assert_receive {:mix_shell, :info,
 268                       ["config :pleroma, Pleroma.Captcha, [enabled: false]\r\n\r\n"]}
 269     end
 270
 271     test "dumps all configuration successfully" do
 272       insert_config_record(:pleroma, :instance, name: "Pleroma Test")
 273       insert_config_record(:pleroma, Pleroma.Captcha, enabled: false)
 274
 275       MixTask.run(["dump"])
 276
 277       assert_receive {:mix_shell, :info,
 278                       ["config :pleroma, :instance, [name: \"Pleroma Test\"]\r\n\r\n"]}
 279
 280       assert_receive {:mix_shell, :info,
 281                       ["config :pleroma, Pleroma.Captcha, [enabled: false]\r\n\r\n"]}
 282     end
 283   end
 284
 285   describe "when configdb disabled" do
 286     test "refuses to dump" do
 287       clear_config(:configurable_from_database, false)
 288
 289       insert_config_record(:pleroma, :instance, name: "Pleroma Test")
 290
 291       MixTask.run(["dump"])
 292
 293       msg =
 294         "ConfigDB not enabled. Please check the value of :configurable_from_database in your configuration."
 295
 296       assert_receive {:mix_shell, :error, [^msg]}
 297     end
 298   end
 299
 300   describe "destructive operations" do
 301     setup do: clear_config(:configurable_from_database, true)
 302
 303     setup do
 304       insert_config_record(:pleroma, :instance, name: "Pleroma Test")
 305       insert_config_record(:pleroma, Pleroma.Captcha, enabled: false)
 306       insert_config_record(:pleroma2, :key2, z: 1)
 307
 308       assert length(config_records()) == 3
 309
 310       :ok
 311     end
 312
 313     test "deletes group of settings" do
 314       MixTask.run(["delete", "--force", "pleroma"])
 315
 316       assert [%ConfigDB{group: :pleroma2, key: :key2}] = config_records()
 317     end
 318
 319     test "deletes specified key" do
 320       MixTask.run(["delete", "--force", "pleroma", "Pleroma.Captcha"])
 321
 322       assert [
 323                %ConfigDB{group: :pleroma, key: :instance},
 324                %ConfigDB{group: :pleroma2, key: :key2}
 325              ] = config_records()
 326     end
 327
 328     test "resets entire config" do
 329       MixTask.run(["reset", "--force"])
 330
 331       assert config_records() == []
 332     end
 333   end
 334 end