gat 0.2.8 → 0.2.11

data/History.txt

@@ -1,3 +1,18 @@
+== 0.2.11 2010-03-22
+ * Bugfix release
+   * Bug in reinterpreter_output_and_error was wrong and cutted up to last line whole ouput
+   * set_backups_to_delete crashed when no system backups must be deleted
+   * Fixed bug at program dependence. config['path'] return nil
+
+== 0.2.10 2010-03-09
+* Bugfix release
+ * Bug at dependence folder mount operation.
+
+== 0.2.9 2010-03-05
+* Improved DarBackup gatget
+ * Include SystemBackup to perform all related operations to search backups
+ * Removed Catalog from dar_backup operations. Running though dump backup content now. Less time, better performance
+
 == 0.2.8 2010-02-16
 * Bugfix release
   * ShellCommandChilds was only executing for the first child

data/PostInstall.txt

@@ -1,22 +1,20 @@
-    Gat Gem Post Install Doc
+Gat Gem Post Install Doc
 ===============================================================================
 
-    Gat provides several built in Gatgets. For now, it contains
+ Gat provides several built in Gatgets. For now, it contains
 
     - GatgetDarBackup => Performs and maintains a whole system of backups with
-dar (Disk Archiver for GNU/Linux)
+                         dar (Disk Archiver for GNU/Linux)
 
 
-    To use this, simply copy the file named launcher.rb to the gatget install
-folder (default by gem, /usr/lib/ruby/gems/ruby1.8/gat/gatgets/<gatget_name>)
-and place it under your local executable folder (for example: /usr/local/bin).
+ To use this, simply run $ gat command and follow instructions
 
 
-  For more information on gat, see http://gat.rubyforge.org
+ For more information on gat, see http://gat.rubyforge.org
 
 
 ===============================================================================
-  Copyright © 2007-2009 Gnoxys. http://www.gnoxys.net.
-  Gat is released under GPL v3.0 or higther. See README for more information
+Copyright © 2007-2009 Gnoxys. http://www.gnoxys.net.
+Gat is released under GPL v3.0 or higther. See README for more information
 
 

data/Rakefile

@@ -4,7 +4,9 @@ require 'rubygems'
 require 'hoe'
 
 Hoe.spec 'gat' do
-   developer('gnoxys', 'soporte@gnoxys.net')
+  developer('gnoxys', 'soporte@gnoxys.net')
+  extra_deps << [ 'tmail', '>=1.2.3' ]
+  extra_deps << [ 'open4', '>=1.0' ]
 
   # self.rubyforge_name = 'blahx' # if different than 'blah'
 end

data/lib/gat.rb

@@ -188,7 +188,7 @@ module Gat
     def get_flag(flag_name)
       ret = self.flags[flag_name]
       if ret == nil
-        self.operation.gatget.logger.log("warning", "get_flag","Undefined flag #{flag_name}")
+        self.operation.gatget.logger.log("warning", "get_flag", "Undefined flag #{flag_name}")
         ret = false
       end
       ret

data/lib/gat/action/shell_command.rb

@@ -19,27 +19,28 @@ module Gat
 
       def run
         ret = nil
