rconf 0.5.0

data/README.rdoc

@@ -0,0 +1,56 @@
+= right_env
+
+== INTRODUCTION
+
+As RightScale systems evolve, developers are faced with having to maintain a
+quickly growing list of applications. Each application requires different tools
+for development and for deployment. Tools may include different versions of
+ruby, rubygems, bundler etc. Being able to setup an environment appropriately
+for each application is becoming increasingly complex and switching from one
+application to another for development in particular is quickly becoming
+close to impossible.
+
+RightEnv aims at addressing some of these difficulties by providing a uniform
+and consistent mechanism for applications developed at RightScale to 
+declaratively specify the tools they depend on in various systems (development,
+test, staging, production) and platforms (linux, darwin and windows). RightEnv
+uses a DSL close to Chef recipes for defining an application configuration.
+Each application must be equipped with a definition that must reside at the top
+level directory of the application and must be named "<application>.re" (where
+"<application>" should be subsituted with the name of the application.
+Configuring the system to run the application then merely consists of running
+the "script/bootstrap_environment" script provided in the "script" directory
+("script/bootstrap_environment.bat" on windows).
+
+Internally RightEnv relies on 'configurators' to configure the machine
+appropriately. There is one configurator per tool that needs configuration.
+Each configurator is dynamically instantiated by RightEnv as it reads the
+application configuration file. This makes for an extensible system where new
+configurator may be added to configure new tools that new applications may 
+rely on. For a list of available configurators run "script/configurator --list".
+
+== REQUIREMENTS
+
+=== Running
+
+- Linux and MAc OS X
+
+ - ruby >= 1.8.6
+ - curl
+ - tar
+
+- Windows
+
+ - ruby >= 1.8.6
+ - Win32API gem
+
+=== Unit testing
+
+Install the following gems for testing:
+- rspec >= 2.0
+- flexmock
+
+Then the build can be tested with
+ 
+  rake spec
+

data/Rakefile

@@ -0,0 +1,63 @@
+# 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 'rubygems'
+
+require 'fileutils'
+require 'rake'
+require 'rspec/core/rake_task'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/clean'
+
+task :default => 'spec'
+
+# == Unit Tests == #
+
+desc "Run unit tests"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["--color"]
+end
+
+namespace :spec do
+  desc "Run unit tests with RCov"
+  RSpec::Core::RakeTask.new(:rcov) do |t| 
+    t.rcov = true
+    t.rcov_opts = %q[--exclude "spec"]
+  end 
+
+  desc "Print Specdoc for unit tests"
+  RSpec::Core::RakeTask.new(:doc) do |t| 
+    t.rspec_opts = ["--format", "documentation"]
+  end 
+end
+
+# == Gem == #
+
+gemtask = Rake::GemPackageTask.new(Gem::Specification.load('rconf.gemspec')) do |package|
+  package.package_dir = ENV['PACKAGE_DIR'] || 'pkg'
+  package.need_zip = true
+  package.need_tar = true
+end
+
+directory gemtask.package_dir
+
+CLEAN.include(gemtask.package_dir)
+
+# == Documentation == #
+
+desc "Generate API documentation to doc/rdocs/index.html"
+Rake::RDocTask.new do |rd|
+  rd.rdoc_dir = 'doc/rdocs'
+  rd.main = 'README.rdoc'
+  rd.rdoc_files.include 'README.rdoc', "lib/**/*.rb"
+end
+

data/bin/rconf

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# 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__), '..', 'lib', 'rconf')
+
+module RightConf
+
+  class Configurer
+
+    include ProgressReporter
+
+    def self.run
+      opts = Trollop::options do
+        version 'rconf 0.1 (c) 2011 RightScale'
+        banner <<-EOS
+#{DESCRIPTION}
+
+Usage:
+       rconf [options]
+
+where [options] are:
+        EOS
+
+        opt :configurators, 'Show available configurators'
+        opt :config, 'Set path to configuration file', :type => :string
+        opt :output, 'Output file (output to STDOUT by default)', :type => :string
+      end
+      if opts[:config].nil?
+        opts[:config] = Dir['./*.rc']
+        if opts[:config].empty?
+          Trollop::die :config, "not used and could not find a '.rc' file in the working directory"
+        else
+          opts[:config] = opts[:config].first
+        end
+      end
+      if opts[:output]
+        begin
+          FileUtils.mkdir_p(File.dirname(opts[:output]))
+        rescue Exception => e
+          Trollop::die :output, "Failed to initialize output file: #{e.message}"
+        end
+      end
+      new.configure(opts)
+    end
+
+    # Actually configure environment
+    #
+    # === Parameters
+    # options[:config](String):: Configuration file
+    # options[:output](String):: Output file, optional
+    #
+    # === Return
+    # true:: Always return true
+    def configure(options)
+      if options[:configurators]
+        puts "The following configurators are registered:\n\n"
+        ConfiguratorRegistry.each do |key, configurator|
+          puts "== #{key} ==".bold
+          puts configurator.desc
+          puts 'Settings:'
+          max_size = configurator.all_settings.keys.map(&:to_s).map(&:size).max
+          configurator.all_settings.each do |name, desc|
+            num_spaces = max_size - name.to_s.size + 1
+            print "  - #{name.to_s.blue}:#{' ' * num_spaces}#{desc}"
+            if configurator.required_settings.include?(name)
+              puts ' [required]'.green
+            else
+              puts
+            end
+          end
+          puts
+        end
+        exit 0
+      end
+      ProgressReporter.report_to_stdout
+      ProgressReporter.report_to_file(options[:output]) if options[:output]
+      begin
+        lang = Language.load(options[:config])
+        report_fatal("Validation of configuration file failed:\n  -#{lang.validation_errors.join("\n  -").map(&:red)}") unless lang.validation_errors.empty?
+        Dir.chdir(File.dirname(options[:config])) { lang.configurators.each(&:run) }
+        report("Successfully configured #{File.basename(options[:config], '.rc').blue} for #{Platform.family.to_s.blue}")
+        lang.configurators.each { |c| report("NOTE: #{c.post_note}") if c.post_note }
+      rescue Exception => e
+        raise if e.is_a?(SystemExit)
+        report_fatal("Execution failed with exception '#{e.message.red}'\n#{e.backtrace.join("\n").map(&:grey)}")
+      end
+    end
+
+  end
+end
+
+# Yeeeehaaaa!
+RightConf::Configurer.run

data/examples/sample.rc

@@ -0,0 +1,9 @@
+# Configuration settings for my project
+ruby do
+  ruby_version     'ree-1.8.7-2010.02'
+  rubygems_version '1.3.7'
+  gemset           'my_project'
+end
+bundler do
+  bundler_version '1.0.7'
+end

data/lib/rconf.rb

@@ -0,0 +1,24 @@
+# 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
+
+BASE_DIR = File.join(File.dirname(__FILE__), 'rconf')
+
+require 'FileUtils'
+require File.join(BASE_DIR, 'ruby_extensions')
+require File.join(BASE_DIR, 'progress_reporter')
+require File.join(BASE_DIR, 'command')
+require File.join(BASE_DIR, 'configurator_registry')
+require File.join(BASE_DIR, 'configurator')
+require File.join(BASE_DIR, 'language')
+require File.join(BASE_DIR, 'platform')
+require File.join(BASE_DIR, 'trollop')
+require File.join(BASE_DIR, 'version')
+

data/lib/rconf/command.rb

@@ -0,0 +1,112 @@
+# 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 'shellwords'
+
+module RightConf
+
+  class Command
+
+    include Singleton
+    include ProgressReporter
+
+    # Execute given command with given arguments
+    #
+    # === Parameters
+    # command(String):: Command to run
+    # args(Array):: Command arguments
+    #
+    # === Return
+    # result(CommandResult):: Result of execution (output and exit status)
+    def execute(command, *args)
+      opts = {}
+      if !args.empty? && args[-1].is_a?(Hash)
+        opts = args[-1]
+        args = args[0..-2]
+      end
+      res = Platform.dispatch(command, *args) { :execute }
+      if !res.success? && msg = opts[:abort_on_failure]
+        report_fatal("#{msg}: '#{command} #{args.join(' ')}' returned\n#{res.output}")
+      end
+      res
+    end
+
+    # Execute given command on *nix systems
+    # 
+    # === Parameters
+    # command(String):: Command name
+    # params(Array):: List of parameters to pass to command
+    #
+    # === Return
+    # result(CommandResult):: Result of execution (output and exit status)
+    def execute_linux(command, *args)
+      out = `#{@prefix} #{Shellwords.join([command, *args])} 2>&1`
+      result = CommandResult.new(out, $?.exitstatus)
+    end
+    alias :execute_darwin :execute_linux
+
+    # Execute given command on Windows systems
+    # 
+    # === Parameters
+    # command(String):: Command name
+    # params(Array):: List of parameters to pass to command
+    #
+    # === Return
+    # result(CommandResult):: Result of execution (output and exit status)
+    def execute_windows(command, *args)
+      raise 'TBD!'
+    end
+
+    # Set prefix to be used for all commands
+    #
+    # === Parameters
+    # prefix(String):: Commands prefix
+    #
+    # === Return
+    # true:: Always return true
+    def set_prefix(prefix)
+      @prefix = prefix
+      true
+    end
+
+  end
+
+  # Command results
+  class CommandResult
+
+    # Process output
+    attr_reader :output
+
+    # Process exit status
+    attr_reader :status
+
+    # Initialize output and exit status
+    #
+    # === Parameters
+    # output(String):: Process output
+    # status(Fixnum):: Process exit status
+    def initialize(output, status)
+      @output = output
+      @status = status
+    end
+
+    # Whether process exited successfully
+    #
+    # === Return
+    # true:: If process exited with status code 0
+    # false:: Otherwise
+    def success?
+      @status == 0
+    end
+
+  end
+
+end

data/lib/rconf/configurator.rb

@@ -0,0 +1,179 @@
+# 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
+
+  # Configurator mixin, defines DSL and common validation method
+  module Configurator
+
+    include ProgressReporter
+
+    module ClassMethods
+
+       # Key associated with configurator
+      attr_reader :key
+ 
+      # Description
+      attr_reader :desc
+
+      # Access to settings for documentation
+      attr_reader :all_settings
+
+      # Access to required settings for validation
+      attr_reader :required_settings
+
+      # Associate configurator with given key
+      #
+      # === Parameters
+      # key(Symbol):: Key configurator should be associated with
+      #
+      # === Return
+      # true:: Always return true
+      def register(key)
+        ConfiguratorRegistry[key] = self
+        @key = key
+        true
+      end
+
+      # Store description for documentation
+      #
+      # === Parameters
+      # description(String):: Description
+      #
+      # === Return
+      # true:: Always return true
+      def description(description)
+        @desc = description
+        true
+      end
+
+      # Store settings and their descriptions in a hash
+      #
+      # === Parameters
+      # settings(Hash):: Settings descriptions indexed by names
+      #
+      # === Return
+      # true:: Always return true
+      def settings(settings)
+        @all_settings = settings
+        true
+      end
+
+       # Store required settings for validation
+      #
+      # === Parameters
+      # settings(Array):: List of settings that should be checked
+      #
+      # === Return
+      # true:: Always return true
+      def validate_has_settings(*settings)
+        @required_settings = settings.flatten
+        true
+      end
+
+   end
+
+    # Extend base class with ClassMethods module methods
+    #
+    # === Parameters
+    # base(Object):: Object including module
+    def self.included(base)
+      base.__send__(:extend, ClassMethods)
+    end
+
+    # Check whether configurator has values for all required settings
+    #
+    # === Return
+    # nil:: If settings are valid for this configurator
+    # error(String):: Error message otherwise
+    def validate
+      init
+      required = self.class.required_settings
+      return nil unless required
+      missing = required.flatten.select { |s| !@settings_values.include?(s) }
+      error = case missing.size
+        when 0 then nil
+        when 1 then "Required setting #{missing.first} is "
+        else
+          "Required settings #{missing.join(', ')} are "
+      end
+      error += "missing for configuration section '#{self.class.key}'" if error
+      error
+    end
+
+    # Run configurator for current platform
+    #
+    # === Parameters
+    # args:: Pass-through arguments, given to platform specific implementation
+    # 
+    # === Return
+    # true:: Always return true
+    def run(*args)
+      init
+      Platform.dispatch(*args) { :run }
+      true
+    end
+
+    # Get value of configuration option
+    #
+    # === Parameters
+    # config_option(Symbol):: Configuration option to return
+    #
+    # === Returns
+    # value:: Value of configuration option if there is one
+    # nil:: Otherwise
+    def [](config_option)
+      init
+      @settings_values[config_option]
+    end
+
+    protected
+
+    # DSL implementation, set settings value if arguments, get it otherwise.
+    #
+    # === Parameters
+    # meth(Symbol):: Method symbol
+    # args(Array):: List of arguments
+    #
+    # === Return
+    # res(Object):: Configuration setting value or setter return value if
+    #               arguments
+    def method_missing(meth, *args)
+      init
+      num_args = args.length
+      res = nil
+      if num_args > 0
+        meth = $1.to_sym unless (meth.to_s =~ /(.+)=$/).nil?
+        value = num_args == 1 ? args[0] : args
+        method_name = meth.id2name
+        if self.public_methods.include?("#{method_name}=")
+          res = self.send("#{method_name}=", value)
+        else
+          res = @settings_values[meth] = value
+        end
+      end
+      res || @settings_values[meth]
+    end
+
+    # Initialize configuration settings hash
+    #
+    # === Return
+    # true:: Always return true
+    def init
+      @settings_values ||= Hash.new
+      true
+    end
+
+  end
+end
+
+# Load all configurators
+Dir[File.join(File.dirname(__FILE__), 'configurators', '*.rb')].each { |c| require c }