pe-razor-client 0.15.2.2 → 1.0.0

data/lib/razor/cli/parse.rb

@@ -6,7 +6,7 @@ module Razor::CLI
 
   class Parse
     extend Forwardable
-    DEFAULT_RAZOR_API = "http://localhost:8080/api"
+    DEFAULT_RAZOR_API = "https://localhost:8151/api"
 
     def_delegator 'navigate', 'query?'
 
@@ -18,12 +18,12 @@ module Razor::CLI
           @dump = true
         end
 
-        opts.on "-f", "--full", "Show full details when viewing entities" do
-          @format = 'full'
+        opts.on "-a", "--api", "Show API help for a command" do
+          @api_help = true
         end
 
-        opts.on "-s", "--short", "Show shortened details when viewing entities" do
-          @format = 'short'
+        opts.on "-k", "--insecure", "Allow SSL connections without verified certificates" do
+          @verify_ssl = false
         end
 
         opts.on "-u", "--url URL",
@@ -53,14 +53,28 @@ module Razor::CLI
     end
 
     def version
+      begin
       <<-VERSION
 Razor Server version: #{navigate.server_version}
 Razor Client version: #{Razor::CLI::VERSION}
       VERSION
+      rescue RestClient::Unauthorized
+        puts <<-UNAUTH
+Error: Credentials are required to connect to the server at #{@api_url}"
+        UNAUTH
+        exit 1
+      rescue
+        puts <<-ERR
+Error: Could not connect to the server at #{@api_url}. More help is available after pointing
+the client to a Razor server
+        ERR
+        exit 1
+      end
     end
 
     def help
       output = get_optparse.to_s
+      exit = 0
       begin
         output << <<-HELP
 #{list_things("Collections", navigate.collections)}
@@ -80,19 +94,25 @@ HELP
         output << <<-UNAUTH
 Error: Credentials are required to connect to the server at #{@api_url}"
 UNAUTH
+        exit = 1
       rescue
         output << <<-ERR
 Error: Could not connect to the server at #{@api_url}. More help is available after pointing
 the client to a Razor server
 ERR
+        exit = 1
       end
-      output
+      [output, exit]
     end
 
     def show_version?
       !!@show_version
     end
 
+    def show_api_help?
+      !!@api_help
+    end
+
     def show_help?
       !!@option_help
     end
@@ -105,13 +125,32 @@ ERR
       !!@dump
     end
 
-    attr_reader :api_url, :format, :args
+    def verify_ssl?
+      !!@verify_ssl
+    end
+
+    attr_reader :api_url, :args
+    # The format can be determined from later segments.
+    attr_accessor :format, :stripped_args, :ssl_ca_file
 
     def initialize(args)
       parse_and_set_api_url(ENV["RAZOR_API"] || DEFAULT_RAZOR_API, :env)
       @args = args.dup
+      # To be populated externally.
+      @stripped_args = []
       @format = 'short'
+      # If this is set, it should actually exist.
+      if ENV['RAZOR_CA_FILE'] && !File.exists?(ENV['RAZOR_CA_FILE'])
+        raise Razor::CLI::InvalidCAFileError.new(ENV['RAZOR_CA_FILE'])
+      end
+      ca_file = ENV["RAZOR_CA_FILE"] || '/etc/puppetlabs/puppet/ssl/certs/ca.pem'
+      @ssl_ca_file = ca_file if ca_file && File.exists?(ca_file)
       @args = get_optparse.order(@args)
+
+      # Localhost won't match the server's certificate; no verification required.
+      # This needs to happen after get_optparse so `-k` and `-u` can take effect.
+      @verify_ssl ||= (@api_url.hostname != 'localhost')
+
       @args = set_help_vars(@args)
       if @args == ['version'] or @show_version
         @show_version = true
@@ -150,6 +189,9 @@ ERR
     private
     def parse_and_set_api_url(url, source)
       begin
+        unless url.start_with?('http:') or url.start_with?('https:')
+          raise Razor::CLI::InvalidURIError.new(url, source)
+        end
         @api_url = URI.parse(url)
       rescue URI::InvalidURIError => e
         raise Razor::CLI::InvalidURIError.new(url, source)

data/lib/razor/cli/query.rb

