vgh 0.1.2 → 0.2.0

data/.travis.yml

@@ -3,4 +3,5 @@ rvm:
   - 1.9.3
   - 1.8.7
   - ree
-script: "rvmsudo bundle exec rake spec"
+script: "bundle exec rake spec"
+#script: "rvmsudo bundle exec rake spec"

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+=== 0.2.0
+  - Add Checkpoint app
+  - Merged all configuration files to a single one
+  - Major code refactoring
+  - Improved tests
+
 === 0.1.2
 [Bugs]
   - Fix snapshot creation process (remove memoization)

data/README.rdoc

@@ -8,12 +8,12 @@ A collection of custom scripts used on VladGh.com
 == Instalation
 
 Some system wide dependencies should be installed first:
-  * ruby 1.8 or 1.9
-  * rubygems (if ruby 1.8)
-  * ruby-dev
-  * build-essential
-  * libxslt & libxslt-dev
-  * libxml2 & libxml2-dev
+* ruby 1.8 or 1.9
+* rubygems (if ruby 1.8)
+* ruby-dev
+* build-essential
+* libxslt & libxslt-dev
+* libxml2 & libxml2-dev
 
 
 Add this line to your application's Gemfile:
@@ -31,26 +31,14 @@ Or install it yourself as:
 
 == Configuration
 
-This gem looks for the following configuration files inside "+/etc/vgh+" or the
-+--confdir+ specified in {VGH::CLI CLI Class}:
+This gem looks for the configuration file inside the following folders
+* +/etc/vgh+
+* +~/.vgh+
+* +--confdir+ (specified in the command line options)
 
-[+config.yml+]
-  The main configuration file for this gem.
-  This file should include the AWS specific configuration.
-  Available values:
-  - +:access_key_id+ - [String] Your AWS credentials
-  - +:secret_access_key+ - [String] Your AWS credentials
-  - +:region+ - optional [String] Your current instance's region.
-    Ex: +'us-west-1'+
+This gem checks if the file exists and if it is in a correct YAML format.
 
