prlbackup 1.1.3 → 1.2.0

data/lib/prlbackup.rb

@@ -1,9 +1,11 @@
 require 'mixlib/cli'
 require 'logger'
 require 'shellwords'
+require 'date'
 require 'prlbackup/version'
 require 'prlbackup/cli'
 require 'prlbackup/virtual_machine'
+require 'prlbackup/backup'
 
 module PrlBackup
   class << self

data/lib/prlbackup/backup.rb

@@ -0,0 +1,66 @@
+module PrlBackup
+  class Backup
+    class << self
+
+      include PrlBackup
+
+      def all(uuid)
+        backup_list(uuid).split("\n").map { |b| create(b) }.compact.sort
+      end
+
+      def backup_list(uuid)
+        run('prlctl', 'backup-list', uuid)
+      end
+
+      def create(line)
+        re = /^
+          (\{[0-9a-f-]+\})        # VM UUID
+          \s+
+          (\{[0-9a-f-]+\}[\.\d]*) # Backup UUID
+          \s+
+          (\S+)                   # Node
+          \s+
+          ([\d\/]+\s[\d:]+)       # Time
+          \s+
+          ([fi])                  # Type
+          \s+
+          (\d+)                   # Size
+        $/x
+        new(:uuid => $2, :time => $4, :type => $5) if re.match(line)
+      end
+    end
+
+    include PrlBackup
+    include Comparable
+
+    attr_reader :properties
+
+    def initialize(properties)
+      @properties = properties
+    end
+
+    def uuid
+      properties[:uuid]
+    end
+
+    def time
+      DateTime.parse(properties[:time])
+    end
+
+    def full?
+      properties[:type] == 'f'
+    end
+
+    def delete
+      conditionally_run('prlctl', 'backup-delete', '--tag', uuid)
+    end
+
+    def <=>(other)
+      time <=> other.time
+    end
+
+    def to_s
+      "Backup: #{time.strftime('%Y-%m-%d %H:%M:%S')}"
+    end
+  end
+end

data/lib/prlbackup/version.rb

@@ -1,3 +1,3 @@
 module PrlBackup
-  VERSION = '1.1.3'
+  VERSION = '1.2.0'
 end

data/lib/prlbackup/virtual_machine.rb

@@ -38,8 +38,7 @@ module PrlBackup
 
     # Cleanup (delete) old backups.
     def cleanup
-      backups = full_backups
-      delete_backup(backups.shift) while backups.count > config[:keep_only]
+      full_backups.shift.delete while full_backups.count > config[:keep_only]
     end
 
     # Return the virtual machine's name.
@@ -97,14 +96,11 @@ module PrlBackup
       update_info[/^State:\s+stopped$/]
     end
 
-    # List of full backups for the virtual machine.
+    # Cached list of virtual machine's full backups.
+    # @return [Array<Backup>] full backups
     def full_backups
-      run('prlctl', 'backup-list', uuid).split("\n").map { |l| $1 if l[/^\{[a-f0-9-]+\}\s+(\{[a-f0-9-]+\})[^(\.\d+)]/] }.compact
+      @full_backups ||= Backup.all(uuid).select { |b| b.full? }
     end
 
-    # Delete the backup given by backup UUID.
-    def delete_backup(backup_uuid)
-      conditionally_run('prlctl', 'backup-delete', '--tag', backup_uuid)
-    end
   end
 end

data/man/prlbackup.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PRLBACKUP" "1" "May 2012" "" "PRLBACKUP V1.1.3"
+.TH "PRLBACKUP" "1" "May 2012" "" "PRLBACKUP V1.2.0"
 .
 .SH "NAME"
 \fBprlbackup\fR \- an awesome backup tool for Parallels Server Virtual Machines

