rconf 0.5.0

data/lib/rconf/platforms/darwin.rb

@@ -0,0 +1,27 @@
+# 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
+
+  # Linux specific implementation
+  class Platform
+
+    attr_reader :flavor, :release
+
+    # Initialize flavor and release
+    def init
+      @flavor = 'mac_os_x'
+      @release = `sw_vers -productVersion`
+    end
+
+  end
+
+end

data/lib/rconf/platforms/linux.rb

@@ -0,0 +1,40 @@
+# 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
+
+  # Linux specific implementation
+  class Platform
+
+    FEDORA_REL = '/etc/fedora-release'
+    FEDORA_SIG = /Fedora release ([0-9]+) \(.*\)/
+
+    attr_reader :flavor, :release
+
+    # Initialize flavor and release
+    def init
+      system('lsb_release --help > /dev/null 2>&1')
+      if $?.success?
+        # Use the lsb_release utility if it's available
+        @flavor  = `lsb_release -is`.strip.downcase
+        @release =  `lsb_release -rs`.strip
+      elsif File.exist?(FEDORA_REL) && (match = FEDORA_SIG.match(File.read(FEDORA_REL)))
+        # Parse the fedora-release file if it exists
+        @distro   = 'fedora'
+        @release  = match[1]
+      else
+        @distro = @release = 'unknown'
+      end
+    end
+
+  end
+
+end

data/lib/rconf/platforms/windows.rb

@@ -0,0 +1,40 @@
+
+# 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 'Win32API'
+
+module RightConf
+
+  # Linux specific implementation
+  class Platform
+
+    attr_reader :flavor, :release
+
+    # Initialize flavor and release
+    def init
+      GetVersionEx = Win32API.new("kernel32", "GetVersionEx", 'P', 'L')
+      osversioninfo = [
+        148,       # size of this struct (IN)
+        0,         # major version (OUT)
+        0,         # minor version (OUT)
+        0,         # build (OUT)
+        0,         # platform (OUT)
+        "\0" * 128 # additional info (OUT)
+      ].pack('LLLLLa128')
+
+      raise 'Failed to detect Windows version' unless GetVersionEx.call(osversioninfo) == 1 # => 1, means succeeded
+      version = osversioninfo.unpack('LLLLLZ128') # 'Z' means ASCIIZ string
+    end
+
+  end
+
+end

data/lib/rconf/progress_reporter.rb

@@ -0,0 +1,72 @@
+# 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
+
+  # Provide progress report methods used by configurators
+  module ProgressReporter
+
+    # Create list of reporters upon inclusion
+    # Also setup forwarders
+    #
+    # === Parameters
+    # base(Object):: Object including this module
+    def self.included(base)
+      @@reporters ||= []
+      [ :report_section, :report, :report_check, :report_success, 
+        :report_failure, :report_fatal, :report_result ].each do |meth|
+        meta_def(meth) { |*args| @@reporters.each { |r| r.__send__(meth, *args) } }
+      end
+    end
+
+    # Print progress reports to stdout, default behavior
+    #
+    # === Return
+    # true:: Always return true
+    def self.report_to_stdout
+      @@reporters ||= []
+      @@reporters << StdoutReporter.new
+      true
+    end
+
+    # Save progress reports to given file
+    #
+    # === Parameters
+    # path(String):: Path to file where progress reports should be saved
+    #
+    # === Return
+    # true:: Always return true
+    def self.report_to_file(path)
+      @@reporters ||= []
+      @@reporters << FileReporter.new(path)
+      true
+    end
+
+    protected
+
+    # Define method programmatically (a.k.a. meta-programming a.k.a use-sparingly)
+    #
+    # === Parameters
+    # name(String):: Method name
+    # blk(Proc):: Method implementation
+    #
+    # === Return
+    # true:: Always return true
+    def self.meta_def(name, &blk)
+      self.instance_eval { define_method(name, &blk) }
+      true
+    end
+
+  end
+end
+
+# Load all progress reporters
+Dir[File.join(File.dirname(__FILE__), 'progress_reporters', '*.rb')].each { |r| require r }

data/lib/rconf/progress_reporters/base_reporter.rb

