gat 0.2.8

data/lib/gat/exceptions.rb

@@ -0,0 +1,163 @@
+=begin
+
+  :file   => exception.rb
+  :author => (c) 2008-2009 A.C. Gnoxys info@gnoxys.net
+  
+  ######################################################################################
+  ## This file is part of GAT: http://gat.rubyforge.org                               ##
+  ##                                                                                  ##
+  ## GAT (Gnoxys Administration Tools) is released under the GPL License 3 or higher. ##
+  ## You can get a copy of the license easily at http://www.gnu.org/licenses/gpl.html.##
+  ######################################################################################
+  
+  THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ 
+=end
+
+
+module Gat
+  
+  class GagetExceptions < StandardError
+    
+    attr_reader :exception_location
+    attr_reader :exception_options
+    attr_reader :exception_backtrace
+    
+    def initialize(error, location, options = {})
+      if error.is_a?(Exception)
+        super(options[:message].nil? ? error.message : options[:message] )
+        @exception_backtrace = error.backtrace
+      else
+        super(error)
+        @exception_backtrace = nil
+      end
+      @exception_location = location
+      @exception_options = options
+    end
+
+    def exception_message
+      return message
+    end
+
+    def exit_level #:nodoc: 
+      return 0
+    end
+     
+    def exit_error
+      error_string = "ERROR: `#{ self.exception_message }` at `#{ self.exception_location }`"
+      if self.exception_backtrace
+        error_string << "\nBACK:\n        #{ self.exception_backtrace.shift } \n        #{  self.exception_backtrace.join("\n        ") }"
+      elsif self.backtrace
+      	error_string << "\nBACK:\n        #{ self.backtrace.shift } \n        #{  self.backtrace.join("\n        ") }"
+      end
+      error_string
+    end
+  end
+
+
+  # Gatget Exception.
+  # Normal Code Exception. Something gone wrong but exit is controlled
+  class GatgetException < GagetExceptions
+
+    def initialize(error, location, options = {})
+      super(error, location, options)
+    end
+
+    def exit_level
+      return 1
+    end
+
+  end
+  
+  # Gatget Fatal Exception.
+  # Fatal Code Exception. Something gone wrong and no callbacks are launched
+  class GatgetFatalException < GagetExceptions
+
+    def initialize(error, location, options = {})
+      super(error, location, options)
+    end
+
+    def exit_level
+      return 2
+    end
+
+  end
+  
+  # Undefined Exception
+  # No controlled Gatget Exception, but callbacks are launched
+  class UndefinedException < GagetExceptions    
+
+    def initialize(error, location, options = {})
+      super(error, location, options)
+    end
+
+    def exit_level
+      return 3
+    end
+
+  end
+
+  
+  # Process Exception
+  # Action || condition failed during the process
+  class GatgetProcessException < GagetExceptions    
+
+    def initialize(error, location, options = {})
+      super(error, location, options)
+    end
+
+    def exit_level
+      return 4
+    end
+
+  end
+  
+  # Config Exception
+  # Config malformed or missing data at YML
+  class GatgetConfigException < GagetExceptions
+
+    def initialize(error, location, options = {})
+      super(error, location, options)
+    end
+
+    def exit_level
+      return 5
+    end
+
+  end
+  
+  # Argument Exception
+  # missing arguments or bad arguments
+  class GatgetArgumentException < GagetExceptions
+
+    def initialize(error, location, options = {})
+      super(error, location, options)
+    end
+
+    def exit_level
+      return 7
+    end
+  end
+  
+  
+  # Instance Exception
+  # Gatget coulnt generate an instance and launch script
+  class GatgetInstanceException < GagetExceptions    
+
+    def initialize(error, location, options = {})
+      super(error, location, options)
+    end
+
+    def exit_level
+      return 6
+    end
+
+  end
+
+end

data/lib/gat/extends.rb

