conjur-cli 4.23.0 → 4.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf3b61260f8129d53e15aaca659af65769bdd729
-  data.tar.gz: b40c45ae844b63e70d1975b2fc2934806562a8b3
+  metadata.gz: f4a996c0914a820ab371451e111785dc061c89a7
+  data.tar.gz: 3469ca2580a5df324247818f181515e530d4bc03
 SHA512:
-  metadata.gz: 0105965b5726d5449fe576a034f7b4f90627d0277d44d9f7c5f95744052fe9a012a037d28ca70f1ba1deef793a5aa0c71bcf9546e221769348aaca60faf37a29
-  data.tar.gz: d0b1bd9f7f6b094bc846439914d4fbcb852b6b3d6a20a195dd24bc7f2bc6e69b781c4494d3def7d51d188620aabf7432d668fd6c1bd5c51bcdf9ad16d1df8fbb
+  metadata.gz: c73f490d57c0dbd9cfc0c69aab11d6832442be416c29cc4b147d048669ca7c0914bdeda8ed6f82f8bde7d171ca955680b201af0685f879ba85334de850e0438b
+  data.tar.gz: b4a2f624525b425cfbfbb69eb03f2b04fd84cbe02772f47ac4dbe14371860aa764dfaa69151e8cc0a021108388ed7c491420cdd16a6944bf539b673c13f03dee

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Unreleased
 
+# 4.24.0
+
+* Interactive mode for variable creation
+
 # 4.23.0
 
 * Don't check if netrc is world-readable on Windows, since the answer is not reliable

data/lib/conjur/command/variables.rb

@@ -18,7 +18,6 @@
 # IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-
 class Conjur::Command::Variables < Conjur::Command
   desc "Manage variables"
   command :variable do |var|
@@ -26,10 +25,10 @@ class Conjur::Command::Variables < Conjur::Command
     var.arg_name "id [value]"
     var.command :create do |c|
       c.arg_name "mime_type"
-      c.flag [:m, :"mime-type"], default_value: "text/plain"
+      c.flag [:m, :"mime-type"], default_value: 'text/plain'
 
       c.arg_name "kind"
-      c.flag [:k, :"kind"], default_value: "secret"
+      c.flag [:k, :"kind"], default_value: 'secret'
 
       c.arg_name "value"
       c.desc "Initial value, which may also be specified as the second command argument after the variable id"
@@ -37,26 +36,54 @@ class Conjur::Command::Variables < Conjur::Command
 
       acting_as_option(c)
 
-      c.action do |global_options,options,args|
-        id = args.shift
-        unless id
-          ActiveSupport::Deprecation.warn "id argument will be required in future releases"
-        end
+      c.arg_name 'interactive'
+      c.desc 'Create variable interactively'
+      c.switch [:i, :'interactive']
+      
+      c.action do |global_options,options, args|
+        @default_mime_type = c.flags[:m].default_value
+        @default_kind = c.flags[:k].default_value
+        
+        id = args.shift unless args.empty?
+
         value = args.shift unless args.empty?
         
-        raise "Received extra arguments '#{args.join(' ')}'" unless args.empty?
         raise "Received conflicting value arguments" if value && options[:value]
-        
-        options[:id] = id if id
-        options[:value] ||= value if value
 
+        groupid = options[:'ownerid']
         mime_type = options.delete(:m)
         kind = options.delete(:k)
-
+        value ||= options.delete(:v)
+        
+        options.delete(:'interactive')
         options.delete(:"mime-type")
         options.delete(:"kind")
+        options.delete(:'value')
+
+        annotations = {}
+
+        # If the user asked for interactive mode, or he didn't specify
+        # both an id and a value, prompt for any missing options.
+        if options.delete(:i) || !(id && value)
+          id ||= prompt_for_id
 
+          groupid ||= prompt_for_group
+
+          kind = prompt_for_kind if !kind || kind == @default_kind
+
+          mime_type = prompt_for_mime_type if !mime_type || mime_type == @default_mime_type
+
+          annotations = prompt_for_annotations
+
+          value ||= prompt_for_value
+        end
+        
+        options[:id] = id
+        options[:value] = value
+        options[:'ownerid'] = groupid if groupid
+        
         var = api.create_variable(mime_type, kind, options)
+        api.resource(var).annotations.merge!(annotations) if annotations && !annotations.empty?
         display(var, options)
       end
     end
@@ -124,4 +151,56 @@ class Conjur::Command::Variables < Conjur::Command
     end
 
   end
