right_agent 0.10.8 → 0.10.9

data/lib/right_agent/pid_file.rb

@@ -114,7 +114,7 @@ module RightScale
       if exists?
         open(@pid_file,'r') { |f| content[:pid] = f.read.to_i }
         open(@cookie_file,'r') do |f|
-          command_options = YAML.load(f.read) rescue {}
+          command_options = (YAML.load(f.read) rescue {}) || {}
           content.merge!(command_options)
         end if File.exists?(@cookie_file)
       end

data/lib/right_agent/platform/windows.rb

@@ -468,8 +468,6 @@ EOF
         # partition has actually been formatted.
         raise ArgumentError.new("Invalid index = #{disk_index}") unless disk_index >= 0
         raise ArgumentError.new("Invalid device = #{device}") unless is_attachable_volume_path?(device)
-        online_command = if @os_info.major < 6; "online noerr"; else; "online disk noerr"; end
-        clear_readonly_command = if @os_info.major < 6; ""; else; "attribute disk clear readonly noerr"; end
 
         # note that Windows 2003 server version of diskpart doesn't support
         # format so that has to be done separately.
@@ -478,8 +476,8 @@ EOF
 rescan
 list disk
 select disk #{disk_index}
-#{clear_readonly_command}
-#{online_command}
+#{get_clear_readonly_command('disk')}
+#{get_online_disk_command}
 clean
 create partition primary
 #{get_assign_command_for_device(device)}
@@ -506,6 +504,8 @@ EOF
       #
       # === Parameters
       # disk_index(int):: zero-based disk index
+      # options(Hash):: A hash of options which allows different behavior while onlining a drive.  Possible options are;
+      #   :idempotent(Bool) - Checks the current disk statuses before attempting to online the disk.  If the drive is already online, it bails out making this method idempotent.
       #
       # === Return
       # always true
@@ -514,22 +514,55 @@ EOF
       # ArgumentError:: on invalid parameters
       # VolumeError:: on failure to online disk
       # ParserError:: on failure to parse volume list
-      def online_disk(disk_index)
+      def online_disk(disk_index, options={})
         raise ArgumentError.new("Invalid disk_index = #{disk_index}") unless disk_index >= 0
-        clear_readonly_command = if @os_info.major < 6; ""; else; "attribute disk clear readonly noerr"; end
-        online_command = if @os_info.major < 6; "online"; else; "online disk noerr"; end
+        # Set some defaults for backward compatibility, allow user specified options to override defaults
+        options = {:idempotent => false}.merge(options)
         script = <<EOF
 rescan
 list disk
 select disk #{disk_index}
-#{clear_readonly_command}
-#{online_command}
+#{get_clear_readonly_command('disk')}
+#{get_online_disk_command}
 EOF
+
+        if(options[:idempotent])
+          disk = disks(:index => disk_index)
+          return true if disk && disk[:status] == "Online"
+        end
+
         exit_code, output_text = run_script(script)
         raise VolumeError.new("Failed to online disk #{disk_index}: exit code = #{exit_code}\n#{script}\n#{output_text}") if exit_code != 0
         true
       end
 
+      # Brings the disk given by index offline
+      #
+      # === Parameters
+      # disk_index(int):: zero-based disk index
+      #
+      # === Return
+      # always true
+      #
+      # === Raise
+      # ArgumentError:: on invalid parameters
+      # VolumeError:: on failure to online disk
+      # ParserError:: on failure to parse volume list
+      def offline_disk(disk_index)
+        raise ArgumentError.new("Invalid disk_index = #{disk_index}") unless disk_index >= 0
+        # Set some defaults for backward compatibility, allow user specified options to override defaults
+        script = <<EOF
+rescan
+list disk
+select disk #{disk_index}
+offline disk noerr
+EOF
+
+        exit_code, output_text = run_script(script)
+        raise VolumeError.new("Failed to offline disk #{disk_index}: exit code = #{exit_code}\n#{script}\n#{output_text}") if exit_code != 0
+        true
+      end
+
       # Assigns the given device name to the volume given by index and clears
       # the readonly attribute, if necessary. The device must not currently be
       # in use.
@@ -537,6 +570,10 @@ EOF
       # === Parameters
       # volume_device_or_index(int):: old device or zero-based volume index (from volumes list, etc.) to select for assignment.
       # device(String):: disk letter or mount path specified for the volume to create
