vgh 0.1.2 → 0.2.0

data/spec/helpers/aws_mock.rb

@@ -0,0 +1,49 @@
+shared_context 'AWS Dummy' do
+
+  before(:all) do
+    @fqdn = 'test.example.com'
+
+    AWS.stub!
+    AWS.config({:access_key_id => '1234', :secret_access_key => '4321'})
+    @ec2 = AWS::EC2.new
+
+    # Instance
+    @instance = @ec2.instances['i-12345678']
+
+    # Volumes
+    @volume1 = @ec2.volumes['vol-11111111']
+    @tag1 = @volume1.tag('Name', :value => 'VolumeName')
+    @tag2 = @volume1.tag('Checkpoint')
+
+    @volume2 = @ec2.volumes['vol-22222222']
+    @tag3 = @volume2.tag('Checkpoint')
+
+    @volume3 = @ec2.volumes['vol-33333333']
+
+    # Tags
+    @tag_collection = AWS::EC2::TagCollection
+    @tag_hash = {
+      'Name'  => 'TestTag',
+      'MyTAG' => 'TestValue'
+    }
+
+    # Attachments
+    @device1 = '/dev/sdz1'
+    @device2 = '/dev/sdz2'
+    @device3 = '/dev/sdz3'
+    @attachment1 = AWS::EC2::Attachment.new(@volume1, @instance, @device1)
+    @attachment2 = AWS::EC2::Attachment.new(@volume2, @instance, @device2)
+    @attachment3 = AWS::EC2::Attachment.new(@volume3, @instance, @device3)
+    @instance_mappings = {
+      @device1 => @attachment1,
+      @device2 => @attachment2,
+      @device3 => @attachment3
+    }
+
+    # Snapshots
+    @snapshot = @ec2.snapshots['snap-12345678']
+
+  end
+
+end
+

data/spec/helpers/spec.rb

@@ -1,3 +1,6 @@
+require 'rspec'
+require 'aws-sdk'
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
@@ -14,26 +17,5 @@ class Dummy
   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
-    })
+require "#{File.dirname(__FILE__)}/aws_mock.rb"
 
-    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

@@ -3,9 +3,34 @@ 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")
+
+  it 'Should write STDOUT messages' do
+    subject.log.should_receive(:stdout).with('RSpec Test')
+    subject.log.stdout('RSpec Test')
+  end
+
+  it 'Should write DEBUG messages' do
+    subject.log.should_receive(:debug).with('RSpec Test')
+    subject.log.debug('RSpec Test')
+  end
+
+  it 'Should write INFO messages' do
+    subject.log.should_receive(:info).with('RSpec Test')
+    subject.log.info('RSpec Test')
+  end
+
+  it 'Should write WARN messages' do
+    subject.log.should_receive(:warn).with('RSpec Test')
+    subject.log.warn('RSpec Test')
+  end
+
+  it 'Should write ERROR messages' do
+    subject.log.should_receive(:error).with('RSpec Test')
+    subject.log.error('RSpec Test')
+  end
+
+  it 'Should write FATAL messages' do
+    subject.log.should_receive(:fatal).with('RSpec Test')
+    subject.log.fatal('RSpec Test')
   end
 end

data/spec/output_spec.rb

@@ -7,9 +7,35 @@ 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")
+
+  it 'Should write STDOUT messages' do
+    subject.should_receive(:stdout).with('RSpec Test')
+    subject.stdout('RSpec Test')
+  end
+
+  it 'Should write DEBUG messages' do
+    subject.should_receive(:debug).with('RSpec Test')
+    subject.debug('RSpec Test')
+  end
+
+  it 'Should write INFO messages' do
+    subject.should_receive(:info).with('RSpec Test')
+    subject.info('RSpec Test')
+  end
+
+  it 'Should write WARN messages' do
+    subject.should_receive(:warn).with('RSpec Test')
+    subject.warn('RSpec Test')
+  end
+
+  it 'Should write ERROR messages' do
+    subject.should_receive(:error).with('RSpec Test')
+    subject.error('RSpec Test')
   end
