bosh_common 0.4.0 → 0.5.0

data/Rakefile

@@ -19,14 +19,14 @@ require "ci_task"
 
 gem_helper = Bundler::GemHelper.new(Dir.pwd)
 
-desc "Build Blobstore Client gem into the pkg directory"
+desc "Build BOSH Common gem into the pkg directory"
 task "build" do
   gem_helper.build_gem
 end
 
-desc "Build and install Blobstore Client into system gems"
+desc "Build and install BOSH Common into system gems"
 task "install" do
-  sh("bundle install --local --without test development")
+  Rake::Task["bundler:install"].invoke
   gem_helper.install_gem
 end
 
@@ -36,7 +36,6 @@ if defined?(RSpec)
   namespace :spec do
     desc "Run Unit Tests"
     rspec_task = RSpec::Core::RakeTask.new(:unit) do |t|
-      t.gemfile = "Gemfile"
       t.pattern = "spec/unit/**/*_spec.rb"
       t.rspec_opts = %w(--format progress --colour)
     end
@@ -46,6 +45,6 @@ if defined?(RSpec)
     end
   end
 
-  desc "Install dependencies and run tests"
-  task :spec => %w(bundler:install:test spec:unit)
-end
+  desc "Run tests"
+  task :spec => %w(spec:unit)
+end

data/lib/common/common.rb

@@ -0,0 +1,47 @@
+# Copyright (c) 2012 VMware, Inc.
+
+module Bosh
+
+  # Module for common methods used throughout the BOSH code.
+  module Common
+
+    # Converts all keys of a [Hash] to symbols. Performs deep conversion.
+    #
+    # @param [Hash] hash to convert
+    # @return [Hash] a copy of the original hash
+    def symbolize_keys(hash)
+      hash.inject({}) do |h, (key, value)|
+        h[key.to_sym] = value.is_a?(Hash) ? symbolize_keys(value) : value
+        h
+      end
+    end
+
+    module_function :symbolize_keys
+
+    # @overload which(program, path)
+    #   Looks for program in the executables search path (PATH).
+    #   The file must be executable to be found.
+    #   @param [String] program
+    #   @param [String] path search path
+    #   @return [String] full path of the executable,
+    #     or nil if not found
+    # @overload which(programs, path)
+    #   Looks for one of the programs in the executables search path (PATH).
+    #   The file must be executable to be found.
+    #   @param [Array] programs
+    #   @param [String] path search path
+    #   @return [String] full path of the executable,
+    #     or nil if not found
+    def which(programs, path=ENV["PATH"])
+      path.split(File::PATH_SEPARATOR).each do |dir|
+        Array(programs).each do |bin|
+          exe = File.join(dir, bin)
+          return exe if File.executable?(exe)
+        end
+      end
+      nil
+    end
+
+    module_function :which
+  end
+end

data/lib/common/exec/error.rb

@@ -0,0 +1,19 @@
+# Copyright (c) 2012 VMware, Inc.
+
+module Bosh::Exec
+# Raised when there was an error executing the command
+  class Error < StandardError
+    def initialize(status, command)
+      @status = status
+      @command = command
+    end
+
+    def message
+      if @status
+        "command '#{@command}' failed with exit code #{@status}"
+      else
+        "command not found: #{@command}"
+      end
+    end
+  end
+end

data/lib/common/exec/result.rb

@@ -0,0 +1,35 @@
+# Copyright (c) 2012 VMware, Inc.
+
+module Bosh::Exec
+  class Result
+    # command that generated the result
+    # @return [String]
+    attr_reader :command
+    # output from the executed command
+    # @return [String]
+    attr_reader :output
+    # exit status of the command
+    # @return [Integer]
+    attr_reader :exit_status
+
+    def initialize(command, output, exit_status, not_found=false)
+      @command = command
+      @output = output
+      @exit_status = exit_status
+      @not_found = not_found
+    end
+
+    def success?
+      @exit_status == 0
+    end
+
+    def failed?
+      @exit_status != 0 || @not_found
+    end
+
+    # true if the command was not found
+    def not_found?
+      @not_found
+    end
+  end
+end

data/lib/common/exec.rb

