pe-razor-client 0.14.0

data/lib/razor/cli/navigate.yaml

@@ -0,0 +1,28 @@
+---
+
+# This file helps Razor::CLI::Navigate with a few things by annotating the
+# API. Ultimately, this should be something the server provides. But until
+# we better understand what sort of annotation we need from the server,
+# we'll keep this with the client.
+#
+# Possible argument types are
+#   - json: parse the argument value as a JSON document and use that
+#   - boolean: if the argument has no value associated with it, or the value
+#              is "true", convert to +true+; everything else gets converted
+#              to +false+
+commands:
+  create-broker:
+    args:
+      configuration: json
+  create-tag:
+    args:
+      rule: json
+  add-policy-tag:
+    args:
+      rule: json
+  update-tag-rule:
+    args:
+      rule: json
+  reboot-node:
+    args:
+      hard: boolean

data/lib/razor/cli/parse.rb

@@ -0,0 +1,86 @@
+require 'uri'
+require 'optparse'
+
+module Razor::CLI
+
+  class Parse
+    DEFAULT_RAZOR_API = "http://localhost:8080/api"
+
+    def get_optparse
+      @optparse ||= OptionParser.new do |opts|
+        opts.banner = "Usage: razor [FLAGS] NAVIGATION\n"
+
+        opts.on "-d", "--dump", "Dumps API output to the screen" do
+          @dump = true
+        end
+
+        opts.on "-u", "--url URL",
+          "The full Razor API URL, can also be set\n" + " "*37 +
+          "with the RAZOR_API environment variable\n" + " "*37 +
+          "(default #{DEFAULT_RAZOR_API})" do |url|
+          parse_and_set_api_url(url, :opts)
+        end
+
+        opts.on "-h", "--help", "Show this screen" do
+          @option_help = true
+        end
+
+      end
+    end
+
+    def list_things(name, items)
+      "\n    #{name}:\n" +
+        items.map {|x| x["name"]}.compact.sort.map do |name|
+        "        #{name}"
+      end.join("\n")
+    end
+
+    def help
+      output = get_optparse.to_s
+      begin
+        output << list_things("Collections", navigate.collections)
+        output << "\n\n      Navigate to entries of a collection using COLLECTION NAME, for example,\n      'nodes node15'  for the  details of a node or 'nodes node15 log' to see\n      the log for node15\n"
+        output << list_things("Commands", navigate.commands)
+        output << "\n\n      Pass arguments to commands either directly by name ('--name=NAME')\n      or save the JSON body for the  command  in a file and pass it with\n      '--json FILE'.  Using --json is the only way to pass  arguments in\n      nested structures such as the configuration for a broker.\n"
+      rescue
+        output << "\nCould not connect to the server at #{@api_url}. More help is available after "
+        output << "pointing\nthe client to a Razor server"
+      end
+      output
+    end
+
+    def show_help?
+      !!@option_help
+    end
+
+    def dump_response?
+      !!@dump
+    end
+
+    attr_reader :api_url
+
+    def initialize(args)
+      parse_and_set_api_url(ENV["RAZOR_API"] || DEFAULT_RAZOR_API, :env)
+      @args = args.dup
+      rest = get_optparse.order(args)
+      if rest.any?
+        @navigation = rest
+      else
+        @option_help = true
+      end
+    end
+
+    def navigate
+      @navigate ||=Navigate.new(self, @navigation)
+    end
+
+    private
+    def parse_and_set_api_url(url, source)
+      begin
+        @api_url = URI.parse(url)
+      rescue URI::InvalidURIError => e
+        raise Razor::CLI::InvalidURIError.new(url, source)
+      end
+    end
+  end
+end

