vgh 0.0.2 → 0.1.0

data/.travis.yml

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

data/.yardopts

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

data/CHANGELOG.rdoc

@@ -0,0 +1,22 @@
+=== 0.1.0
+[Features]
+  - Add remote backup option
+  - Remove extra AWS configuration file
+  - Provide MySQL credentials in the configuration file
+  - Check if run as root at application level
+  - If log file can not be created, return STDOUT
+  - Add `gemdir` command line option to return gem files path
+  - Add configuration examples
+  - Add CHANGELOG
+[Bugs]
+  - Clean up code
+  - More tests
+  - Improve documentation
+  - Fix Rakefile
+
+=== 0.0.2
+[Bugs]
+  - Minor code fixes
+
+=== 0.0.1
+Initial release

data/README.rdoc

@@ -1,4 +1,6 @@
-= VGH Scripts {<img src="https://secure.travis-ci.org/vladgh/vgh.png" alt="Build Status" />}[http://travis-ci.org/vladgh/vgh]
+= VGH Scripts
+{<img src="https://secure.travis-ci.org/vladgh/vgh.png" alt="Build Status" />}[http://travis-ci.org/vladgh/vgh]
+{<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/vladgh/vgh]
 
 A collection of custom scripts used on VladGh.com
 
@@ -29,10 +31,7 @@ This gem looks for the following configuration files inside "+/etc/vgh+" or the
 
 [+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.
+  This file should include the AWS specific configuration.
   Available values:
   - +:access_key_id+ - [String] Your AWS credentials
   - +:secret_access_key+ - [String] Your AWS credentials
@@ -40,8 +39,9 @@ This gem looks for the following configuration files inside "+/etc/vgh+" or the
     Ex: +'us-west-1'+
 
 [+#APP_NAME.config.yml+]
-  The application specific configuration (see below a list of available apps and
-  values).
+  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.
 
@@ -58,6 +58,10 @@ 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.
+
+Ex: <tt>vgh --gemdir</tt>
 
 == Command line options
 
@@ -71,6 +75,7 @@ The following command line options are available:
 [+-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.
+[+-g+ +--gemdir+] Gem files location.
 [+-h+ +--help+] Displays this list.
 [+-V+ +--version+] Displays the version number.
 
@@ -86,12 +91,18 @@ The following command line options are available:
   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.
+
+  You can also backup a remote instance, if you specify an +:instance+ or
+  +fqdn+ value in the configuration file. But if you do so, you loose the
+  ability to suspend MySQL or Logical Volumes.
+
   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
@@ -102,9 +113,21 @@ The following command line options are available:
 
   ==== EC2-Backup Configuration
   +ec2-backup.config.yml+
-  - +:expiration+ -- [Integer] Number of days to keep the snapshots.
+  - +: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
@@ -118,4 +141,13 @@ The following command line options are available:
 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)
+5. Create new Pull Request
+   ({http://help.github.com/articles/using-pull-requests Using Pull Requests})
+
+
+== License
+See {file:LICENSE LICENSE}
+
+
+== Changelog
+See {file:CHANGELOG.rdoc CHANGELOG}

data/Rakefile

@@ -1,14 +1,15 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "yard"
+require 'bundler/gem_helper'
+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
+Bundler::GemHelper.install_tasks
 
 task :default do
-  `rake -T`
+  puts `rake -T`
 end
 
 task :test => :spec

data/conf/config.yml.example

@@ -0,0 +1,9 @@
+# Main settings for VGH gem
+
+# AWS Credentials:
+:access_key_id: 'xxxxxxxxxxxxxxxxxx'
+:secret_access_key: 'xxxxxxxxxxxxxxxxxx'
+
+# AWS Region (optional). It defaults to 'us-east-1'
+#:region: 'us-west-1'
+

data/conf/ec2-backup.config.yml.example

@@ -0,0 +1,12 @@
+# EC2-Backup app settings
+
+# Expiration period
+:expiration: 7 # Number of days to keep the snapshots
+
+# MySQL Settings
+:mysql_user: 'dbadmin' # The MySQL user that can flush the tables
+:mysql_pwd: 'MyStrongPassword' # The password of the above MySQL user
+
+# Remote settings
+#:instance: 'i-12345678' # The id of the remote instance you want to backup
+#:fqdn: 'MyServer.Example.com' # The FQDN of the remote instance you want to backup

data/lib/vgh/apps/ec2_backup.rb

@@ -14,7 +14,8 @@ module APPS
 
     # Loads the necessary classes
     def initialize
-      $cfg      = parse_config.app_config
+      # 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
@@ -40,14 +41,29 @@ module APPS
 
     # Flushes MySQL tables and suspends Logical Volumes
     def lock
-      @mysql.flush
-      @lv.suspend
+      unless remotely?
+        @mysql.flush
+        @lv.suspend
+      end
     end
 
     # Resumes MySQL and Logical Volumes
     def unlock
-      @mysql.unlock
-      @lv.resume
+      unless remotely?
+        @mysql.unlock
+        @lv.resume
+      end
+    end
+
+    # 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

data/lib/vgh/cli.rb

@@ -70,6 +70,7 @@ module VGH
       confdir
       verbose
       logging
+      gemdir
       help
       version
       validate(args)
@@ -134,6 +135,14 @@ module VGH
       end
     end
 
+    # Displays the location of gem files
+    def gemdir
+      @optparse.on_tail('-g', '--gemdir', 'Gem files location') do
+        puts File.expand_path('../../', File.dirname(__FILE__))
+        exit
+      end
+    end
+
     # Loads the help argument
     def help
       @optparse.on_tail('-h', '--help', 'Show this message') do
@@ -176,7 +185,7 @@ module VGH
       exit
     end
 
-  end # Class CLI
+  end # class CLI
 
 end # module VGH
 

data/lib/vgh/configuration.rb

@@ -6,34 +6,33 @@ require 'logger'
 module VGH
 
   # Initialize the configuration parser
+  # @return [Hash]
   def parse_config
-    $config ||= Configuration.new
+    $parse_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
+  # @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
   end
 
   # Returns a single merged hash with all configurations
+  # @return [Hash]
   def global_config
-    $global_config ||= [main_config, aws_config, app_config].inject(:merge)
+    $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 = aws_config[:region]
+    region = config[:region]
     if region
       $ec2 = AWS::EC2.new.regions[region]
     else
@@ -49,13 +48,11 @@ module VGH
   #
   # == Usage:
   #
-  #     cfg         = Configuration.new
-  #     main_config = cfg.main_config
-  #     aws_config  = cfg.aws_config
-  #     app_config  = cfg.app_config
+  #     parse       = Configuration.new
+  #     main_config = parse.main_config
+  #     app_config  = parse.app_config
   #
   #     pp main_config
-  #     pp aws_config
   #     pp app_config
   #
   class Configuration
@@ -63,9 +60,6 @@ module VGH
     # Main configuration
     attr_reader :main_config
 
-    # AWS configuration
-    attr_reader :aws_config
-
     # App specific configuration
     attr_reader :app_config
 
@@ -73,12 +67,12 @@ module VGH
     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)
+    def validate_config_dir(default_confdir)
+      cli = cli_confdir
       if cli.nil?
         return default_confdir
       else
@@ -94,11 +88,6 @@ module VGH
       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)
@@ -109,30 +98,24 @@ module VGH
       parse(path).kind_of?(Hash)
     end
 
+    # Returns a parsed configuration
+    def parse(path)
+      @parse = YAML.load(File.read(path))
+    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)
+      @main_config = parse(@main)
       AWS.config({
-        :logger        => log,
-        :log_formatter => AWS::Core::LogFormatter.colored,
-        :max_retries   => 2
+        :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
     end
 
     # Parse app specific configuration
@@ -157,13 +140,14 @@ To run this script, you need to create a file named
 :integer: 123
 :boolean: true/false
 :array:
- - '1st'
- - '2nd'
+- '1st'
+- '2nd'
 :hash:
- -
- :sub_key: 'sub value'
+-
+:sub_key: 'sub value'
 
 END
+      return load_error
     end
 
   end # class Configuration

data/lib/vgh/extended_aws/extended_ec2/metadata.rb

@@ -1,8 +1,19 @@
 require 'open-uri'
-require 'net/http'
-require 'uri'
 
 module VGH
+
+  # Looks for the instance id in the configuration. If it does not exist then it
+  # queries the API server for it.
+  # @return [String]
+  def instance_id
+      remote_instance = app_config[:instance]
+      if remote_instance
+        $instance_id ||= remote_instance
+      else
+        $instance_id ||= VGH::Extended_AWS::Extended_EC2::MetaData.new.instance_id
+      end
+  end
+
 module Extended_AWS
 module Extended_EC2
 

data/lib/vgh/extended_aws/extended_ec2/snapshot.rb

@@ -11,12 +11,6 @@ module Extended_EC2
 #
 class Snapshot
 
-  # Load all needed classes
-  def initialize
-    @instance_id = MetaData.new.instance_id
-    @fqdn        = System.fqdn
-  end
-
   # The workflow to create a snapshot:
   # - create snapshot
   # - add a name tag
@@ -27,7 +21,7 @@ class Snapshot
     snapshot(volume_id, volume_tag)
     name_tag
     info_tag(volume_id)
-    message.info "Creating and tagging snapshot \"#{@snapshot.id}\""
+    message.info "Creating and tagging snapshot \"#{snapshot.id}\""
   end
 
   # Creates a snapshot for the specified volume
@@ -42,19 +36,19 @@ class Snapshot
   # Creates a name tag for the newly created snapshot.
   # The name is the FQDN of the current instance.
   def name_tag
-    ec2.snapshots[@snapshot.id].tag('Name', :value => @fqdn)
+    ec2.snapshots[snapshot.id].tag('Name', :value => fqdn)
   end
 
   # Creates an info tag for the newly created snapshot
   def info_tag(volume_id)
-    ec2.snapshots[@snapshot.id].tag("Backup_#{@instance_id}", :value => volume_id)
+    ec2.snapshots[snapshot.id].tag("Backup_#{instance_id}", :value => volume_id)
   end
 
   # Purges expired snapshots
   def purge
-    expired.each do |snapshot|
-      message.info "Deleting expired snapshot (#{snapshot.id})"
-      snapshot.delete
+    expired.each do |snap|
+      message.info "Deleting expired snapshot (#{snap.id})"
+      snap.delete
     end
   end
 
@@ -63,9 +57,9 @@ class Snapshot
   # @return [Array] An array of expired snapshot objects
   def expired
     @expired = []
-    all.each {|snapshot|
-      if snapshot.start_time < (Time.now - $cfg[:expiration]*24*60*60)
-        @expired.push snapshot
+    all.each {|snap|
+      if snap.start_time < (Time.now - app_config[:expiration]*24*60*60)
+        @expired.push snap
       end
     }
     return @expired
@@ -75,7 +69,7 @@ class Snapshot
   def all
     @all ||= ec2.snapshots.
       with_owner('self').
-      tagged('Name').tagged_values(@fqdn)
+      tagged('Name').tagged_values(fqdn)
   end
 
 end # class Snapshot

data/lib/vgh/extended_aws/extended_ec2/volume.rb

@@ -13,9 +13,9 @@ module Extended_EC2
 #
 class Volume
 
-  # Collects all needed variables
-  def initialize
-    @instance_id = MetaData.new.instance_id
+  # @return An instance object
+  def instance
+    @instance ||= ec2.instances[instance_id]
   end
 
   # Creates a Hash collection of volumes containing their id, tag and device
@@ -32,11 +32,11 @@ class Volume
     return @list
   end
 
-  # Returns a Hash containing the block device mappings of the current instance
+  # Returns a Hash containing the block device mappings of the current instance.
   # @return [Hash]
   def mappings
     message.info "Creating a list of volumes..."
-    @mappings ||= ec2.instances[@instance_id].block_device_mappings
+    @mappings ||= instance.block_device_mappings
   end
 
   # Get volume's Name tag

data/lib/vgh/logging.rb

@@ -2,7 +2,7 @@ require 'logger'
 
 module VGH
 
-  # Returns log state
+  # Log message
   def log
     if logging?
       $log ||= Logging.new.log
@@ -46,7 +46,11 @@ module VGH
 
     # Opens the log file
     def log_file
-      File.open(@path, File::WRONLY | File::APPEND | File::CREAT)
+      begin
+        File.open(@path, File::WRONLY | File::APPEND | File::CREAT)
+      rescue
+        STDOUT
+      end
     end
 
     # Global, memoized, lazy initialized instance of a logger
@@ -63,4 +67,3 @@ module VGH
 end # module VGH
 
 require 'vgh/cli'
-

data/lib/vgh/output.rb

@@ -109,5 +109,4 @@ END_FOOTER
 end # module VGH
 
 require 'vgh/cli'
-require 'vgh/configuration'
 require 'vgh/logging'

data/lib/vgh/system/mysql.rb

@@ -16,10 +16,11 @@ class MySQL
 
   # Load defaults
   def initialize
+    cfg         = app_config
     @mysqladmin = '/usr/bin/mysqladmin'
     @mysql      = '/usr/bin/mysql'
-    @user       = $cfg[:mysql_user]
-    @password   = $cfg[:mysql_pwd]
+    @user       = cfg[:mysql_user]
+    @password   = cfg[:mysql_pwd]
   end
 
   # Check if server is running and we have access to the credentials file

data/lib/vgh/system.rb

@@ -1,5 +1,27 @@
 module VGH
 
+  # Returns the FQDN (either the one specified in the configuration file or
+  # the system's one)
+  # @return [String]
+  def fqdn
+    remote_fqdn = app_config[:fqdn]
+    if remote_fqdn
+      $fqdn ||= remote_fqdn
+    else
+      $fqdn ||= System.fqdn
+    end
+  end
+
+  # Check if the script is run as root
+  # @return [Boolean]
+  def is_root?
+    if Process.uid == 0
+      return true
+    else
+      return false
+    end
+  end
+
   # This is a parent class for different system actions performed by the scripts
   # included in this gem. For more information see the classes defined under
   # this namespace.
@@ -10,8 +32,8 @@ module VGH
   #
   module System
 
-    # FQDN
-    # @return [String] The FQDN of the current machine.
+    # Returns the current system's FQDN
+    # @return [String]
     def self.fqdn
       $fqdn ||= `hostname -f`
     end

data/lib/vgh/version.rb

@@ -1,6 +1,6 @@
 module VGH
   # Version number
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 
   # Returns the version number
   def version

data/lib/vgh.rb

@@ -21,9 +21,6 @@ module VGH
   # The main run method
   def run
 
-    # Check if this script is run with root credentials
-    root_check
-
     # Display header
     show_header
 
@@ -48,13 +45,9 @@ module VGH
     message.footer
   end
 
-  # Raise error if this app is not run as root
-  def root_check
-    raise 'Must run as root' unless Process.uid == 0
-  end
-
 end # module VGH
 
 require "vgh/output"
+require "vgh/system"
 require "vgh/apps"
 require "vgh/apps/ec2_backup"

data/spec/apps_spec.rb

@@ -0,0 +1,8 @@
+require 'helpers/spec'
+require 'vgh/apps'
+
+describe VGH::APPS do
+  it "Should have an array of supported apps" do
+    subject.list.should be_an Array
+  end
+end

data/spec/cli_spec.rb

@@ -1,25 +1,44 @@
-require 'spec_helper'
+require 'helpers/spec'
 require 'vgh'
 require 'vgh/apps'
 require 'vgh/cli'
 
-describe "Command Line" do
-  VGH::APPS.list.map {|app_name|
-    it "Should accept '#{app_name}' as the first argument" do
-      ARGV[0] = app_name
-      VGH::CLI.new.options[:app].should eq app_name
+describe VGH::CLI do
+
+  let(:app) {VGH::APPS.list.shuffle.first}
+
+  before(:all) do
+    ARGV[0] = app
+  end
+
+  it "Should get the app name as the first argument" do
+      VGH::CLI.new.options[:app].should eq app
     end
-  }
 
-  it "Should enable verbosity" do
-    ARGV[0] = VGH::APPS.list.shuffle.first
-    ARGV.push('-v')
-    VGH::CLI.new.options[:verbose].should be_true
+  context "When '-v' passed to the command line" do
+    it "Verbosity should be enabled" do
+      ARGV.push('-v')
+      VGH::CLI.new.options[:verbose].should be_true
+    end
   end
 
-  it "Should enable logging" do
-    ARGV[0] = VGH::APPS.list.shuffle.first
-    ARGV.push('-l')
-    VGH::CLI.new.options[:logging].should be_true
+  context "When '-v' NOT passed to the command line" do
+    it "Verbosity should be disabled" do
+      VGH::CLI.new.options[:verbose].should be_false
+    end
   end
+
+  context "When '-l' passed to the command line" do
+    it "Logging should be enabled" do
+      ARGV.push('-l')
+      VGH::CLI.new.options[:logging].should be_true
+    end
+  end
+
+  context "When '-l' NOT passed to the command line" do
+    it "Logging should be disabled" do
+      VGH::CLI.new.options[:logging].should be_false
+    end
+  end
+
 end

data/spec/extended_aws/extended_ec2/metadata_spec.rb

@@ -0,0 +1,24 @@
+require 'helpers/spec'
+
+require 'vgh/extended_aws/extended_ec2/metadata'
+
+describe VGH::Extended_AWS::Extended_EC2::MetaData do
+
+  before(:each) do
+    subject.stub(:message).and_return(Dummy.new)
+  end
+
+  it "Should retrieve the instance id" do
+    unless subject.instance_id.nil?
+      subject.instance_id.should match(/i\-.*/)
+    end
+  end
+
+  it "Should retrieve the root device" do
+    unless subject.root_device.nil?
+      subject.root_device.should match(/\/dev\/.*/)
+    end
+  end
+
+end
+

data/spec/extended_aws/extended_ec2/snapshot_spec.rb

@@ -0,0 +1,48 @@
+require 'helpers/spec'
+
+require 'aws-sdk'
+require 'vgh/extended_aws/extended_ec2/snapshot'
+require 'vgh/system'
+
+describe VGH::Extended_AWS::Extended_EC2::Snapshot do
+
+  include_context "Dummy Instance"
+
+  it "Should return a snapshot" do
+    subject.snapshot(@volume.id, 'test').should be_a(AWS::EC2::Snapshot)
+  end
+
+  it "Should add a Name tag to a snapshot" do
+    subject.name_tag.should be_a(AWS::EC2::Tag)
+  end
+
+  it "Should add an Info tag to a snapshot" do
+    subject.info_tag(@volume.id).should be_a(AWS::EC2::Tag)
+  end
+
+  it "Should get a list of all snapshots" do
+    subject.all.should be_a(AWS::EC2::SnapshotCollection)
+  end
+
+  it "Should create an array of expired snapshots" do
+    subject.expired.should be_empty
+  end
+
+  it "Should purge expired snapshots" do
+    subject.purge.should be_empty
+  end
+
+  #it "Should create a list of volumes" do
+    #subject.list.should be_a_kind_of Hash
+  #end
+
+  #it "Should get a collection of volume tags" do
+    #subject.tags(@volume.id).should be_a(AWS::EC2::TagCollection)
+  #end
+
+  #it "If no tags, it should return (NOTAG)" do
+    #subject.tag(@volume.id).should eq('(NOTAG)')
+  #end
+
+end
+

data/spec/extended_aws/extended_ec2/volume_spec.rb

@@ -0,0 +1,27 @@
+require 'helpers/spec'
+
+require 'aws-sdk'
+require 'vgh/extended_aws/extended_ec2/volume'
+
+describe VGH::Extended_AWS::Extended_EC2::Volume do
+
+  include_context "Dummy Instance"
+
+  it "Should create a hash with block device mappings" do
+    subject.mappings.should be_a_kind_of Hash
+  end
+
+  it "Should create a list of volumes" do
+    subject.list.should be_a_kind_of Hash
+  end
+
+  it "Should get a collection of volume tags" do
+    subject.tags(@volume.id).should be_a(AWS::EC2::TagCollection)
+  end
+
+  it "If no tags, it should return (NOTAG)" do
+    subject.tag(@volume.id).should eq('(NOTAG)')
+  end
+
+end
+

data/spec/helpers/spec.rb

@@ -0,0 +1,39 @@
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end
+
+class Dummy
+  def method_missing(name, *args, &block)
+    #puts "Tried to handle unknown method %s" % name # name is a symbol
+    #unless args.empty?
+      #puts "It had arguments: %p" % [args]
+    #end
+  end
+end
+
+shared_context "Dummy Instance" do
+  before(:each) do
+    AWS.stub!
+    AWS.config({:access_key_id => '', :secret_access_key => ''})
+    @ec2 = AWS::EC2.new
+    @instance = AWS::EC2::Instance.new('i-12345678')
+    @fqdn = 'test.example.com'
+    @volume = AWS::EC2::Volume.new('vol-12345678')
+    @snapshot = AWS::EC2::Snapshot.new('snap-12345678')
+    @device = '/dev/test'
+    @attachment = AWS::EC2::Attachment.new(@volume, @instance, @device)
+    @instance.stub(:block_device_mappings).and_return({
+      @device => @attachment
+    })
+
+    subject.stub(:ec2).and_return(@ec2)
+    subject.stub(:instance_id).and_return(@instance.id)
+    subject.stub(:fqdn).and_return(@fqdn)
+    subject.stub(:instance).and_return(@instance)
+    subject.stub(:snapshot).and_return(@snapshot)
+    subject.stub(:message).and_return(Dummy.new)
+  end
+end

data/spec/logging_spec.rb

@@ -0,0 +1,11 @@
+require 'helpers/spec'
+require 'vgh'
+require 'vgh/logging'
+
+describe VGH::Logging do
+  it "Should write logs" do
+    log = VGH::Logging.new.log
+    log.should_receive(:info).with("RSpec Test")
+    log.info("RSpec Test")
+  end
+end

data/spec/output_spec.rb

@@ -0,0 +1,15 @@
+require 'helpers/spec'
+require 'vgh'
+require 'vgh/cli'
+require 'vgh/apps'
+require 'vgh/output'
+require 'vgh/logging'
+require 'vgh/configuration'
+
+describe VGH::Output do
+  let(:message) {VGH::Output.new}
+  it "Should write messages" do
+    message.should_receive(:stdout).with("RSpec Test")
+    message.stdout("RSpec Test")
+  end
+end

metadata

@@ -1,129 +1,132 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: vgh
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Vlad Ghinea
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-10-14 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: aws-sdk
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 6
-        - 6
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.6.6
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: sinatra
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 1
-        - 3
-        - 3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.3.3
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Vlad's custom scripts
-email: 
+email:
 - vgit@vladgh.com
-executables: 
+executables:
 - vgh
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .travis.yml
 - .yardopts
+- CHANGELOG.rdoc
 - Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
 - bin/vgh
+- conf/config.yml.example
+- conf/ec2-backup.config.yml.example
 - lib/vgh.rb
 - lib/vgh/apps.rb
 - lib/vgh/apps/ec2_backup.rb
@@ -140,46 +143,47 @@ files:
 - lib/vgh/system/lvm.rb
 - lib/vgh/system/mysql.rb
 - lib/vgh/version.rb
+- spec/apps_spec.rb
 - spec/cli_spec.rb
-- spec/misc_spec.rb
-- spec/spec_helper.rb
+- spec/extended_aws/extended_ec2/metadata_spec.rb
+- spec/extended_aws/extended_ec2/snapshot_spec.rb
+- spec/extended_aws/extended_ec2/volume_spec.rb
+- spec/helpers/spec.rb
+- spec/logging_spec.rb
+- spec/output_spec.rb
 - tasks/documentation.rake
 - vgh.gemspec
 homepage: https://github.com/vladgh/vgh
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A collection of custom scripts used on VladGh.com
-test_files: 
+test_files:
+- spec/apps_spec.rb
 - spec/cli_spec.rb
-- spec/misc_spec.rb
-- spec/spec_helper.rb
+- spec/extended_aws/extended_ec2/metadata_spec.rb
+- spec/extended_aws/extended_ec2/snapshot_spec.rb
+- spec/extended_aws/extended_ec2/volume_spec.rb
+- spec/helpers/spec.rb
+- spec/logging_spec.rb
+- spec/output_spec.rb
 has_rdoc: 

data/spec/misc_spec.rb

@@ -1,25 +0,0 @@
-require 'spec_helper'
-require 'vgh'
-require 'vgh/cli'
-require 'vgh/apps'
-require 'vgh/output'
-require 'vgh/logging'
-require 'vgh/configuration'
-
-describe "Various Tests" do
-  it "Should have an array of supported apps" do
-    VGH::APPS.list.should be_an Array
-  end
-
-  it "Should write logs" do
-    log = VGH::Logging.new.log
-    log.should_receive(:info).with("RSpec Test")
-    log.info("RSpec Test")
-  end
-
-  it "Should write messages" do
-    message = VGH::Output.new
-    message.should_receive(:stdout).with("RSpec Test")
-    message.stdout("RSpec Test")
-  end
-end

data/spec/spec_helper.rb

@@ -1,7 +0,0 @@
-RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-  config.order = 'random'
-end
-