@@ -0,0 +1,102 @@
+=begin
+
+  :file   => extends.rb
+  :author => see each method for more information
+  
+  ######################################################################################
+  ## This file is part of GAT: http://gat.rubyforge.org                               ##
+  ##                                                                                  ##
+  ## GAT (Gnoxys Administration Tools) is released under the GPL License 3 or higher. ##
+  ## You can get a copy of the license easily at http://www.gnu.org/licenses/gpl.html.##
+  ######################################################################################
+  
+  THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+  
+=end
+
+# This file just extend some objects with usefull methods for gat
+
+# Underscore and camelize method ... DarBackup.underscore => dar_backup.camelize => DarBackup
+# stolen from rails code ;)
+# http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html
+# Rails is released under the MIT licens as you can see at http://rubyonrails.org/
+class String
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+
+  
+  def camelize
+    self.gsub(/\/(.?)/) { "::#{ $1.upcase }" }.
+         gsub(/(?:^|_)(.)/) { $1.upcase }
+  end
+end
+
+
+class File
+  def self.nice_size(file)
+    filesize = File.size(file)
+    
+    if filesize >= 1073741824
+      filesize = "#{ filesize / 1073741824 } Gb."
+    elsif filesize >= 1048576
+      filesize = "#{ filesize / 1048576 } Mb."
+    elsif filesize >= 1024
+      filesize = "#{ filesize / 1024 } Kb."
+    else
+      filesize = "#{ filesize } bytes"
+    end
+  
+    filesize
+  end
+end
+
+# Hash#deep_merge
+# From: http://pastie.textmate.org/pastes/30372, Elliott Hird
+# Source: http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
+# This file contains extensions to Ruby and other useful snippits of code.
+# Time to extend Hash with some recursive merging magic.
+
+
+class Hash
+
+  # Merges self with another hash, recursively.
+  # 
+  # This code was lovingly stolen from some random gem:
+  # http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
+  # 
+  # Thanks to whoever made it.
+
+  def deep_merge(hash)
+    target = dup
+    
+    hash.keys.each do |key|
+      if hash[key].is_a? Hash and self[key].is_a? Hash
+        target[key] = target[key].deep_merge(hash[key])
+        next
+      end
+
+      target[key] = hash[key]
+    end
+    
+    target
+  end
+
+end
+
+
+
+
+
+
+

data/lib/gat/help.rb

@@ -0,0 +1,79 @@
+=begin
+
+  :file   => help.rb
+  :author => (c) 2008-2009 A.C. Gnoxys info@gnoxys.net
+  
+  ######################################################################################
+  ## This file is part of GAT: http://gat.rubyforge.org                               ##
+  ##                                                                                  ##
+  ## GAT (Gnoxys Administration Tools) is released under the GPL License 3 or higher. ##
+  ## You can get a copy of the license easily at http://www.gnu.org/licenses/gpl.html.##
+  ######################################################################################
+  
+  THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+  
+=end
+
+
+module Gat
+  module Help
+
+    def gatget_help
+
+      help_message =  "\n Help: \n"
+      help_message << " ------\n\n"
+      help_message << " # #{ 'launcher name'.ljust(31) } : #{ $0 }\n"
+      help_message << " # #{ 'launcher class'.ljust(31) } : #{ self.class.name }\n"
+      help_message << " # #{ 'gatget name'.ljust(31) } : #{ self.name.camelize }\n"
+      help_message << " # #{ 'description'.ljust(31) } : #{ self.config['description'] || '<gatget description not avalilable>' }\n"
+
+      if self.config['operations'].nil? or self.config['operations'].is_a?(String)
+        help_message << " # no operations defined\n"
+      else
+        help_message << " # operations\n"
+
+        self.config['operations'].each_pair do |op_key, op_data|
+          help_message   << " #{ ' ' * 5 } * #{ op_key.ljust(25)   } : #{ op_data['description'] || '< no description avalilable >' } \n\n"
+          syntax_message =  " #{ ' ' * 9 } $ > #{ $0 } #{ op_key } "
+          argument_message = ''
+  
+          if op_data['arguments'] and op_data['arguments'].any?
+  
+            if self.config['arguments'].nil?
+              raise GatgetConfigException.new("Global arguments not defined in yml", 'gatget_help')
+            end
+  
+            op_data['arguments'].each do |argument|
+            syntax_message << "<#{ argument }> "
+            unless self.config['arguments'][argument].nil?
+              argument_data = self.config['arguments'][argument]['description'] || '<no description available>'
+            argument_message << "\n #{ ' ' * 9 } | #{ "<#{ argument }>".ljust(21) } : #{ argument_data } "
+            else
+              raise GatgetConfigException.new("argument '#{argument}' not defined", 'gatget_help')
+            end
+            end
+          end
+          help_message << syntax_message
+          help_message << argument_message
+          help_message << "\n\n\n"
+        end
+      end
+      help_message << "Gat Version #{ Gat::VERSION }"
+      
+
+      $stdout.puts help_message
+    end
+    
+ def returning(value)
+     yield(value)
+    value
+  end
+
+  end
+end

data/lib/gat/interpreter.rb

