Use a callback strategy to short circuit the functions and print a nice error
This commit is contained in:
Mark Felder
parent
a7b5280b5b
commit
13947999ad
|
|
@ -14,149 +14,158 @@ defmodule Mix.Tasks.Pleroma.Config do
|
||||||
@moduledoc File.read!("docs/administration/CLI_tasks/config.md")
|
@moduledoc File.read!("docs/administration/CLI_tasks/config.md")
|
||||||
|
|
||||||
def run(["migrate_to_db"]) do
|
def run(["migrate_to_db"]) do
|
||||||
check_configdb()
|
check_configdb(fn ->
|
||||||
start_pleroma()
|
start_pleroma()
|
||||||
migrate_to_db()
|
migrate_to_db()
|
||||||
|
end)
|
||||||
end
|
end
|
||||||
|
|
||||||
def run(["migrate_from_db" | options]) do
|
def run(["migrate_from_db" | options]) do
|
||||||
check_configdb()
|
check_configdb(fn ->
|
||||||
start_pleroma()
|
start_pleroma()
|
||||||
|
|
||||||
{opts, _} =
|
{opts, _} =
|
||||||
OptionParser.parse!(options,
|
OptionParser.parse!(options,
|
||||||
strict: [env: :string, delete: :boolean],
|
strict: [env: :string, delete: :boolean],
|
||||||
aliases: [d: :delete]
|
aliases: [d: :delete]
|
||||||
)
|
)
|
||||||
|
|
||||||
migrate_from_db(opts)
|
migrate_from_db(opts)
|
||||||
|
end)
|
||||||
end
|
end
|
||||||
|
|
||||||
def run(["dump"]) do
|
def run(["dump"]) do
|
||||||
check_configdb()
|
check_configdb(fn ->
|
||||||
start_pleroma()
|
start_pleroma()
|
||||||
|
|
||||||
header = config_header()
|
header = config_header()
|
||||||
|
|
||||||
settings =
|
settings =
|
||||||
ConfigDB
|
ConfigDB
|
||||||
|> Repo.all()
|
|> Repo.all()
|
||||||
|> Enum.sort()
|
|> Enum.sort()
|
||||||
|
|
||||||
unless settings == [] do
|
unless settings == [] do
|
||||||
shell_info("#{header}")
|
shell_info("#{header}")
|
||||||
|
|
||||||
settings |> Enum.each(&dump(&1))
|
settings |> Enum.each(&dump(&1))
|
||||||
else
|
else
|
||||||
shell_error("No settings in ConfigDB.")
|
shell_error("No settings in ConfigDB.")
|
||||||
end
|
end
|
||||||
|
end)
|
||||||
end
|
end
|
||||||
|
|
||||||
def run(["dump", group, key]) do
|
def run(["dump", group, key]) do
|
||||||
check_configdb()
|
check_configdb(fn ->
|
||||||
start_pleroma()
|
start_pleroma()
|
||||||
|
|
||||||
group = maybe_atomize(group)
|
group = maybe_atomize(group)
|
||||||
key = maybe_atomize(key)
|
key = maybe_atomize(key)
|
||||||
|
|
||||||
dump_key(group, key)
|
dump_key(group, key)
|
||||||
|
end)
|
||||||
end
|
end
|
||||||
|
|
||||||
def run(["dump", group]) do
|
def run(["dump", group]) do
|
||||||
check_configdb()
|
check_configdb(fn ->
|
||||||
start_pleroma()
|
start_pleroma()
|
||||||
|
|
||||||
group = maybe_atomize(group)
|
group = maybe_atomize(group)
|
||||||
|
|
||||||
dump_group(group)
|
dump_group(group)
|
||||||
|
end)
|
||||||
end
|
end
|
||||||
|
|
||||||
def run(["groups"]) do
|
def run(["groups"]) do
|
||||||
check_configdb()
|
check_configdb(fn ->
|
||||||
start_pleroma()
|
start_pleroma()
|
||||||
|
|
||||||
groups =
|
groups =
|
||||||
ConfigDB
|
ConfigDB
|
||||||
|> Repo.all()
|
|> Repo.all()
|
||||||
|> Enum.map(fn x -> x.group end)
|
|> Enum.map(fn x -> x.group end)
|
||||||
|> Enum.sort()
|
|> Enum.sort()
|
||||||
|> Enum.uniq()
|
|> Enum.uniq()
|
||||||
|
|
||||||
if length(groups) > 0 do
|
if length(groups) > 0 do
|
||||||
shell_info("The following configuration groups are set in ConfigDB:\r\n")
|
shell_info("The following configuration groups are set in ConfigDB:\r\n")
|
||||||
groups |> Enum.each(fn x -> shell_info("- #{x}") end)
|
groups |> Enum.each(fn x -> shell_info("- #{x}") end)
|
||||||
shell_info("\r\n")
|
shell_info("\r\n")
|
||||||
end
|
end
|
||||||
|
end)
|
||||||
end
|
end
|
||||||
|
|
||||||
def run(["reset"]) do
|
def run(["reset"]) do
|
||||||
check_configdb()
|
check_configdb(fn ->
|
||||||
start_pleroma()
|
start_pleroma()
|
||||||
|
|
||||||
shell_info("The following settings will be permanently removed:")
|
shell_info("The following settings will be permanently removed:")
|
||||||
|
|
||||||
ConfigDB
|
ConfigDB
|
||||||
|> Repo.all()
|
|> Repo.all()
|
||||||
|> Enum.sort()
|
|> Enum.sort()
|
||||||
|> Enum.each(&dump(&1))
|
|> Enum.each(&dump(&1))
|
||||||
|
|
||||||
shell_error("\nTHIS CANNOT BE UNDONE!")
|
shell_error("\nTHIS CANNOT BE UNDONE!")
|
||||||
|
|
||||||
if shell_prompt("Are you sure you want to continue?", "n") in ~w(Yn Y y) do
|
if shell_prompt("Are you sure you want to continue?", "n") in ~w(Yn Y y) do
|
||||||
Ecto.Adapters.SQL.query!(Repo, "TRUNCATE config;")
|
Ecto.Adapters.SQL.query!(Repo, "TRUNCATE config;")
|
||||||
Ecto.Adapters.SQL.query!(Repo, "ALTER SEQUENCE config_id_seq RESTART;")
|
Ecto.Adapters.SQL.query!(Repo, "ALTER SEQUENCE config_id_seq RESTART;")
|
||||||
|
|
||||||
shell_info("The ConfigDB settings have been removed from the database.")
|
shell_info("The ConfigDB settings have been removed from the database.")
|
||||||
else
|
else
|
||||||
shell_error("No changes made.")
|
shell_error("No changes made.")
|
||||||
end
|
end
|
||||||
|
end)
|
||||||
end
|
end
|
||||||
|
|
||||||
def run(["delete", group]) do
|
def run(["delete", group]) do
|
||||||
check_configdb()
|
check_configdb(fn ->
|
||||||
start_pleroma()
|
start_pleroma()
|
||||||
|
|
||||||
group = maybe_atomize(group)
|
group = maybe_atomize(group)
|
||||||
|
|
||||||
if group_exists?(group) do
|
if group_exists?(group) do
|
||||||
shell_info("The following settings will be removed from ConfigDB:\n")
|
shell_info("The following settings will be removed from ConfigDB:\n")
|
||||||
|
|
||||||
dump_group(group)
|
dump_group(group)
|
||||||
|
|
||||||
|
if shell_prompt("Are you sure you want to continue?", "n") in ~w(Yn Y y) do
|
||||||
|
ConfigDB
|
||||||
|
|> Repo.all()
|
||||||
|
|> Enum.filter(fn x ->
|
||||||
|
if x.group == group do
|
||||||
|
x |> delete(true)
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
else
|
||||||
|
shell_error("No changes made.")
|
||||||
|
end
|
||||||
|
else
|
||||||
|
shell_error("No settings in ConfigDB for #{inspect(group)}. Aborting.")
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
|
def run(["delete", group, key]) do
|
||||||
|
check_configdb(fn ->
|
||||||
|
start_pleroma()
|
||||||
|
|
||||||
|
group = maybe_atomize(group)
|
||||||
|
key = maybe_atomize(key)
|
||||||
|
|
||||||
if shell_prompt("Are you sure you want to continue?", "n") in ~w(Yn Y y) do
|
if shell_prompt("Are you sure you want to continue?", "n") in ~w(Yn Y y) do
|
||||||
ConfigDB
|
ConfigDB
|
||||||
|> Repo.all()
|
|> Repo.all()
|
||||||
|> Enum.filter(fn x ->
|
|> Enum.filter(fn x ->
|
||||||
if x.group == group do
|
if x.group == group and x.key == key do
|
||||||
x |> delete(true)
|
x |> delete(true)
|
||||||
end
|
end
|
||||||
end)
|
end)
|
||||||
else
|
else
|
||||||
shell_error("No changes made.")
|
shell_error("No changes made.")
|
||||||
end
|
end
|
||||||
else
|
end)
|
||||||
shell_error("No settings in ConfigDB for #{inspect(group)}. Aborting.")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def run(["delete", group, key]) do
|
|
||||||
check_configdb()
|
|
||||||
start_pleroma()
|
|
||||||
|
|
||||||
group = maybe_atomize(group)
|
|
||||||
key = maybe_atomize(key)
|
|
||||||
|
|
||||||
if shell_prompt("Are you sure you want to continue?", "n") in ~w(Yn Y y) do
|
|
||||||
ConfigDB
|
|
||||||
|> Repo.all()
|
|
||||||
|> Enum.filter(fn x ->
|
|
||||||
if x.group == group and x.key == key do
|
|
||||||
x |> delete(true)
|
|
||||||
end
|
|
||||||
end)
|
|
||||||
else
|
|
||||||
shell_error("No changes made.")
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
@spec migrate_to_db(Path.t() | nil) :: any()
|
@spec migrate_to_db(Path.t() | nil) :: any()
|
||||||
|
|
@ -282,7 +291,7 @@ defmodule Mix.Tasks.Pleroma.Config do
|
||||||
end
|
end
|
||||||
|
|
||||||
defp configdb_not_enabled do
|
defp configdb_not_enabled do
|
||||||
raise(
|
shell_error(
|
||||||
"ConfigDB not enabled. Please check the value of :configurable_from_database in your configuration."
|
"ConfigDB not enabled. Please check the value of :configurable_from_database in your configuration."
|
||||||
)
|
)
|
||||||
end
|
end
|
||||||
|
|
@ -336,9 +345,9 @@ defmodule Mix.Tasks.Pleroma.Config do
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp check_configdb() do
|
defp check_configdb(callback) do
|
||||||
with true <- Pleroma.Config.get([:configurable_from_database]) do
|
with true <- Pleroma.Config.get([:configurable_from_database]) do
|
||||||
:ok
|
callback.()
|
||||||
else
|
else
|
||||||
_ -> configdb_not_enabled()
|
_ -> configdb_not_enabled()
|
||||||
end
|
end
|
||||||
|
|
|
||||||
|
|
@ -22,8 +22,6 @@ defmodule Mix.Tasks.Pleroma.ConfigTest do
|
||||||
:ok
|
:ok
|
||||||
end
|
end
|
||||||
|
|
||||||
setup_all do: clear_config(:configurable_from_database, true)
|
|
||||||
|
|
||||||
test "error if file with custom settings doesn't exist" do
|
test "error if file with custom settings doesn't exist" do
|
||||||
Mix.Tasks.Pleroma.Config.migrate_to_db("config/not_existance_config_file.exs")
|
Mix.Tasks.Pleroma.Config.migrate_to_db("config/not_existance_config_file.exs")
|
||||||
|
|
||||||
|
|
@ -36,6 +34,7 @@ defmodule Mix.Tasks.Pleroma.ConfigTest do
|
||||||
|
|
||||||
describe "migrate_to_db/1" do
|
describe "migrate_to_db/1" do
|
||||||
setup do
|
setup do
|
||||||
|
clear_config(:configurable_from_database, true)
|
||||||
initial = Application.get_env(:quack, :level)
|
initial = Application.get_env(:quack, :level)
|
||||||
on_exit(fn -> Application.put_env(:quack, :level, initial) end)
|
on_exit(fn -> Application.put_env(:quack, :level, initial) end)
|
||||||
end
|
end
|
||||||
|
|
@ -83,6 +82,7 @@ defmodule Mix.Tasks.Pleroma.ConfigTest do
|
||||||
|
|
||||||
describe "with deletion temp file" do
|
describe "with deletion temp file" do
|
||||||
setup do
|
setup do
|
||||||
|
clear_config(:configurable_from_database, true)
|
||||||
temp_file = "config/temp.exported_from_db.secret.exs"
|
temp_file = "config/temp.exported_from_db.secret.exs"
|
||||||
|
|
||||||
on_exit(fn ->
|
on_exit(fn ->
|
||||||
|
|
@ -187,89 +187,114 @@ defmodule Mix.Tasks.Pleroma.ConfigTest do
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
test "dumping a specific group" do
|
describe "operations on database config" do
|
||||||
insert(:config,
|
setup do: clear_config(:configurable_from_database, true)
|
||||||
group: :pleroma,
|
|
||||||
key: :instance,
|
|
||||||
value: [
|
|
||||||
name: "Pleroma Test"
|
|
||||||
]
|
|
||||||
)
|
|
||||||
|
|
||||||
insert(:config,
|
test "dumping a specific group" do
|
||||||
group: :web_push_encryption,
|
insert(:config,
|
||||||
key: :vapid_details,
|
group: :pleroma,
|
||||||
value: [
|
key: :instance,
|
||||||
subject: "mailto:administrator@example.com",
|
value: [
|
||||||
public_key:
|
name: "Pleroma Test"
|
||||||
"BOsPL-_KjNnjj_RMvLeR3dTOrcndi4TbMR0cu56gLGfGaT5m1gXxSfRHOcC4Dd78ycQL1gdhtx13qgKHmTM5xAI",
|
]
|
||||||
private_key: "Ism6FNdS31nLCA94EfVbJbDdJXCxAZ8cZiB1JQPN_t4"
|
)
|
||||||
]
|
|
||||||
)
|
|
||||||
|
|
||||||
Mix.Tasks.Pleroma.Config.run(["dump", "pleroma"])
|
insert(:config,
|
||||||
|
group: :web_push_encryption,
|
||||||
|
key: :vapid_details,
|
||||||
|
value: [
|
||||||
|
subject: "mailto:administrator@example.com",
|
||||||
|
public_key:
|
||||||
|
"BOsPL-_KjNnjj_RMvLeR3dTOrcndi4TbMR0cu56gLGfGaT5m1gXxSfRHOcC4Dd78ycQL1gdhtx13qgKHmTM5xAI",
|
||||||
|
private_key: "Ism6FNdS31nLCA94EfVbJbDdJXCxAZ8cZiB1JQPN_t4"
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
assert_receive {:mix_shell, :info,
|
Mix.Tasks.Pleroma.Config.run(["dump", "pleroma"])
|
||||||
["config :pleroma, :instance, [name: \"Pleroma Test\"]\r\n\r\n"]}
|
|
||||||
|
|
||||||
refute_receive {
|
assert_receive {:mix_shell, :info,
|
||||||
:mix_shell,
|
["config :pleroma, :instance, [name: \"Pleroma Test\"]\r\n\r\n"]}
|
||||||
:info,
|
|
||||||
[
|
refute_receive {
|
||||||
"config :web_push_encryption, :vapid_details, [subject: \"mailto:administrator@example.com\", public_key: \"BOsPL-_KjNnjj_RMvLeR3dTOrcndi4TbMR0cu56gLGfGaT5m1gXxSfRHOcC4Dd78ycQL1gdhtx13qgKHmTM5xAI\", private_key: \"Ism6FNdS31nLCA94EfVbJbDdJXCxAZ8cZiB1JQPN_t4\"]\r\n\r\n"
|
:mix_shell,
|
||||||
]
|
:info,
|
||||||
}
|
[
|
||||||
|
"config :web_push_encryption, :vapid_details, [subject: \"mailto:administrator@example.com\", public_key: \"BOsPL-_KjNnjj_RMvLeR3dTOrcndi4TbMR0cu56gLGfGaT5m1gXxSfRHOcC4Dd78ycQL1gdhtx13qgKHmTM5xAI\", private_key: \"Ism6FNdS31nLCA94EfVbJbDdJXCxAZ8cZiB1JQPN_t4\"]\r\n\r\n"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
test "dumping a specific key in a group" do
|
||||||
|
insert(:config,
|
||||||
|
group: :pleroma,
|
||||||
|
key: :instance,
|
||||||
|
value: [
|
||||||
|
name: "Pleroma Test"
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
|
insert(:config,
|
||||||
|
group: :pleroma,
|
||||||
|
key: Pleroma.Captcha,
|
||||||
|
value: [
|
||||||
|
enabled: false
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
|
Mix.Tasks.Pleroma.Config.run(["dump", "pleroma", "Pleroma.Captcha"])
|
||||||
|
|
||||||
|
refute_receive {:mix_shell, :info,
|
||||||
|
["config :pleroma, :instance, [name: \"Pleroma Test\"]\r\n\r\n"]}
|
||||||
|
|
||||||
|
assert_receive {:mix_shell, :info,
|
||||||
|
["config :pleroma, Pleroma.Captcha, [enabled: false]\r\n\r\n"]}
|
||||||
|
end
|
||||||
|
|
||||||
|
test "dumps all configuration successfully" do
|
||||||
|
insert(:config,
|
||||||
|
group: :pleroma,
|
||||||
|
key: :instance,
|
||||||
|
value: [
|
||||||
|
name: "Pleroma Test"
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
|
insert(:config,
|
||||||
|
group: :pleroma,
|
||||||
|
key: Pleroma.Captcha,
|
||||||
|
value: [
|
||||||
|
enabled: false
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
|
Mix.Tasks.Pleroma.Config.run(["dump"])
|
||||||
|
|
||||||
|
assert_receive {:mix_shell, :info,
|
||||||
|
["config :pleroma, :instance, [name: \"Pleroma Test\"]\r\n\r\n"]}
|
||||||
|
|
||||||
|
assert_receive {:mix_shell, :info,
|
||||||
|
["config :pleroma, Pleroma.Captcha, [enabled: false]\r\n\r\n"]}
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
test "dumping a specific key in a group" do
|
describe "when configdb disabled" do
|
||||||
insert(:config,
|
test "refuses to dump" do
|
||||||
group: :pleroma,
|
clear_config(:configurable_from_database, false)
|
||||||
key: :instance,
|
|
||||||
value: [
|
|
||||||
name: "Pleroma Test"
|
|
||||||
]
|
|
||||||
)
|
|
||||||
|
|
||||||
insert(:config,
|
insert(:config,
|
||||||
group: :pleroma,
|
group: :pleroma,
|
||||||
key: Pleroma.Captcha,
|
key: :instance,
|
||||||
value: [
|
value: [
|
||||||
enabled: false
|
name: "Pleroma Test"
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
|
|
||||||
Mix.Tasks.Pleroma.Config.run(["dump", "pleroma", "Pleroma.Captcha"])
|
Mix.Tasks.Pleroma.Config.run(["dump"])
|
||||||
|
|
||||||
refute_receive {:mix_shell, :info,
|
assert_receive {:mix_shell, :error,
|
||||||
["config :pleroma, :instance, [name: \"Pleroma Test\"]\r\n\r\n"]}
|
[
|
||||||
|
"ConfigDB not enabled. Please check the value of :configurable_from_database in your configuration."
|
||||||
assert_receive {:mix_shell, :info,
|
]}
|
||||||
["config :pleroma, Pleroma.Captcha, [enabled: false]\r\n\r\n"]}
|
end
|
||||||
end
|
|
||||||
|
|
||||||
test "dumps all configuration successfully" do
|
|
||||||
insert(:config,
|
|
||||||
group: :pleroma,
|
|
||||||
key: :instance,
|
|
||||||
value: [
|
|
||||||
name: "Pleroma Test"
|
|
||||||
]
|
|
||||||
)
|
|
||||||
|
|
||||||
insert(:config,
|
|
||||||
group: :pleroma,
|
|
||||||
key: Pleroma.Captcha,
|
|
||||||
value: [
|
|
||||||
enabled: false
|
|
||||||
]
|
|
||||||
)
|
|
||||||
|
|
||||||
Mix.Tasks.Pleroma.Config.run(["dump"])
|
|
||||||
|
|
||||||
assert_receive {:mix_shell, :info,
|
|
||||||
["config :pleroma, :instance, [name: \"Pleroma Test\"]\r\n\r\n"]}
|
|
||||||
|
|
||||||
assert_receive {:mix_shell, :info,
|
|
||||||
["config :pleroma, Pleroma.Captcha, [enabled: false]\r\n\r\n"]}
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue