right_agent 0.17.2 → 1.0.1

data/spec/platform/unix/spec_helper.rb

@@ -0,0 +1,149 @@
+#
+# Copyright (c) 2013 RightScale Inc
+#
+# 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:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# 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.
+
+require ::File.expand_path('../../spec_helper', __FILE__)
+
+require 'stringio'
+
+shared_examples_for 'supports unix platform filesystem' do
+
+  context '#find_executable_in_path' do
+    let(:path_env) { '/usr/local/bin:/usr/bin:/bin' }
+
+    it 'should find executable' do
+      mock_env = flexmock(::ENV)
+      mock_env.should_receive(:[]).with('PATH').and_return(path_env)
+
+      file_class.should_receive(:executable?).with('/usr/local/bin/foo').and_return(false).twice
+      file_class.should_receive(:executable?).with('/usr/bin/foo').and_return(true).twice
+      file_class.should_receive(:executable?).with('/usr/local/bin/bar').and_return(false).twice
+      file_class.should_receive(:executable?).with('/usr/bin/bar').and_return(false).twice
+      file_class.should_receive(:executable?).with('/bin/bar').and_return(false).twice
+
+      subject.find_executable_in_path('foo').should == '/usr/bin/foo'
+      subject.has_executable_in_path('foo').should be_true
+      subject.find_executable_in_path('bar').should be_nil
+      subject.has_executable_in_path('bar').should be_false
+    end
+  end # find_executable_in_path
+
+  context 'paths' do
+    it 'should return unix path constants' do
+      subject.right_agent_cfg_dir.should == '/var/lib/rightscale/right_agent'
+      subject.right_scale_static_state_dir.should == '/etc/rightscale.d'
+      subject.right_link_static_state_dir.should == '/etc/rightscale.d/right_link'
+      subject.right_link_dynamic_state_dir.should == '/var/lib/rightscale/right_link'
+      subject.spool_dir.should == '/var/spool'
+      subject.ssh_cfg_dir.should == '/etc/ssh'
+      subject.cache_dir.should == '/var/cache'
+      subject.log_dir.should == '/var/log'
+      subject.source_code_dir.should == '/usr/src'
+      subject.temp_dir.should == '/tmp'
+      subject.pid_dir.should == '/var/run'
+      subject.right_link_home_dir.should == '/opt/rightscale'
+      subject.private_bin_dir.should == '/opt/rightscale/bin'
+      subject.sandbox_dir.should == '/opt/rightscale/sandbox'
+    end
+
+    it 'should return unmodified paths from Windows compatibility methods' do
+      path = '/tmp/some_path_to_test'
+      subject.long_path_to_short_path(path).should == path
+      subject.pretty_path(path, false).should == path
+      subject.pretty_path(path, true).should == path
+      subject.ensure_local_drive_path(path, 'foo').should == path
+    end
+  end # paths
+
+  context '#create_symlink' do
+    it 'should use ruby file to create symlink (under unix)' do
+      file_class.should_receive(:symlink).with('/tmp/from', '/tmp/to').and_return(0)
+      subject.create_symlink('/tmp/from', '/tmp/to').should == 0
+    end
+  end # create_symlink
+end # supports unix platform filesystem
+
+shared_examples_for 'supports unix platform shell' do
+  it_should_behave_like 'supports any platform shell'
+
+  context 'paths' do
+    it 'should return path constants for unix' do
+      subject.null_output_name.should == '/dev/null'
+      subject.sandbox_ruby.should == '/opt/rightscale/sandbox/bin/ruby'
+    end
+  end # paths
+
+  context 'commands' do
+    it 'should return unmodified commands from Windows compatibility methods' do
+      cmd = 'sh -c echo foo'
+      subject.format_script_file_name(cmd).should == cmd
+      subject.format_script_file_name(cmd, '.foo').should == cmd
+    end
+
+    [:format_executable_command, :format_shell_command].each do |methud|
+      context methud do
+        it 'should format commands' do
+          subject.send(methud, 'foo').should == 'foo'
+          subject.send(methud, 'bar', 'foo').should == 'bar foo'
+          subject.send(methud, 'baz', 'a b', "c'd", 'foo').should == "baz \"a b\" \"c'd\" foo"
+        end
+      end # methud
+    end # for each method (having identical behavior under unix)
+
+    it 'should format ruby commands using sandbox ruby' do
+      script_path = '/tmp/foo.rb'
+      subject.format_ruby_command(script_path).should == '/opt/rightscale/sandbox/bin/ruby /tmp/foo.rb'
+      subject.format_ruby_command(script_path, 'bar').should == '/opt/rightscale/sandbox/bin/ruby /tmp/foo.rb bar'
+    end
+  end # commands
+end # supports unix platform shell
+
+shared_examples_for 'supports unix platform rng' do
+  context '#pseudorandom_bytes' do
+    it 'should read requested byte length from urandom device under unix' do
+      sio = StringIO.new
+      buffer = 0.chr * 256
+      256.times.each { |i| buffer[i] = i.chr }
+      sio.write buffer
+      sio.rewind
+      file_class.should_receive(:open).with('/dev/urandom', 'r', Proc).and_yield(sio)
+      subject.pseudorandom_bytes(16).should == buffer[0, 16]
+      subject.pseudorandom_bytes(32).should == buffer[16, 32]
+    end
+  end # pseudorandom_bytes
+end # supports unix platform rng
+
+shared_examples_for 'supports unix platform process' do
+  context '#resident_set_size' do
+    it 'should return resident set size for current process' do
+      cmd = "ps -o rss= -p #{$$}"
+      platform_class.should_receive(:execute).with(cmd, {}).and_return('12345').once
+      subject.resident_set_size.should == 12345
+    end
+
+    it 'should return resident set size for other process' do
+      pid = 789
+      cmd = "ps -o rss= -p #{pid}"
+      platform_class.should_receive(:execute).with(cmd, {}).and_return('23456').once
+      subject.resident_set_size(pid).should == 23456
+    end
+  end # pseudorandom_bytes
+end # supports unix platform rng

data/spec/platform/windows/mingw/platform_spec.rb

@@ -0,0 +1,222 @@
+#
+# Copyright (c) 2013 RightScale Inc
+#
+# 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:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# 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.
+
+require ::File.expand_path('../../spec_helper', __FILE__)
+
+# stub FII for testing on non-mingw platforms; any mingw-specific tests must
+# mock API calls.
+module FFI
+  module Library
+
+    def typedef(*args)
+      true
+    end
+
+    def ffi_lib(*args)
+      true
+    end
+
+    def ffi_convention(*args)
+      true
+    end
+
+    def attach_function(*args)
+      true
+    end
+  end
+end
+
+describe RightScale::Platform do
+
+  include PlatformSpecHelper
+
+  context 'windows/mingw' do
+
+    # required by before_all_platform_tests
+    # called by before(:all) so not defined using let().
+    def expected_genus; :windows; end
+    def expected_species; :mingw; end
+
+    def to_wide(str)
+      str.encode(::RightScale::Platform::PlatformHelperBase::WIDE)
+    end
+
+    def instrument_win32_error(error_code, error_message)
+      flexmock(::FFI).should_receive(:errno).and_return(error_code).once
+      flexmock(described_class::WindowsCommon::API).
+        should_receive(:FormatMessageW).
+        with(0x1200, nil, error_code, 0, String, Integer, nil).
+        and_return do |flags, _, message_id, _, unicode_buffer, _, _|
+          if flags == 0x1200 && message_id == 5
+            unicode_message = to_wide(error_message)
+            unicode_message.chars.each_with_index do |c, index|
+              unicode_buffer[index] = c
+            end
+            unicode_message.length
+          else
+            fail "Unexpected arguments: #{[flags, message_id].inspect}"
+          end
+        end.once
+    end
+
+    before(:all) do
+      before_all_platform_tests
+    end
+
+    after(:all) do
+      after_all_platform_tests
+    end
+
+    before(:each) do
+      before_each_platform_test
+    end
+
+    after(:each) do
+      after_each_platform_test
+    end
+
+    context :statics do
+      subject { platform_class }
+
+      it_should_behave_like 'supports windows platform statics'
+    end
+
+    context :initialization do
+      def instrument_os_info(major, minor, build)
+        flexmock(::FFI).should_receive(:errno).and_return(0).once
+        flexmock(described_class::WindowsSystemInformation::API).
+          should_receive(:GetVersionExW).
+          with(String).
+          and_return do |vib|
+            vib[4,12] = [major, minor, build].pack('LLL')
+          end.once
+      end
+
+      it_should_behave_like 'supports windows platform initialization'
+    end # initialization
+
+    context :controller do
+      subject { described_class.controller }
+
+      def instrument_initiate_system_shutdown_api(reboot_after_shutdown)
+        controller_api = flexmock(described_class::Controller::API)
+        process_api = flexmock(described_class::Process::API)
+        windows_common_api = flexmock(described_class::WindowsCommon::API)
+        windows_security_api = flexmock(described_class::WindowsSecurity::API)
+
+        process_api.should_receive(:GetCurrentProcess).and_return(-1).once
+        process_api.should_receive(:OpenProcessToken).and_return(true).once
+        windows_security_api.should_receive(:LookupPrivilegeValueW).and_return(true).once
+        windows_security_api.should_receive(:AdjustTokenPrivileges).and_return(true).once
+        controller_api.
+          should_receive(:InitiateSystemShutdownW).
+          with(nil, nil, 1, true, reboot_after_shutdown).
+          and_return(true).
+          once
+        windows_common_api.should_receive(:CloseHandle).and_return(true).once
+      end
+
+      it_should_behave_like 'supports windows platform controller'
+    end # controller
+
+    context :filesystem do
+      subject { flexmock(described_class.filesystem) }
+
+      def instrument_create_symbolic_link_api(from_path, to_path, flags, &callback)
+        flexmock(described_class::Filesystem::API).
+          should_receive(:CreateSymbolicLinkW).
+          with(to_wide(to_path + 0.chr), to_wide(from_path + 0.chr), flags).
+          and_return { callback.call == 0 ? false : true }.
+          once
+      end
+
+      def instrument_get_short_path_name_api(long_path, short_path_from_api, &callback)
+        flexmock(described_class::Filesystem::API).
+          should_receive(:GetShortPathNameW).
+          with(to_wide(long_path + 0.chr), String, Integer).
+          and_return do |lp, short_path_buffer, _|
+            to_wide(short_path_from_api).chars.each_with_index do |c, index|
+              short_path_buffer[index] = c
+            end
+            callback.call
+          end.once
+      end
+
+      def instrument_get_temp_path_api(temp_path_from_api, &callback)
+        flexmock(described_class::Filesystem::API).
+          should_receive(:GetTempPathW).
+          with(Integer, String).
+          and_return do |_, buffer|
+            to_wide(temp_path_from_api).chars.each_with_index do |c, index|
+              buffer[index] = c
+            end
+            callback.call
+          end.once
+      end
+
+      it_should_behave_like 'supports windows platform filesystem'
+    end # filesystem
+
+    context :installer do
+      subject { described_class.installer }
+
+      it_should_behave_like 'supports windows platform installer'
+    end # installer
+
+    context :shell do
+      subject { flexmock(described_class.shell) }
+
+      it_should_behave_like 'supports windows platform shell'
+    end # shell
+
+    context :rng do
+      subject { described_class.rng }
+
+      it_should_behave_like 'supports windows platform rng'
+    end # rng
+
+    context :process do
+      subject { described_class.process }
+
+      def instrument_get_process_memory_info_api(resident_set_size)
+        process_api = flexmock(described_class::Process::API)
+        process_api.should_receive(:GetCurrentProcess).and_return(-1).once
+        process_api.
+          should_receive(:GetProcessMemoryInfo).
+          with(-1, String, Integer).
+          and_return do |_, pmib, _|
+            pmib[3 * 4, 4] = [resident_set_size * 1024].pack('L')
+            true
+          end.once
+      end
+
+      it_should_behave_like 'supports windows platform process'
+    end # process
+
+    context :volume_manager do
+      subject { flexmock(described_class.volume_manager) }
+
+      it_should_behave_like 'supports windows platform volume manager'
+    end # volume_manager
+
+  end # windows/mingw
+end # RightScale::Platform

