vgh 0.0.1

data/.gitignore

@@ -0,0 +1,28 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+html/
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# Mac Stuff
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+Icon?
+ehthumbs.db
+Thumbs.db

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - ree
+script: "rvmsudo bundle exec rake spec"

data/.yardopts

@@ -0,0 +1,2 @@
+--no-private --protected --readme=README.rdoc - LICENSE
+

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Vlad
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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.

data/README.rdoc

@@ -0,0 +1,121 @@
+= VGH Scripts {<img src="https://secure.travis-ci.org/vladgh/vgh.png" alt="Build Status" />}[http://travis-ci.org/vladgh/vgh]
+
+A collection of custom scripts used on VladGh.com
+
+
+== Instalation
+
+Some system wide dependencies should be installed first:
+
+    apt-get install libxslt-dev libxml2-dev
+
+Add this line to your application's Gemfile:
+
+    gem 'vgh'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vgh
+
+
+== Configuration
+
+This gem looks for the following configuration files inside "+/etc/vgh+" or the
++--confdir+ specified in {VGH::CLI CLI Class}:
+
+[+config.yml+]
+  The main configuration file for this gem.
+  <em>At this moment nothing needs to be configured here.</em>
+
+[+aws.config.yml+]
+  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'+
+
+[+#APP_NAME.config.yml+]
+  The application specific configuration (see below 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):
+    # Comment
+    :key: 'value'
+    :string: 'string value'
+    :integer: 123
+    :boolean: true/false
+    :array:
+     - '1st'
+     - '2nd'
+    :hash:
+     -
+     :sub_key: 'sub value'
+
+
+== Command line options
+
+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.
+[+-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.
+[+-h+ +--help+] Displays this list.
+[+-V+ +--version+] Displays the version number.
+
+
+== Applications
+
+=== EC2-Backup
+
+[/bin/vgh ec2-backup]
+
+  ==== Description
+  This app creates a snapshot of the attached EBS volumes. It also deletes
+  snapshots older than the expiration period specified in the configuration
+  file. It is intended to be used as a cron job on an AWS instance running
+  Ubuntu.
+  If a MySQL server is running, and the script has access to the administrator
+  credentials, then it closes all open tables and locks all tables for all
+  databases with a global read lock. Everything is unlocked at the end of the
+  script even if errors occur during the snapshot process. <em>You need to
+  provide the necessary mysql credentials in the +ec2-backup.config.yml+ file.
+  </em>
+  If Logical Volumes are found on the system then they are suspended for the
+  duration on the snapshot process.
+  Suspending a volume becomes useful if you want for example a consistent
+  EC2 snapshot of it. Any I/O that has already been mapped by the device but
+  has not yet completed will be flushed. Any further I/O to that device will
+  be postponed for as long as the device is suspended.
+
+
+  ==== EC2-Backup Configuration
+  +ec2-backup.config.yml+
+  - +:expiration+ -- [Integer] Number of days to keep the snapshots.
+      # Ex:
+      :expiration: 7
+
+
+  ==== Intended usage
+    # Cron Job:
+    0 */6 * * * vgh ec2-backup -l
+
+
+== Contributing
+
+1. Fork it
+2. Create your feature branch (<tt>git checkout -b my-new-feature</tt>)
+3. Commit your changes (<tt>git commit -am 'Add some feature'</tt>)
+4. Push to the branch (<tt>git push origin my-new-feature</tt>)
+5. Create new Pull Request (http://help.github.com/articles/using-pull-requests)

data/Rakefile

@@ -0,0 +1,25 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "yard"
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'tasks')
+Dir['tasks/**/*.rake'].each { |task| load task }
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  `rake -T`
+end
+
+task :test => :spec
+
+desc 'Look for the @todo tag'
+task :todo do |task|
+  Rake::Task['yard:doc_info'].execute
+  YARD::Registry.load!.all.each do |o|
+    todo = o.tag(:todo)
+    puts "#{todo.object} - #{todo.text}" if todo
+  end
+end
+
+

data/bin/vgh

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'vgh'
+
+include VGH
+run
+

data/lib/vgh/apps/ec2_backup.rb

@@ -0,0 +1,63 @@
+module VGH
+module APPS
+
+  # == Description:
+  #
+  # See {file:README.rdoc#EC2-Backup EC2-Backup Section} in the README
+  # file.
+  #
+  # == Usage:
+  #     backup = APPS::EC2_Backup.new
+  #     backup.run
+  #
+  class EC2_Backup
+
+    # Loads the necessary classes
+    def initialize
+      $cfg      = parse_config.app_config
+      @mysql    = System::MySQL.new
+      @lv       = System::LV.new
+      @volume   = Extended_AWS::Extended_EC2::Volume.new
+      @snapshot = Extended_AWS::Extended_EC2::Snapshot.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
+
+    # Flushes MySQL tables and suspends Logical Volumes
+    def lock
+      @mysql.flush
+      @lv.suspend
+    end
+
+    # Resumes MySQL and Logical Volumes
+    def unlock
+      @mysql.unlock
+      @lv.resume
+    end
+
+  end # class EC2_Backup
+
+end # module APPS
+end # module VGH
+
+require 'vgh/output'
+require 'vgh/system/lvm'
+require 'vgh/system/mysql'
+require 'vgh/extended_aws/extended_ec2/volume'
+require 'vgh/extended_aws/extended_ec2/snapshot'
+

data/lib/vgh/apps.rb

@@ -0,0 +1,22 @@
+module VGH
+
+# See {file:README.rdoc#Applications Applications Section} in the README
+# file.
+#
+#
+# == Usage:
+#     APPS.list
+#
+module APPS
+
+  # Lists the available applications
+  # @return [Array]
+  def self.list
+    @apps ||= [
+      'ec2-backup'
+    ]
+  end
+
+end # module APPS
+
+end # module VGH

data/lib/vgh/cli.rb

@@ -0,0 +1,185 @@
+require 'optparse'
+
+module VGH
+
+  # Returns a global collection of options.
+  # @return [Hash]
+  def cli
+    $cli ||= CLI.new.options
+  end
+
+  # Returns the app name specified in the command line
+  # @return [String]
+  def app
+    $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?
+    $verbose = cli[:verbose]
+  end
+
+  # Returns logging
+  # @return [Boolean]
+  def logging?
+    $logging = cli[:logging]
+  end
+
+  # == Description:
+  #
+  # Returns a structure describing the command line options and arguments.
+  # See {file:README.rdoc#Command+line+options Command line options} in
+  # the README file.
+  #
+  #
+  # == Usage:
+  #     cli = CLI.new.options
+  #     puts cli[:app]
+  #     puts cli[:verbose]
+  #     puts cli[:logging]
+  #     puts cli[:confdir]
+  #
+  class CLI
+
+    # Command line options
+    attr_reader :options
+
+    # We set default values here.
+    def defaults
+      @options[:app]     = false
+      @options[:verbose] = false
+      @options[:logging] = false
+    end
+
+    # Collect options
+    # @param [Array] apps A list of available apps
+    # @param [String] app The name of the app
+    # @param [Array] args The command line arguments
+    def initialize(apps = APPS.list, app = ARGV[0], args = ARGV)
+      @options = {}
+      @optparse = OptionParser.new()
+      defaults
+      banner(apps)
+      confdir
+      verbose
+      logging
+      help
+      version
+      validate(args)
+      check_app(apps, app)
+    end
+
+    # Checks if the provided app is in the available list
+    def check_app(apps, app)
+      if apps.include? app
+        @options[:app] = app
+      else
+        puts "ERROR: You need to specify one of the following apps: \
+#{apps.join(', ')}"
+        exit
+      end
+    end
+
+    # Returns the banner
+    def banner(apps)
+      header
+      available_apps(apps)
+      global_options
+    end
+
+    # Returns the header of the banner
+    def header
+      @optparse.banner = 'Usage: vgh app [options]'
+      @optparse.separator '========================'
+    end
+
+    # Returns a list of available apps
+    def available_apps(apps)
+      @optparse.separator ''
+      @optparse.separator "Available apps: #{apps.join(', ')}"
+    end
+
+    # Returns the header of the global options section
+    def global_options
+      @optparse.separator ''
+      @optparse.separator 'Options:'
+    end
+
+    # 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)
+      end
+    end
+
+    # Loads the verbosity argument
+    def verbose
+      @optparse.on('-v', '--[no-]verbose', 'Run verbosely') do |verbose|
+        @options[:verbose] = verbose
+      end
+    end
+
+    # Loads the logging argument
+    def logging
+      @optparse.on('-l', '--[no-]logging', 'Enable logging') do |logging|
+        @options[:logging] = logging
+      end
+    end
+
+    # Loads the help argument
+    def help
+      @optparse.on_tail('-h', '--help', 'Show this message') do
+        show_help
+      end
+    end
+
+    # Loads the version argument
+    def version
+      @optparse.on_tail('-V', '--version', 'Show version') do
+        show_version
+      end
+    end
+
+    # Parses the arguments
+    def validate(args)
+      begin
+        @optparse.parse!(args)
+      rescue OptionParser::ParseError,
+             OptionParser::InvalidArgument,
+             OptionParser::InvalidOption,
+             OptionParser::MissingArgument
+        puts $!.to_s
+        show_help
+        exit
+      end
+    end
+
+    # Returns the help
+    def show_help
+      puts @optparse
+      puts ''
+      show_version
+      exit
+    end
+
+    # Returns a message with the script's version
+    def show_version
+      puts "VGH Scripts: v#{VGH::VERSION}"
+      exit
+    end
+
+  end # Class CLI
+
+end # module VGH
+
+require 'vgh/apps'
+require 'vgh/version'
+

data/lib/vgh/configuration.rb

@@ -0,0 +1,176 @@
+require 'aws-sdk'
+require 'yaml'
+
+require 'logger'
+
+module VGH
+
+  # Initialize the configuration parser
+  def parse_config
+    $config ||= Configuration.new
+  end
+
+  # Returns a hash containing the main settings
+  def main_config
+    $main_config ||= parse_config.main_config
+  end
+
+  # Returns a hash containing the AWS settings
+  def aws_config
+    $aws_config ||= parse_config.aws_config
+  end
+
+  # Returns a hash containing the app settings
+  def app_config
+    $app_config ||= parse_config.app_config
+  end
+
+  # Returns a single merged hash with all configurations
+  def global_config
+    $global_config ||= [main_config, aws_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 = aws_config[:region]
+    if region
+      $ec2 = AWS::EC2.new.regions[region]
+    else
+      $ec2 = AWS::EC2.new
+    end
+  end
+
+  # == Description:
+  #
+  # See {file:README.rdoc#Configuration Configuration Section} in the
+  # README file.
+  #
+  #
+  # == Usage:
+  #
+  #     cfg         = Configuration.new
+  #     main_config = cfg.main_config
+  #     aws_config  = cfg.aws_config
+  #     app_config  = cfg.app_config
+  #
+  #     pp main_config
+  #     pp aws_config
+  #     pp app_config
+  #
+  class Configuration
+
+    # Main configuration
+    attr_reader :main_config
+
+    # AWS configuration
+    attr_reader :aws_config
+
+    # App specific configuration
+    attr_reader :app_config
+
+    # Set defaults
+    def initialize
+      @confdir = validate_config_dir('/etc/vgh')
+      @main    = "#{@confdir}/config.yml"
+      @aws     = "#{@confdir}/aws.config.yml"
+      @app     = "#{@confdir}/#{app}.config.yml"
+    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
+      else
+        return cli
+      end
+    end
+
+    # Returns error if the configuration is not right
+    def validate(cfg)
+      unless config_exists?(cfg) and config_correct?(cfg)
+        puts load_error(cfg)
+        exit 1
+      end
+    end
+
+    # Returns a parsed configuration
+    def parse(path)
+      @parse = YAML.load(File.read(path))
+    end
+
+    # Checks if the configuration file exists
+    def config_exists?(path)
+      File.exist?(path)
+    end
+
+    # Checks if the configuration is a valid YAML file
+    def config_correct?(path)
+      parse(path).kind_of?(Hash)
+    end
+
+    # Parse the main configuration
+    def main_config
+      message.info "Loading main configuration..."
+      validate(@main)
+      parse(@main)
+    end
+
+    # Parse the AWS configuration
+    def aws_config
+      message.info "Loading AWS configuration..."
+      validate(@aws)
+      @aws_config = parse(@aws)
+      load_aws
+      return @aws_config
+    end
+
+    # Overwrite the AWS Core configuration
+    def load_aws
+      AWS.config(@aws_config)
+      AWS.config({
+        :logger        => log,
+        :log_formatter => AWS::Core::LogFormatter.colored,
+        :max_retries   => 2
+      })
+    end
+
+    # Parse app specific configuration
+    def app_config
+      message.info "Loading #{app} configuration..."
+      validate(@app)
+      @app_config = parse(@app)
+    end
+
+    # Returns the error message in case the configuration os not right
+    def load_error(path)
+      log.fatal("#{path} is either missing or formatted incorrectly!")
+      load_error = <<END
+#{path} is either missing or formatted incorrectly!
+
+To run this script, you need to create a file named
+#{path} with your configuration in the following format:
+
+# Comment
+:key: 'value'
+:string: 'string value'
+:integer: 123
+:boolean: true/false
+:array:
+ - '1st'
+ - '2nd'
+:hash:
+ -
+ :sub_key: 'sub value'
+
+END
+    end
+
+  end # class Configuration
+
+end # module VGH
+
+require 'vgh/cli'
+require 'vgh/output'
+require 'vgh/logging'
+