@@ -0,0 +1,87 @@
+# Copyright (c) 2012 VMware, Inc.
+
+require "common/exec/result"
+require "common/exec/error"
+
+module Bosh
+
+  # Module to execute shell commands using different ways to invoke processes.
+  module Exec
+
+    # Execute commands in a way that forces you to deal with failures and
+    # helps you to simplify testing. The module can be included which will
+    # add sh both as an instance and a class method.
+    #
+    # A sample way to mock the execution of "ls /":
+    #   it "should be possible to mock the result of a command execution" do
+    #     cmd = "ls /"
+    #     result = Bosh::Exec::Result.new(cmd, "bin etc var", "", 0)
+    #     Bosh::Exec.should_receive(:sh).with(cmd).and_return(result)
+    #     result = Bosh::Exec.sh(cmd)
+    #     result.success?.should be_true
+    #   end
+    #
+    # @note As commands are executed using %x{...} you need to append 2>&1 to
+    #   redirect stderr or it will be output to the stderr of the process
+    #   invoking the sh method
+    # @param [String] command shell command to execute
+    # @param [Hash] options
+    # @option options [Symbol] :on_error if set to :return failing commands
+    #   return [Bosh::Exec::Result] instead of raising [Bosh::Exec::Error]
+    # @option options [Symbol] :yield if set to :on_false it will execute
+    #   the block when the command fails, else it will execute the block
+    #   only when the command succeeds. Implies :on_error = :return
+    # @yield [Bosh::Exec::Result] command result
+    # @return [Bosh::Exec::Result] command result
+    # @raise [Bosh::Exec::Error] raised when the command isn't found or
+    #   the command exits with a non zero status
+    # @example by default execute block only when command succeeds and raise
+    #   error on failure
+    #   sh("command") do |result|
+    #     ...
+    #   end
+    # @example don't raise error if the command fails
+    #   result = sh("command", :on_error => :return)
+    # @example execute block only when command fails (which implies
+    #   :on_error => :return)
+    #   sh("command", :yield => :on_false) do |result|
+    #     ...
+    #   end
+    def sh(command, options={})
+      opts = options.dup
+      # can only yield if we don't raise errors
+      opts[:on_error] = :return if opts[:yield] == :on_false
+
+      output = %x{#{command}}
+      result = Result.new(command, output, $?.exitstatus)
+
+      if result.failed?
+        unless opts[:on_error] == :return
+          raise Error.new(result.exit_status, command)
+        end
+        yield result if block_given? && opts[:yield] == :on_false
+
+      else
+        yield result if block_given?
+      end
+
+      result
+    rescue Errno::ENOENT => e
+      msg = "command not found: #{command}"
+
+      raise Error.new(nil, command) unless opts[:on_error] == :return
+
+      result = Result.new(command, msg, -1, true)
+
+      yield result if block_given? && opts[:yield] == :on_false
+      result
+    end
+
+    # Helper method to add sh as a class method when it is included
+    def self.included(base)
+      base.extend(Bosh::Exec)
+    end
+
+    module_function :sh
+  end
+end

data/lib/common/version.rb

@@ -2,6 +2,6 @@
 
 module Bosh
   module Common
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,13 @@
-require 'rspec/core'
+# Copyright (c) 2009-2012 VMware, Inc.
 
-$:.unshift(File.expand_path("../../lib", __FILE__))
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
 
-RSpec.configure do |c|
-  c.color_enabled = true
+require "rubygems"
+require "bundler"
+Bundler.setup(:default, :test)
+
+require "rspec"
+
+def asset(file)
+  File.expand_path(File.join(File.dirname(__FILE__), "assets", file))
 end

data/spec/unit/common_spec.rb

@@ -0,0 +1,59 @@
+# Copyright (c) 2012 VMware, Inc.
+
+require "spec_helper"
+
+require "common/common"
+
+describe Bosh::Common do
+
+  describe "#symbolize_keys" do
+    ORIGINAL = {
+      "foo1" => "bar",
+      :foo2 => "bar",
+      "foo3" => {
+        "foo4" => "bar"
+      }
+    }.freeze
+
+    EXPECTED = {
+      :foo1 => "bar",
+      :foo2 => "bar",
+      :foo3 => {
+        :foo4 => "bar"
+      }
+    }.freeze
+
+    it "should not modify the original hash" do
+      duplicate = ORIGINAL.dup
+      Bosh::Common.symbolize_keys(ORIGINAL)
+      ORIGINAL.should == duplicate
+    end
+
+    it "should return a new hash with all keys as symbols" do
+      Bosh::Common.symbolize_keys(ORIGINAL).should == EXPECTED
+    end
+  end
+
+  describe "#which" do
+    let(:path) {
+      path = ENV["PATH"]
+      path += ":#{File.expand_path('../../assets', __FILE__)}"
+    }
+
+    it "should return the path when it finds the executable" do
+      Bosh::Common.which("foo1", path).should_not be_nil
+    end
+
+    it "should return the path when it finds an executable" do
+      Bosh::Common.which(%w[foo2 foo1], path).should match(%r{/foo1$})
+    end
+
+    it "should return nil when it isn't executable" do
+      Bosh::Common.which("foo2", path).should be_nil
+    end
+
+    it "should return nil when it doesn't find an executable" do
+      Bosh::Common.which("foo1").should be_nil
+    end
+  end
+end

data/spec/unit/exec_spec.rb

@@ -0,0 +1,111 @@
+# Copyright (c) 2012 VMware, Inc.
+
+require "spec_helper"
+require "common/exec"
+
+describe Bosh::Exec do
+  let(:opts) { {} }
+
+  describe "existing command" do
+
+    describe "executes successfully" do
+      it "should not fail" do
+        Bosh::Exec.sh("ls /", opts).failed?.should be_false
+      end
+
+      it "should execute block" do
+        block = false
+        Bosh::Exec.sh("ls /", opts) do
+          block = true
+        end
+        block.should be_true
+      end
+    end
+
+    describe "fails to execute" do
+      it "should raise error by default" do
+        lambda {
+          Bosh::Exec.sh("ls /asdasd 2>&1", opts)
+        }.should raise_error Bosh::Exec::Error
+      end
+
+      it "should yield block on false" do
+        opts[:yield] = :on_false
+        block = false
+        Bosh::Exec.sh("ls /asdasd 2>&1", opts) do
+          block = true
+        end
+        block.should be_true
+      end
+
+      it "should return result" do
+        opts[:on_error] = :return
+        Bosh::Exec.sh("ls /asdasd 2>&1", opts).failed?.should be_true
+      end
+    end
+
+  end
+
+  describe "missing command" do
+    it "should raise error by default" do
+      lambda {
+        Bosh::Exec.sh("/asdasd 2>&1", opts)
+      }.should raise_error Bosh::Exec::Error
+    end
+
+    it "should not raise error when requested" do
+      opts[:on_error] = :return
+      lambda {
+        Bosh::Exec.sh("/asdasd 2>&1", opts)
+      }.should_not raise_error Bosh::Exec::Error
+    end
+
+    it "should execute block when requested" do
+      opts[:yield] = :on_false
+      lambda {
+      Bosh::Exec.sh("/asdasd 2>&1", opts) do
+        raise "foo"
+      end
+      }.should raise_error "foo"
+    end
+
+  end
+
+  describe "mock" do
+    it "should be possible fake result" do
+      cmd = "ls /"
+      result = Bosh::Exec::Result.new(cmd, "output", 0)
+      Bosh::Exec.should_receive(:sh).with(cmd).and_return(result)
+      result = Bosh::Exec.sh(cmd)
+      result.success?.should be_true
+    end
+  end
+
+  describe "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
+    class IncludeTest
+      include Bosh::Exec
+      def run
+        sh("ls /")
+      end
+
+      def self.run
+        sh("ls /")
+      end
+    end
+
+    it "should add instance method" do
+      inc = IncludeTest.new
+      inc.run.success?.should be_true
+    end
+
+    it "should add class method" do
+      IncludeTest.run.success?.should be_true
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bosh_common
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,33 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-22 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &2156296060 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2156296060
-description: Bosh common
+date: 2012-07-27 00:00:00.000000000 Z
+dependencies: []
+description: BOSH common
 email: support@vmware.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README
-- Rakefile
+- lib/common/common.rb
+- lib/common/exec.rb
+- lib/common/exec/error.rb
+- lib/common/exec/result.rb
 - lib/common/thread_formatter.rb
 - lib/common/thread_pool.rb
 - lib/common/version.rb
-- spec/Rakefile
-- spec/lib/cloud/spec.rb
+- README
+- Rakefile
+- spec/assets/foo1
+- spec/assets/foo2
 - spec/spec_helper.rb
+- spec/unit/common_spec.rb
+- spec/unit/exec_spec.rb
 - spec/unit/thread_pool_spec.rb
 homepage: http://www.vmware.com
 licenses: []
@@ -51,7 +46,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -472840810854006979
+      hash: 852108980354805257
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -60,15 +55,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -472840810854006979
+      hash: 852108980354805257
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Bosh common
+summary: BOSH common
 test_files:
-- spec/Rakefile
-- spec/lib/cloud/spec.rb
+- spec/assets/foo1
+- spec/assets/foo2
 - spec/spec_helper.rb
+- spec/unit/common_spec.rb
+- spec/unit/exec_spec.rb
 - spec/unit/thread_pool_spec.rb
+has_rdoc: 

data/spec/Rakefile

@@ -1,87 +0,0 @@
-require "tempfile"
-require "rake"
-
-APP_DIR = File.expand_path(File.join("..", ".."), __FILE__)
-ENV["BUNDLE_GEMFILE"] ||= File.join(APP_DIR, "Gemfile")
-require "rubygems"
-require "bundler"
-Bundler.setup(:default, :test)
-
-require "rspec/core/rake_task"
-require "ci/reporter/rake/rspec"
-
-desc "Run all examples"
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern    = "**/*_spec.rb"
-  t.rspec_opts = %w[--color]
-end
-
-task :default => [:spec]
-
-coverage_dir   = File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_coverage"))
-reports_dir    = File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_reports"))
-dump_file      = File.join(Dir.tmpdir, "bosh-common.rcov")
-
-ENV["CI_REPORTS"] = reports_dir
-
-namespace "spec" do
-  gemfile   = "../Gemfile"
-  spec_opts = ["--format", "documentation", "--colour"]
-
-  if RUBY_VERSION < "1.9"
-    desc "Run specs for ci"
-    task "ci" => [ "ci:setup:rspec", "spec:rcov", "convert_rcov_to_clover" ]
-
-    desc "Run spec with coverage"
-    RSpec::Core::RakeTask.new("rcov") do |t|
-      FileUtils.rm_rf(dump_file)
-      t.gemfile    = gemfile
-      t.pattern    = "**/*_spec.rb"
-      t.rspec_opts = ["--format", "progress", "--colour"]
-      t.rcov       = true
-      t.rcov_opts  = %W{--aggregate #{dump_file} --exclude osx\/objc,gems\/,spec\/,unit\/,features\/ -o "#{coverage_dir}"}
-    end
-
-    task "convert_rcov_to_clover" do |t|
-      ignore_pattern = "spec,[.]bundle,[/]gems[/]"
-      clover_output  = File.join(coverage_dir, "clover.xml")
-
-      sh("bundle exec rcov_analyzer #{dump_file} #{ignore_pattern} > #{clover_output}")
-      FileUtils.rm_rf(dump_file)
-    end
-
-  else
-    desc "Run specs for ci"
-    task "ci" => [ "ci:setup:rspec", "spec:rcov" ]
-
-    desc "Run spec with coverage"
-    task :rcov => :cleanup_coverage do
-      require "simplecov"
-      require "simplecov-rcov"
-      require "simplecov-clover"
-
-      class SimpleCov::Formatter::CombinedFormatter
-        def format(result)
-          SimpleCov::Formatter::CloverFormatter.new.format(result)
-          SimpleCov::Formatter::RcovFormatter.new.format(result)
-        end
-      end
-
-      SimpleCov.formatter = SimpleCov::Formatter::CombinedFormatter
-      SimpleCov.root('..')
-      SimpleCov.coverage_dir('cov')
-      SimpleCov.start do
-        require "rspec/core"
-        add_filter "/spec/"
-        spec_dir = File.expand_path("..", __FILE__)
-        RSpec::Core::Runner.disable_autorun!
-        RSpec::Core::Runner.run([spec_dir], STDERR, STDOUT)
-      end
-    end
-  end
-
-  task "cleanup_coverage" do
-    rm_rf "cov"
-  end
-
-end

data/spec/lib/cloud/spec.rb

@@ -1,8 +0,0 @@
-module Bosh
-  module Clouds
-    class Spec
-      def initialize(options)
-      end
-    end
-  end
-end