data/spec/prlbackup/backup_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+module PrlBackup
+  describe Backup do
+    before do
+      @uuid = '{deadbeef}'
+      Backup.stub(:run).and_return('')
+      Backup.stub(:conditionally_run).and_return('')
+    end
+
+    describe '.all' do
+      it 'should query the backup list by UUID' do
+        Backup.should_receive(:backup_list).with(@uuid).and_return('')
+        Backup.all(@uuid)
+      end
+
+      it 'should initialize backups by line' do
+        Backup.stub(:backup_list).and_return("line 1\nline 2")
+        Backup.should_receive(:create).with('line 1')
+        Backup.should_receive(:create).with('line 2')
+        Backup.all(@uuid)
+      end
+
+      it 'should only return successfully initialized backups' do
+        Backup.stub(:backup_list).and_return("line 1\nline 2\nline 3")
+        Backup.stub(:create).and_return(nil, 'backup', nil)
+        Backup.all(@uuid).should eql(['backup'])
+      end
+
+      it 'should return the backups sorted' do
+        backup1 = Backup.new(:time => '02/27/2012 13:11:31')
+        backup2 = Backup.new(:time => '02/27/2012 13:11:32')
+        backup3 = Backup.new(:time => '02/27/2012 13:11:33')
+        Backup.stub(:create).and_return(backup2, backup3, backup1)
+        Backup.stub(:backup_list).and_return("line 1\nline 2\nline 3")
+        Backup.all(@uuid).should eql([backup1, backup2, backup3])
+      end
+    end
+
+    describe '.backup_list' do
+      it 'should query and return the backup list by UUID' do
+        Backup.should_receive(:run).with('prlctl', 'backup-list', @uuid).and_return('backup list')
+        Backup.backup_list(@uuid).should eql('backup list')
+      end
+    end
+
+    describe '.create' do
+      it 'should initialize a backup with properties' do
+        line = '{deadbeef} {ae6565dd-7f8f-42cb-a088-8b1d98f5160b} psfm.example.com 02/27/2012 13:11:32     f 10537597943'
+        backup = Backup.create(line)
+        backup.properties[:uuid].should eql('{ae6565dd-7f8f-42cb-a088-8b1d98f5160b}')
+        backup.properties[:time].should eql('02/27/2012 13:11:32')
+        backup.properties[:type].should eql('f')
+      end
+
+      it 'should return nil when the backup line is not parsable' do
+        Backup.create('hello, world.').should be_nil
+      end
+    end
+
+    describe '#uuid' do
+      it 'should return the backup uuid' do
+        backup = Backup.new(:uuid => '{ae6565dd-7f8f-42cb-a088-8b1d98f5160b}')
+        backup.uuid.should eql('{ae6565dd-7f8f-42cb-a088-8b1d98f5160b}')
+      end
+    end
+
+    describe '#time' do
+      it 'should return the time object' do
+        backup = Backup.new(:time => '02/27/2012 13:11:32')
+        backup.time.year.should eql(2012)
+        backup.time.month.should eql(2)
+        backup.time.day.should eql(27)
+        backup.time.hour.should eql(13)
+        backup.time.min.should eql(11)
+        backup.time.sec.should eql(32)
+      end
+    end
+
+    describe '#full?' do
+      it 'should be true when full' do
+        backup = Backup.new(:type => 'f')
+        backup.should be_full
+      end
+
+      it 'should be false when incremental' do
+        backup = Backup.new(:type => 'i')
+        backup.should_not be_full
+      end
+    end
+
+    describe '#delete' do
+      it 'should delete itself' do
+        backup = Backup.new(:uuid => '{some-backup-uuid}')
+        backup.should_receive(:conditionally_run).with('prlctl', 'backup-delete', '--tag', '{some-backup-uuid}')
+        backup.delete
+      end
+    end
+
+    describe '#<=>' do
+      it 'should compare backups by time' do
+        first_backup = Backup.new(:time => '02/27/2012 13:11:32')
+        last_backup = Backup.new(:time => '02/27/2012 13:11:33')
+        first_backup.should < last_backup
+      end
+    end
+
+    describe '#to_s' do
+      it 'should display the backup time' do
+        backup = Backup.new(:time => '02/27/2012 13:11:32')
+        backup.to_s.should eql('Backup: 2012-02-27 13:11:32')
+      end
+    end
+  end
+end

