RubyGems - prlbackup - Versions diffs - 1.0.0 - Mend

prlbackup 1.0.0

Files changed (27) hide show

data/.gitignore +6 -0
data/Gemfile +4 -0
data/Guardfile +21 -0
data/README.md +27 -0
data/Rakefile +14 -0
data/bin/prlbackup +5 -0
data/features/cleanup.feature +29 -0
data/features/create_backups.feature +53 -0
data/features/dev_steps.feature +60 -0
data/features/logging.feature +39 -0
data/features/steps/dev_steps.rb +49 -0
data/features/support/env.rb +2 -0
data/lib/prlbackup/cli.rb +90 -0
data/lib/prlbackup/version.rb +3 -0
data/lib/prlbackup/virtual_machine.rb +111 -0
data/lib/prlbackup.rb +51 -0
data/man/prlbackup +31 -0
data/man/prlbackup.1 +168 -0
data/man/prlbackup.1.html +195 -0
data/man/prlbackup.1.ronn +107 -0
data/man/prlbackup.html +253 -0
data/prlbackup.gemspec +32 -0
data/spec/prlbackup/cli_spec.rb +84 -0
data/spec/prlbackup/virtual_machine_spec.rb +252 -0
data/spec/prlbackup_spec.rb +126 -0
data/spec/spec_helper.rb +1 -0
metadata +213 -0

data/man/prlbackup.html ADDED Viewed