+      # options(Hash):: A hash of options which allows different behavior while assigning a device.  Possible options are:
+      #   :clear_readonly(Bool) - Set to true by default, since the previous implementation of this method always cleared readonly
+      #   :remove_all(Bool) - Removes all previously assigned devices and paths, essentially a big RESET button for volume assignment
+      #   :idempotent(Bool) - Checks the current device assignments before assigning the device according to the specified parameters.  If the device is already assigned, it bails out making this method idempotent.
       #
       # === Return
       # always true
@@ -545,7 +582,10 @@ EOF
       # ArgumentError:: on invalid parameters
       # VolumeError:: on failure to assign device name
       # ParserError:: on failure to parse volume list
-      def assign_device(volume_device_or_index, device)
+      def assign_device(volume_device_or_index, device, options={})
+        # Set some defaults for backward compatibility, allow user specified options to override defaults
+        options = {:clear_readonly => true, :idempotent => false}.merge(options)
+
         if device.match(@assignable_path_regex) && @os_info.major < 6
           raise ArgumentError.new("Mount path assignment is not supported in this version of windows")
         end
@@ -556,11 +596,26 @@ EOF
         raise ArgumentError.new("Invalid volume_device_or_index = #{volume_device_or_index}") unless volume_selector_match
         volume_selector = volume_selector_match[1]
         raise ArgumentError.new("Invalid device = #{device}") unless is_attachable_volume_path?(device)
+        if(options[:idempotent])
+          # Device already assigned?
+          vols = volumes
+          already_assigned = vols.select do |k,v|
+              # The volume is specified by it's index and is already mounted to the specified device/path
+              (k == :index && v == volume_device_or_index && vols[:device] == device) ||
+              # The volume is specified by it's current device/path assignment and is already mounted to the specified device/path
+              (k == :device && v == volume_device_or_index)
+          end
+
+          return true if already_assigned.length > 0
+        end
+        # Validation ends here, and real stuff starts to happen
+
         script = <<EOF
 rescan
 list volume
 select volume "#{volume_selector}"
-attribute volume clear readonly noerr
+#{get_clear_readonly_command('volume') if options[:clear_readonly]}
+#{"remove all noerr" if options[:remove_all]}
 #{get_assign_command_for_device(device)}
 EOF
 
@@ -858,6 +913,25 @@ EOF
         end
       end
 
+      # Returns the correct 'online disk' diskpart command based on the OS version
+      #
+      # === Return
+      # result(String):: Either "online noerr" or "online disk noerr" depending upon the OS version
+      def get_online_disk_command()
+        if @os_info.major < 6; "online noerr" else; "online disk noerr" end
+      end
+
+      # Returns the correct 'attribute disk clear readonly' diskpart command based on the OS version
+      #
+      # === Parameters
+      # object_type(String):: One of "disk" or "volume" to clear read only for
+      #
+      # === Return
+      # result(String):: Either a blank string or "attribute #{object_type} clear readonly noerr" depending upon the OS version
+      def get_clear_readonly_command(object_type)
+        if @os_info.major < 6; "" else; "attribute #{object_type} clear readonly noerr" end
+      end
+
     end # VolumeManager
 
     # Provides utilities for formatting executable shell commands, etc.

data/right_agent.gemspec

@@ -24,8 +24,8 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name      = 'right_agent'
-  spec.version   = '0.10.8'
-  spec.date      = '2012-05-10'
+  spec.version   = '0.10.9'
+  spec.date      = '2012-06-18'
   spec.authors   = ['Lee Kirchhoff', 'Raphael Simon', 'Tony Spataro']
   spec.email     = 'lee@rightscale.com'
   spec.homepage  = 'https://github.com/rightscale/right_agent'

data/spec/platform/windows_volume_manager_spec.rb

@@ -139,6 +139,7 @@ rescan
 list volume
 select volume "0"
 attribute volume clear readonly noerr
+
 assign letter=S
 EOF
 
@@ -160,6 +161,7 @@ rescan
 list volume
 select volume "0"
 attribute volume clear readonly noerr
+
 assign mount="C:\\Program Files\\RightScale\\Mount\\Softlayer"
 EOF
 
@@ -187,6 +189,51 @@ EOF
           lambda{@platform.volume_manager.assign_device(0, "C:\\Somepath")}.should raise_error(RightScale::Platform::VolumeManager::ArgumentError)
           @platform.volume_manager.set_osinfo(old_osinfo)
         end
