bosh_common 0.5.1 → 0.5.3

data/lib/common/exec/error.rb

@@ -3,9 +3,12 @@
 module Bosh::Exec
 # Raised when there was an error executing the command
   class Error < StandardError
-    def initialize(status, command)
+    attr_reader :output
+
+    def initialize(status, command, output=nil)
       @status = status
       @command = command
+      @output = output
     end
 
     def message
@@ -15,5 +18,9 @@ module Bosh::Exec
         "command not found: #{@command}"
       end
     end
+
+    def to_s
+      message
+    end
   end
-end
+end

data/lib/common/exec.rb

@@ -1,5 +1,7 @@
 # Copyright (c) 2012 VMware, Inc.
 
+module Bosh; end
+
 require "common/exec/result"
 require "common/exec/error"
 
@@ -57,7 +59,7 @@ module Bosh
 
       if result.failed?
         unless opts[:on_error] == :return
-          raise Error.new(result.exit_status, command)
+          raise Error.new(result.exit_status, command, output)
         end
         yield result if block_given? && opts[:yield] == :on_false
 

data/lib/common/properties/template_evaluation_context.rb

@@ -14,6 +14,9 @@ module Bosh::Common
     # @return [Hash] Template properties
     attr_reader :properties
 
+    # @return [Hash] Raw template properties (no openstruct)
+    attr_reader :raw_properties
+
     # @return [Hash] Template spec
     attr_reader :spec
 
@@ -43,16 +46,46 @@ module Bosh::Common
     end
 
     # Property lookup helper
-    # @param [String] name Property name
-    # @param [optional, Object] default Default value
-    # @return [Object] Property value
-    def p(name, default = nil)
-      result = lookup_property(@raw_properties, name)
-      if result.nil?
-        return default if default
-        raise UnknownProperty.new(name)
+    #
+    # @overload p(name, default_value)
+    #   Returns property value or default value if property not set
+    #   @param [String] name Property name
+    #   @param [Object] default_value Default value
+    #   @return [Object] Property value
+    #
+    # @overload p(names, default_value)
+    #   Returns first property from the list that is set or default value if
+    #   none of them are set
+    #   @param [Array<String>] names Property names
+    #   @param [Object] default_value Default value
+    #   @return [Object] Property value
+    #
+    # @overload p(names)
+    #   Looks up first property from the list that is set, raises an error
+    #   if none of them are set.
+    #   @param [Array<String>] names Property names
+    #   @return [Object] Property value
+    #   @raise [Bosh::Common::UnknownProperty]
+    #
+    # @overload p(name)
+    #   Looks up property and raises an error if it's not set
+    #   @param [String] name Property name
+    #   @return [Object] Property value
+    #   @raise [Bosh::Common::UnknownProperty]
+    def p(*args)
+      names = args[0]
+      default_given = args.size > 1
+      default = args[1]
+
+      names = Array(names) unless names.kind_of?(Array)
+
+      names.each do |name|
+        result = lookup_property(@raw_properties, name)
+        return result if result
       end
-      result
+
+      return default if default_given
+      raise UnknownProperty.new(name)
     end
 
     # Run a block of code if all given properties are defined

data/lib/common/version.rb

@@ -2,6 +2,6 @@
 
 module Bosh
   module Common
-    VERSION = "0.5.1"
+    VERSION = "0.5.3"
   end
 end

data/spec/unit/exec_spec.rb

@@ -6,9 +6,9 @@ require "common/exec"
 describe Bosh::Exec do
   let(:opts) { {} }
 
-  describe "existing command" do
+  context "existing command" do
 
-    describe "executes successfully" do
+    context "executes successfully" do
       it "should not fail" do
         Bosh::Exec.sh("ls /", opts).failed?.should be_false
       end
@@ -22,11 +22,14 @@ describe Bosh::Exec do
       end
     end
 
-    describe "fails to execute" do
+    context "fails to execute" do
       it "should raise error by default" do