-	      # Shell Command can be multiple, that means the command will be execute over a foreach variable subtitutions.
-	      # That is usefull, for example, when you need to do the same actions with some variable subtition, like
-	      # a multiple files compression.
-	      @childs = (@config['multiple'] and @config['multiple'].any?) ? set_multiple_childs(@config['multiple']) : [ ]
-
-	      # If ShellCommand is multiple, then, we exec all of its childs
-	      # If not, we just execute ShellCommand instance
-	      if @childs.any?
-	        @childs.each { |child|
+        # Shell Command can be multiple, that means the command will be execute over a foreach variable subtitutions.
+        # That is usefull, for example, when you need to do the same actions with some variable subtition, like
+        # a multiple files compression.
+        @childs = (@config['multiple'] and @config['multiple'].any?) ? set_multiple_childs(@config['multiple']) : [ ]
+
+        # If ShellCommand is multiple, then, we exec all of its childs
+        # If not, we just execute ShellCommand instance
+        if @childs.any?
+          @childs.each { |child|
             if not child.exec
               ret = false
             end
           }
-	      else
-	        self.parsed_syntax = interpreter_parameters(self.syntax, self.operation.gatget)
-	        ret = exec(self.parsed_syntax)
-	      end
+	else
+	  self.parsed_syntax = interpreter_parameters(self.syntax, self.operation.gatget)
 
-	      if self.config['output']
-	        self.operation.gatget.logger.log("direct", "action_output", self.output)
-	      end
+	  ret = exec(self.parsed_syntax)
+	end
+
+	if self.config['output']
+	  self.operation.gatget.logger.log("direct", "action_output", self.output)
+        end
         ret
       end
 
@@ -52,7 +53,7 @@ module Gat
       # Even it has some problems too. Open4 module has big problems when the stdout or the stderr comes
       # with tons of information. For example, with a mysqldump output.
       #
-      # The solution presented here is a wapper through Process.fork. We create a new fork, making
+      # The solution presented here is a wrapper through Process.fork. We create a new fork, making
       # and the output is not managed by the ruby script itself but by the fork process.
       # IO.pipes are created to pass the stdout, stderr and stdin data through Gat proccess and Fork process
       #

data/lib/gat/boot.rb

@@ -33,7 +33,7 @@ GAT_TEMPLATES 	= GAT_ROOT + '/templates'
 # External gems
 gems            = [ 'ftools', 'rubygems', 'open4', 'yaml', 'erb', 'rdoc/usage', 'rdoc/code_objects',
                     'rdoc/markup/simple_markup', 'rdoc/markup/simple_markup/to_flow', 'rdoc/ri/ri_formatter',
-                    'rdoc/ri/ri_options', 'net/smtp', 'tmail', 'erb' ]
+                    'rdoc/ri/ri_options', 'net/smtp', 'tmail', 'erb', 'fileutils' ]
 
 # Gat Modules 
 modules         = [ 'debug', 'help', 'interpreter', 'extends', 'version', 'launcher', 'checks', 'email' ]

data/lib/gat/checks.rb

@@ -103,8 +103,7 @@ module Gat
       r = FileUtils.mkdir(lockdir) rescue r = nil
       if not r.nil?
           # lock succeeded, install signal handlers and store the PID
-          trap 0, proc { p "Trapped"
-FileUtils.rm_rf lockdir }
+          trap 0, proc { FileUtils.rm_rf lockdir }
           r = File.open(pidfile, 'w') {|f| f.write($$) }
       else
           # lock failed, now check if the other PID is alive
@@ -119,8 +118,7 @@ FileUtils.rm_rf lockdir }
           r = Process.kill(0, otherpid) rescue r = nil
           if r == nil
               # lock is stale, remove it and go on
-              trap 0, proc { p "Trapped"
-FileUtils.rm_rf lockdir }
+              trap 0, proc { FileUtils.rm_rf lockdir }
               r = File.open(pidfile, 'w') {|f| f.write($$) } rescue r=nil
               return false
           else

data/lib/gat/condition.rb

@@ -0,0 +1,80 @@
+=begin
+
+  :file   => condition.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 Condition
+    
+    include Gat::Checks
+    include Gat::Interpreter
+
+    attr_reader :operation
+    attr_reader :config
+    attr_reader :name
+    attr_reader :type
+    attr_reader :description
+    
+    attr_reader :onfail
+    attr_reader :onfail_message
+    
+    def initialize(name, config, operation)
+      operation.gatget.logger.log("trace", "condition", "Initialize condition #{ name }")
+      @operation      = operation
+      @config         = config
+      @name           = name
+
+      @description    = config['description'] || "Another Condition"
+      
+      @type           = config['type']   || 'check_true'
+      @onfail         = config['onfail'] || 'abort'
+      @onfail_message = config['onfail_message'] || "Gatget Process fail at condition #{ self.name }"
+        
+    end
+    
+    
+    def evalue
+      unless Gat::Checks.instance_methods.include?(self.type)
+        raise GatgetConfigException.new("Check condition method #{ self.type } not available at Gat::Checks", "evalue_condition")
+      end
+      
+      condition_arguments = {}
+      
+      self.config['arguments'].each_pair do |argument_name, argument_parameter|
+        condition_arguments[argument_name] = interpreter_parameter(argument_parameter, self.operation.gatget)
+      end
+      
+      # Eval condition by send check_method
+      # if condition fail, onfail config will checked. unless it is different for 'abort' (default value)
+      # gat will stop the process thourgh GatgetProcessException
+      unless self.send(self.type, condition_arguments)
+        @@conditions_status = 'failed'
+        self.operation.gatget.logger.log('warning', 'condition_eval', "Condition #{ self.name } evalued at False")
+        
+        if self.onfail == 'abort'
+          self.operation.gatget.logger.log('error', 'condition_eval', "Condition #{ self.name } abort Gatget")
+          self.operation.status = 'failed'
+          raise GatgetProcessException.new(self.onfail_message, "evalue_condition")
+        end
+      end
+    end
+  end
+end