@@ -0,0 +1,69 @@
+class Razor::CLI::Query
+  def initialize(parse, navigate, collections, segments)
+    @parse = parse
+    @navigate = navigate
+    @collections = collections
+    @segments = segments
+    @stripped_segments = []
+    @options = {}
+  end
+
+  def stripped_segments
+    @stripped_segments.join
+  end
+
+  def get_optparse(doc, nav)
+    # If the last document is an Array, we need to find
+    # which element matches the given query. Once found,
+    # return the 'params' section, if it has one.
+    if doc.is_a?(Array)
+      query = doc.find {|coll| coll['name'] == nav}
+      params = (query && query['params']) || {}
+    elsif doc.is_a?(Hash)
+      params = (doc[nav].is_a?(Hash) && doc[nav].has_key?('params') &&
+          doc[nav]['params'].is_a?(Hash) && doc[nav]['params']) || {}
+    end
+    @queryoptparse = OptionParser.new do |opts|
+      opts.on "-f", "--full", "Show full details when viewing entities" do
+        @parse.format = 'full'
+      end
+
+      opts.on "-s", "--short", "Show shortened details when viewing entities" do
+        @parse.format = 'short'
+      end
+
+      params.each do |param, args|
+        if args['type'] == 'boolean'
+          opts.on "--#{param}" do
+            @options[param] = true
+          end
+        else
+          opts.on "--#{param} VALUE" do |value|
+            @options[param] = value
+          end
+        end
+      end
+    end
+  end
+
+  def run
+    @doc = @collections
+    while @segments.any?
+      nav = @segments.shift
+      @parse.stripped_args << nav
+      @segments = get_optparse(@doc, nav).order(@segments)
+      @doc = @navigate.move_to nav, @doc, @options
+    end
+
+    # Get the next level if it's a list of objects.
+    if @doc.is_a?(Hash) and @doc['items'].is_a?(Array)
+      # Cache doc_resource since these queries are just for extra detail.
+      temp_doc_resource = @navigate.doc_resource
+      @doc['items'] = @doc['items'].map do |item|
+        item.is_a?(Hash) && item.has_key?('id') ? @navigate.json_get(URI.parse(item['id'])) : item
+      end
+      @navigate.doc_resource = temp_doc_resource
+    end
+    @doc
+  end
+end

data/lib/razor/cli/table_format.rb

@@ -0,0 +1,41 @@
+require 'command_line_reporter'
+class Razor::CLI::TableFormat
+  include CommandLineReporter
+
+  def run(doc, column_overrides)
+    suppress_output
+    table(:border => true, :encoding => :ascii) do
+      headings = (column_overrides or get_headers(doc))
+      row do
+        headings.each do |header|
+          column(header, :width => get_width(header, doc))
+        end
+      end
+      doc.each do |page|
+        row do
+          headings.each do |heading|
+            column(page[heading])
+          end
+        end
+      end
+    end
+    # Capturing stores the string, rather than printing to STDOUT (default).
+    capture_output.strip
+  end
+
+  def get_width(header, doc)
+    (doc.map do |page|
+      (page[header] or '').to_s.length
+    end << header.to_s.length).max
+  end
+
+  def get_headers(doc)
+    [].tap do |headers|
+      doc.map do |page|
+        page.map do |item|
+          headers << item[0] unless headers.include?(item[0])
+        end
+      end
+    end
+  end
+end

data/lib/razor/cli/transforms.rb

@@ -26,9 +26,20 @@ module Razor::CLI
     def name(obj)
       obj ? obj['name'] : "---"
     end
+    def name_hide_nil(obj)
+      raise Razor::CLI::HideColumnError if obj.nil?
+      obj['name']
+    end
     def name_if_present(obj)
       obj ? obj['name'] : "---"
     end
+    def name_or_whole(obj)
+      if obj
+        (obj['name'] ? obj['name'] : obj)
+      else
+        '---'
+      end
+    end
     def count_column(hash)
       hash['count']
     end
@@ -38,5 +49,19 @@ module Razor::CLI
     def count_hash(hash)
       hash.is_a?(Hash) ? hash.keys.size : 0
     end
+    def event_msg(obj)
+      raise Razor::CLI::HideColumnError if obj['msg'].nil?
+      obj['msg'].to_s[0..50] + (obj['msg'].to_s.size > 50 ? '...' : '')
+    end
+    def full_event_msg(obj)
+      raise Razor::CLI::HideColumnError if obj['msg'].nil?
+      obj['msg']
+    end
+    def event_entities(hash)
+      shallow_hash(Hash[hash].keep_if {|k,_| ['task', 'policy', 'broker', 'repo', 'node', 'command'].include?(k)})
+    end
+    def event_misc(hash)
+      shallow_hash(Hash[hash].delete_if {|k,_|['task', 'policy', 'broker', 'repo', 'node', 'msg', 'command'].include?(k)})
+    end
   end
 end

data/lib/razor/cli/version.rb

@@ -18,7 +18,7 @@ module Razor
     #
     # The next line is the one that our packaging tools modify, so please make
     # sure that any change to it is discussed and agreed first.
-    version = '0.15.2.2'
+    version = '1.0.0'
 
     if version == "DEVELOPMENT"
       root = File.expand_path("../../..", File.dirname(__FILE__))

data/lib/razor/cli/views.yaml