-        lambda {
+        expect {
           Bosh::Exec.sh("ls /asdasd 2>&1", opts)
-        }.should raise_error Bosh::Exec::Error
+        }.to raise_error { |error|
+          error.should be_a Bosh::Exec::Error
+          error.output.should match /No such file or directory/
+        }
       end
 
       it "should yield block on false" do
@@ -46,32 +49,32 @@ describe Bosh::Exec do
 
   end
 
-  describe "missing command" do
+  context "missing command" do
     it "should raise error by default" do
-      lambda {
+      expect {
         Bosh::Exec.sh("/asdasd 2>&1", opts)
-      }.should raise_error Bosh::Exec::Error
+      }.to raise_error Bosh::Exec::Error
     end
 
     it "should not raise error when requested" do
       opts[:on_error] = :return
-      lambda {
+      expect {
         Bosh::Exec.sh("/asdasd 2>&1", opts)
-      }.should_not raise_error Bosh::Exec::Error
+      }.to_not raise_error Bosh::Exec::Error
     end
 
     it "should execute block when requested" do
       opts[:yield] = :on_false
-      lambda {
+      expect {
       Bosh::Exec.sh("/asdasd 2>&1", opts) do
         raise "foo"
       end
-      }.should raise_error "foo"
+      }.to raise_error "foo"
     end
 
   end
 
-  describe "mock" do
+  context "mock" do
     it "should be possible fake result" do
       cmd = "ls /"
       result = Bosh::Exec::Result.new(cmd, "output", 0)
@@ -81,13 +84,13 @@ describe Bosh::Exec do
     end
   end
 
-  describe "module" do
+  context "module" do
     it "should be possible to invoke as a module" do
       Bosh::Exec.sh("ls /").success?.should be_true
     end
   end
 
-  describe "include" do
+  context "include" do
     class IncludeTest
       include Bosh::Exec
       def run

data/spec/unit/properties/template_evaluation_context_spec.rb

@@ -32,6 +32,11 @@ describe Bosh::Common::TemplateEvaluationContext do
     eval_template("<%= properties.foo %>", @context).should == "bar"
   end
 
+  it "retains raw_properties" do
+    eval_template("<%= raw_properties['router']['token'] %>", @context).
+      should == "zbb"
+  end
+
   it "supports looking up template index" do
     eval_template("<%= spec.index %>", @context).should == "0"
   end
@@ -45,6 +50,32 @@ describe Bosh::Common::TemplateEvaluationContext do
     eval_template("<%= p('bar.baz', 22) %>", @context).should == "22"
   end
 
+  it "supports chaining property lookup via 'p' helper" do
+    eval_template(<<-TMPL, @context).strip.should == "zbb"
+      <%= p(%w(a b router.token c)) %>
+    TMPL
+
+    expect {
+      eval_template(<<-TMPL, @context)
+        <%= p(%w(a b c)) %>
+      TMPL
+    }.to raise_error(Bosh::Common::UnknownProperty)
+
+    eval_template(<<-TMPL, @context).strip.should == "22"
+      <%= p(%w(a b c), 22) %>
+    TMPL
+  end
+
+  it "allows 'false' and 'nil' defaults for 'p' helper" do
+    eval_template(<<-TMPL, @context).strip.should == "false"
+      <%= p(%w(a b c), false) %>
+    TMPL
+
+    eval_template(<<-TMPL, @context).strip.should == ""
+      <%= p(%w(a b c), nil) %>
+    TMPL
+  end
+
   it "supports 'if_p' helper" do
     template = <<-TMPL
       <% if_p("router.token") do |token| %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bosh_common
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-05 00:00:00.000000000 Z
+date: 2012-12-27 00:00:00.000000000 Z
 dependencies: []
 description: BOSH common
 email: support@vmware.com
@@ -50,18 +50,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -411355085407901587
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -411355085407901587
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24