data/lib/gat/dependence/folder.rb

@@ -64,10 +64,8 @@ module Gat
       private
       # check if folder is mounted, if not, try it, if doesnt work, launch GatgetProcessException
       def mounted?
-        unless already_mounted? 
-          unless mount_folder
-            raise Gat::GatgetProcessException.new("Unable to mount folder #{ self.name } at #{ self.path }", "mounted")
-	  end
+        unless already_mounted? || mount_folder
+          raise Gat::GatgetProcessException.new("Unable to mount folder #{ self.name } at #{ self.path }", "mounted")
 	end
       end
       
@@ -77,7 +75,7 @@ module Gat
         mounts_file = File.open('/proc/mounts', 'r')
         mounted = false
         mounts_file.each_line do |mount_line|
-          mounted = true if mount_line.split(" ")[2].include?(self.path)
+          mounted = true if mount_line.split(" ")[1].include?(self.path)
         end
         mounted
       end
@@ -90,7 +88,7 @@ module Gat
         
         ignored, status_open4 = Process::waitpid2 pid_open4
         
-        if status_open4.exitstatus == 0   # try to mount_folder
+        if status_open4.exitstatus == 0
           self.operation.gatget.logger.log("trace", "mount_folder", "Folder #{ self.name } nicely mounted ")
           ret = true
         else

data/lib/gat/dependence/program.rb

@@ -11,7 +11,11 @@ module Gat
       end
       
       def evalue
-        self.path || evalue_from_shell
+        evalue_from_path || evalue_from_shell
+      end
+      
+      def evalue_from_path
+        self.value = self.path
       end
       
       # Program is evalued through 'which' shell command
@@ -33,4 +37,4 @@ module Gat
       end
     end
   end
-end
+end

data/lib/gat/extends.rb

@@ -46,21 +46,36 @@ 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
+    nice_file_size(filesize)
+  end
+end
+
+def nice_file_size(size)
+  if size >= 1073741824
+    filesize = "#{ (size.to_f / 1073741824.0).round_to(2) } Gb."
+  elsif size >= 1048576
+    filesize = "#{ (size.to_f / 1048576.0).round_to(2) } Mb."
+  elsif size >= 1024
+    filesize = "#{ (size.to_f / 1024.0).round_to(2) } Kb."
+  else
+    filesize = "#{ size } bytes"
   end
+  filesize
 end
 
+
+# Float#round_to
+# From: http://www.hans-eric.com/code-samples/ruby-floating-point-round-off/
+# Source: --
+# Just round a float number to x decimals
+class Float
+  def round_to(x)
+    (self * 10**x).round.to_f / 10**x
+  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

data/lib/gat/logger.rb

@@ -141,12 +141,12 @@ module Gat
       @gatget.logger.log("direct", "operation_output_template", template.result(binding))
     end
 
-    # Standar email output
+    # Standard email output
     # See output for more information
     def output_email
       # default email config is used
       unless @gatget.config['email_config']
-        raise GatgetConfigException.new("Default email config is empty at @gatget.config['email_config']", "run_output_email")
+        raise GatgetConfigException.new("Default email config is empty at @gatget.config['email_config']", "logger:output_email")
       end
 
       if @gatget.operation.status == 'ok'

data/lib/gat/sample.yml