+
+  it 'Should write FATAL messages' do
+    subject.should_receive(:fatal).with('RSpec Test')
+    subject.fatal('RSpec Test')
+  end
+
 end

data/spec/version_spec.rb

@@ -0,0 +1,11 @@
+require 'helpers/spec'
+require 'vgh/version'
+
+describe VGH do
+
+  it 'Should return a semantic version number' do
+    extend VGH
+    version.should =~ /\d+\.\d+\.\d+/
+  end
+
+end

data/vgh.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rake"
   gem.add_development_dependency "yard"
   gem.add_development_dependency "bundler"
+  gem.add_development_dependency "reek"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vgh
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-29 00:00:00.000000000 Z
+date: 2013-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -107,6 +107,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Vlad's custom scripts
 email:
 - vgit@vladgh.com
@@ -126,17 +142,16 @@ files:
 - Rakefile
 - bin/vgh
 - conf/config.yml.example
-- conf/ec2-backup.config.yml.example
 - lib/vgh.rb
 - lib/vgh/apps.rb
+- lib/vgh/apps/checkpoint.rb
 - lib/vgh/apps/ec2_backup.rb
 - lib/vgh/cli.rb
 - lib/vgh/configuration.rb
-- lib/vgh/extended_aws.rb
-- lib/vgh/extended_aws/extended_ec2.rb
-- lib/vgh/extended_aws/extended_ec2/metadata.rb
-- lib/vgh/extended_aws/extended_ec2/snapshot.rb
-- lib/vgh/extended_aws/extended_ec2/volume.rb
+- lib/vgh/ec2.rb
+- lib/vgh/ec2/metadata.rb
+- lib/vgh/ec2/snapshot.rb
+- lib/vgh/ec2/volume.rb
 - lib/vgh/logging.rb
 - lib/vgh/output.rb
 - lib/vgh/system.rb
@@ -145,12 +160,15 @@ files:
 - lib/vgh/version.rb
 - spec/apps_spec.rb
 - spec/cli_spec.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/configuration_spec.rb
+- spec/ec2/metadata_spec.rb
+- spec/ec2/snapshot_spec.rb
+- spec/ec2/volume_spec.rb
+- spec/helpers/aws_mock.rb
 - spec/helpers/spec.rb
 - spec/logging_spec.rb
 - spec/output_spec.rb
+- spec/version_spec.rb
 - tasks/documentation.rake
 - vgh.gemspec
 homepage: https://github.com/vladgh/vgh
@@ -165,12 +183,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -87386979
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -87386979
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -180,10 +204,13 @@ summary: A collection of custom scripts used on VladGh.com
 test_files:
 - spec/apps_spec.rb
 - spec/cli_spec.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/configuration_spec.rb
+- spec/ec2/metadata_spec.rb
+- spec/ec2/snapshot_spec.rb
+- spec/ec2/volume_spec.rb
+- spec/helpers/aws_mock.rb
 - spec/helpers/spec.rb
 - spec/logging_spec.rb
 - spec/output_spec.rb
+- spec/version_spec.rb
 has_rdoc: 

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

@@ -1,12 +0,0 @@
-# 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/extended_aws/extended_ec2/snapshot.rb