data/spec/platform/windows/mswin/platform_spec.rb

@@ -0,0 +1,259 @@
+#
+# Copyright (c) 2013 RightScale Inc
+#
+# 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:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# 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.
+
+require ::File.expand_path('../../spec_helper', __FILE__)
+
+# stub out definition of ::Win32::API for testing on non-Windows platforms.
+module Win32
+  class API; end
+end
+
+describe RightScale::Platform do
+
+  include PlatformSpecHelper
+
+  context 'windows/mswin' do
+
+    # required by before_all_platform_tests
+    # called by before(:all) so not defined using let().
+    def expected_genus; :windows; end
+    def expected_species; :mswin; end
+
+    def instrument_win32_error(error_code, error_message)
+      w32a = flexmock(::Win32::API)
+      w32a.
+        should_receive(:new).
+        with('GetLastError', 'V', 'L', 'kernel32').
+        and_return(lambda { error_code }).
+        once
+      w32a.
+        should_receive(:new).
+        with('FormatMessage', 'LLLLPLP', 'L', 'kernel32').
+        and_return do
+          lambda do |flags, _, message_id, _, buffer, _, _|
+
+            if flags == 0x1200 && message_id == 5
+              error_message.chars.each_with_index do |c, index|
+                buffer[index] = c
+              end
+              error_message.length
+            else
+              fail "Unexpected arguments: #{[mn, m, t, tac, ras].inspect}"
+            end
+          end
+        end.once
+    end
+
+    before(:all) do
+      before_all_platform_tests
+    end
+
+    after(:all) do
+      after_all_platform_tests
+    end
+
+    before(:each) do
+      before_each_platform_test
+    end
+
+    after(:each) do
+      after_each_platform_test
+    end
+
+    context :statics do
+      subject { platform_class }
+
+      it_should_behave_like 'supports windows platform statics'
+    end
+
+    context :initialization do
+      def instrument_os_info(major, minor, build)
+        w32a = flexmock(::Win32::API)
+        w32a.
+          should_receive(:new).
+          with('GetLastError', 'V', 'L', 'kernel32').
+          and_return(lambda { 0 }).
+          once
+        w32a.
+          should_receive(:new).
+          with('GetVersionEx', 'P', 'L', 'kernel32').
+          and_return(
+            lambda do |vib|
+              vib[4,12] = [major, minor, build].pack('LLL')
+              1
+            end
+          ).once
+      end
+
+      it_should_behave_like 'supports windows platform initialization'
+    end # initialization
+
+    context :controller do
+      subject { described_class.controller }
+
+      def instrument_initiate_system_shutdown_api(reboot_after_shutdown)
+        w32a = flexmock(::Win32::API)
+        w32a.
+          should_receive(:new).
+          with('GetCurrentProcess', 'V', 'L', 'kernel32').
+          and_return(lambda { -1 }).
+          once
+        w32a.
+          should_receive(:new).
+          with('OpenProcessToken', 'LLP', 'B', 'advapi32').
+          and_return(lambda { |ph, da, th| 1 }).
+          once
+        w32a.
+          should_receive(:new).
+          with('LookupPrivilegeValue', 'PPP', 'B', 'advapi32').
+          and_return(lambda { |sn, n, luid| 1 }).
+          once
+        w32a.
+          should_receive(:new).
+          with('AdjustTokenPrivileges', 'LLPLPP', 'B', 'advapi32').
+          and_return(lambda { |th, dap, ns, bl, ps, rl| 1 }).
+          once
+        w32a.
+          should_receive(:new).
+          with('InitiateSystemShutdown', 'PPLLL', 'B', 'advapi32').
+          and_return(
+            lambda do |mn, m, t, tac, ras|
+              if mn == 0 && m == 0 && t == 1 && tac == 1 && ras == (reboot_after_shutdown ? 1 : 0)
+                1
+              else
+                fail "Unexpected arguments: #{[mn, m, t, tac, ras].inspect}"
+              end
+            end
+          ).once
+        w32a.
+          should_receive(:new).
+          with('CloseHandle', 'L', 'B', 'kernel32').
+          and_return(lambda { |h| 1 }).
+          once
+      end
+
+      it_should_behave_like 'supports windows platform controller'
+    end # controller
+
+    context :filesystem do
+      subject { flexmock(described_class.filesystem) }
+
+      def instrument_create_symbolic_link_api(from_path, to_path, flags, &callback)
+        flexmock(::Win32::API).
+          should_receive(:new).
+          with('CreateSymbolicLink', 'SSL', 'B', 'kernel32').
+          and_return(
+            lambda do |tp, fp, fgs|
+              if fp == (from_path + 0.chr) && tp == (to_path + 0.chr) && fgs == flags
+                callback.call
+              else
+                fail "Unexpected arguments: #{[tp, fp, fgs].inspect}"
+              end
+            end
+          ).once
+      end
+
+      def instrument_get_short_path_name_api(long_path, short_path_from_api, &callback)
+        flexmock(::Win32::API).
+          should_receive(:new).
+          with('GetShortPathName', 'SPL', 'L', 'kernel32').
+          and_return(
+            lambda do |lp, short_path_buffer, short_path_buffer_length|
+              if lp == (long_path + 0.chr)
+                short_path_from_api.chars.each_with_index do |c, index|
+                  short_path_buffer[index] = c
+                end
+                callback.call
+              else
+                fail "Unexpected arguments: #{lp.inspect}"
+              end
+            end
+          ).once
+      end
+
+      def instrument_get_temp_path_api(temp_path_from_api, &callback)
+        flexmock(::Win32::API).
+          should_receive(:new).
+          with('GetTempPath', 'LP', 'L', 'kernel32').
+          and_return(
+            lambda do |buffer_length, buffer|
+              temp_path_from_api.chars.each_with_index do |c, index|
+                buffer[index] = c
+              end
+              callback.call
+            end
+          ).once
+      end
+
+      it_should_behave_like 'supports windows platform filesystem'
+    end # filesystem
+
+    context :installer do
+      subject { described_class.installer }
+
+      it_should_behave_like 'supports windows platform installer'
+    end # installer
+
+    context :shell do
+      subject { flexmock(described_class.shell) }
+
+      it_should_behave_like 'supports windows platform shell'
+    end # shell
+
+    context :rng do
+      subject { described_class.rng }
+
+      it_should_behave_like 'supports windows platform rng'
+    end # rng
+
+    context :process do
+      subject { described_class.process }
+
+      def instrument_get_process_memory_info_api(resident_set_size)
+        w32a = flexmock(::Win32::API)
+        w32a.
+          should_receive(:new).
+          with('GetCurrentProcess', 'V', 'L', 'kernel32').
+          and_return(lambda { -1 }).
+          once
+        w32a.
+          should_receive(:new).
+          with('GetProcessMemoryInfo', 'LPL', 'B', 'psapi').
+          and_return(
+            lambda do |ph, pmib, pmibs|
+              pmib[3 * 4, 4] = [resident_set_size * 1024].pack('L')
+              1
+            end
+          ).once
+      end
+
+      it_should_behave_like 'supports windows platform process'
+    end # process
+
+    context :volume_manager do
+      subject { flexmock(described_class.volume_manager) }
+
+      it_should_behave_like 'supports windows platform volume manager'
+    end # volume_manager
+
+  end # windows/mswin
+end # RightScale::Platform