rconf 0.7.6 → 0.7.8

data/lib/rconf/configurator_registry.rb

@@ -48,7 +48,7 @@ module RightConf
     # === Return
     # true:: Always return true
     def each(&blk)
-      @configurators.each(&blk)
+      @configurators.keys.map(&:to_s).sort.each { |k| blk.call(k, @configurators[k.to_sym]) }
       true
     end
 

data/lib/rconf/configurators/build_configurator.rb

@@ -0,0 +1,73 @@
+# Copyright (C) 2011 RightScale, Inc, All Rights Reserved Worldwide.
+#
+# THIS PROGRAM IS CONFIDENTIAL AND PROPRIETARY TO RIGHTSCALE
+# AND CONSTITUTES A VALUABLE TRADE SECRET. Any unauthorized use,
+# reproduction, modification, or disclosure of this program is
+# strictly prohibited. Any use of this program by an authorized
+# licensee is strictly subject to the terms and conditions,
+# including confidentiality obligations, set forth in the applicable
+# License Agreement between RightScale.com, Inc. and
+# the licensee
+
+module RightConf
+
+  class BuildConfigurator
+
+    include Configurator
+
+    register :build
+
+    description 'Builds a repository using the ./configure, make, make install commands'
+
+    settings :path           => 'Path to source files',
+             :pre_step       => 'Command ran prior to ./configure',
+             :message        => 'Progress message to display if any while building',
+             :configure_opts => 'Hash of options to be given to the configure script. ' +
+                                'The keys are the platform families (:darwin, :linux or :windows)',
+             :only_if        => 'Ruby code that should return true for build to proceed'
+
+    validate_has_settings :path
+
+    # Run command line
+    #
+    # === Return
+    # true:: Always return true
+    def run
+      if only_if.nil? || instance_eval(only_if)
+        message("Building #{path}") if message.nil?
+        report_check message
+        Dir.chdir(path) do
+          Command.execute(*command_args(pre_step)) if pre_step
+          opts = configure_opts && configure_opts[Platform.family]
+          Command.execute(*command_args("./configure #{opts}"))
+          Command.execute(*command_args('make'))
+          report_success
+          report("Please enter you password to run the install step")
+          Command.sudo('echo')
+          report_check 'Installing'
+          Command.sudo(*command_args('make install'))
+        end
+        report_success
+      end
+      true
+    end
+
+    protected
+
+    # Build arguments for Command.execute from command line
+    #
+    # === Arguments
+    # command(String):: Command line to run
+    #
+    # === Return
+    # args(Array):: Array of arguments to be passed to Command.execute
+    def command_args(command)
+      args = command.split(' ').compact
+      args += [ { :abort_on_failure => "Failed to run #{command.rstrip}" } ]
+    end
+
+  end
+end
+
+
+

data/lib/rconf/configurators/execute_configurator.rb

@@ -0,0 +1,46 @@
+# Copyright (C) 2011 RightScale, Inc, All Rights Reserved Worldwide.
+#
+# THIS PROGRAM IS CONFIDENTIAL AND PROPRIETARY TO RIGHTSCALE
+# AND CONSTITUTES A VALUABLE TRADE SECRET. Any unauthorized use,
+# reproduction, modification, or disclosure of this program is
+# strictly prohibited. Any use of this program by an authorized
+# licensee is strictly subject to the terms and conditions,
+# including confidentiality obligations, set forth in the applicable
+# License Agreement between RightScale.com, Inc. and
+# the licensee
+
+module RightConf
+
+  class ExecuteConfigurator
+
+    include Configurator
+
+    register :execute
+
+    description 'Run arbitraty shell commands'
+
+    settings :command_line     => 'Command line to run',
+             :message          => 'Progress message to display if any while command is running',
+             :abort_on_failure => 'Message to display when aborting configuration if command fails. ' +
+                                  'Do not abort if not set'
+
+    validate_has_settings :command_line
+
+    # Run command line
+    #
+    # === Return
+    # true:: Always return true
+    def run
+      report_check message if message
+      args = command_line.split(' ')
+      args += [ { :abort_on_failure => abort_on_failure } ] if abort_on_failure
+      Command.execute(*args)
+      report_success if message
+      true
+    end
+
+  end
+end
+
+
+

