commit: caadde3b04cf4c6509cc0841a338503e646221a0
parent c09844d3d250feccce08cf06d6f2f326daf897a7
Author: feld <feld@feld.me>
Date: Tue, 23 Mar 2021 17:46:52 +0000
Merge branch 'fix/2585-config-migration-dir' into 'develop'
migrating config to tmp folder
Closes #2585
See merge request pleroma/pleroma!3379
Diffstat:
4 files changed, 85 insertions(+), 18 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## Unreleased (Patch)
+### Fixed
+
+- Try to save exported ConfigDB settings (migrate_from_db) in the system temp directory if default location is not writable.
+
## [2.3.0] - 2020-03-01
### Security
@@ -51,7 +55,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- Pleroma API: Reroute `/api/pleroma/*` to `/api/v1/pleroma/*`
</details>
-- Improved hashtag timeline performance (requires a background migration).
+- Improved hashtag timeline performance (requires a background migration).
### Added
diff --git a/docs/administration/CLI_tasks/config.md b/docs/administration/CLI_tasks/config.md
@@ -32,16 +32,20 @@
config :pleroma, configurable_from_database: false
```
-To delete transferred settings from database optional flag `-d` can be used. `<env>` is `prod` by default.
+Options:
+
+- `<path>` - where to save migrated config. E.g. `--path=/tmp`. If file saved into non standart folder, you must manually copy file into directory where Pleroma can read it. For OTP install path will be `PLEROMA_CONFIG_PATH` or `/etc/pleroma`. For installation from source - `config` directory in the pleroma folder.
+- `<env>` - environment, for which is migrated config. By default is `prod`.
+- To delete transferred settings from database optional flag `-d` can be used
=== "OTP"
```sh
- ./bin/pleroma_ctl config migrate_from_db [--env=<env>] [-d]
+ ./bin/pleroma_ctl config migrate_from_db [--env=<env>] [-d] [--path=<path>]
```
=== "From Source"
```sh
- mix pleroma.config migrate_from_db [--env=<env>] [-d]
+ mix pleroma.config migrate_from_db [--env=<env>] [-d] [--path=<path>]
```
## Dump all of the config settings defined in the database
diff --git a/lib/mix/tasks/pleroma/config.ex b/lib/mix/tasks/pleroma/config.ex
@@ -27,7 +27,7 @@ defmodule Mix.Tasks.Pleroma.Config do
{opts, _} =
OptionParser.parse!(options,
- strict: [env: :string, delete: :boolean],
+ strict: [env: :string, delete: :boolean, path: :string],
aliases: [d: :delete]
)
@@ -259,18 +259,43 @@ defmodule Mix.Tasks.Pleroma.Config do
defp migrate_from_db(opts) do
env = opts[:env] || Pleroma.Config.get(:env)
+ filename = "#{env}.exported_from_db.secret.exs"
+
config_path =
- if Pleroma.Config.get(:release) do
- :config_path
- |> Pleroma.Config.get()
- |> Path.dirname()
- else
- "config"
+ cond do
+ opts[:path] ->
+ opts[:path]
+
+ Pleroma.Config.get(:release) ->
+ :config_path
+ |> Pleroma.Config.get()
+ |> Path.dirname()
+
+ true ->
+ "config"
end
- |> Path.join("#{env}.exported_from_db.secret.exs")
+ |> Path.join(filename)
- file = File.open!(config_path, [:write, :utf8])
+ with {:ok, file} <- File.open(config_path, [:write, :utf8]) do
+ write_config(file, config_path, opts)
+ shell_info("Database configuration settings have been exported to #{config_path}")
+ else
+ _ ->
+ shell_error("Impossible to save settings to this directory #{Path.dirname(config_path)}")
+ tmp_config_path = Path.join(System.tmp_dir!(), filename)
+ file = File.open!(tmp_config_path)
+
+ shell_info(
+ "Saving database configuration settings to #{tmp_config_path}. Copy it to the #{
+ Path.dirname(config_path)
+ } manually."
+ )
+ write_config(file, tmp_config_path, opts)
+ end
+ end
+
+ defp write_config(file, path, opts) do
IO.write(file, config_header())
ConfigDB
@@ -278,11 +303,7 @@ defmodule Mix.Tasks.Pleroma.Config do
|> Enum.each(&write_and_delete(&1, file, opts[:delete]))
:ok = File.close(file)
- System.cmd("mix", ["format", config_path])
-
- shell_info(
- "Database configuration settings have been exported to config/#{env}.exported_from_db.secret.exs"
- )
+ System.cmd("mix", ["format", path])
end
if Code.ensure_loaded?(Config.Reader) do
diff --git a/test/mix/tasks/pleroma/config_test.exs b/test/mix/tasks/pleroma/config_test.exs
@@ -200,6 +200,44 @@ defmodule Mix.Tasks.Pleroma.ConfigTest do
end
end
+ describe "migrate_from_db/1" do
+ setup do: clear_config(:configurable_from_database, true)
+
+ setup do
+ insert_config_record(:pleroma, :setting_first, key: "value", key2: ["Activity"])
+ insert_config_record(:pleroma, :setting_second, key: "value2", key2: [Repo])
+ insert_config_record(:quack, :level, :info)
+
+ path = "test/instance_static"
+ file_path = Path.join(path, "temp.exported_from_db.secret.exs")
+
+ on_exit(fn -> File.rm!(file_path) end)
+
+ [file_path: file_path]
+ end
+
+ test "with path parameter", %{file_path: file_path} do
+ MixTask.run(["migrate_from_db", "--env", "temp", "--path", Path.dirname(file_path)])
+
+ file = File.read!(file_path)
+ assert file =~ "config :pleroma, :setting_first,"
+ assert file =~ "config :pleroma, :setting_second,"
+ assert file =~ "config :quack, :level, :info"
+ end
+
+ test "release", %{file_path: file_path} do
+ clear_config(:release, true)
+ clear_config(:config_path, file_path)
+
+ MixTask.run(["migrate_from_db", "--env", "temp"])
+
+ file = File.read!(file_path)
+ assert file =~ "config :pleroma, :setting_first,"
+ assert file =~ "config :pleroma, :setting_second,"
+ assert file =~ "config :quack, :level, :info"
+ end
+ end
+
describe "operations on database config" do
setup do: clear_config(:configurable_from_database, true)
