diff options
author | Kasper Timm Hansen <kaspth@gmail.com> | 2017-03-01 20:40:39 +0100 |
---|---|---|
committer | Kasper Timm Hansen <kaspth@gmail.com> | 2017-03-01 20:44:17 +0100 |
commit | 82f7dc6178f86e5e2dd82f9e528475a6acee6cd8 (patch) | |
tree | 9f2fce1e57cbef8c797015e2242b18ddd0d31318 | |
parent | b61a56541aecd7ac685d4f19d943177a3f1b465a (diff) | |
download | rails-82f7dc6178f86e5e2dd82f9e528475a6acee6cd8.tar.gz rails-82f7dc6178f86e5e2dd82f9e528475a6acee6cd8.tar.bz2 rails-82f7dc6178f86e5e2dd82f9e528475a6acee6cd8.zip |
Tell users how to assign a $EDITOR.
In case there's no $EDITOR assigned users would see a cryptic:
```
% EDITOR= bin/rails secrets:edit
Waiting for secrets file to be saved. Abort with Ctrl-C.
sh: /var/folders/wd/xnncwqp96rj0v1y2nms64mq80000gn/T/secrets.yml.enc: Permission denied
New secrets encrypted and saved.
```
That error is misleading, so give a hint in this easily detectable case.
Fixes #28143.
-rw-r--r-- | railties/lib/rails/commands/secrets/secrets_command.rb | 11 | ||||
-rw-r--r-- | railties/test/commands/secrets_test.rb | 24 |
2 files changed, 35 insertions, 0 deletions
diff --git a/railties/lib/rails/commands/secrets/secrets_command.rb b/railties/lib/rails/commands/secrets/secrets_command.rb index 3ba8c0c85b..9438eeb9f7 100644 --- a/railties/lib/rails/commands/secrets/secrets_command.rb +++ b/railties/lib/rails/commands/secrets/secrets_command.rb @@ -18,6 +18,17 @@ module Rails end def edit + if ENV["EDITOR"].empty? + say "No $EDITOR to open decrypted secrets in. Assign one like this:" + say "" + say %(EDITOR="mate --wait" bin/rails secrets:edit) + say "" + say "For editors that fork and exit immediately, it's important to pass a wait flag," + say "otherwise the secrets will be saved immediately with no chance to edit." + + return + end + require_application_and_environment! Rails::Secrets.read_for_editing do |tmp_path| diff --git a/railties/test/commands/secrets_test.rb b/railties/test/commands/secrets_test.rb new file mode 100644 index 0000000000..13fcf6c8a4 --- /dev/null +++ b/railties/test/commands/secrets_test.rb @@ -0,0 +1,24 @@ +require "isolation/abstract_unit" +require "rails/command" +require "rails/commands/secrets/secrets_command" + +class Rails::Command::SecretsCommandTest < ActiveSupport::TestCase + include ActiveSupport::Testing::Isolation + + def setup + build_app + end + + def teardown + teardown_app + end + + test "edit without editor gives hint" do + assert_match "No $EDITOR to open decrypted secrets in", run_edit_command(editor: "") + end + + private + def run_edit_command(editor: "cat") + Dir.chdir(app_path) { `EDITOR="#{editor}" bin/rails secrets:edit` } + end +end |