rconf 0.5.0

data/lib/rconf/version.rb

@@ -0,0 +1,30 @@
+# 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
+
+  MAJOR = 0
+  MINOR = 5
+  BUILD = 0
+
+  VERSION = [MAJOR, MINOR, BUILD].map(&:to_s).join('.')
+
+  DESCRIPTION = <<-EOS
+rconf configures the environment for a given application. rconf reads
+the content of an application configuration file (.rc) and installs and/or
+configures the required tools for running or developing the corresponding
+application. rconf can easily be extended to configure new tools and makes
+it easy to support multiple platforms.
+Consult the README.rdoc file for information on how to write rconf 
+configuration files (.rc).
+  EOS
+
+end

data/rconf.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'rconf/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'rconf'
+  s.version     = RightConf::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Raphael Simon']
+  s.email       = ['raphael@rightscale.com']
+  s.homepage    = 'http://rubygems.org/gems/rconf'
+  s.summary     = %q{Cross platform environment configuration}
+  s.description = RightConf::DESCRIPTION
+
+  s.rubyforge_project = 'rconf'
+
+  s.add_development_dependency('rspec', "~> 2.5")
+  s.add_development_dependency('flexmock', "~> 0.9")
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end
+

data/spec/command_spec.rb

@@ -0,0 +1,38 @@
+# 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.join(File.dirname(__FILE__), 'spec_helper')
+
+describe RightConf::Command do
+
+  def success_result
+    RightConf::CommandResult.new(0, '')
+  end
+
+  def failed_result
+    RightConf::CommandResult.new(1, '')
+  end
+
+  it 'should execute' do
+    flexmock(RightConf::Platform.instance).should_receive(:dispatch).with('test', '42', Proc).once.and_return(success_result)
+    RightConf::Command.execute('test', '42')
+  end
+
+  it 'should report fatal errors when required to' do
+    flexmock(RightConf::Platform.instance).should_receive(:dispatch).with('test', '42', 
+       Proc).once.and_return(failed_result)
+    flexmock(RightConf::Command.instance).should_receive(:report_fatal).once.with("FAILED: 'test 42' returned\n1")
+    RightConf::Command.execute('test', '42', :abort_on_failure => 'FAILED')
+  end
+
+end
+
+

data/spec/configurator_spec.rb

@@ -0,0 +1,64 @@
+# 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.join(File.dirname(__FILE__), 'spec_helper')
+
+describe RightConf::Configurator do
+
+  class TestConfigurator
+    include RightConf::Configurator
+    register :test
+    validate_has_settings :required
+    attr_reader :custom_setting
+    def test_setter(value)
+      @custom_setting = value
+    end
+  end
+
+  class AnotherConfigurator
+    include RightConf::Configurator
+    register :another
+  end
+
+  before(:each) do
+    @configurator = TestConfigurator.new
+  end
+    
+  it 'should register configurators' do
+    RightConf::ConfiguratorRegistry[:test].should == TestConfigurator
+    RightConf::ConfiguratorRegistry[:another].should == AnotherConfigurator
+  end
+
+  it 'should have associated key' do
+    TestConfigurator.key.should == :test
+    AnotherConfigurator.key.should == :another
+  end
+
+  it 'should initialize configuration using meta-programming' do
+    @configurator.instance_eval { test_setting 42 }
+    @configurator[:test_setting].should == 42
+  end
+
+  it 'should use configurator setter if it exists' do
+    @configurator.instance_eval { test_setter 43 }
+    @configurator.custom_setting.should == 43
+  end
+
+  it 'should validate' do
+    @configurator.validate.should =~ /^Required setting.*missing for configuration/
+    @configurator.instance_eval { required 42 }
+    @configurator.validate.should be_nil
+  end
+
+end
+
+
+

data/spec/configurators/bundler_configurator_spec.rb