@@ -9,13 +9,14 @@
 # `+show`: This section configures which attributes are shown in the output.
 # `+layout`: This configures whether to use 'list' or 'table' output.
 # `+column`: This changes which column is used in the field formatting.
+# `+format`: This references a method inside `transforms.rb` which will mutate the column's value.
 collections:
   brokers:
     +short:
       +layout: table
       +show:
         name:
-        broker-type:
+        broker_type:
         configuration:
           +format: nested
         policies:
@@ -25,7 +26,7 @@ collections:
         +layout: list
         +show:
           name:
-          broker-type:
+          broker_type:
           configuration:
           policies:
             +format: count_column
@@ -194,3 +195,53 @@ collections:
             +format: count
           status:
           submitted_at:
+  events:
+    +short:
+      +layout: table
+      +show:
+        name:
+        timestamp:
+        message:
+          +column: entry
+          +format: event_msg
+        entities:
+          +column: entry
+          +format: event_entities
+        entry:
+          +column: entry
+          +format: event_misc
+    member:
+      +short:
+        +show:
+          name:
+          timestamp:
+          message:
+            +column: entry
+            +format: full_event_msg
+          broker:
+            +format: name_hide_nil
+          node:
+            +format: name_hide_nil
+          policy:
+            +format: name_hide_nil
+          repo:
+            +format: name_hide_nil
+          command:
+            +format: name_or_whole
+          task:
+            +format: name_hide_nil
+          entry:
+  hooks:
+    +short:
+      +layout: table
+      +show:
+        name:
+        hook_type:
+        configuration:
+          +format: shallow_hash
+    member:
+      +short:
+        +show:
+          name:
+          hook_type:
+          configuration:

data/spec/cli/command_spec.rb

@@ -0,0 +1,66 @@
+# -*- encoding: utf-8 -*-
+# Needed to make the client work on Ruby 1.8.7
+unless Kernel.respond_to?(:require_relative)
+  module Kernel
+    def require_relative(path)
+      require File.join(File.dirname(caller[0]), path.to_str)
+    end
+  end
+end
+
+require_relative '../spec_helper'
+
+describe Razor::CLI::Command do
+  Command = Razor::CLI::Command
+  # let(:inst) { Class.new { include Razor::CLI::Command } }
+
+  let :existing_value do nil end
+
+  context "convert_arg" do
+    it "performs no conversion for 'json' reserved argument name" do
+      value = '/some/path'
+      cmd_schema = {'json' => {'type' => 'number', 'aliases' => ['b']}}
+      result = Command.convert_arg('json', value, existing_value, cmd_schema)
+      result.should == '/some/path'
+    end
+
+    [['number', '123', 123], ['array', '[1, 2]', [1, 2]], ['array', '1', [1]],
+     ['object', '{"abc":123}', {'abc' => 123}], ['object', 'abc=123', {'abc' => '123'}]].
+        each do |type, orig, final|
+      it "finds the right datatype for #{type} #{orig}" do
+        cmd_schema = {"tags"=>{"type"=>"#{type}"}}
+        result = Command.convert_arg('tags', orig, existing_value, cmd_schema)
+        result.should == final
+      end
+    end
+    it "returns argument as-is when it cannot find the datatype" do
+      cmd_schema = {"tags"=>{}}
+      result = Command.convert_arg('tags', 'abc', existing_value, cmd_schema)
+      result.should == 'abc'
+    end
+    it "appends to existing values" do
+      cmd_schema = {"tags"=>{'type' => 'array'}}
+      existing_value = ['abc']
+      result = Command.convert_arg('tags', 'def', existing_value, cmd_schema)
+      result.should == %w(abc def)
+    end
+  end
+
+  context "resolve_alias" do
+    it "resolves the alias when alias is present" do
+      cmd_schema = {'def' => {'type' => 'array', 'aliases' => ['abc']}}
+      result = Command.resolve_alias('abc', cmd_schema)
+      result.should == 'def'
+    end
+    it "leaves name alone when alias is present" do
+      cmd_schema = {'def' => {'type' => 'array', 'aliases' => ['abc']}}
+      result = Command.resolve_alias('ghi', cmd_schema)
+      result.should == 'ghi'
+    end
+    it "leaves name alone when no alias is present" do
+      cmd_schema = {'def' => {'type' => 'array'}}
+      result = Command.resolve_alias('abc', cmd_schema)
+      result.should == 'abc'
+    end
+  end
+end

data/spec/cli/format_spec.rb

@@ -1,3 +1,4 @@
+# -*- encoding: utf-8 -*-
 # Needed to make the client work on Ruby 1.8.7
 unless Kernel.respond_to?(:require_relative)
   module Kernel
@@ -14,7 +15,8 @@ describe Razor::CLI::Format do
   include described_class
 
   def format(doc, args = {})