data/lib/rconf/configurators/git_repo_configurator.rb

@@ -19,38 +19,33 @@ module RightConf
 
     description 'Clone git repository and build if needed'
 
-    settings :repo           => 'git repo URL',
-             :tag            => 'git tag or branch or sha that should be checked out',
-             :install_path   => 'Path where git repo should be cloned to',
-             :build_commands => 'Comma separated list of commands to run in repo after clone',
-             :only_if        => 'Ruby lambda expression that should return true to proceed ' +
-                                'with the cloning / build if defined'
+    settings :repo => 'git repo URL',
+             :path => 'Path where git repo should be cloned to',
+             :tag  => 'git tag or branch or sha that should be checked out ("master" by default)'
 
-    validate_has_settings :repo, :install_path
+    validate_has_settings :repo, :path
     
     # Clone git repo and run build commands if given
     #
     # === Return
     # true:: Always return true
     def run
-      if only_if.nil? || only_if.call
-        report_check("Cloning #{repo} into #{install_path}")
-        if File.exist?(install_path)
-          FileUtils.mv(install_path, "#{install_path}_old") 
-          post_note "Had to move pre-existing #{install_path} to #{install_path}_old"
+      if File.exist?(path)
+        unless File.exist?(File.join(path, '.git'))
+          FileUtils.mv(path, "#{path}_old") 
+          post_note "Had to move #{path} to #{path}_old"
         end
-        Command.execute('git', 'clone', repo, install_path, 
-                        :abort_on_failure => "Failed to clone #{repo} into #{install_path}")
-        Command.execute('git', 'checkout', tag) if tag
+      end
+      unless File.exist?(path)
+        report_check("Cloning #{repo} into #{path}")
+        Command.execute('git', 'clone', repo, path, 
+                        :abort_on_failure => "Failed to clone #{repo} into #{path}")
         report_success
-        if build_commands
-          report_check "Building"
-          Dir.chdir(install_path) do
-            build_commands.split(',').each do |c|
-              c.lstrip!
-              args = c.split(' ') +  [ { :abort_on_failure => "#{c} failed" } ]
-              Command.execute(*args)
-            end
+        if tag
+          report_check("Checking out #{tag}")
+          Dir.chdir(path) do
+            Command.execute('git', 'checkout', tag,
+                            :abort_on_failure => "Failed to checkout #{tag}")
           end
           report_success
         end
@@ -58,16 +53,6 @@ module RightConf
       true
     end
 
-    # Clone on Windows 
-    #
-    # === Return
-    # true:: Always return true
-    def run_windows
-      # TBD
-    end
-
   end
 end
 
-
-

data/lib/rconf/support/environment_updater.rb

@@ -59,8 +59,8 @@ module RightConf
           end
           FileUtils.mv(bashrc_path, bashrc_path + '.old')
           File.open(bashrc_path, 'w') { |f| f.puts content }
+          updated = true
         end
-        updated = true
       else
         report_error "Failed to update bash resource or profile: file not found"
       end

data/lib/rconf/version.rb

@@ -13,7 +13,7 @@ module RightConf
 
   MAJOR = 0
   MINOR = 7
-  BUILD = 6
+  BUILD = 8
 
   VERSION = [MAJOR, MINOR, BUILD].map(&:to_s).join('.')
 

data/spec/configurators/build_configurator_spec.rb