data/spec/prlbackup/virtual_machine_spec.rb

@@ -112,55 +112,43 @@ module PrlBackup
 
       it 'should delete 2 backups when there are 2 more backups than to keep' do
         @vm.stub(:config).and_return({:keep_only => 0})
-        @vm.should_receive(:delete_backup).with(@old_backup).once
-        @vm.should_receive(:delete_backup).with(@new_backup).once
+        @old_backup.should_receive(:delete).once
+        @new_backup.should_receive(:delete).once
         @vm.cleanup
       end
 
       it 'should delete the oldest backup when there is 1 more backup than to keep' do
         @vm.stub(:config).and_return({:keep_only => 1})
-        @vm.should_receive(:delete_backup).with(@old_backup).once
-        @vm.should_not_receive(:delete_backup).with(@new_backup)
+        @old_backup.should_receive(:delete).once
+        @new_backup.should_not_receive(:delete)
         @vm.cleanup
       end
 
       it 'should not delete any backups when there are as many backups as to keep' do
         @vm.stub(:config).and_return({:keep_only => 2})
-        @vm.should_not_receive(:delete_backup)
+        @old_backup.should_not_receive(:delete)
+        @new_backup.should_not_receive(:delete)
         @vm.cleanup
       end
     end
 
-    describe '#delete_backup' do
-      it 'should delete the virtual machines backup' do
-        @vm.should_receive(:conditionally_run).with('prlctl', 'backup-delete', '--tag', '{some-backup-uuid}')
-        @vm.instance_eval { delete_backup('{some-backup-uuid}') }
-      end
-    end
-
     describe '#full_backups' do
       before do
-        stdout = 'prlctl backup-list {bf364fd4-8f6b-4032-818d-4958f9c0945b}
-ID Backup_ID                              Node                 Date                 Type       Size
-{deadbeef} {ae6565dd-7f8f-42cb-a088-8b1d98f5160b} psfm.example.com 02/27/2012 13:11:32     f 10537597943
-{deadbeef} {ae6565dd-7f8f-42cb-a088-8b1d98f5160b}.2 psfm.example.com 02/27/2012 15:26:02     i 2951747588
-{deadbeef} {5f9dd263-ec56-443e-9917-dab9b40d3027} psfm.example.com 03/13/2012 18:06:00     f 11748325372
-{deadbeef} {2aeb4ada-6623-4087-9fc5-f09aeaafd81e} psfm.example.com 03/23/2012 21:25:50     f 47315014888
-{deadbeef} {68f7e154-6755-46f6-ad1f-a79c5f488f35} psfm.example.com 03/28/2012 15:09:05     f 23462808438
-{deadbeef} {68f7e154-6755-46f6-ad1f-a79c5f488f35}.2 psfm.example.com 04/05/2012 17:21:12     i 12841952117'
-        @vm.stub(:run).and_return(stdout)
-      end
-
-      it 'should query the backup list by CLI' do
-        @vm.should_receive(:run).with('prlctl', 'backup-list', @uuid)
-        @vm.instance_eval { full_backups }
-      end
-
-      it 'should return a list of the virtual machines full backup UUIDs' do
-        @vm.instance_eval { full_backups }.should eql(['{ae6565dd-7f8f-42cb-a088-8b1d98f5160b}',
-          '{5f9dd263-ec56-443e-9917-dab9b40d3027}',
-          '{2aeb4ada-6623-4087-9fc5-f09aeaafd81e}',
-          '{68f7e154-6755-46f6-ad1f-a79c5f488f35}'])
+        Backup.stub(:all).and_return([])
+      end
+
+      it 'should query list of backups for given UUID once' do
+        Backup.should_receive(:all).with(@vm.uuid).once
+        2.times { @vm.instance_eval { full_backups } }
+      end
+
+      it 'should return only full backups' do
+        full_backup = double('full backup')
+        full_backup.stub(:full?).and_return(true)
+        incremental_backup = double('incremental backup')
+        incremental_backup.stub(:full?).and_return(false)
+        Backup.stub(:all).and_return([full_backup, incremental_backup])
+        @vm.instance_eval { full_backups }.should eql([full_backup])
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prlbackup
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-05-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
-  requirement: &70149533786540 !ruby/object:Gem::Requirement
+  requirement: &70297487607280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70149533786540
+  version_requirements: *70297487607280
 - !ruby/object:Gem::Dependency
   name: gem-man