+
+        it 'does not assign the device if the device is already assigned' do
+          script = <<EOF
+rescan
+list volume
+select volume "0"
+attribute volume clear readonly noerr
+
+assign mount="C:\\Program Files\\RightScale\\Mount\\Softlayer"
+EOF
+
+          flexmock(@platform.volume_manager).should_receive(:run_script).with(script).once.and_return([0, ''])
+
+          @platform.volume_manager.assign_device('0', "C:\\Program Files\\RightScale\\Mount\\Softlayer")
+          flexmock(@platform.volume_manager).should_receive(:volumes).once.and_return({:index => '0', :device => "C:\\Program Files\\RightScale\\Mount\\Softlayer"})
+          @platform.volume_manager.assign_device('0', "C:\\Program Files\\RightScale\\Mount\\Softlayer", :idempotent => true)
+        end
+
+        it 'does not clear readonly flag if :clear_readonly option is set to false' do
+          script = <<EOF
+rescan
+list volume
+select volume "0"
+
+
+assign mount="C:\\Program Files\\RightScale\\Mount\\Softlayer"
+EOF
+
+          flexmock(@platform.volume_manager).should_receive(:run_script).with(script).once.and_return([0, ''])
+          @platform.volume_manager.assign_device('0', "C:\\Program Files\\RightScale\\Mount\\Softlayer", {:clear_readonly => false})
+        end
+
+        it 'removes all previous assignments if :remove_all option is set to true' do
+          script = <<EOF
+rescan
+list volume
+select volume "0"
+attribute volume clear readonly noerr
+remove all noerr
+assign mount="C:\\Program Files\\RightScale\\Mount\\Softlayer"
+EOF
+
+          flexmock(@platform.volume_manager).should_receive(:run_script).with(script).once.and_return([0, ''])
+          @platform.volume_manager.assign_device('0', "C:\\Program Files\\RightScale\\Mount\\Softlayer", :remove_all => true)
+        end
       end
 
       context :format_disk do
@@ -248,6 +295,24 @@ EOF
         end
 
       end
+
+      context :online_disk do
+        it 'does not online the disk if the disk is already online' do
+          script = <<EOF
+rescan
+list disk
+select disk 0
+attribute disk clear readonly noerr
+online disk noerr
+EOF
+
+          flexmock(@platform.volume_manager).should_receive(:run_script).with(script).once.and_return([0, ''])
+
+          @platform.volume_manager.online_disk(0)
+          flexmock(@platform.volume_manager).should_receive(:disks).once.and_return({:index => 0, :status => "Online"})
+          @platform.volume_manager.online_disk(0, :idempotent => true)
+        end
+      end
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: right_agent
 version: !ruby/object:Gem::Version 
-  hash: 39
-  prerelease: 
+  hash: 37
+  prerelease: false
   segments: 
   - 0
   - 10
-  - 8
-  version: 0.10.8
+  - 9
+  version: 0.10.9
 platform: ruby
 authors: 
 - Lee Kirchhoff
@@ -17,10 +17,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-10 00:00:00 Z
+date: 2012-06-18 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: right_support
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -31,11 +31,11 @@ dependencies:
         - 1
         - 3
         version: "1.3"
-  type: :runtime
   requirement: *id001
+  name: right_support
   prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: right_amqp
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -46,11 +46,11 @@ dependencies:
         - 0
         - 3
         version: "0.3"
-  type: :runtime
   requirement: *id002
+  name: right_amqp
   prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: json
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -61,11 +61,11 @@ dependencies:
         - 1
         - 4
         version: "1.4"
-  type: :runtime
   requirement: *id003
+  name: json
   prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: eventmachine
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -77,11 +77,11 @@ dependencies:
         - 12
         - 10
         version: 0.12.10
-  type: :runtime
   requirement: *id004
+  name: eventmachine
   prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: right_popen
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -93,11 +93,11 @@ dependencies:
         - 0
         - 11
         version: 1.0.11
-  type: :runtime
   requirement: *id005
+  name: right_popen
   prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: msgpack
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -109,11 +109,11 @@ dependencies:
         - 4
         - 4
         version: 0.4.4
-  type: :runtime
   requirement: *id006
+  name: msgpack
   prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: net-ssh
   version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -124,9 +124,10 @@ dependencies:
         - 2
         - 0
         version: "2.0"
-  type: :runtime
   requirement: *id007
+  name: net-ssh
   prerelease: false
+  type: :runtime
 description: |
   RightAgent provides a foundation for running an agent on a server to interface
   in a secure fashion with other agents in the RightScale system. A RightAgent
@@ -290,6 +291,7 @@ files:
 - spec/spec.win32.opts
 - spec/spec_helper.rb
 - spec/tracer_spec.rb
+has_rdoc: true
 homepage: https://github.com/rightscale/right_agent
 licenses: []
 
@@ -324,7 +326,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Agent for interfacing server with RightScale system