-[+#APP_NAME.config.yml+]
-  The application specific configuration (see
-  {file:README.rdoc#Applications Applications} below for a list of available
-  apps and values).
-
-This gem checks if the files exists and if they are in a correct YAML format.
-
-All files should have the following format (where the keys are symbols):
+It should have the following format (where the keys are symbols):
     # Comment
     :key: 'value'
     :string: 'string value'
@@ -63,11 +51,14 @@ All files should have the following format (where the keys are symbols):
      -
      :sub_key: 'sub value'
 
-Example configuration files can be found in this gem's directory. You can
-find were that is by specifying the +--gemdir+ command line option.
+An example of the configuration file can be found in this gem's directory.
+You can find were that is by specifying the +--gemdir+ command line option.
 
 Ex: <tt>vgh --gemdir</tt>
 
+Read the config.yml.example for a list of configuration options.
+
+
 == Command line options
 
 The following command line options are available:
@@ -75,8 +66,8 @@ The following command line options are available:
 [+ApplicationName+] Specify the application you want to run. For a
                     list of available apps see
                     {file:README.rdoc#Applications Applications} below.
-[+-c+ <tt>--confdir '~/.vgh'</tt>] Specify the desired directory in which
-                                   the configuration files reside.
+[<tt>--confdir=~/.vgh</tt>] Specify the desired directory in which
+                            the configuration files reside.
 [+-v+ <tt>--[no-]verbose</tt>] Specify whether to display messages on the
                                screen or not.
 [+-l+ <tt>--[no-]logging</tt>] Specify whether to log messages or not.
@@ -116,28 +107,27 @@ The following command line options are available:
   be postponed for as long as the device is suspended.
 
 
-  ==== EC2-Backup Configuration
-  +ec2-backup.config.yml+
-  - +:expiration+ -- required [Integer] Number of days to keep the snapshots.
-      # Ex:
-      :expiration: 7
-  - +:mysql_user+ -- required [String] The MySQL user that can flush the tables.
-      # Ex:
-      :mysql_user: 'dbadmin'
-  - +:mysql_pwd+ -- required [String] The password of the above MySQL user.
-      # Ex:
-      :mysql_pwd: 'MyStrongPassword'
-  - +:instance+ -- optional [String] The id of the remote instance you want to backup.
-      # Ex:
-      :instance: 'i-12345678'
-  - +:fqdn+ -- optional [String] The FQDN of the remote instance you want to backup.
-      # Ex:
-      :fqdn: 'MyServer.Example.com'
+  ==== Intended usage
+    # Cron Job:
+    0 */6 * * * vgh ec2-backup -l
+
+=== Checkpoint
+
+[/bin/vgh checkpoint]
+
+  ==== Description
+  This app looks for volumes tagged with the 'CHECKPOINT' key attached to the
+  current instance, and creates snapshots for them.
+  It is intended to be used as a cron job on an AWS instance running
+  Ubuntu.
+
+  MySQL flushing and LVM suspending specified above in the EC2-Backup app, work
+  the same.
 
 
   ==== Intended usage
     # Cron Job:
-    0 */6 * * * vgh ec2-backup -l
+    0 */6 * * * vgh checkpoint -l
 
 
 == Contributing

data/Rakefile

@@ -1,6 +1,7 @@
 require 'bundler/gem_helper'
 require 'rspec/core/rake_task'
 require 'yard'
+require 'reek/rake/task'
 
 $LOAD_PATH << File.join(File.dirname(__FILE__), 'tasks')
 Dir['tasks/**/*.rake'].each { |task| load task }
@@ -8,6 +9,12 @@ Dir['tasks/**/*.rake'].each { |task| load task }
 RSpec::Core::RakeTask.new
 Bundler::GemHelper.install_tasks
 
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = false
+  t.verbose = false
+  t.reek_opts = "--quiet"
+end
+
 task :default do
   puts `rake -T`
 end

data/conf/config.yml.example

@@ -1,9 +1,30 @@
-# Main settings for VGH gem
+# Configuration for the VGH gem
 
-# AWS Credentials:
-:access_key_id: 'xxxxxxxxxxxxxxxxxx'
-:secret_access_key: 'xxxxxxxxxxxxxxxxxx'
+#####################
+# AWS Configuration #
+#####################
+# (See http://docs.aws.amazon.com/AWSRubySDK/latest/AWS.html#config-class_method
+# for a full list of configuration options):
+# (NOTE: It's recommended to use IAM roles and not put your credentials here:
+# http://docs.aws.amazon.com/AWSSdkDocsRuby/latest/DeveloperGuide/ruby-dg-roles.html)
+#
+#:access_key_id: '1234'
+#:secret_access_key: '4321'
+#:ec2_endpoint: 'ec2.us-west-2.amazonaws.com'
+#:auto_scaling_endpoint: 'autoscaling.us-west-2.amazonaws.com'
 
-# AWS Region (optional). It defaults to 'us-east-1'
-#:region: 'us-west-1'
 
+###########################
+# EC2-Backup app settings #
+###########################
+
+# Expiration period (defaults to 7 days)
+#:expiration: 7 # Number of days to keep the snapshots
+
+# MySQL Settings
+#:mysql_user: 'dbadmin' # The MySQL user that can flush the tables
+#:mysql_password: 'MyStrongPassword' # The password of the above MySQL user
+
+# Remote settings
+#:instance: 'i-12345678' # The id of the remote instance you want to backup
+#:fqdn: 'server.example.com' # The fully qualified domain name of the server

data/lib/vgh/apps/checkpoint.rb

@@ -0,0 +1,55 @@
+module VGH
+module APPS
+
+  # == Description:
+  #
+  # See {file:README.rdoc#Checkpoint Checkpoint Section} in the README
+  # file.
+  #
+  # == Usage:
+  #     checkpoint = APPS::Checkpoint.new
+  #     checkpoint.run
+  #
+  class Checkpoint
+
+    # @return [Object] Volumes Class
+    attr_reader :volumes
+
+    # Initialize external classes
+    def initialize
+      @volumes ||= EC2::Volume.new
+    end
+
+    # Runs the checkpoint app logic
+    def run
+
+      System.lock
+
+      vols = volumes
+      vols.list_tagged('CHECKPOINT').map {|vid|
+        snap_and_tag(
+          vid,
+          "CHECKPOINT for #{vid}(#{vols.name_tag(vid)})",
+          {
+            'Name'   => fqdn,
+            'CHECKPOINT' => "#{instance_id};#{vid}"
+          }
+        )
+      }
+
+      System.unlock
+
+    end
+
+  end # class EC2_Backup
+
+end # module APPS
+end # module VGH
+
+require 'vgh/output'
+require 'vgh/configuration'
+require 'vgh/system/lvm'
+require 'vgh/system/mysql'
+require 'vgh/ec2/volume'
+require 'vgh/ec2/snapshot'
+

data/lib/vgh/apps/ec2_backup.rb

@@ -12,58 +12,33 @@ module APPS
   #
   class EC2_Backup
 
-    # Loads the necessary classes
+    # @return [Object] Volumes Class
+    attr_reader :volumes
+
+    # Initialize external classes
     def initialize
-      # Check if this script is run with root credentials
-      abort "ERROR: This app needs to be run as root!" unless is_root?
-      @mysql    = System::MySQL.new
-      @lv       = System::LV.new
-      @volume   = Extended_AWS::Extended_EC2::Volume.new
-      @snapshot = Extended_AWS::Extended_EC2::Snapshot.new
+      @volumes ||= EC2::Volume.new
     end
 
     # Runs the ec2-backup app logic
     def run
-      lock
-
-      begin
-        @volume.list.map {|id, info|
-          @snapshot.create(id, info[:tag])
-        }
-      rescue
-        message.fatal "Something went wrong in the snapshot creation process!"
-      end
-
-      unlock
 
-      @snapshot.purge
-    end
+      System.lock
 
-    # Flushes MySQL tables and suspends Logical Volumes
-    def lock
-      unless remotely?
-        @mysql.flush
-        @lv.suspend
-      end
-    end
+      vols = volumes
+      vols.list.map {|vid|
+        snap_and_tag(
+          vid,
+          "Backup for #{vid}(#{vols.name_tag(vid)})",
+          {
+            'Name'   => fqdn,
+            'BACKUP' => "#{instance_id};#{vid}"
+          }
+        )
+      }
 
-    # Resumes MySQL and Logical Volumes
-    def unlock
-      unless remotely?
-        @mysql.unlock
-        @lv.resume
-      end
-    end
+      System.unlock
 
-    # Checks if this script is run remotely.
-    # @return [Boolean]
-    def remotely?
-      cfg = app_config
-      if cfg[:instance] or cfg[:fqdn]
-        @remotely = true
-      else
-        @remotely = false
-      end
     end
 
   end # class EC2_Backup
@@ -72,8 +47,9 @@ end # module APPS
 end # module VGH
 
 require 'vgh/output'
+require 'vgh/configuration'
 require 'vgh/system/lvm'
 require 'vgh/system/mysql'
-require 'vgh/extended_aws/extended_ec2/volume'
-require 'vgh/extended_aws/extended_ec2/snapshot'
+require 'vgh/ec2/volume'
+require 'vgh/ec2/snapshot'
 

data/lib/vgh/apps.rb

@@ -13,7 +13,8 @@ module APPS
   # @return [Array]
   def self.list
     @apps ||= [
-      'ec2-backup'
+      'ec2-backup',
+      'checkpoint'
     ]
   end
 

data/lib/vgh/cli.rb

@@ -14,12 +14,6 @@ module VGH
     $app ||= cli[:app]
   end
 
-  # Returns the configuration specified in the command line
-  # @return [String]
-  def cli_confdir
-    $cli_confdir ||= cli[:confdir]
-  end
-
   # Returns verbosity
   # @return [Boolean]
   def verbose?
@@ -56,6 +50,7 @@ module VGH
       @options[:app]     = false
       @options[:verbose] = false
       @options[:logging] = false
+      @options[:confdir] = nil
     end
 
     # Collect options
@@ -115,9 +110,14 @@ module VGH
 
     # Loads the configuration directory
     def confdir
-      @optparse.on('-c', '--confdir \'~/.vgh\'', 'Configuration directory') do |conf|
-        path = File.expand_path(conf)
-        @options[:confdir] = path if File.directory?(path)
+      @optparse.on('--confdir=PATH', 'Configuration directory') do |config_dir|
+        path = File.expand_path(config_dir)
+        if File.directory?(path)
+          @options[:confdir] = path
+        else
+          puts "The configuration directory '#{config_dir}' does not exist!"
+          exit
+        end
       end
     end
 

data/lib/vgh/configuration.rb

@@ -5,40 +5,12 @@ require 'logger'
 
 module VGH
 
-  # Initialize the configuration parser
-  # @return [Hash]
-  def parse_config
-    $parse_config ||= Configuration.new
-  end
-
-  # Returns a hash containing the main settings
+  # Global config method
   # @return [Hash]
   def config
-    $config ||= parse_config.main_config
-  end
-
-  # Returns a hash containing the app settings
-  # @return [Hash]
-  def app_config
-    $app_config ||= parse_config.app_config
+    $config ||= Configuration.new.config
   end
 
-  # Returns a single merged hash with all configurations
-  # @return [Hash]
-  def global_config
-    $global_config ||= [config, app_config].inject(:merge)
-  end
-
-  # Creates a global ec2 method (passing the specified region).
-  # The default region is us-east-1, so we overwrite it here.
-  def ec2
-    region = config[:region]
-    if region
-      $ec2 = AWS::EC2.new.regions[region]
-    else
-      $ec2 = AWS::EC2.new
-    end
-  end
 
   # == Description:
   #
@@ -48,81 +20,98 @@ module VGH
   #
   # == Usage:
   #
-  #     parse       = Configuration.new
-  #     main_config = parse.main_config
-  #     app_config  = parse.app_config
+  #     config    = Configuration.new.config
+  #     mysetting = config[:mysetting]
   #
-  #     pp main_config
-  #     pp app_config
   #
   class Configuration
 
-    # Main configuration
-    attr_reader :main_config
+    # Global configuration
+    # @return [Hash] The configuration hash
+    attr_reader :config
 
-    # App specific configuration
-    attr_reader :app_config
-
-    # Set defaults
+    # Parse the main configuration
+    # @return [Hash]
     def initialize
-      @confdir = validate_config_dir('/etc/vgh')
-      @main    = "#{@confdir}/config.yml"
-      @app     = "#{@confdir}/#{app}.config.yml"
+      message.info "Loading configuration..."
+      @config ||= validate(config_file)
+      aws_config
+    end
+
+    # The global configuration directory
+    # @return [String]
+    def global_config_dir
+      '/etc/vgh'
+    end
+
+    # The user configuration directory
+    # @return [String]
+    def user_config_dir
+      File.expand_path('~/.vgh')
     end
 
     # IF specified, use the confdir specified in the command line options
-    def validate_config_dir(default_confdir)
-      cli = cli_confdir
-      if cli.nil?
-        return default_confdir
+    # @return [String]
+    def confdir
+      cli_confdir = cli[:confdir]
+      global = global_config_dir
+      if !cli_confdir.nil?
+        return cli_confdir
+      elsif File.directory?(global)
+        return global
       else
-        return cli
+        return user_config_dir
       end
     end
 
+    # The main configuration file
+    # @return [String]
+    def config_file
+      "#{confdir}/config.yml"
+    end
+
     # Returns error if the configuration is not right
-    def validate(cfg)
-      unless config_exists?(cfg) and config_correct?(cfg)
-        puts load_error(cfg)
+    # @return [Hash]
+    def validate(path)
+      if config_exists?(path) and config_correct?(path)
+        parse(path)
+      else
+        puts load_error(path)
         exit 1
       end
     end
 
     # Checks if the configuration file exists
+    # @return [Boolean]
     def config_exists?(path)
       File.exist?(path)
     end
 
     # Checks if the configuration is a valid YAML file
+    # @return [Boolean]
     def config_correct?(path)
       parse(path).kind_of?(Hash)
     end
 
     # Returns a parsed configuration
+    # @return [Hash]
     def parse(path)
-      @parse = YAML.load(File.read(path))
+      YAML.load(File.read(path))
     end
 
-    # Parse the main configuration
-    def main_config
-      message.info "Loading main configuration..."
-      validate(@main)
-      @main_config = parse(@main)
-      AWS.config({
-        :access_key_id     => @main_config[:access_key_id],
-        :secret_access_key => @main_config[:secret_access_key],
-        :logger            => log,
-        :log_formatter     => AWS::Core::LogFormatter.colored,
-        :max_retries       => 2
-      })
-      return @main_config
+    # Configures AWS
+    def aws_config
+      AWS.config(config)
+      AWS.config(aws_logging)
     end
 
-    # Parse app specific configuration
-    def app_config
-      message.info "Loading #{app} configuration..."
-      validate(@app)
-      @app_config = parse(@app)
+    # Implements our own Logging class
+    # @return [Hash]
+    def aws_logging
+      aws_logging ||= {
+        :logger        => log,
+        :log_formatter => AWS::Core::LogFormatter.colored
+      }
     end
 
     # Returns the error message in case the configuration os not right

data/lib/vgh/{extended_aws/extended_ec2 → ec2}/metadata.rb

@@ -6,16 +6,16 @@ module VGH
   # queries the API server for it.
   # @return [String]
   def instance_id
-      remote_instance = app_config[:instance]
+      remote_instance = config[:instance]
       if remote_instance
         $instance_id ||= remote_instance
       else
-        $instance_id ||= VGH::Extended_AWS::Extended_EC2::MetaData.new.instance_id
+        $instance_id ||= VGH::EC2::MetaData.new.instance_id
       end
+      return $instance_id
   end
 
-module Extended_AWS
-module Extended_EC2
+module EC2
 
 # This class gathers metadata information about the current instance, used by
 # the applications in this gem.
@@ -50,8 +50,7 @@ class MetaData
 
 end
 
-end # module Extended_EC2
-end # module Extended_AWS
+end # module EC2
 end # module VGH
 
 require 'vgh/output'