@@ -0,0 +1,41 @@
+# Copyright (C) 2011 RightScale, Inc, All Rights Reserved Worldwide.
+#
+# THIS PROGRAM IS CONFIDENTIAL AND PROPRIETARY TO RIGHTSCALE
+# AND CONSTITUTES A VALUABLE TRADE SECRET. Any unauthorized use,
+# reproduction, modification, or disclosure of this program is
+# strictly prohibited. Any use of this program by an authorized
+# licensee is strictly subject to the terms and conditions,
+# including confidentiality obligations, set forth in the applicable
+# License Agreement between RightScale.com, Inc. and
+# the licensee
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe RightConf::BuildConfigurator do
+
+  before(:each) do
+    lang = RightConf::Language.parse('build { path "../source" }')
+    @configurator = lang.configurators.first
+    [:report_check, :report_result, :report_success].each do |meth|
+      flexmock(@configurator).should_receive(meth)
+    end
+    flexmock(@configurator).should_receive(:report_fatal).and_return { |*args| raise args.join(' ') }
+  end
+
+  it 'should build' do
+    flexmock(Dir).should_receive(:chdir).with('../source', Proc).once.and_yield
+    should_execute('./configure', {:abort_on_failure=>"Failed to run ./configure"}).once.ordered
+    should_execute('make', {:abort_on_failure=>"Failed to run make"}).once.ordered
+    should_sudo('echo').once.ordered
+    should_sudo('make', 'install', {:abort_on_failure=>"Failed to run make install"}).once.ordered
+    @configurator.run
+  end
+
+  it 'should honor only_if' do
+    @configurator.instance_eval { only_if('false') }
+    should_execute.and_return { raise "Command should not execute" }
+    @configurator.run
+  end
+
+end
+

data/spec/configurators/bundler_configurator_spec.rb

@@ -32,23 +32,19 @@ describe RightConf::BundlerConfigurator do
   end
 
   it 'should succeed when bundler succeeds' do
-    flexmock(RightConf::Command.instance).should_receive(:execute_in_ruby).once.with(
-      'bundle', '--version').and_return(success_result('0'))
-    flexmock(RightConf::Command.instance).should_receive(:execute_in_ruby).once.with(
-      'bundle','_0_', 'install', {:abort_on_failure=>"Failed to install gems"}).and_return(success_result)
+    should_execute_in_ruby('bundle', '--version').once.and_return(success_result('0'))
+    should_execute_in_ruby('bundle','_0_', 'install', 
+                           {:abort_on_failure=>"Failed to install gems"}).once.and_return(success_result)
     @configurator.run_linux
   end
 
   it 'should install bunlder if needed' do
-    flexmock(RightConf::Command.instance).should_receive(:execute_in_ruby).twice.with(
-      'bundle', '--version').and_return(success_result('1'))
-    flexmock(RightConf::Command.instance).should_receive(:execute_in_ruby).once.with(
-      'bundle','_0_', 'install', {:abort_on_failure=>"Failed to install gems"}).and_return(success_result)
-    flexmock(RightConf::Command.instance).should_receive(:execute_in_ruby).once.with(
-      'gem', 'uninstall', 'bundler', '-a', '-x').and_return(success_result)
-    flexmock(RightConf::Command.instance).should_receive(:execute_in_ruby).once.with(
-      'gem', 'install', 'bundler', '-v', '0', '--no-ri', '--no-rdoc',
-      {:abort_on_failure=>"Failed to install bundler"}).once.and_return(success_result)
+    should_execute_in_ruby('bundle', '--version').twice.and_return(success_result('1'))
+    should_execute_in_ruby('bundle','_0_', 'install', 
+                           {:abort_on_failure=>"Failed to install gems"}).once.and_return(success_result)
+    should_execute_in_ruby('gem', 'uninstall', 'bundler', '-a', '-x').once.and_return(success_result)
+    should_execute_in_ruby('gem', 'install', 'bundler', '-v', '0', '--no-ri', '--no-rdoc',
+                           {:abort_on_failure=>"Failed to install bundler"}).once.and_return(success_result)
     @configurator.run_linux
   end
 

data/spec/configurators/git_repo_configurator_spec.rb