@@ -0,0 +1,195 @@
+
+###### Global variables, only accessible in yaml scripts via eval code
+
+#### Identification, used in logs
+
+subsystem_name: backup 
+subsystem_description: Irgat backup module 
+server_name: balrog
+server_domain: gnoxys.net
+
+
+###### Logs definitions
+
+script_log:
+
+  # Log to stdout, not the same as the debug output
+  stdout:
+    enable: false
+    level: 4  # 0.-No output, 1.-Errors, 2.-Warnings, 3.-Messages, 4.-Trace
+
+  # email log
+  mail:
+    enable: false
+    send_to: santi@gnoxys.net
+    smtp_mode: smtp # smtp or sendmail
+    level: 4  # see above
+    smtp_values:  # smtp configuration
+      server: mail.gnoxys.net
+      port: 25
+      domain: gnoxys.net
+      user: santi@gnoxys.net
+      password: 
+
+
+
+###### Script variables, used only in the yaml script
+script_variables:
+
+# User who should run the .rb script
+  run_as_user: gnoxys
+
+# Path to the backups
+  working_path: /tmp/backups
+
+# Array of folders to create inside working_path to store things that will be backed up
+  folders_tree: 
+  - data
+  - data/local
+  - data/local/current   # stores the '.dar' files
+  - data/local/old
+  - extras
+  - extras/mysql         # stores the mysql dumps
+
+# days in which a complete backup will be made (0 -> Sunday, 1 -> Monday, etc.)
+# Put it into quotes!
+  complet_backup_days:  "2"
+
+# maximum complete backups to be stored in the system
+  max_stored_backups: 2
+
+# Exclude folders from backup, absolute path without first slash
+# for example var/tmp
+# IMPORTANT: data and restore irgat::backup folders are by definition excluded.
+# You don't need to write it here.
+  exclude_folders: 
+  - boot
+  - dev
+  - var/tmp
+
+# files ommited inside backup files, can contain wildcards
+  exclude_files:
+  - *.dar
+
+# exclude types in the compress phase
+  exclude_to_compress: 
+    - .gz
+    - .bz2
+    - .zip
+    - .png
+
+# MySQL dump options
+  mysql_user:
+  mysql_pass:
+
+# dar options
+  dar:
+    compression: 256                 # enable compression. nil disable
+    file_size: 500M                  # size of division each file
+    enable_empty_folders: true       # enable backup empty folders
+    root_backup: '/'                 # root folder from backup
+    encrypt_passwd:                  # password to encrypt backups
+    decrypt_passwd:                  # password to decrypt backups
+
+
+###### Script action definition
+###### Script actions consist of conditions and actions
+
+sample_script_action:
+
+  # Script actions can be disabled. They are enabled by default
+  enabled: false
+  disabled: true  # both of them work
+
+  # Conditions are checked before any subaction.
+  conditions:             # Must be an array, hence the following hyphen
+    - sample_condition:
+
+        # Conditions can be disabled. They are enabled by default
+        enabled: false
+        disabled: true    # both of them work
+
+        type:							# Type of value to be checked:
+                            # fixed: A literal value
+                            # array: A literal array
+                            # script_variable: one of the ones defined in the script_variables section
+                            # script_array: one of the ones defined in the script_variables section
+                            # eval: Ruby code to be evaluated
+                            # dependence: 
+                              # folder/_a_folder
+                              # programs/_a_program
+        value:            # definition of the value to be checked
+
+        negated: false    # conditions can be negated, defaults to false
+
+        onfail: fail      # What to do if condition fails:
+                            # skip .- skips this subaction
+                            # continue .- skips this condition
+                            # fail .- exits script
+        post_eval: code   # code to be evaluated after getting the value (%). 
+                            # Example: if % print true else print false end 
+
+        arguments:        # conditions can have arguments
+          - sample_argument:
+            type:         # same as condition
+            value:        # same as condition
+
+
+  # Actions included in script actions are executed if all the conditions are met
+  actions:                
+    # Actions can be disabled. They are enabled by default
+    enabled: false
+    disabled: true  # both of them work
+
+    - sample_action:       # Must be an array, hence the following hyphen
+         # Actions can be 'command' or 'set_variable'
+         - set_variable:
+           name:           # Script variable name
+           type:           # same as condition above
+           value:          # same as condition above
+
+         - command:
+             type: shell | ruby | shell.foreach | ruby.foreach
+
+             syntax:       # syntax of the command. 
+                           # % is a placeholder for arguments: cd %
+
+             arguments:    # same as conditions
+
+             onfail:       # same values as conditions
+
+             # For types shell.foreach and ruby.foreach:
+             source_action:   # Name of the action that produced the array to be processed.
+                              # Each element of the array is named 'line'
+
+
+###### Optional initialize script
+
+initialize:
+  conditions:
+    - condition_1:
+    - condition_2:
+
+  actions:
+    - action_1:
+    - action_2:
+
+
+###### The actions of the script, not including the optional initalize action
+
+script_actions:
+  - script_action_1:
+  - script_action_2:
+
+
+
+###### Known issues
+#
+# There are a number of problems with writing ruby expressions in yaml code 
+# 1.- String concatenation:
+#
+# 2.- Don't use return statements in eval code: 
+#   return statements, besides returning a value, will end the calling irgat script function
+
+
+