-    args = {:format => 'short', :args => ['something', 'else'], :query? => true, :show_command_help? => false}.merge(args)
+    args = {:format => 'short', :stripped_args => ['something', 'else'], :query? => true, :show_command_help? => false,
+        :show_api_help? => false}.merge(args)
     parse = double(args)
     format_document doc, parse
   end
@@ -86,14 +88,102 @@ describe Razor::CLI::Format do
              "items"=>[{'a' => 'b', 'c' => 'd'},
                        {'b' => 'c', 'e' => 'f'}]}
       result = format doc
-      result.should == <<-OUTPUT.rstrip
+      result.should ==
+          # The framework seems to be adding unnecessary spaces at the end of each data line;
+          # Working around this by adding \s to the expectation.
+
+          # Unicode:
+#┏━━━┳━━━┳━━━┳━━━┓
+#┃ a ┃ c ┃ b ┃ e ┃\s
+#┣━━━╊━━━╊━━━╊━━━┫
+#┃ b ┃ d ┃   ┃   ┃\s
+#┣━━━╊━━━╊━━━╊━━━┫
+#┃   ┃   ┃ c ┃ f ┃\s
+#┗━━━┻━━━┻━━━┻━━━┛
+          # ASCII:
+          <<-OUTPUT.rstrip
++---+---+---+---+
+| a | c | b | e |\s
 +---+---+---+---+
-| a | c | b | e |
+| b | d |   |   |\s
 +---+---+---+---+
-| b | d |   |   |
-|   |   | c | f |
+|   |   | c | f |\s
 +---+---+---+---+
+          OUTPUT
+    end
+
+    it "works right with unicode" do
+      doc = {"spec"=>"http://api.puppetlabs.com/razor/v1/collections/nodes/log",
+             "items"=>[{'a' => 'ᓱᓴᓐ ᐊᒡᓗᒃᑲᖅ'}]}
+      result = format doc
+      result.should ==
+          # The framework seems to be adding unnecessary spaces at the end of each data line;
+          # Working around this by adding \s to the expectation.
+
+          # Unicode:
+#┏━━━━━━━━━━━━┓
+#┃ a          ┃\s
+#┣━━━━━━━━━━━━┫
+#┃ ᓱᓴᓐ ᐊᒡᓗᒃᑲᖅ ┃\s
+#┗━━━━━━━━━━━━┛
+          # ASCII:
+          <<-OUTPUT.rstrip
++------------+
+| a          |\s
++------------+
+| ᓱᓴᓐ ᐊᒡᓗᒃᑲᖅ |\s
++------------+
 OUTPUT
     end
   end
+
+  context 'api help' do
+    it "displays the CLI help by default" do
+      doc = {"name"=>"some-help", "help" => {"summary"=>"summary here",
+                                             "examples"=>{"api"=>"api example is here", "cli"=>"cli example is here"},
+                                             "full" => "shouldn't show this"},
+             "schema" => {"name"=>{"type"=>"string"}}}
+      result = format doc, show_command_help?: true
+      result.should =~ /cli example is here/
+    end
+
+    it "displays the API help when the --api flag is true" do
+      doc = {"name"=>"some-help", "help" => {"summary"=>"summary here",
+          "examples"=>{"api"=>"api example is here", "cli"=>"cli example is here"},
+          "full" => "shouldn't show this"},
+          "schema" => {"name"=>{"type"=>"string"}}}
+      result = format doc, show_api_help?: true, show_command_help?: true
+      result.should =~ /api example is here/
+    end
+
+    it "displays the full help if on an older server" do
+      doc = {"name"=>"some-help", "help" => {"full" => "full help is here"},
+             "schema" => {"name"=>{"type"=>"string"}}}
+      result = format doc, show_command_help?: true
+      result.should =~ /full help is here/
+    end
+
+    it "displays the full help if on an older server and api is specified" do
+      doc = {"name"=>"some-help", "help" => {"full" => "full help is here"},
+             "schema" => {"name"=>{"type"=>"string"}}}
+      result = format doc, show_api_help?: true, show_command_help?: true
+      result.should =~ /full help is here/
+    end
+
+    it "skips the 'Examples' section if cli examples are not included" do
+      doc = {"name"=>"some-help", "help" => {"summary"=>"summary here",
+                                             "examples"=>{"api"=>"api example is here"},
+                                             "full" => "shouldn't show this"},
+             "schema" => {"name"=>{"type"=>"string"}}}
+      result = format doc, show_cli_help?: true, show_command_help?: true
+      result.should =~ /summary here/
+      result.should_not =~ /EXAMPLES/
+    end
+
+    it "errors if help does not exist" do
+      doc = {"name"=>"some-help", "schema" => {"name"=>{"type"=>"string"}}}
+      expect { format doc, show_cli_help?: true, show_command_help?: true }.
+          to raise_error(Razor::CLI::Error, /Could not find help for that entry/)
+    end
+  end
 end