data/pe-razor-client.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "pe-razor-client"
+  spec.version       = "0.14.0"
+  spec.authors       = ["Puppet Labs"]
+  spec.email         = ["info@puppetlabs.com"]
+  spec.description   = "The client for the Razor server"
+  spec.summary       = "The client for everybody's favorite provisioning tool"
+  spec.homepage      = "https://github.com/puppetlabs/razor-client"
+  spec.license       = "ASL2"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.bindir        = "bin"
+  spec.executables   = ['razor']
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version
+
+  # mime-types is a dependency of rest-client. We need to explicitly depend
+  # on it and pin its version to make sure the gem works with Ruby 1.8.7
+  spec.add_dependency "mime-types", '< 2.0'
+  spec.add_dependency "multi_json"
+  spec.add_dependency "rest-client"
+  spec.add_dependency "terminal-table"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/cli/navigate_spec.rb

@@ -0,0 +1,52 @@
+# 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::Navigate do
+  context "with no path", :vcr do
+    subject(:nav) {Razor::CLI::Parse.new([]).navigate}
+    it do
+      nav.get_document.should_not be_nil
+      nav.get_document.should == nav.entrypoint
+    end
+  end
+
+  context "with a single item path", :vcr do
+    subject(:nav) {Razor::CLI::Parse.new(["tags"]).navigate}
+    it { nav.get_document.should == []}
+
+    it do
+      nav.get_document;
+      nav.last_url.to_s.should =~ %r{/api/collections/tags$}
+    end
+  end
+
+  context "with an invalid path", :vcr do
+    subject(:nav) {Razor::CLI::Parse.new(["going","nowhere"]).navigate}
+
+    it {expect{nav.get_document}.to raise_error Razor::CLI::NavigationError}
+  end
+
+  context "with authentication", :vcr do
+    AuthArg = %w[-u http://fred:dead@localhost:8080/api].freeze
+
+    it "should supply that to the API service" do
+      nav = Razor::CLI::Parse.new(AuthArg).navigate
+      nav.get_document.should be_an_instance_of Hash
+      URI.parse(nav.last_url.to_s).userinfo.should == "fred:dead"
+    end
+
+    it "should preserve that across navigation" do
+      nav = Razor::CLI::Parse.new(AuthArg + ['tags']).navigate
+      nav.get_document.should == []
+      URI.parse(nav.last_url.to_s).userinfo.should == "fred:dead"
+    end
+  end
+end

data/spec/cli/parse_spec.rb

@@ -0,0 +1,76 @@
+# 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 "rspec/expectations"
+require_relative '../spec_helper'
+
+describe Razor::CLI::Parse do
+
+  def parse(*args)
+    Razor::CLI::Parse.new(args)
+  end
+
+  describe "#new" do
+    context "with no arguments" do
+      it {parse.show_help?.should be true}
+    end
+
+    context "with a '-h'" do
+      it {parse("-h").show_help?.should be true}
+    end
+
+    context "with a '-d'" do
+      it {parse("-d").dump_response?.should be true}
+    end
+
+    context "with a '-u'" do
+      it "should use the given URL" do
+        url = 'http://razor.example.com:2150/path/to/api'
+        parse('-u',url).api_url.to_s.should == url
+      end
+
+      it "should terminate with an error if an invalid URL is provided" do
+        expect{parse('-u','not valid url')}.to raise_error(Razor::CLI::InvalidURIError)
+      end
+    end
+
+    context "with ENV RAZOR_API set" do
+      it "should use the given URL" do
+        url = 'http://razor.example.com:2150/env/path/to/api'
+        ENV["RAZOR_API"] = url
+        parse.api_url.to_s.should == url
+      end
+
+      it "should use -u before ENV" do
+        env_url = 'http://razor.example.com:2150/env/path/to/api'
+        url = 'http://razor.example.com:2150/path/to/api'
+        ENV["RAZOR_API"] = env_url
+        parse('-u',url).api_url.to_s.should == url
+      end
+
+      it "should terminate with an error if an invalid URL is provided" do
+        ENV["RAZOR_API"] = 'not valid url'
+        expect{parse}.to raise_error(Razor::CLI::InvalidURIError)
+      end
+    end
+
+    describe "#help", :vcr do
+      subject(:p) {parse}
+      it { should respond_to :help}
+
+      it { p.help.should be_a String}
+
+      it "should print a list of known endpoints" do
+        p.navigate.should_receive(:collections).and_return([])
+        p.navigate.should_receive(:commands).and_return([])
+        p.help
+      end
+    end
+  end
+end

data/spec/fixtures/vcr/Razor_CLI_Navigate/with_a_single_item_path/.yml

@@ -0,0 +1,69 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8080/api
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json;charset=utf-8
+      Content-Length:
+      - '1566'
+      Date:
+      - Wed, 28 Aug 2013 21:46:05 GMT
+    body:
+      encoding: US-ASCII
+      string: ! '{"commands":[{"name":"create-image","rel":"http://api.puppetlabs.com/razor/v1/commands/create-image","id":"http://localhost:8080/api/commands/create-image"},{"name":"delete-image","rel":"http://api.puppetlabs.com/razor/v1/commands/delete-image","id":"http://localhost:8080/api/commands/delete-image"},{"name":"create-installer","rel":"http://api.puppetlabs.com/razor/v1/commands/create-installer","id":"http://localhost:8080/api/commands/create-installer"},{"name":"create-tag","rel":"http://api.puppetlabs.com/razor/v1/commands/create-tag","id":"http://localhost:8080/api/commands/create-tag"},{"name":"create-broker","rel":"http://api.puppetlabs.com/razor/v1/commands/create-broker","id":"http://localhost:8080/api/commands/create-broker"},{"name":"create-policy","rel":"http://api.puppetlabs.com/razor/v1/commands/create-policy","id":"http://localhost:8080/api/commands/create-policy"}],"collections":[{"name":"brokers","rel":"http://api.puppetlabs.com/razor/v1/collections/brokers","id":"http://localhost:8080/api/collections/brokers"},{"name":"images","rel":"http://api.puppetlabs.com/razor/v1/collections/images","id":"http://localhost:8080/api/collections/images"},{"name":"tags","rel":"http://api.puppetlabs.com/razor/v1/collections/tags","id":"http://localhost:8080/api/collections/tags"},{"name":"policies","rel":"http://api.puppetlabs.com/razor/v1/collections/policies","id":"http://localhost:8080/api/collections/policies"},{"name":"nodes","rel":"http://api.puppetlabs.com/razor/v1/collections/nodes","id":"http://localhost:8080/api/collections/nodes"}]}'
+    http_version: 
+  recorded_at: Wed, 28 Aug 2013 21:46:05 GMT
+- request:
+    method: get
+    uri: http://localhost:8080/api/collections/tags
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json;charset=utf-8
+      Content-Length:
+      - '2'
+      Date:
+      - Wed, 28 Aug 2013 21:46:05 GMT
+    body:
+      encoding: US-ASCII
+      string: ! '[]'
+    http_version: 
+  recorded_at: Wed, 28 Aug 2013 21:46:05 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/vcr/Razor_CLI_Navigate/with_an_invalid_path/.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8080/api
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json;charset=utf-8
+      Content-Length:
+      - '1566'
+      Date:
+      - Wed, 28 Aug 2013 21:46:05 GMT
+    body:
+      encoding: US-ASCII
+      string: ! '{"commands":[{"name":"create-image","rel":"http://api.puppetlabs.com/razor/v1/commands/create-image","id":"http://localhost:8080/api/commands/create-image"},{"name":"delete-image","rel":"http://api.puppetlabs.com/razor/v1/commands/delete-image","id":"http://localhost:8080/api/commands/delete-image"},{"name":"create-installer","rel":"http://api.puppetlabs.com/razor/v1/commands/create-installer","id":"http://localhost:8080/api/commands/create-installer"},{"name":"create-tag","rel":"http://api.puppetlabs.com/razor/v1/commands/create-tag","id":"http://localhost:8080/api/commands/create-tag"},{"name":"create-broker","rel":"http://api.puppetlabs.com/razor/v1/commands/create-broker","id":"http://localhost:8080/api/commands/create-broker"},{"name":"create-policy","rel":"http://api.puppetlabs.com/razor/v1/commands/create-policy","id":"http://localhost:8080/api/commands/create-policy"}],"collections":[{"name":"brokers","rel":"http://api.puppetlabs.com/razor/v1/collections/brokers","id":"http://localhost:8080/api/collections/brokers"},{"name":"images","rel":"http://api.puppetlabs.com/razor/v1/collections/images","id":"http://localhost:8080/api/collections/images"},{"name":"tags","rel":"http://api.puppetlabs.com/razor/v1/collections/tags","id":"http://localhost:8080/api/collections/tags"},{"name":"policies","rel":"http://api.puppetlabs.com/razor/v1/collections/policies","id":"http://localhost:8080/api/collections/policies"},{"name":"nodes","rel":"http://api.puppetlabs.com/razor/v1/collections/nodes","id":"http://localhost:8080/api/collections/nodes"}]}'
+    http_version: 
+  recorded_at: Wed, 28 Aug 2013 21:46:05 GMT
+recorded_with: VCR 2.5.0

data/spec/fixtures/vcr/Razor_CLI_Navigate/with_authentication/should_preserve_that_across_navigation.yml

@@ -0,0 +1,102 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8080/api/collections/tags
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json;charset=utf-8
+      Content-Length:
+      - '73'
+      Date:
+      - Wed, 29 Jan 2014 21:06:11 GMT
+    body:
+      encoding: US-ASCII
+      string: ! '{"spec":"http://api.puppetlabs.com/razor/v1/collections/tags","items":[]}'
+    http_version: 
+  recorded_at: Wed, 29 Jan 2014 21:06:11 GMT
+- request:
+    method: get
+    uri: http://fred:dead@localhost:8080/api
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json;charset=utf-8
+      Content-Length:
+      - '4491'
+      Date:
+      - Wed, 29 Jan 2014 21:14:20 GMT
+    body:
+      encoding: US-ASCII
+      string: ! '{"commands":[{"name":"create-repo","rel":"http://api.puppetlabs.com/razor/v1/commands/create-repo","id":"http://localhost:8080/api/commands/create-repo"},{"name":"delete-repo","rel":"http://api.puppetlabs.com/razor/v1/commands/delete-repo","id":"http://localhost:8080/api/commands/delete-repo"},{"name":"delete-node","rel":"http://api.puppetlabs.com/razor/v1/commands/delete-node","id":"http://localhost:8080/api/commands/delete-node"},{"name":"delete-policy","rel":"http://api.puppetlabs.com/razor/v1/commands/delete-policy","id":"http://localhost:8080/api/commands/delete-policy"},{"name":"update-node-metadata","rel":"http://api.puppetlabs.com/razor/v1/commands/update-node-metadata","id":"http://localhost:8080/api/commands/update-node-metadata"},{"name":"remove-node-metadata","rel":"http://api.puppetlabs.com/razor/v1/commands/remove-node-metadata","id":"http://localhost:8080/api/commands/remove-node-metadata"},{"name":"modify-node-metadata","rel":"http://api.puppetlabs.com/razor/v1/commands/modify-node-metadata","id":"http://localhost:8080/api/commands/modify-node-metadata"},{"name":"reinstall-node","rel":"http://api.puppetlabs.com/razor/v1/commands/reinstall-node","id":"http://localhost:8080/api/commands/reinstall-node"},{"name":"set-node-ipmi-credentials","rel":"http://api.puppetlabs.com/razor/v1/commands/set-node-ipmi-credentials","id":"http://localhost:8080/api/commands/set-node-ipmi-credentials"},{"name":"reboot-node","rel":"http://api.puppetlabs.com/razor/v1/commands/reboot-node","id":"http://localhost:8080/api/commands/reboot-node"},{"name":"set-node-desired-power-state","rel":"http://api.puppetlabs.com/razor/v1/commands/set-node-desired-power-state","id":"http://localhost:8080/api/commands/set-node-desired-power-state"},{"name":"create-task","rel":"http://api.puppetlabs.com/razor/v1/commands/create-task","id":"http://localhost:8080/api/commands/create-task"},{"name":"create-tag","rel":"http://api.puppetlabs.com/razor/v1/commands/create-tag","id":"http://localhost:8080/api/commands/create-tag"},{"name":"delete-tag","rel":"http://api.puppetlabs.com/razor/v1/commands/delete-tag","id":"http://localhost:8080/api/commands/delete-tag"},{"name":"update-tag-rule","rel":"http://api.puppetlabs.com/razor/v1/commands/update-tag-rule","id":"http://localhost:8080/api/commands/update-tag-rule"},{"name":"create-broker","rel":"http://api.puppetlabs.com/razor/v1/commands/create-broker","id":"http://localhost:8080/api/commands/create-broker"},{"name":"delete-broker","rel":"http://api.puppetlabs.com/razor/v1/commands/delete-broker","id":"http://localhost:8080/api/commands/delete-broker"},{"name":"create-policy","rel":"http://api.puppetlabs.com/razor/v1/commands/create-policy","id":"http://localhost:8080/api/commands/create-policy"},{"name":"move-policy","rel":"http://api.puppetlabs.com/razor/v1/commands/move-policy","id":"http://localhost:8080/api/commands/move-policy"},{"name":"enable-policy","rel":"http://api.puppetlabs.com/razor/v1/commands/enable-policy","id":"http://localhost:8080/api/commands/enable-policy"},{"name":"disable-policy","rel":"http://api.puppetlabs.com/razor/v1/commands/disable-policy","id":"http://localhost:8080/api/commands/disable-policy"},{"name":"add-policy-tag","rel":"http://api.puppetlabs.com/razor/v1/commands/add-policy-tag","id":"http://localhost:8080/api/commands/add-policy-tag"},{"name":"remove-policy-tag","rel":"http://api.puppetlabs.com/razor/v1/commands/remove-policy-tag","id":"http://localhost:8080/api/commands/remove-policy-tag"},{"name":"modify-policy-max-count","rel":"http://api.puppetlabs.com/razor/v1/commands/modify-policy-max-count","id":"http://localhost:8080/api/commands/modify-policy-max-count"}],"collections":[{"name":"brokers","rel":"http://api.puppetlabs.com/razor/v1/collections/brokers","id":"http://localhost:8080/api/collections/brokers"},{"name":"repos","rel":"http://api.puppetlabs.com/razor/v1/collections/repos","id":"http://localhost:8080/api/collections/repos"},{"name":"tags","rel":"http://api.puppetlabs.com/razor/v1/collections/tags","id":"http://localhost:8080/api/collections/tags"},{"name":"policies","rel":"http://api.puppetlabs.com/razor/v1/collections/policies","id":"http://localhost:8080/api/collections/policies"},{"name":"nodes","rel":"http://api.puppetlabs.com/razor/v1/collections/nodes","id":"http://localhost:8080/api/collections/nodes"},{"name":"tasks","rel":"http://api.puppetlabs.com/razor/v1/collections/tasks","id":"http://localhost:8080/api/collections/tasks"}]}'
+    http_version: 
+  recorded_at: Wed, 29 Jan 2014 21:14:20 GMT
+- request:
+    method: get
+    uri: http://fred:dead@localhost:8080/api/collections/tags
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json;charset=utf-8
+      Content-Length:
+      - '73'
+      Date:
+      - Wed, 29 Jan 2014 21:14:20 GMT
+    body:
+      encoding: US-ASCII
+      string: ! '{"spec":"http://api.puppetlabs.com/razor/v1/collections/tags","items":[]}'
+    http_version: 
+  recorded_at: Wed, 29 Jan 2014 21:14:21 GMT
+recorded_with: VCR 2.5.0