@@ -0,0 +1,51 @@
+# 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::BundlerConfigurator do
+
+  def success_result(output=nil)
+    flexmock('res', :success? => true, :output => output)
+  end
+
+  before(:each) do
+    lang = RightConf::Language.parse('bundler { bundler_version "0" }')
+    @configurator = lang.configurators.first
+    [:report_check, :report_result, :report_fatal, :report_success].each do |meth|
+      flexmock(@configurator).should_receive(meth)
+    end
+  end
+
+  it 'should succeed when bundler succeeds' do
+    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
+      'bundle', '--version').and_return(success_result('0'))
+    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
+      'bundle', 'install', {:abort_on_failure=>"Failed to install gems"}).and_return(success_result)
+    @configurator.run_linux
+  end
+
+  it 'should install bunlder if needed' do
+    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
+      'bundle', '--version').and_return(success_result('1'))
+    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
+      'bundle', 'install', {:abort_on_failure=>"Failed to install gems"}).and_return(success_result)
+    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
+      'gem', 'uninstall', 'bundler', '-a', '-x', {:abort_on_failure=>"Failed to uninstall bundler"}).and_return(success_result)
+    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
+      'gem', 'install', 
+      File.join(RightConf::BundlerConfigurator::DEFAULT_GEM_PATH, 'bundler-0.gem'),
+      '--no-ri', '--no-rdoc', {:abort_on_failure=>"Failed to install bundler"}).once.and_return(success_result)
+    @configurator.run_linux
+  end
+
+  
+end

data/spec/configurators/ruby_configurator_spec.rb

@@ -0,0 +1,60 @@
+# 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::RubyConfigurator do
+
+  def success_result(output=nil)
+    flexmock('res', :success? => true, :output => output)
+  end
+
+  before(:each) do
+    lang = RightConf::Language.parse('ruby { ruby_version "0"; rubygems_version "1" }')
+    @configurator = lang.configurators.first
+    [:report_check, :report_result, :report_fatal, :report_success, :report].each do |meth|
+      flexmock(@configurator).should_receive(meth)
+    end
+  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 #{RightConf::RubyConfigurator::RVM_VERSION}"))
+    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
+      'rvm', 'list').and_return(success_result("=> rvm #{RightConf::RubyConfigurator::RVM_VERSION}"))
+    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
+      'rvm', 'use', '0').and_return(success_result('Using'))
+    @configurator.run_linux
+  end
+
+  it 'should install rvm if needed' do
+    rvm_tar = "rvm-#{RightConf::RubyConfigurator::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 #{RightConf::RubyConfigurator::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 #{RightConf::RubyConfigurator::RVM_VERSION}"}).and_return(success_result)
+    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
+      'tar', 'zxf', rvm_tar).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 #{RightConf::RubyConfigurator::RVM_VERSION}"}).and_return(success_result)
+    flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
+      'rvm', 'use', '0').and_return(success_result('Using'))
+    @configurator.run_linux
+  end
+
+  
+end
+

data/spec/language_spec.rb

@@ -0,0 +1,60 @@
+# 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.join(File.dirname(__FILE__), 'spec_helper')
+
+describe RightConf::Language do
+
+  it 'should invalidate missing blocks' do
+    lang = RightConf::Language.parse('toto')
+    lang.validation_errors.size.should == 1
+    lang.validation_errors.first.should == "Invalid syntax, expecting block after 'toto'"
+  end
+
+  it 'should invalidate non-existent configurator' do
+    lang = RightConf::Language.parse('toto { 42 }')
+    lang.validation_errors.size.should == 1
+    lang.validation_errors.first.should == "Unknown configurator 'toto'"
+  end
+
+  it 'should parse correctly' do
+    lang = RightConf::Language.parse('ruby { ruby_version "1"; rubygems_version "2" }')
+    lang.validation_errors.size.should == 0
+    lang.configurators.size.should == 1
+    lang.configurators.first.class.should == RightConf::RubyConfigurator
+    lang.configurators.first.instance_variable_get(:@settings_values).should ==
+      { :ruby_version => '1', :rubygems_version => '2' }
+  end
+
+  it 'should parse multiple configurations' do
+    lang = RightConf::Language.parse(<<-EOS
+      ruby do
+        ruby_version "1"
+        rubygems_version "2" 
+      end
+      bundler do
+        bundler_version "3"
+      end
+    EOS
+    )
+    lang.validation_errors.size.should == 0
+    lang.configurators.size.should == 2
+    lang.configurators[0].class.should == RightConf::RubyConfigurator
+    lang.configurators[0].instance_variable_get(:@settings_values).should ==
+      { :ruby_version => '1', :rubygems_version => '2' }
+    lang.configurators[1].class.should == RightConf::BundlerConfigurator
+    lang.configurators[1].instance_variable_get(:@settings_values).should ==
+      { :bundler_version => '3' }
+  end
+
+
+end
+