+
+  def self.prompt_for_id
+    highline.ask('Enter the id: ')
+  end
+
+  def self.prompt_for_group
+    highline.ask('Enter the group: ', ->(name) { @group && @group.roleid } ) do |q|
+      q.validate = ->(name) do
+        name.empty? || (@group = api.group(name)).exists?
+      end
+      q.responses[:not_valid] = "Group '<%= @answer %>' doesn't exist, or you don't have permission to use it"
+    end
+  end
+
+  def self.prompt_for_kind
+    highline.ask('Enter the kind: ') {|q| q.default = @default_kind }
+  end
+
+  def self.prompt_for_mime_type
+    highline.ask('Enter the MIME type: ') {|q| q.default = @default_mime_type }
+  end
+
+  def self.prompt_for_annotations
+    highline.say('Add annotations (press enter to finish):')
+    {}.tap do |annotations|
+      until (name = highline.ask('annotation name: ')).empty?
+        annotations[name] = read_till_eof('annotation value (^D to finish):')
+      end
+    end
+  end
+
+  def self.prompt_for_value
+    read_till_eof('Enter the value (^D on its own line to finish):')
+  end
+  
+  def self.highline
+    require 'highline'
+    @highline ||= HighLine.new($stdin,$stderr)
+  end
+
+  def self.read_till_eof(prompt = nil)
+    highline.say(prompt) if prompt
+    [].tap do |lines|
+      loop do
+        begin
+          lines << highline.ask('')
+        rescue EOFError
+          break
+        end
+      end
+    end.join("\n")
+  end
 end

data/lib/conjur/version.rb

@@ -19,6 +19,6 @@
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 module Conjur
-  VERSION = "4.23.0"
+  VERSION = "4.24.0"
   ::Version=VERSION
 end

data/spec/command/variables_spec.rb

@@ -1,72 +1,157 @@
 require 'spec_helper'
 
 describe Conjur::Command::Variables, logged_in: true do
-  let(:collection_url) { "https://core.example.com/variables" }
-  let(:base_payload) { { mime_type: 'text/json', kind: 'password' } }
+  let(:host) { 'https://core.example.com' }
+  let(:collection_url) { "#{host}/variables" }
+  let(:mime_type) { 'text/plain' }
+  let(:kind) { 'secret' }
+  let(:base_payload) do
+    { id: id, value: value, mime_type: mime_type, kind: kind }.tap do |t|
+      group && t.merge(ownerid: group)
+    end
+  end
   let(:id) { 'the-id' }
   let(:variable) { post_response(id) }
-
-  describe_command "variable:create -m text/json -k password" do
-    let(:id) { 'assigned-id' }
-    it "lets the server assign the id" do
-     expect(RestClient::Request).to receive(:execute).with({
-        method: :post,
-        url: collection_url,
-        headers: {},
-        payload: base_payload
-      }.merge(cert_store_options)).and_return(variable)
-
-      expect { invoke }.to write({ id: 'assigned-id' }).to(:stdout)
+  let (:group) { nil }
+  let (:annotation) { {} }
+  let (:value) { 'the-value' }
+  let (:full_payload) { base_payload }
+  
+  context 'when there are command-line errors' do
+    describe_command "variable:create -v the-value-1 the-id the-value-2" do
+      it "complains about conflicting values" do
+        expect { invoke }.to raise_error("Received conflicting value arguments")
+      end
     end
   end
 
-  describe_command "variable:create -m text/json -k password the-id" do
-    it "propagates the user-assigned id" do
-     expect(RestClient::Request).to receive(:execute).with({
-        method: :post,
-        url: collection_url,
-        headers: {},
-        payload: base_payload.merge({ id: 'the-id' })
-      }.merge(cert_store_options)).and_return(variable)
+  context 'when there are no command-line errors' do
+    
+    before do
+      allow(Conjur::Command::Variables).to receive(:prompt_for_id) { id }
+      allow(Conjur::Command::Variables).to receive(:prompt_for_group) { group }
+      allow(Conjur::Command::Variables).to receive(:prompt_for_kind) { kind }
+      allow(Conjur::Command::Variables).to receive(:prompt_for_mime_type) { mime_type }
+      allow(Conjur::Command::Variables).to receive(:prompt_for_annotations) { annotation }
+      allow(Conjur::Command::Variables).to receive(:prompt_for_value)  { value }
 
-      expect { invoke }.to write({ id: 'the-id' }).to(:stdout)
+      expect(RestClient::Request).to receive(:execute).with({
+          method: :post,
+          url: collection_url,
+          headers: {},
+          payload: full_payload
+        }.merge(cert_store_options)).and_return(variable)
     end
-  end
-
-  describe_command "variable:create -m text/json -k password the-id the-value" do
-    it "propagates the user-assigned id and value" do
-     expect(RestClient::Request).to receive(:execute).with({
-        method: :post,
-        url: collection_url,
-        headers: {},
-        payload: base_payload.merge({ id: 'the-id', value: 'the-value' })
-      }.merge(cert_store_options)).and_return(variable)
-
-      expect { invoke }.to write({ id: 'the-id' }).to(:stdout)
+    
+    describe_command "variable:create the-different-id" do
+      let (:id) { 'the-different-id' }
+      it "propagates the user-assigned id" do
+        expect { invoke }.to write({ id: 'the-different-id' }).to(:stdout)
+      end
     end