@@ -0,0 +1,253 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>prlbackup</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+  <style type='text/css' media='all'>
+  /* style: toc */
+  .man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
+  .man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
+  .man-navigation a:hover {color:#111;text-decoration:underline}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+  </div>
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>prlbackup</li>
+    <li class='tc'>PRLBACKUP MANUAL</li>
+    <li class='tr'>prlbackup</li>
+  </ol>
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>prlbackup</code>
+</p>
+<p>.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PRLBACKUP" "1" "May 2012" "" "PRLBACKUP MANUAL"
+.
+.SH "NAME"
+\fBprlbackup\fR - an awesome backup tool for Parallels Server Virtual Machines
+.
+.SH "SYNOPSIS"
+\fBprlbackup\fR \fB-h\fR|\fB--help\fR
+.
+.br
+\fBprlbackup\fR [\fIOPTIONS\fR...] \fIvm_id|vm_name\fR...
+.
+.br
+\fBprlbackup\fR [\fIOPTIONS\fR...] \fB-a\fR|\fB--all\fR
+.
+.br
+\fBprlbackup\fR [\fIOPTIONS\fR...] \fB-a\fR|\fB--all\fR \fB-e\fR|\fB--exclude\fR \fIvm_id|vm_name\fR...
+.
+.SH "DESCRIPTION"
+\fBprlbackup\fR simplifies the backup of one or multiple Virtual Machines (VM) running on Parallels Server by stoping them during backup and deleting old backups on demand. A working installation of Parallels Server is required.
+.
+.P
+\fBprlbackup\fR was tested under Parallels Server for Mac 4.0 (PSfM).
+.
+.SH "OPTIONS"
+.
+.TP
+\fB-h\fR, \fB--help\fR
+Display a short help.
+.
+.TP
+\fB-a\fR, \fB--all\fR
+Backup all virtual machines which are registered in Parallels Server.
+.
+.TP
+\fB-e\fR, \fB--exclude\fR
+Backup all but the given virtual machines (only applicable in combination with option \fB--all\fR!).
+.
+.TP
+\fB-f\fR, \fB--full\fR
+Create full backups (by default incremental backups are created). Note that the first backup for a VM is always a full backup despide of this option.
+.
+.TP
+\fB-v\fR, \fB--verbose\fR
+Show commands with an impact on the VMs prior to their execution.
+.
+.TP
+\fB-n\fR, \fB--dry-run\fR
+Don\'t do anything with the VMs, just pretend to.
+.
+.TP
+\fB-k\fR \fInumber_of_full_backups\fR, \fB--keep-only\fR \fInumber_of_full_backups\fR
+Delete the oldest full backup(s) until only \fInumber_of_full_backups\fR exist. This cleanup action will be executed for each VM right after creating the corresponding backup but only if the backup was successfully created. Incremental backups are automatically deleted by Parallels Server when their full backup is deleted.
+.
+.SH "EXAMPLES"
+Display short help:
+.
+.IP "" 4
+.
+.nf</p>
+<p>$ prlbackup --help
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Backup VMs by name:
+.
+.IP "" 4
+.
+.nf</p>
+<p>$ prlbackup Alpha Bravo Charlie
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Backup a VM by id:
+.
+.IP "" 4
+.
+.nf</p>
+<p>$ prlbackup "{97351580-afd7-4aff-9960-814196b28e37}"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Create full backups of all VMs
+.
+.IP "" 4
+.
+.nf</p>
+<p>$ prlbackup --full --all
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Backup all but not the given VMs:
+.
+.IP "" 4
+.
+.nf</p>
+<p>$ prlbackup --all --exclude Delta Echo
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Show which commands would have been run when backing up all VMs:
+.
+.IP "" 4
+.
+.nf</p>
+<p>$ prlbackup --dry-run --verbose --all
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Create the weekly full backup for all VMs and delete backups older than four weeks:
+.
+.IP "" 4
+.
+.nf</p>
+<p>$ prlbackup --all --keep-only 5
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+.
+.IP "(bu" 4
+<span class="man-ref">prlctl<span class="s">(8)</span></span>
+.
+.IP "(bu" 4
+prlbackup\'s homepage \fIhttps://github.com/bjoernalbers/prlbackup\fR
+.
+.IP "" 0
+.
+.SH "COPYRIGHT"
+Copyright (c) 2012 Bjoern Albers (\fIbjoernalbers@googlemail.com\fR)
+.
+.P
+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:
+.
+.P
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+.
+.P
+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.</p>
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>May 2012</li>
+    <li class='tr'>prlbackup</li>
+  </ol>
+  </div>
+</body>
+</html>

data/prlbackup.gemspec ADDED Viewed

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "prlbackup/version"
+Gem::Specification.new do |s|
+  s.name        = 'prlbackup'
+  s.version     = PrlBackup::VERSION
+  s.authors     = ['Björn Albers']
+  s.email       = ['bjoernalbers@googlemail.com']
+  s.homepage    = "https://github.com/bjoernalbers/#{s.name}"
+  s.summary     = 'an awesome backup tool for Parallels Server Virtual Machines'
+  s.description = %q{prlbackup simplifies the backup of one or multiple Virtual Machines
+(VM) running on Parallels Server by stoping them during backup and
+deleting old backups on demand.}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+  s.add_dependency 'mixlib-cli', '>= 1.2.0'
+  s.add_dependency 'gem-man', '>= 0.3.0'
+  s.add_development_dependency 'cucumber', '>= 1.1.4'
+  s.add_development_dependency 'aruba', '>= 0.4.11'
+  s.add_development_dependency 'aruba-doubles', '~> 1.2.1'
+  s.add_development_dependency 'guard-cucumber', '>= 0.7.5'
+  s.add_development_dependency 'guard-rspec', '>= 0.5.1'
+  s.add_development_dependency 'guard-ronn', '>= 0.1.2'
+  s.add_development_dependency 'ronn', '>= 0.7.3'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rb-fsevent', '>= 0.9.0' if RUBY_PLATFORM =~ /darwin/i
+end

data/spec/prlbackup/cli_spec.rb ADDED Viewed

@@ -0,0 +1,84 @@
+require 'spec_helper'
+module PrlBackup
+  describe CLI do
+    describe '.run' do
+      before do
+        @cli = double('cli')
+        @cli.stub(:run)
+        CLI.stub(:new).and_return(@cli)
+      end
+      it 'should initialize a new instance' do
+        CLI.should_receive(:new).and_return(@cli)
+        CLI.run
+      end
+      it 'should run the new instance with ARGV' do
+        @cli.should_receive(:run).with(ARGV)
+        CLI.run
+      end
+    end
+    describe '#run' do
+      before do
+        @vm = double('vm')
+        @vm.stub(:safe_backup)
+        @vm.stub(:cleanup)
+        VirtualMachine.stub(:new).and_return(@vm)
+        @cli = CLI.new
+      end
+      context 'without options' do
+        before do
+          VirtualMachine.should_receive(:new).with('foo').and_return(@vm)
+        end
+        it 'should backup each selected virtual machine' do
+          @vm.should_receive(:safe_backup).once
+          @cli.run %w[foo]
+        end
+        it 'should not perform cleanup actions' do
+          @vm.should_not_receive(:cleanup)
+          @cli.run %w[foo]
+        end
+      end
+      context 'with option --all' do
+        it 'should backup all virtual machines' do
+          VirtualMachine.should_receive(:all).and_return([@vm, @vm])
+          @vm.should_receive(:safe_backup).twice
+          @cli.run %w[--all]
+        end
+      end
+      context 'with options --all and --exclude' do
+        before do
+          VirtualMachine.should_receive(:all).and_return([@vm, @vm])
+        end
+        it 'should not backup virtual machines which are given' do
+          @cli.stub(:given_virtual_machines).and_return([@vm])
+          @vm.should_not_receive(:safe_backup)
+          @cli.run %w[--all --exclude foo]
+        end
+        it 'should backup virtual machines which are not given' do
+          @cli.stub(:given_virtual_machines).and_return([])
+          @vm.should_receive(:safe_backup).twice
+          @cli.run %w[--all --exclude foo]
+        end
+      end
+      context 'with option --keep-only' do
+        it 'should perform cleanup actions after backing up' do
+          @vm.should_receive(:safe_backup).ordered
+          @vm.should_receive(:cleanup).ordered
+          @cli.stub(:config).and_return({:keep_only => 3})
+          @cli.run %w[foo]
+        end
+      end
+    end
+  end
+end

data/spec/prlbackup/virtual_machine_spec.rb ADDED Viewed

@@ -0,0 +1,252 @@
+require 'spec_helper'
+module PrlBackup
+  describe VirtualMachine do
+    before do
+      VirtualMachine.any_instance.stub(:command).and_return('')
+      @uuid = '{deadbeef}'
+      @vm = VirtualMachine.new('foo')
+      @vm.stub(:uuid).and_return(@uuid)
+      @vm.stub(:logger).and_return(stub(:info => nil))
+    end
+    describe '.each' do
+      it 'should iterate over all virtual machines' do
+        virtual_machines = []
+        3.times { |i| virtual_machines << mock("virtual_machine_#{i}") }
+        virtual_machines.map { |vm| vm.should_receive(:foo) }
+        VirtualMachine.stub(:all).and_return(virtual_machines)
+        VirtualMachine.each { |vm| vm.foo }
+      end
+    end
+    describe '.all' do
+      before do
+        @stdout = %q{UUID
+  {264eab18-563e-4ccb-935d-50269130c592}
+  {b0749d89-27c5-4d0f-88e4-b8aeab95cd35}
+  {b893da77-f465-4de4-ab3f-f77e16f0c485} }
+        @uuids = ['{264eab18-563e-4ccb-935d-50269130c592}',
+          '{b0749d89-27c5-4d0f-88e4-b8aeab95cd35}',
+          '{b893da77-f465-4de4-ab3f-f77e16f0c485}']
+      end
+      it 'should return a list of all virtual machines' do
+        vm = mock('virtual_machine')
+        VirtualMachine.stub(:command).and_return(@stdout)
+        VirtualMachine.stub(:new).and_return(vm)
+        VirtualMachine.all.should eql([vm, vm, vm])
+      end
+      it 'should return an empty list if no virtual machines exist' do
+        VirtualMachine.stub(:command).and_return('')
+        VirtualMachine.all.should eql([])
+      end
+      it 'should instantiate all virtual machines by their uuid' do
+        VirtualMachine.stub(:command).and_return(@stdout)
+        @uuids.each { |uuid| VirtualMachine.should_receive(:new).with(uuid) }
+        VirtualMachine.all
+      end
+      it 'should query a list of all virtual machines via command' do
+        cmd = %w{prlctl list --all --output uuid}
+        VirtualMachine.should_receive(:command).with(*cmd).and_return(@stdout)
+        VirtualMachine.stub(:new)
+        VirtualMachine.all
+      end
+    end
+    describe '#config' do
+      it 'should return the global config' do
+        PrlBackup.should_receive(:config).and_return({:foo => 'bar'})
+        @vm.config.should eql({:foo => 'bar'})
+      end
+    end
+    %w[start stop].each do |cmd|
+      describe "##{cmd}" do
+        it "should #{cmd} the virtual machine" do
+          @vm.should_receive(:command!).with('prlctl', cmd, @uuid).and_return('')
+          @vm.send(cmd)
+        end
+      end
+    end
+    describe '#backup' do
+      it 'should create an incremental backup by default' do
+        @vm.stub(:config).and_return({})
+        @vm.should_receive(:command!).with('prlctl', 'backup', @uuid)
+        @vm.instance_eval { backup }
+      end
+      it 'should create a full backup when configured' do
+        @vm.stub(:config).and_return({:full => true})
+        @vm.should_receive(:command!).with('prlctl', 'backup', @uuid, '--full')
+        @vm.instance_eval { backup }
+      end
+    end
+    describe '#safe_backup' do
+      it 'should stop the VM during the backup' do
+        @vm.stub(:stopped?).and_return(false)
+        @vm.should_receive(:stop).ordered
+        @vm.should_receive(:backup).ordered
+        @vm.should_receive(:start).ordered
+        @vm.safe_backup
+      end
+      it 'should not stop the VM when already shutdown' do
+        @vm.stub(:stopped?).and_return(true)
+        @vm.should_receive(:backup)
+        @vm.safe_backup
+      end
+    end
+    describe '#cleanup' do
+      before do
+        @old_backup = double('old backup')
+        @new_backup = double('new backup')
+        @vm.stub(:full_backups).and_return([@old_backup, @new_backup])
+      end
+      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
+        @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)
+        @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)
+        @vm.cleanup
+      end
+    end
+    describe '#delete_backup' do
+      it 'should delete the virtual machines backup' do
+        @vm.should_receive(:command!).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(:command).and_return(stdout)
+      end
+      it 'should query the backup list by CLI' do
+        @vm.should_receive(:command).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}'])
+      end
+    end
+    describe '#name' do
+      it 'should return the name of the virtual machine' do
+        @vm.stub(:info).and_return('Name: foo')
+        @vm.name.should eql('foo')
+      end
+      it 'should return nil if the name cannot be parsed' do
+        @vm.stub(:info).and_return(nil)
+        @vm.name.should be_nil
+      end
+    end
+    describe '#uuid' do
+      before do
+        @vm = VirtualMachine.new('foo')
+      end
+      it "should return the virtual machine's UUID" do
+        @vm.stub(:info).and_return('ID: {423dba54-45e3-46f1-9aa2-87d61ce6b757}')
+        @vm.uuid.should eql('{423dba54-45e3-46f1-9aa2-87d61ce6b757}')
+      end
+      it 'should return nil if the uuid cannot be parsed' do
+        @vm.stub(:info).and_return(nil)
+        @vm.uuid.should be_nil
+      end
+    end
+    describe '#update_info' do
+      it 'should query infos about the virtual machine' do
+        @vm.should_receive(:command).with('prlctl', 'list', '--info', 'foo')
+        @vm.instance_eval { update_info }
+      end
+      it 'should update and return the infos' do
+        @vm.stub(:command).and_return('Foo: Bar', 'Foo: Baz')
+        @vm.instance_eval { update_info }.should eql('Foo: Bar')
+        @vm.instance_eval { info }.should eql('Foo: Bar')
+        @vm.instance_eval { update_info }.should eql('Foo: Baz')
+        @vm.instance_eval { info }.should eql('Foo: Baz')
+      end
+    end
+    describe '#stopped?' do
+      it 'should return true when virtual machine is stopped' do
+        @vm.stub!(:update_info).and_return('State: stopped')
+        @vm.should be_stopped
+      end
+      it 'should return false when virtual machine is not stopped' do
+        @vm.stub!(:update_info).and_return('State: running')
+        @vm.should_not be_stopped
+      end
+    end
+    describe '#==' do
+      before do
+        @other_vm = VirtualMachine.new('other_vm')
+      end
+      it 'should be true when UUIDs are equal' do
+        @other_vm.stub(:uuid).and_return(@vm.uuid)
+        @vm.should == @other_vm
+        @other_vm.should == @vm
+      end
+      it 'should be false when UUIDs are not equal' do
+        @other_vm.stub(:uuid).and_return('{a-completely-different-uuid}')
+        @vm.should_not == @other_vm
+        @other_vm.should_not == @vm
+      end
+    end
+    describe '#to_s' do
+      it 'should return the name' do
+        @vm.should_receive('name').and_return('name_of_the_vm')
+        @vm.to_s.should eql('name_of_the_vm')
+      end
+      it 'should return "Unknown VM" if name is nil' do
+        @vm.should_receive(:name).and_return(nil)
+        @vm.to_s.should eql('Unknown VM')
+      end
+    end
+  end
+end