@@ -0,0 +1,93 @@
+=begin
+
+  :file   => interpreter.rb
+  :author => (c) 2008-2009 A.C. Gnoxys info@gnoxys.net
+
+  ######################################################################################
+  ## This file is part of GAT: http://gat.rubyforge.org                               ##
+  ##                                                                                  ##
+  ## GAT (Gnoxys Administration Tools) is released under the GPL License 3 or higher. ##
+  ## You can get a copy of the license easily at http://www.gnu.org/licenses/gpl.html.##
+  ######################################################################################
+
+  THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+=end
+
+module Gat
+  module Interpreter
+
+
+    def interpreter_parameters(gatget_text, gatget_object)
+
+      interpreted_string = gatget_text.gsub(/\{\{[\w\d]+\}\}/) do |gat_parameter|
+        parameter        = gat_parameter.gsub(/[{}]/,'')
+        gat_parameter    = interpreter_parameter(parameter, gatget_object)
+      end
+    end
+
+
+
+    def interpreter_parameter(parameter_name, gatget_object)
+      parameter_config = gatget_object.get_element_config('parameters', parameter_name)
+
+      if not parameter_config or parameter_config.nil?
+ # FIXME This is never true as it would have raised an exception in get_element_config
+        raise GatgetConfigException.new("Parameter #{ parameter_name } not found at YML", "interpreter_parameters")
+      end
+
+      if not parameter_config['value'] or parameter_config['value'].blank?
+        raise GatgetConfigException.new("Parameter #{ parameter_name } has blank or missing value", "interpreter_parameter")
+      end
+
+      case parameter_config['type']
+      when 'dependence'
+        dependence_type, *dependence_name = parameter_config['value'].split("/")
+        ret = gatget_object.get_dependence_value(dependence_type, dependence_name.join("_"))
+        if parameter_config['array_method']
+          ret = eval("ret.#{ parameter_config['array_method'] }")
+        end
+
+        if parameter_config['join']
+          ret = [ *ret ].join(parameter_config['join'])
+        end
+      when 'eval'
+        ret = eval(parameter_config['value'])
+      else
+        if parameter_config['type'].empty?
+          raise GatgetConfigException.new("'#{parameter_config['type']}' type invalid for argument #{ parameter_name }. Should be 'dependence' or 'eval'", "interpreter_parameter")
+        else
+          raise GatgetConfigException.new("missing type por argument #{ parameter_name }", "interpreter_parameter")
+        end
+
+      end
+      ret
+
+      # What does it happens if a ret is nil or blank or false?????
+      # ToDo
+
+    end
+
+
+    def interpreter_shell_command(action)
+      syntax = self.syntax.gsub(/\{\{[\w\d]+\}\}/) do |argument|
+
+        # replace current argument with data
+        unless self.arguments.keys.include?(argument.gsub(/[{}]/,''))
+          raise GatgetConfigException.new("Syntax failed for action #{ action.name }. Missing argument: #{ argument }", "interpreter_shell_command")
+        end
+
+        argument = self.arguments[argument.gsub(/[{}]/,'')]
+      end
+      syntax
+    end
+  end
+end
+
+

data/lib/gat/launcher.rb

@@ -0,0 +1,100 @@
+=begin
+
+  :file   => launcher.rb
+  :author => (c) 2008-2009 A.C. Gnoxys info@gnoxys.net
+  
+  ######################################################################################
+  ## This file is part of GAT: http://gat.rubyforge.org                               ##
+  ##                                                                                  ##
+  ## GAT (Gnoxys Administration Tools) is released under the GPL License 3 or higher. ##
+  ## You can get a copy of the license easily at http://www.gnu.org/licenses/gpl.html.##
+  ######################################################################################
+  
+  THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+  
+=end
+
+module Gat
+  module Launcher
+
+    class << self
+      def included(base)
+        base.extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+
+      # This method launches the Gatget
+      # Usage:
+      #   class ExampleGatget < Gat::Base
+      #   end
+      #  
+      #   options = { :specific_gatget_options }
+      #
+      #   ExampleScript.launch(options, ARGV)
+      #
+ 
+      def launch(options, arguments)
+        
+        launch_error = false
+        
+        # Load Instance gatget. 
+        #
+        # Gatget exceptions are rescued by Instance Error if fails
+        # Other exceptions are parsed as Undefined
+        begin
+          instance_gatget = self.new(options, arguments)
+        rescue GatgetException, GatgetConfigException, GatgetArgumentException => error
+          launch_error = GatgetInstanceException.new(error, error.exception_location)
+        rescue => error
+          launch_error = UndefinedException.new(error, 'initialize_gatget')
+        end
+        
+        
+        # If no error, continue with the process
+        unless launch_error
+          # Gatget exceptions are rescued and parsed as is.
+          # Other exceptions are parsed as Undefined
+          begin
+            instance_gatget.execute
+          rescue GatgetException, GatgetProcessException, GatgetConfigException, GatgetArgumentException  => error
+            launch_error = error
+          rescue => error
+            launch_error = UndefinedException.new(error, 'launch_error')
+          end
+          
+
+          # Rescue operations
+          if launch_error and instance_gatget.methods.include?('onfail')
+            begin
+              instance_gatget.onfail_error = launch_error
+              instance_gatget.logger.log("message", "failed_gatget", 'starting rescue operations for failed_gatget')
+              instance_gatget.send('onfail')
+            rescue => error
+              $stderr.puts launch_error.exit_error
+              # no controlled gatget failed, exit
+              instance_gatget.logger.log("error", "failed_gatget", error.message)
+              error_string = error.methods.include?('exception_message') ? error.exception_message : error
+              launch_error = GatgetFatalException.new(error_string, 'launch')
+            end
+          end        
+        end
+  
+        if launch_error   
+          $stderr.puts launch_error.exit_error
+          exit launch_error.exit_level  
+        else
+          # Success
+          exit 0
+        end
+      end
+    end       
+  end
+end