-  end
-
-  describe_command "variable:create -v the-value-1 the-id the-value-2" do
-    it "complains about conflicting values" do
-      expect { invoke }.to raise_error("Received conflicting value arguments")
+    
+    describe_command "variable:create the-id the-different-value" do
+      let (:value) { 'the-different-value' }
+      it "propagates the user-assigned id" do
+        expect { invoke }.to write({ id: 'the-id' }).to(:stdout)
+      end
     end
-  end
-
-  describe_command "variable:create the-id -v the-value" do
-    it "complains about extra arguments" do
-      expect { invoke }.to raise_error("Received extra arguments 'the-value'")
+    
+    describe_command "variable:create -m application/json" do
+      let (:mime_type) { 'application/json' }
+      it "propagates the user-assigned MIME type" do
+        expect { invoke }.to write({ id: 'the-id' }).to(:stdout)
+      end
     end
-  end
+    
+    describe_command "variable:create -k password" do
+      let (:kind) { 'password' }
+      it "propagates the user-assigned kind" do
+        expect { invoke }.to write({ id: 'the-id' }).to(:stdout)
+      end
+    end
+    
+    describe "in interactive mode" do
+      after do
+        expect { invoke }.to write({ id: 'the-id' }).to(:stdout)
+      end
+      
+      subject { Conjur::Command::Variables }
+      
+      context "when -i is omitted" do
+        describe_command 'variable:create' do
+          it { is_expected.to receive(:prompt_for_id) }
+          it { is_expected.to receive(:prompt_for_group) }
+          it { is_expected.to receive(:prompt_for_kind) }
+          it { is_expected.to receive(:prompt_for_mime_type) }
+          it { is_expected.to receive(:prompt_for_annotations) }
+          it { is_expected.to receive(:prompt_for_value) }
+        end
+        
+        describe_command 'variable:create the-id' do
+          it { is_expected.not_to receive(:prompt_for_id) }
+        end
+        
+        describe_command 'variable:create the-id the-value' do
+          it { is_expected.not_to receive(:prompt_for_value) }
+        end
+        
+        describe_command 'variable:create -m application/json' do
+          let (:mime_type) { 'application/json' }
+          it { is_expected.not_to receive(:prompt_for_mime_type) }
+        end
+        
+        describe_command 'variable:create -k password' do
+          let (:kind) { 'password' }
+          it { is_expected.not_to receive(:prompt_for_kind) }
+        end
+        
+        describe_command 'variable:create -v the-value' do
+          it { is_expected.not_to receive(:prompt_for_value) }
+        end
 
-  describe_command "variable:create" do
-    it "provides default values for optional parameters mime_type and kind" do
-      expect(RestClient::Request).to receive(:execute).with({
-        method: :post,
-        url: collection_url,
-        headers: {},
-        payload: { mime_type: 'text/plain', kind: 'secret'}
-      }.merge(cert_store_options)).and_return(variable)
-      expect { invoke }.to write # invoke_silently
+        describe_command 'variable:create --as-group the-group' do
+          before do
+            allow(RestClient::Request).to receive(:execute).with({
+                method: :head,
+                url: 'https://authz.example.com/the-account/roles/group/the-group',
+                headers: {}
+              }.merge(cert_store_options)).and_return(OpenStruct.new(headers: {}, body: '{}'))
+          end
+            
+          let (:full_payload) { base_payload.merge(ownerid: 'the-account:group:the-group') }
+
+          it { is_expected.not_to receive(:prompt_for_group) }
+        end
+
+        describe_command 'variable:create --as-role the-account:group:the-group' do
+          before do
+            allow(RestClient::Request).to receive(:execute).with({
+                method: :head,
+                url: 'https://authz.example.com/the-account/roles/group/the-group',
+                headers: {}
+              }.merge(cert_store_options)).and_return(OpenStruct.new(headers: {}, body: '{}'))
+          end
+            
+          let (:full_payload) { base_payload.merge(ownerid: 'the-account:group:the-group') }
+
+          it { is_expected.not_to receive(:prompt_for_group) }
+        end
+        
+      end
+      
+      context "when -i is provided" do
+        describe_command 'variable:create -i the-id the-value' do
+          it { is_expected.not_to receive(:prompt_for_id) }
+          it { is_expected.not_to receive(:prompt_for_value) }
+          it { is_expected.to receive(:prompt_for_group) }
+          it { is_expected.to receive(:prompt_for_mime_type) }
+          it { is_expected.to receive(:prompt_for_kind) }
+          it { is_expected.to receive(:prompt_for_annotations) }
+        end
+      end
+      
     end
+    
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: conjur-cli
 version: !ruby/object:Gem::Version
-  version: 4.23.0
+  version: 4.24.0
 platform: ruby
 authors:
 - Rafal Rzepecki
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-04 00:00:00.000000000 Z
+date: 2015-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport