razor-client 0.16.0 → 1.0.0

data/NEWS.md

@@ -1,5 +1,20 @@
 # Razor Client Release Notes
 
+## 1.0.0 - 2015-06-08
+
+* NEW: Fit collection output to STDIN size for easier viewing.
+* NEW: RAZOR_CA_FILE environment variable allows TLS/SSL certificate
+  verification for requests.
+* NEW: The default API protocol and port are HTTPS over TLS/SSL on port 8151.
+* NEW: Utilizes `aliases` property in command metadata to better guess datatypes
+  for aliases.
+* IMPROVEMENT: `razor hooks` now displays as a table.
+* IMPROVEMENT: Better output for `razor events ##`.
+* IMPROVEMENT: Exits with an error code of 1 when a `razor` command fails.
+* BUGFIX: `razor events` no longer causes exception.
+* BUGFIX: `razor commands ## errors` no longer causes exception.
+* BUGFIX: Hook output message can now be any datatype.
+
 ## 0.16.0 - 2015-01-05
 
 * BUGFIX: Commands were not always including authentication

data/bin/razor

@@ -33,8 +33,9 @@ if parse.show_version?
 end
 
 if parse.show_help? and not parse.show_command_help?
-  puts parse.help
-  exit 0
+  output, exitcode = parse.help
+  puts output
+  exit exitcode
 end
 
 def unexpected_error(e)

data/lib/razor/cli.rb

@@ -26,6 +26,12 @@ module Razor
       end
     end
 
+    class InvalidCAFileError < Error
+      def initialize(path)
+        super "CA file '#{path}' in ENV variable RAZOR_CA_FILE does not exist"
+      end
+    end
+
     class VersionCompatibilityError < Error
       def initialize(reason)
         super "Server version is not compatible with client version: #{reason}"

data/lib/razor/cli/command.rb

@@ -37,6 +37,7 @@ class Razor::CLI::Command
   def extract_command
     cmd = command(@segments.shift)
     @cmd_url = URI.parse(cmd['id'])
+    @cmd_schema = cmd_schema(@cmd_url)
     body = {}
     until @segments.empty?
       argument = @segments.shift
@@ -44,7 +45,8 @@ class Razor::CLI::Command
         # `--arg=value` or `--arg value`
         arg, value = [$1, $3]
         value = @segments.shift if value.nil? && @segments[0] !~ /^--/
-        body[arg] = convert_arg(cmd["name"], arg, value, body[arg])
+        arg = self.class.resolve_alias(arg, @cmd_schema)
+        body[arg] = self.class.convert_arg(arg, value, body[arg], @cmd_schema)
       else
         raise ArgumentError, "Unexpected argument #{argument}"
       end
@@ -63,19 +65,20 @@ class Razor::CLI::Command
     [cmd, body]
   end
 
-  def cmd_schema(cmd_name)
+  def cmd_schema(cmd_url)
     begin
-      @navigate.json_get(@cmd_url)['schema']
+      @navigate.json_get(cmd_url)['schema']
     rescue RestClient::ResourceNotFound => _
       raise VersionCompatibilityError, 'Server must supply the expected datatypes for command arguments; use `--json` or upgrade razor-server'
     end
   end
 
-  def arg_type(cmd_name, arg_name)
+  def self.arg_type(arg_name, cmd_schema)
     # Short-circuit to allow this as a work-around for backwards compatibility.
     return nil if arg_name == 'json'
-    cmd = cmd_schema(cmd_name)
-    cmd && cmd[arg_name] && cmd[arg_name]['type'] or nil
+    return nil unless cmd_schema.is_a?(Hash)
+    return cmd_schema[arg_name]['type'] if cmd_schema.has_key?(arg_name)
+    return nil
   end
 
   # `cmd_name`: The name of the command being executed.
@@ -85,22 +88,19 @@ class Razor::CLI::Command
   #     by previous calls to this method. The new `value` will be
   #     concatenated to an array or hash if an array/hash is
   #     accepted by the command for the given argument.
-  def convert_arg(cmd_name, arg_name, value, existing_value)
+  def self.convert_arg(arg_name, value, existing_value, cmd_schema)
     value = nil if value == "null"
 
-    argument_type = arg_type(cmd_name, arg_name)
+    argument_type = arg_type(arg_name, cmd_schema)
 
     # This might be helpful, since there's no other method for debug-level logging on the client.
-    puts "Formatting argument #{arg_name} with value #{value} as #{argument_type}\n" if @parse.dump_response?
+    puts "Formatting argument #{arg_name} with value #{value} as #{argument_type}\n" if @parse && @parse.dump_response?
 
     case argument_type
       when "array"
         existing_value ||= []
         begin
-          MultiJson::load(value).tap do |value|
-            value = Array(value)
-            existing_value + value
-          end
+          existing_value + Array(MultiJson::load(value))
         rescue MultiJson::LoadError => _
           existing_value + Array(value)
         end
@@ -136,4 +136,15 @@ class Razor::CLI::Command
         raise Razor::CLI::Error, "Unexpected datatype '#{argument_type}' for argument #{arg_name}"
     end
   end
+
+  def self.resolve_alias(arg_name, cmd_schema)
+    return arg_name if cmd_schema[arg_name]
+    cmd_schema.find do |other_attr, metadata|
+      if metadata && metadata.has_key?('aliases')
+        return other_attr if metadata['aliases'].find {|aliaz| aliaz == arg_name}
+      end
+    end
+    # No results; return the same name to generate a reasonable error message.
+    arg_name
+  end
 end

data/lib/razor/cli/navigate.rb

@@ -142,6 +142,7 @@ module Razor::CLI
     def create_resource(url, headers)
       @doc_resource = RestClient::Resource.new(url.to_s, :headers => headers,
                                          :verify_ssl => @parse.verify_ssl?,
+                                         :ssl_ca_file      =>  @parse.ssl_ca_file,
                                          :user => @username,
                                          :password => @password)
     end

data/lib/razor/cli/parse.rb

@@ -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,13 +94,15 @@ 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?
@@ -115,7 +131,7 @@ ERR
 
     attr_reader :api_url, :args
     # The format can be determined from later segments.
-    attr_accessor :format, :stripped_args
+    attr_accessor :format, :stripped_args, :ssl_ca_file
 
     def initialize(args)
       parse_and_set_api_url(ENV["RAZOR_API"] || DEFAULT_RAZOR_API, :env)
@@ -123,8 +139,18 @@ ERR
       # To be populated externally.
       @stripped_args = []
       @format = 'short'
-      @verify_ssl = true
+      # 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"]
+      @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

data/lib/razor/cli/query.rb

@@ -20,7 +20,8 @@ class Razor::CLI::Query
       query = doc.find {|coll| coll['name'] == nav}
       params = (query && query['params']) || {}
     elsif doc.is_a?(Hash)
-      params = (doc[nav] && doc[nav]['params']) || {}
+      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

data/lib/razor/cli/table_format.rb

@@ -8,7 +8,7 @@ class Razor::CLI::TableFormat
       headings = (column_overrides or get_headers(doc))
       row do
         headings.each do |header|
-          column(header, :width => get_width(header, doc))
+          column(header, :width => column_width!(headings, header, doc))
         end
       end
       doc.each do |page|
@@ -23,12 +23,48 @@ class Razor::CLI::TableFormat
     capture_output.strip
   end
 
-  def get_width(header, doc)
+  # This method has the side effect of modifying the remaining extra_width.
+  # It pulls everything together to come up with a single value for the column.
+  def column_width!(headings, header, doc)
+    content_width = content_width(header, doc)
+    average_width = average_width(headings)
+    # Is the column too wide and can we do anything about it?
+    if content_width > average_width && extra_width(headings, doc) > 0
+      # Determine how much room we'd need to make to accommodate the content.
+      remaining = content_width - average_width
+      # Add back in what we can.
+      width = average_width + [@extra_width, remaining].min
+      # The new width can't be negative.
+      @extra_width = [@extra_width - remaining, 0].max
+      width
+    else
+      [content_width, average_width].min
+    end
+  end
+
+  # This calculates how much leeway would exist in all columns if we were to
+  # use an auto-sized fixed width for the whole table.
+  def extra_width(headings, doc)
+    @extra_width ||= headings.map do |header|
+                       [average_width(headings) - content_width(header, doc), 0].max
+                     end.inject(:+)
+  end
+
+  # This calculates what an auto-sized fixed-width table's column width would be.
+  def average_width(headings)
+    # The 3 here = 2 for width gap + 1 for the column separator.
+    # The 1 is for the last separator.
+    @average_width ||= (((`stty size | cut -d ' ' -f 2` || 80).to_i - (headings.count * 3) - 1) / headings.count)
+  end
+
+  def content_width(header, doc)
+    # Find longest item, including the header
     (doc.map do |page|
       (page[header] or '').to_s.length
     end << header.to_s.length).max
   end
 
+  # Traverse all headers to compile a unique list.
   def get_headers(doc)
     [].tap do |headers|
       doc.map do |page|

data/lib/razor/cli/transforms.rb

@@ -33,6 +33,13 @@ module Razor::CLI
     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
@@ -44,7 +51,7 @@ module Razor::CLI
     end
     def event_msg(obj)
       raise Razor::CLI::HideColumnError if obj['msg'].nil?
-      obj['msg'][0..50] + ('...' if obj['msg'].size > 50) if obj['msg']
+      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?

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.16.0'
+    version = '1.0.0'
 
     if version == "DEVELOPMENT"
       root = File.expand_path("../../..", File.dirname(__FILE__))

data/lib/razor/cli/views.yaml

@@ -16,7 +16,7 @@ collections:
       +layout: table
       +show:
         name:
-        broker-type:
+        broker_type:
         configuration:
           +format: nested
         policies:
@@ -26,7 +26,7 @@ collections:
         +layout: list
         +show:
           name:
-          broker-type:
+          broker_type:
           configuration:
           policies:
             +format: count_column
@@ -227,8 +227,21 @@ collections:
           repo:
             +format: name_hide_nil
           command:
-            +format: name_hide_nil
+            +format: name_or_whole
           task:
             +format: name_hide_nil
           entry:
-            +format: event_misc
+  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/navigate_spec.rb

@@ -148,7 +148,7 @@ describe Razor::CLI::Navigate do
   end
 
   context "with authentication", :vcr do
-    AuthArg = %w[-u http://fred:dead@localhost:8080/api].freeze
+    AuthArg = %w[-u http://fred:dead@localhost:8150/api].freeze
 
     it "should supply that to the API service" do
       nav = Razor::CLI::Parse.new(AuthArg).navigate
@@ -167,29 +167,29 @@ describe Razor::CLI::Navigate do
 
   context "with query parameters", :vcr do
     it "should append limit" do
-      nav = Razor::CLI::Parse.new(%w[-u http://fred:dead@localhost:8080/api events --limit 1]).navigate
+      nav = Razor::CLI::Parse.new(%w[-u http://fred:dead@localhost:8150/api events --limit 1]).navigate
       nav.get_document.should be_an_instance_of Hash
       nav.last_url.to_s.should =~ /limit=1/
     end
     it "should append start" do
-      nav = Razor::CLI::Parse.new(%w[-u http://fred:dead@localhost:8080/api events --start 1]).navigate
+      nav = Razor::CLI::Parse.new(%w[-u http://fred:dead@localhost:8150/api events --start 1]).navigate
       nav.get_document.should be_an_instance_of Hash
       nav.last_url.to_s.should =~ /start=1/
     end
     it "should throw an error if the query parameter is not in the API" do
-      nav = Razor::CLI::Parse.new(%w[-u http://fred:dead@localhost:8080/api events --not-in-api 1]).navigate
+      nav = Razor::CLI::Parse.new(%w[-u http://fred:dead@localhost:8150/api events --not-in-api 1]).navigate
       expect {nav.get_document}.to raise_error(OptionParser::InvalidOption, 'invalid option: --not-in-api')
     end
     it "should not fail when query returns details for one item" do
       nav = Razor::CLI::Parse.new(['register-node', '--installed', 'true', '--hw-info', 'net0=78:31:c1:be:c8:00']).navigate.get_document
       name = nav['name']
-      nav = Razor::CLI::Parse.new(['-u', 'http://fred:dead@localhost:8080/api', 'nodes', name]).navigate
+      nav = Razor::CLI::Parse.new(['-u', 'http://fred:dead@localhost:8150/api', 'nodes', name]).navigate
       nav.get_document['name'].should == name
     end
     it "should throw an error if the query parameter is not in the API from a single item" do
       nav = Razor::CLI::Parse.new(['register-node', '--installed', 'true', '--hw-info', 'net0=78:31:c1:be:c8:00']).navigate.get_document
       name = nav['name']
-      expect {Razor::CLI::Parse.new(['-u', 'http://fred:dead@localhost:8080/api', 'nodes', name, '--limit', '1']).
+      expect {Razor::CLI::Parse.new(['-u', 'http://fred:dead@localhost:8150/api', 'nodes', name, '--limit', '1']).
           navigate.get_document}.to raise_error(OptionParser::InvalidOption, 'invalid option: --limit')
     end
     it "should store query without query parameters" do
@@ -197,7 +197,7 @@ describe Razor::CLI::Navigate do
           navigate.get_document['name']
       Razor::CLI::Parse.new(['register-node', '--installed', 'true', '--hw-info', 'net0=78:31:c1:be:c8:01']).
           navigate.get_document
-      parse = Razor::CLI::Parse.new(['-u', 'http://fred:dead@localhost:8080/api', 'nodes', name, 'log', '--limit', '1'])
+      parse = Razor::CLI::Parse.new(['-u', 'http://fred:dead@localhost:8150/api', 'nodes', name, 'log', '--limit', '1'])
       parse.navigate.get_document
       parse.stripped_args.should == ['nodes', name, 'log']
     end