@@ -14,7 +14,7 @@ require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
 describe RightConf::GitRepoConfigurator do
 
   before(:each) do
-    lang = RightConf::Language.parse('git_repo { repo "git"; install_path "./git" }')
+    lang = RightConf::Language.parse('git_repo { repo "git"; path "./git" }')
     @configurator = lang.configurators.first
     [:report_check, :report_result, :report_success].each do |meth|
       flexmock(@configurator).should_receive(meth)
@@ -24,24 +24,34 @@ describe RightConf::GitRepoConfigurator do
   end
 
   it 'should clone' do
-    flexmock(RightConf::Command.instance).should_receive(:execute).with('git', 'clone', 'git', './git', @abf).once
+    should_execute('git', 'clone', 'git', './git', @abf).once
     @configurator.run
   end
 
-  it 'run the build commands' do
-    @configurator.instance_eval { build_commands('do one, do two') }
-    flexmock(RightConf::Command.instance).should_receive(:execute).with('git', 'clone', 'git', './git', @abf).once
-    flexmock(Dir).should_receive(:chdir).with('./git', Proc).once.and_yield
-    flexmock(RightConf::Command.instance).should_receive(:execute).with('do', 'one', :abort_on_failure => 'do one failed').once
-    flexmock(RightConf::Command.instance).should_receive(:execute).with('do', 'two', :abort_on_failure => 'do two failed').once
+  it 'should checkout the right tag' do
+    @configurator.instance_eval { tag('tag') }
+    should_execute('git', 'clone', 'git', './git', @abf).once
+    flexmock(Dir).should_receive(:chdir).with('./git', Proc).and_yield
+    should_execute('git', 'checkout', 'tag', {:abort_on_failure=>"Failed to checkout tag"}).once
     @configurator.run
   end
 
-  it 'should honor only_if' do
-    @configurator.instance_eval { only_if(lambda { false }) }
-    flexmock(RightConf::Command.instance).should_receive(:execute).and_return { raise "Command should not execute" }
+  it 'should skip checkout if directory already exists and contains a .git subdirectory' do
+    flexmock(File).should_receive(:exist?).with('./git').twice.and_return(true)
+    flexmock(File).should_receive(:exist?).with('./git/.git').once.and_return(true)
+    should_execute.and_return { raise 'Command.execute should not be called' }
+    @configurator.run
+  end
+
+  it 'should move directory if already exists but not a git repo' do
+    flexmock(File).should_receive(:exist?).with('./git').once.ordered.and_return(true)
+    flexmock(File).should_receive(:exist?).with('./git/.git').once.ordered.and_return(false)
+    flexmock(File).should_receive(:exist?).with('./git').once.ordered.and_return(false)
+    flexmock(FileUtils).should_receive(:mv).once
+    should_execute('git', 'clone', 'git', './git', @abf).once
     @configurator.run
   end
 
 end
 
+

data/spec/configurators/ruby_configurator_spec.rb