data/spec/platform_spec.rb

@@ -0,0 +1,37 @@
+# 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.join(File.dirname(__FILE__), 'spec_helper')
+
+describe RightConf::Platform do
+
+   it 'should try to dispatch using platform family' do
+    def test_amiga(val); val; end
+    flexmock(RightConf::Platform.instance).should_receive(:family).and_return('amiga')
+    RightConf::Platform.dispatch(44) { :test }.should == 44
+  end
+
+   it 'should try to dispatch using platform family and flavor' do
+    def test_atari_st(val); val; end
+    flexmock(RightConf::Platform.instance).should_receive(:flavor).and_return('st')
+    flexmock(RightConf::Platform.instance).should_receive(:family).and_return('atari')
+    RightConf::Platform.dispatch(43) { :test }.should == 43
+  end
+
+it 'should try to dispatch using platform family, flavor and release' do
+    def test_commodore_c_64(val); val; end
+    flexmock(RightConf::Platform.instance).should_receive(:release).and_return('64')
+    flexmock(RightConf::Platform.instance).should_receive(:flavor).and_return('c')
+    flexmock(RightConf::Platform.instance).should_receive(:family).and_return('commodore')
+    RightConf::Platform.dispatch(42) { :test }.should == 42
+  end
+
+end

data/spec/progress_reporters/base_reporter_spec.rb

@@ -0,0 +1,84 @@
+# 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::BaseReporter do
+
+  before(:each) do
+    @written = nil
+    @reporter = RightConf::BaseReporter.new
+    flexmock(@reporter).should_receive(:write).and_return { |t| @written = t }
+  end
+
+  it 'should report standard messages' do
+    @reporter.report('42')
+    @written.should == @reporter.send(:format_message, '42')
+    @reporter.report_message('43')
+    @written.should == @reporter.send(:format_message, '43')
+  end
+
+  it 'should report new sections' do
+    @reporter.report_section('42')
+    @written.should == @reporter.send(:format_section, '42')
+  end
+
+  it 'should report errors' do
+    @reporter.report_error('42')
+    @written.should == @reporter.send(:format_error, '42')
+  end
+
+  it 'should report checks' do
+    @reporter.report_check('42')
+    @written.should == @reporter.send(:format_check, '42')
+  end
+
+  it 'should report success' do
+    @reporter.report_success
+    @written.should == @reporter.send(:format_success)
+    @written = nil
+    @reporter.report_result(true)
+    @written.should == @reporter.send(:format_success)
+  end
+
+  it 'should report failures' do
+    @reporter.report_failure
+    @written.should == @reporter.send(:format_failure)
+    @written = nil
+    @reporter.report_result(false)
+    @written.should == @reporter.send(:format_failure)
+  end
+
+  it 'should report fatal' do
+    exception = nil
+    begin
+      @reporter.report_fatal('42')
+    rescue Exception => e
+      exception = e
+    end
+    @written.should == @reporter.send(:format_fatal, '42')
+    exception.should_not be_nil
+    exception.class.should == SystemExit
+    exception.message.should == 'exit'
+  end
+
+  it 'should raise NoMethodError when using a wrong report method' do
+    exception = nil
+    begin
+      @reporter.report_something_that_does_no_exist
+    rescue Exception => e
+      exception = e
+    end
+    exception.should_not be_nil
+    exception.class.should == NoMethodError
+  end
+
+end