@@ -1,87 +0,0 @@
-module VGH
-module Extended_AWS
-module Extended_EC2
-
-# Creates a snapshot of the specified volume.
-#
-# == Usage
-#
-#     snap = Snapshot.new.
-#     snap.create(id, tag)
-#
-class Snapshot
-
-  # @return [Object] The Snapshot object
-  attr_reader :snapshot
-
-  # The workflow to create a snapshot:
-  # - create snapshot
-  # - add a name tag
-  # - add an info tag
-  # @param [String] volume_id The ID of the volume to snapshot
-  # @param [String] volume_tag The Tag of the volume to snapshot
-  def create(volume_id, volume_tag)
-    create_snapshot(volume_id, volume_tag)
-    name_tag
-    info_tag(volume_id)
-    message.info "Creating and tagging snapshot \"#{snapshot.id}\""
-  end
-
-  # Creates a snapshot for the specified volume
-  # @param [String] volume_id The ID of the volume to snapshot
-  # @param [String] volume_tag The tag of the volume to snapshot
-  # @return [Object] The newly created snapshot object
-  def create_snapshot(volume_id, volume_tag)
-    @snapshot = ec2.volumes[volume_id].
-      create_snapshot("Backup for #{volume_id}(#{volume_tag})")
-  end
-
-  # 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)
-  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)
-  end
-
-  # Purges expired snapshots
-  def purge
-    expired.each do |snap|
-      message.info "Deleting expired snapshot (#{snap.id})"
-      snap.delete
-    end
-  end
-
-  # Creates a list of expired snapshots according to the expiration time
-  # specified in the app's configuration file
-  # @return [Array] An array of expired snapshot objects
-  def expired
-    @expired = []
-    all.each {|snap|
-      if snap.start_time < (Time.now - app_config[:expiration]*24*60*60)
-        @expired.push snap
-      end
-    }
-    return @expired
-  end
-
-  # Returns a list of snapshots that are named the same with the current FQDN.
-  def all
-    @all ||= ec2.snapshots.
-      with_owner('self').
-      tagged('Name').tagged_values(fqdn)
-  end
-
-end # class Snapshot
-
-end # module Extended_EC2
-end # module Extended_AWS
-end # module VGH
-
-require 'vgh/system'
-require 'vgh/output'
-require 'vgh/configuration'
-require 'vgh/extended_aws/extended_ec2/metadata'

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

@@ -1,66 +0,0 @@
-module VGH
-module Extended_AWS
-module Extended_EC2
-
-# Collects information about the EBS volumes attached to the current instance.
-# == Usage
-#     @volume = Volume.new
-#     @volume.list.map {|id, info|
-#       puts id
-#       puts info[:tag]
-#       puts info[:device)
-#     }
-#
-class Volume
-
-  # @return An instance object
-  def instance
-    @instance ||= ec2.instances[instance_id]
-  end
-
-  # Creates a Hash collection of volumes containing their id, tag and device
-  # @return [Hash]
-  def list
-    @list = {}
-    mappings.map {|device, info|
-      volume_id = info.volume.id
-      @list[volume_id] = {
-        :device => device,
-        :tag => tag(volume_id)
-      }
-    }
-    return @list
-  end
-
-  # Returns a Hash containing the block device mappings of the current instance.
-  # @return [Hash]
-  def mappings
-    message.info "Creating a list of volumes..."
-    @mappings ||= instance.block_device_mappings
-  end
-
-  # Get volume's Name tag
-  # @return [String] The tag of the volume or (NOTAG) if a tag does not exists.
-  def tag(volume_id)
-    v_tags = tags(volume_id)
-    v_tags.count == 0 ? @tag = '(NOTAG)' : @tag = v_tags.first.value
-  end
-
-  # Returns a collection of tags for the specified volume.
-  # @param [String] volume_id The id of the volume to query for tags.
-  def tags(volume_id)
-    @tags = ec2.tags.
-      filter('resource-type', 'volume').
-      filter('key', 'Name').
-      filter('resource-id', volume_id)
-  end
-
-end # class Volume
-
-end # module Extended_EC2
-end # module Extended_AWS
-end # module VGH
-
-require 'vgh/output'
-require 'vgh/configuration'
-require 'vgh/extended_aws/extended_ec2/metadata'

data/lib/vgh/extended_aws/extended_ec2.rb

@@ -1,10 +0,0 @@
-module VGH
-module Extended_AWS
-
-# A collection of classes used with the AWS-SDK for Ruby (EC2).
-module Extended_EC2
-
-end
-
-end # module Extended_AWS
-end # module VGH

data/lib/vgh/extended_aws.rb

@@ -1,10 +0,0 @@
-require 'aws-sdk'
-
-module VGH
-
-  # A collection of classes used with the AWS-SDK for Ruby.
-  module Extended_AWS
-
-  end # module Extended_AWS
-
-end # module VGH

data/spec/extended_aws/extended_ec2/metadata_spec.rb

@@ -1,24 +0,0 @@
-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

@@ -1,48 +0,0 @@
-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

@@ -1,27 +0,0 @@
-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
-