@@ -29,53 +29,36 @@ describe RightConf::RubyConfigurator do
   end
 
   it 'should succeed on linux when rvm succeeds' do
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'rvm', '--version').and_return(success_result("rvm #{RVM_VERSION}"))
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'rvm', 'list').and_return(success_result("=> rvm #{RVM_VERSION}"))
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'rvm', 'use', '0').and_return(success_result('Using '))
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'rvm', '0@', 'gem', '--version').and_return(success_result('1'))
+    should_execute('rvm', '--version').once.and_return(success_result("rvm #{RVM_VERSION}"))
+    should_execute('rvm', 'list').once.and_return(success_result("=> rvm #{RVM_VERSION}"))
+    should_execute('rvm', 'use', '0').once.and_return(success_result('Using '))
+    should_execute('rvm', '0@', 'gem', '--version').once.and_return(success_result('1'))
     @configurator.run_linux
   end
 
   it 'should install rvm if needed' do
     rvm_tar = "rvm-#{RVM_VERSION}.tar.gz" 
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'rvm', '--version').and_return(success_result("rvm"))
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'rvm', 'list').and_return(success_result("=> rvm #{RVM_VERSION}"))
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'curl', '-O', '-f',
-      "http://rvm.beginrescueend.com/releases/#{rvm_tar}",
-      {:abort_on_failure=>"Failed to download rvm #{RVM_VERSION}"}).and_return(success_result)
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'tar', 'zxf', rvm_tar, 
-      {:abort_on_failure=>"Failed to extract rvm tgz from #{File.expand_path(File.join(File.dirname(__FILE__), '..', '..', "rvm-#{RVM_VERSION}.tar.gz"))}"}).and_return(success_result)
+    should_execute('rvm', '--version').once.and_return(success_result("rvm"))
+    should_execute('rvm', 'list').once.and_return(success_result("=> rvm #{RVM_VERSION}"))
+    should_execute('curl', '-O', '-f', "http://rvm.beginrescueend.com/releases/#{rvm_tar}",
+      {:abort_on_failure=>"Failed to download rvm #{RVM_VERSION}"}).once.and_return(success_result)
+    should_execute('tar', 'zxf', rvm_tar, 
+      {:abort_on_failure=>"Failed to extract rvm tgz from #{File.expand_path(File.join(File.dirname(__FILE__), '..', '..', "rvm-#{RVM_VERSION}.tar.gz"))}"}).once.and_return(success_result)
     flexmock(Dir).should_receive(:chdir).and_yield
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      './install', {:abort_on_failure=>"Failed to install rvm #{RVM_VERSION}"}).and_return(success_result)
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'rvm', 'use', '0').and_return(success_result('Using '))
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'rvm', '0@', 'gem', '--version').and_return(success_result('1'))
+    should_execute('./install', {:abort_on_failure=>"Failed to install rvm #{RVM_VERSION}"}).once.and_return(success_result)
+    should_execute('rvm', 'use', '0').once.and_return(success_result('Using '))
+    should_execute('rvm', '0@', 'gem', '--version').once.and_return(success_result('1'))
     flexmock(@configurator).should_receive(:setup_bashrc).once.and_return(true)
     @configurator.run_linux
   end
 
   it 'should install rubygems if needed' do
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'rvm', '--version').and_return(success_result("rvm #{RVM_VERSION}"))
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'rvm', 'list').and_return(success_result("=> rvm #{RVM_VERSION}"))
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'rvm', 'use', '0').and_return(success_result('Using '))
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'rvm', '0@', 'gem', '--version').and_return(success_result('0'))
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'rvm', '0@', 'rubygems', '1',
-      {:abort_on_failure=>'Failed to install rubygems'}).and_return(success_result)
+    should_execute('rvm', '--version').once.and_return(success_result("rvm #{RVM_VERSION}"))
+    should_execute('rvm', 'list').once.and_return(success_result("=> rvm #{RVM_VERSION}"))
+    should_execute('rvm', 'use', '0').once.and_return(success_result('Using '))
+    should_execute('rvm', '0@', 'gem', '--version').once.and_return(success_result('0'))
+    should_execute('rvm', '0@', 'rubygems', '1',
+      {:abort_on_failure=>'Failed to install rubygems'}).once.and_return(success_result)
     @configurator.run_linux
   end
 

data/spec/spec_helper.rb

@@ -19,3 +19,36 @@ RSpec.configure do |c|
   c.mock_with(:flexmock)
 end
 