-  requirement: &70149533785600 !ruby/object:Gem::Requirement
+  requirement: &70297487605600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70149533785600
+  version_requirements: *70297487605600
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70149533784760 !ruby/object:Gem::Requirement
+  requirement: &70297487603540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 1.1.4
   type: :development
   prerelease: false
-  version_requirements: *70149533784760
+  version_requirements: *70297487603540
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70149533783860 !ruby/object:Gem::Requirement
+  requirement: &70297487584840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.4.11
   type: :development
   prerelease: false
-  version_requirements: *70149533783860
+  version_requirements: *70297487584840
 - !ruby/object:Gem::Dependency
   name: aruba-doubles
-  requirement: &70149533779320 !ruby/object:Gem::Requirement
+  requirement: &70297487583560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.2.1
   type: :development
   prerelease: false
-  version_requirements: *70149533779320
+  version_requirements: *70297487583560
 - !ruby/object:Gem::Dependency
   name: guard-cucumber
-  requirement: &70149533778340 !ruby/object:Gem::Requirement
+  requirement: &70297487581460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 0.7.5
   type: :development
   prerelease: false
-  version_requirements: *70149533778340
+  version_requirements: *70297487581460
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70149533777420 !ruby/object:Gem::Requirement
+  requirement: &70297487579380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: 0.5.1
   type: :development
   prerelease: false
-  version_requirements: *70149533777420
+  version_requirements: *70297487579380
 - !ruby/object:Gem::Dependency
   name: ronn
-  requirement: &70149533776180 !ruby/object:Gem::Requirement
+  requirement: &70297487578400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: 0.7.3
   type: :development
   prerelease: false
-  version_requirements: *70149533776180
+  version_requirements: *70297487578400
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70149533775380 !ruby/object:Gem::Requirement
+  requirement: &70297487576720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70149533775380
+  version_requirements: *70297487576720
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70149533773760 !ruby/object:Gem::Requirement
+  requirement: &70297487574660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +120,7 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *70149533773760
+  version_requirements: *70297487574660
 description: an awesome backup tool for Parallels Server Virtual Machines
 email:
 - bjoernalbers@googlemail.com
@@ -142,12 +142,14 @@ files:
 - features/steps/dev_steps.rb
 - features/support/env.rb
 - lib/prlbackup.rb
+- lib/prlbackup/backup.rb
 - lib/prlbackup/cli.rb
 - lib/prlbackup/version.rb
 - lib/prlbackup/virtual_machine.rb
 - man/prlbackup.1
 - man/prlbackup.1.ronn
 - prlbackup.gemspec
+- spec/prlbackup/backup_spec.rb
 - spec/prlbackup/cli_spec.rb
 - spec/prlbackup/virtual_machine_spec.rb
 - spec/prlbackup_spec.rb
@@ -166,7 +168,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1653831612304394743
+      hash: -855199531079728294
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -175,13 +177,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1653831612304394743
+      hash: -855199531079728294
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: prlbackup-1.1.3
+summary: prlbackup-1.2.0
 test_files:
 - features/cleanup.feature
 - features/create_backups.feature
@@ -189,6 +191,7 @@ test_files:
 - features/logging.feature
 - features/steps/dev_steps.rb
 - features/support/env.rb
+- spec/prlbackup/backup_spec.rb
 - spec/prlbackup/cli_spec.rb
 - spec/prlbackup/virtual_machine_spec.rb
 - spec/prlbackup_spec.rb