Added prompt to commands that wait for input from STDIN (kontena#2045)

* Fix broken update and import.

* Use stdin.tty? to determine if prompting is possible

* Vault update didnt have --grid option

* Move Kontena.stdinput to common.stdin_input

* Borrow and adapt specs from kontena#2002

* Add mode to stdin_input

* Added comment to common#stdin_input

* Fixed specs to match

Author: colinmollenhour

cli/lib/kontena/cli/common.rb

@@ -22,6 +22,19 @@ def pastel
         @pastel ||= Pastel.new(enabled: $stdout.tty?)
       end
 
+      # Read from STDIN. If stdin is a console, use prompt to ask.
+      # @param [String] message
+      # @param [Symbol] mode (prompt method: :ask, :multiline, etc)
+      def stdin_input(message = nil, mode = :ask)
+        if $stdin.tty?
+          Array(prompt.send(mode, message)).join.chomp
+        elsif !$stdin.eof?
+          $stdin.read.chomp
+        else
+          exit_with_error 'Missing input'
+        end
+      end
+
       def running_silent?
         self.respond_to?(:silent?) && self.silent?
       end

cli/lib/kontena/cli/master/config/import_command.rb

@@ -8,7 +8,7 @@ class ImportCommand < Kontena::Command
 
     banner "Updates configuration from a file into Master"
 
-    parameter '[PATH]', "Input from file in PATH, default: STDIN", required: false
+    parameter '[PATH]', "Input from file in PATH (default: STDIN)", required: false
 
     option ['--preset'], '[NAME]', 'Load preset', hidden: true
 
@@ -30,7 +30,7 @@ def input_as_hash
         path = File.join(Kontena.root, 'lib/kontena/presets', "#{self.preset}.yml")
         File.read(path)
       else
-        STDIN.read
+        stdin_input("Enter master configuration as #{format.upcase}", :multiline)
       end
     end
 

cli/lib/kontena/cli/vault/import_command.rb

@@ -10,7 +10,7 @@ class ImportCommand < Kontena::Command
     option '--skip-null', :flag, "Do not remove keys with null values"
     option '--empty-is-null', :flag, "Treat empty values as null"
 
-    parameter '[PATH]', "Input from file in PATH, default: STDIN"
+    parameter '[PATH]', "Input from file in PATH (default: STDIN)"
 
     requires_current_master
 
@@ -23,7 +23,7 @@ def parsed_input
     end
 
     def input
-      path ? File.read(path) : STDIN.read
+      path ? File.read(path) : stdin_input("Enter secrets YAML", :multiline)
     end
 
     def execute

cli/lib/kontena/cli/vault/update_command.rb

@@ -1,26 +1,23 @@
 module Kontena::Cli::Vault
   class UpdateCommand < Kontena::Command
     include Kontena::Cli::Common
+    include Kontena::Cli::GridOptions
 
     parameter 'NAME', 'Secret name'
-    parameter '[VALUE]', 'Secret value'
+    parameter '[VALUE]', 'Secret value (default: STDIN)'
 
     option ['-u', '--upsert'], :flag, 'Create secret unless already exists', default: false
     option '--silent', :flag, "Reduce output verbosity"
 
-    def execute
-      require_api_url
-      require_current_grid
+    requires_current_master
+
+    def default_value
+      stdin_input("Enter value for secret '#{name}'", :mask)
+    end
 
-      token = require_token
-      value ||= STDIN.read.chomp
-      data = {
-        name: name,
-        value: value,
-        upsert: upsert?
-      }
+    def execute
       vspinner "Updating #{name.colorize(:cyan)} value in the vault " do
-        client(token).put("secrets/#{current_grid}/#{name}", data)
+        client.put("secrets/#{current_grid}/#{name}", {name: name, value: value, upsert: upsert? })
       end
     end
   end

cli/lib/kontena/cli/vault/write_command.rb

@@ -4,26 +4,19 @@ class WriteCommand < Kontena::Command
     include Kontena::Cli::GridOptions
 
     parameter 'NAME', 'Secret name'
-    parameter '[VALUE]', 'Secret value'
+    parameter '[VALUE]', 'Secret value (default: STDIN)'
 
     option '--silent', :flag, "Reduce output verbosity"
 
-    def execute
-      require_api_url
-      require_current_grid
+    requires_current_master
 
-      token = require_token
-      secret = value
-      if secret.to_s == ''
-        secret = STDIN.read
-      end
-      exit_with_error('No value provided') if secret.to_s == ''
-      data = {
-          name: name,
-          value: secret
-      }
+    def default_value
+      stdin_input("Enter value for secret '#{name}'", :mask)
+    end
+
+    def execute
       vspinner "Writing #{name.colorize(:cyan)} to the vault " do
-        client(token).post("grids/#{current_grid}/secrets", data)
+        client.post("grids/#{current_grid}/secrets", { name: name, value: value })
       end
     end
   end

cli/spec/kontena/cli/vault/update_command_spec.rb

@@ -0,0 +1,79 @@
+require_relative "../../../spec_helper"
+require 'kontena/cli/vault/update_command'
+
+describe Kontena::Cli::Vault::UpdateCommand do
+
+  include RequirementsHelper
+  include ClientHelpers
+
+  let(:subject) { described_class.new(File.basename($0)) }
+
+  describe '#execute' do
+
+    context 'without value parameter' do
+
+      let(:stdin) { double(:stdin) }
+
+      before(:each) do
+        @old_stdin = $stdin
+        $stdin = stdin
+      end
+
+      after(:each) { $stdin = @old_stdin }
+
+      context 'without tty' do
+        before(:each) { allow(stdin).to receive(:tty?).and_return(false) }
+        after(:each) { $stdin = @old_stdin }
+
+        context 'nothing in stdin' do
+          before(:each) do
+            allow(stdin).to receive(:eof?).and_return(true)
+          end
+
+          it 'returns error if value not provided' do
+            expect{subject.run(['mysql_password'])}.to exit_with_error.and output(/Missing/).to_stderr
+          end
+        end
+
+        context 'value in stdin' do
+          it 'sends update request' do
+            expect(stdin).to receive(:eof?).and_return(false)
+            expect(stdin).to receive(:read).and_return('secret')
+            expect(client).to receive(:put).with('secrets/test-grid/mysql_password', { name: 'mysql_password', value: 'secret', upsert: false})
+            expect{subject.run(['mysql_password'])}.not_to exit_with_error
+          end
+        end
+      end
+
+      context 'with tty' do
+        before(:each) do
+          allow(stdin).to receive(:tty?).and_return(true)
+        end
+
+        context 'when value not given' do
+          let(:prompt) { double(:prompt) }
+          it 'prompts for value' do
+            expect(subject).to receive(:prompt).and_return(prompt)
+            expect(prompt).to receive(:mask).once.and_return('very-secret')
+            expect(client).to receive(:put).with('secrets/test-grid/mysql_password', { name: 'mysql_password', value: 'very-secret', upsert: false})
+            expect{subject.run(['mysql_password'])}.not_to exit_with_error
+          end
+        end
+      end
+    end
+
+    context 'with value parameter' do
+      it 'sends update request' do
+        expect(client).to receive(:put).with('secrets/test-grid/mysql_password', { name: 'mysql_password', value: 'secret', upsert: false})
+        expect{subject.run(['mysql_password', 'secret'])}.not_to exit_with_error
+      end
+
+      context 'when giving --upsert flag' do
+        it 'sets upsert true' do
+          expect(client).to receive(:put).with('secrets/test-grid/mysql_password', { name: 'mysql_password', value: 'secret', upsert: true})
+          subject.run(['-u', 'mysql_password', 'secret'])
+        end
+      end
+    end
+  end
+end

cli/spec/kontena/cli/vault/write_command_spec.rb

@@ -0,0 +1,60 @@
+require_relative "../../../spec_helper"
+require 'kontena/cli/vault/write_command'
+
+describe Kontena::Cli::Vault::WriteCommand do
+
+  include RequirementsHelper
+  include ClientHelpers
+
+  let(:subject) { described_class.new(File.basename($0)) }
+
+  describe '#execute' do
+    context 'without value parameter' do
+
+      let(:stdin) { double(:stdin) }
+
+      before(:each) do
+        @old_stdin = $stdin
+        $stdin = stdin
+      end
+
+      after(:each) { $stdin = @old_stdin }
+
+      context 'no tty' do
+        context 'stdin empty' do
+          it 'returns an error' do
+            expect(stdin).to receive(:tty?).and_return(false)
+            expect(stdin).to receive(:eof?).and_return(true)
+            expect{subject.run(['mysql_password'])}.to exit_with_error.and output(/Missing/).to_stderr
+          end
+        end
+
+        context 'stdin has a value' do
+          it 'sends create request' do
+            expect(stdin).to receive(:tty?).and_return(false)
+            expect(stdin).to receive(:eof?).and_return(false)
+            expect(stdin).to receive(:read).and_return('secret')
+            expect(client).to receive(:post).with('grids/test-grid/secrets', { name: 'mysql_password', value: 'secret'})
+            expect{subject.run(['mysql_password'])}.not_to exit_with_error
+          end
+        end
+      end
+
+      context 'with tty' do
+        let(:prompt) { double(:prompt) }
+        it 'prompts value from STDIN' do
+          expect(stdin).to receive(:tty?).and_return(true)
+          expect(subject).to receive(:prompt).and_return(prompt)
+          expect(prompt).to receive(:mask).and_return('secret')
+          expect(client).to receive(:post).with('grids/test-grid/secrets', { name: 'mysql_password', value: 'secret'})
+          expect{subject.run(['mysql_password'])}.not_to exit_with_error
+        end
+      end
+    end
+
+    it 'sends create request' do
+      expect(client).to receive(:post).with('grids/test-grid/secrets', { name: 'mysql_password', value: 'secret'})
+      subject.run(['mysql_password', 'secret'])
+    end
+  end
+end