+# Helper method to mock Command.execute
+#
+# === Parameters
+# Parameters are passed through to flexmock 'with' method
+#
+# === Return
+# mock(Flexmock):: Corresponding flexmock instance
+def should_execute(*with)
+  mock = flexmock(RightConf::Command.instance).should_receive(:execute).with(*with)
+end
+
+# Helper method to mock Command.execute_in_ruby
+#
+# === Parameters
+# Parameters are passed through to flexmock 'with' method
+#
+# === Return
+# mock(Flexmock):: Corresponding flexmock instance
+def should_execute_in_ruby(*with)
+  mock = flexmock(RightConf::Command.instance).should_receive(:execute_in_ruby).with(*with)
+end
+
+# Helper method to mock Command.sudo
+#
+# === Parameters
+# Parameters are passed through to flexmock 'with' method
+#
+# === Return
+# mock(Flexmock):: Corresponding flexmock instance
+def should_sudo(*with)
+  mock = flexmock(RightConf::Command.instance).should_receive(:sudo).with(*with)
+end
+

data/spec/support/package_installer_spec.rb

@@ -26,25 +26,21 @@ describe RightConf::PackageInstaller do
   it 'should install packages on Ubuntu' do
     flexmock(RightConf::Platform.instance).should_receive(:family).and_return(:linux)
     flexmock(RightConf::Platform.instance).should_receive(:flavor).and_return('ubuntu')
-    flexmock(RightConf::Command.instance).should_receive(:sudo).once.with(
-      'apt-get', 'install', '-y', 'deb1', 'deb2').and_return(success_result)
+    should_sudo('apt-get', 'install', '-y', 'deb1', 'deb2').once.and_return(success_result)
     RightConf::PackageInstaller.install(['deb1', 'deb2'])
   end
 
   it 'should install packages on Centos' do
     flexmock(RightConf::Platform.instance).should_receive(:family).and_return(:linux)
     flexmock(RightConf::Platform.instance).should_receive(:flavor).and_return('centos')
-    flexmock(RightConf::Command.instance).should_receive(:sudo).once.with(
-      'yum', 'install', '-y', 'cent1', 'cent2').and_return(success_result)
+    should_sudo('yum', 'install', '-y', 'cent1', 'cent2').once.and_return(success_result)
     RightConf::PackageInstaller.install(['cent1', 'cent2'])
   end
 
   it 'should install packages on Darwin' do
     flexmock(RightConf::Platform.instance).should_receive(:family).and_return(:darwin)
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'brew', 'install', 'mac1').and_return(success_result)
-    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'brew', 'install', 'mac2').and_return(success_result)
+    should_execute('brew', 'install', 'mac1').once.and_return(success_result)
+    should_execute('brew', 'install', 'mac2').once.and_return(success_result)
     RightConf::PackageInstaller.install(['mac1', 'mac2'])
   end
 

metadata

@@ -2,7 +2,7 @@
 name: rconf
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.7.6
+  version: 0.7.8
 platform: ruby
 authors: 
 - Raphael Simon
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-30 00:00:00 -07:00
+date: 2011-03-31 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,8 +74,10 @@ files:
 - lib/rconf/command.rb
 - lib/rconf/configurator.rb
 - lib/rconf/configurator_registry.rb
+- lib/rconf/configurators/build_configurator.rb
 - lib/rconf/configurators/bundler_configurator.rb
 - lib/rconf/configurators/cassandra_configurator.rb
+- lib/rconf/configurators/execute_configurator.rb
 - lib/rconf/configurators/git_repo_configurator.rb
 - lib/rconf/configurators/mercurial_configurator.rb
 - lib/rconf/configurators/packages_configurator.rb
@@ -101,6 +103,7 @@ files:
 - rconf.rconf
 - spec/command_spec.rb
 - spec/configurator_spec.rb
+- spec/configurators/build_configurator_spec.rb
 - spec/configurators/bundler_configurator_spec.rb
 - spec/configurators/git_repo_configurator_spec.rb
 - spec/configurators/packages_configurator_spec.rb
@@ -146,6 +149,7 @@ summary: Cross platform environment configuration
 test_files: 
 - spec/command_spec.rb
 - spec/configurator_spec.rb
+- spec/configurators/build_configurator_spec.rb
 - spec/configurators/bundler_configurator_spec.rb
 - spec/configurators/git_repo_configurator_spec.rb
 - spec/configurators/packages_configurator_spec.rb