@@ -0,0 +1,156 @@
+# 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
+
+  # Common base to all progress reporters
+  #
+  # Reporters expose the following report methods whose default implementations
+  # can be overridden in descendants:
+  #
+  # - report_message:: Standard progress report message
+  # - report_section:: Title
+  # - report_error:: Non fatal error
+  # - report_fatal:: Fatal error, will raise after reporting message
+  # - report_check:: Report a check being done on system, should be followed by
+  # - report_success:: Report check success
+  # - report_failure:: Report check failure
+  # - report_result:: Report check success or failure depending on argument
+  #
+  # Alternatively reporters can override any associated formatting method 
+  # (:format_message, :format_section, etc.) and/or the :write method used to
+  # write the progress report.
+  class BaseReporter
+
+    # Report methods are associated with formatting methods
+    # Call the formatting method then call the reporter 'write' method
+    # Reporters can override any formatting method and/or the write method
+    #
+    # === Parameters
+    # meth(Symbol):: Reporting method
+    # args(Array):: Arguments
+    #
+    # === Return
+    # true:: Always return true
+    #
+    # === Raise
+    # (Exception):: If there is no formatting method
+    def method_missing(meth, *args)
+      # Shortcut for standard progress report message
+      meth = :report_message if meth == :report
+      if meth.to_s =~ /^report_([a-zA-Z]+)$/
+        format_method = "format_#{Regexp.last_match[1]}".to_s
+        if self.respond_to?(format_method)
+          text = self.__send__(format_method, *args)
+          write(text)
+          exit 1 if Regexp.last_match[1] == 'fatal'
+        else
+          super(meth, *args)
+        end
+      else
+        super(meth, *args)
+      end
+    end
+
+    # Report success or failure
+    #
+    # === Parameters
+    # res(TrueClass|FalseClass):: true for success, false for failure
+    #
+    # === Return
+    # true:: Always return true
+    def report_result(res)
+      res ? report_success : report_failure
+    end
+
+    protected
+
+    # Actually write text, implement in descendant
+    #
+    # === Parameters
+    # text(String):: Text to be written
+    #
+    # === Return
+    # true:: Always return true
+    def write(text)
+      raise "Implement!"
+    end
+
+    # Generic progress report formatting
+    #
+    # === Parameters
+    # message(String):: Progress report content
+    #
+    # === Return
+    # text(String):: Resulting text
+    def format_message(message)
+      text = message + "\n"
+    end
+
+    # Format new progress report section
+    #
+    # === Parameters
+    # section(String):: Section title
+    #
+    # === Return
+    # text(String):: Resulting text
+    def format_section(section)
+      text = ['', '-' * 80, section.upcase, '-' * 80, ''].join("\n")
+    end
+
+    # Format non-fatal error
+    #
+    # === Parameters
+    # error(String):: Error to report
+    #
+    # === Return
+    # text(String):: Resulting text
+    def format_error(error)
+      text = '**WARN: ' + error + "\n"
+    end
+
+    # Format check
+    #
+    # === Parameters
+    # check(String):: Check title
+    #
+    # === Return
+    # text(String):: Resulting text
+    def format_check(check)
+      text = check + '...'
+    end
+
+    # Format check success
+    #
+    # === Return
+    # text(String):: Resulting text
+    def format_success
+      text ="OK\n"
+    end
+
+    # Format check failure
+    #
+    # === Return
+    # text(String):: Resulting text
+    def format_failure
+      text ="FAILED\n"
+    end
+
+    # Format fatal error
+    #
+    # === Return
+    # text(String):: Resulting text
+    def format_fatal(error)
+      text = "\n***FATAL: " + error + "\n"
+    end
+
+  end
+end

data/lib/rconf/progress_reporters/file_reporter.rb

@@ -0,0 +1,58 @@
+# 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
+
+  # File progress reporter, logs progress to file
+  class FileReporter < BaseReporter
+
+    # Set filename and check file can be written to
+    # Create file directory if needed
+    #
+    # === Parameters
+    # path(String):: Path to progress reports file
+    #
+    # === Raise
+    # (Exception):: If progress report file is not writable
+    def initialize(path)
+      FileUtils.mkdir_p(File.dirname(path))
+      system("touch #{path}")
+      raise "Could not initialize progress report file #{path}" unless $?.success?
+      @path = path
+    end
+
+    # Write lines to progress report file, prepend timestamp
+    #
+    # === Parameters
+    # lines(Array|String):: Lines to be written as array of strings or strings
+    #
+    # === Return
+    # true:: Always return true
+    def write(lines)
+      lines = '' if lines.nil?
+      lines = lines.split("\n") if lines.is_a?(String)
+      lines = lines.flatten
+      begin
+        File.open(@path, 'a') do |f|
+          lines.each do |line|
+            f.puts Time.now.strftime("[%m/%d/%Y %H:%M:%S] ") + line
+          end
+        end
+      rescue Exception => e
+        puts lines.join("\n")
+      end
+      true
+    end
+
+  end
+end
+
+

data/lib/rconf/progress_reporters/stdout_reporter.rb

@@ -0,0 +1,83 @@
+# 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
+
+$stdout.sync = true
+
+module RightConf
+
+  # STDOUT progress reporter, logs progress to console
+  class StdoutReporter < BaseReporter
+
+    # Print given text to STDOUT
+    #
+    # === Parameters
+    # text(String):: Text to be printed
+    #
+    # === Return
+    # true:: Always return true
+    def write(text)
+      $stdout.print(text)
+      true
+    end
+
+    # Format new progress report section
+    #
+    # === Parameters
+    # section(String):: Section title
+    #
+    # === Return
+    # text(String):: Formatted text
+    def format_section(section)
+      text = super(section).green
+    end
+
+    # Format check, should be followed by +report_success+ or +report_failure+
+    #
+    # === Parameters
+    # check(String):: Check title
+    #
+    # === Return
+    # text(String):: Formatted text
+    def format_check(check)
+      text = super(check)
+    end
+
+    # Format check success
+    #
+    # === Return
+    # text(String):: Formatted text
+    def format_success
+      text = super.blue
+    end
+
+    # Format check failure
+    #
+    # === Return
+    # text(String):: Formatted text
+    def format_failure
+      text = super.red
+    end
+
+    # Format fatal error and raise exception to stop execution
+    #
+    # === Return
+    # text(String):: Formatted text
+    def format_fatal(error)
+      text = super.split("\n")
+      text[0] = text[0].red.bold
+      text[1] = text[1].red.bold if text.size > 1
+      text.join("\n") + "\n"
+    end
+
+  end
+end
+
+