right_agent 2.0.7-x86-mingw32

data/spec/pending_requests_spec.rb

@@ -0,0 +1,136 @@
+#
+# 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(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe RightScale::PendingRequest do
+
+  context :initialize do
+    it "creates pending request" do
+      now = Time.now
+      response_handler = lambda { |_| }
+      pending_request = RightScale::PendingRequest.new(:send_request, now, response_handler)
+      pending_request.kind.should == :send_request
+      pending_request.receive_time.should == now
+      pending_request.response_handler.should == response_handler
+      pending_request.retry_parent_token.should be_nil
+      pending_request.non_delivery.should be_nil
+    end
+  end
+
+  context :retry_parent_token do
+    it "can be set" do
+      pending_request = RightScale::PendingRequest.new(:send_request, Time.now, lambda { |_| })
+      pending_request.retry_parent_token = "retry token"
+      pending_request.retry_parent_token.should == "retry token"
+    end
+  end
+
+  context :non_delivery do
+    it "can be set" do
+      pending_request = RightScale::PendingRequest.new(:send_request, Time.now, lambda { |_| })
+      pending_request.non_delivery = "because"
+      pending_request.non_delivery.should == "because"
+    end
+  end
+end
+
+describe RightScale::PendingRequests do
+
+  # Add specified kinds of pending requests to pending_requests hash
+  def add_requests(pending_requests, kinds)
+    i = 0
+    kinds.each do |kind|
+      i += 1
+      pending_requests["token#{i}"] = RightScale::PendingRequest.new(kind, Time.now, lambda { |_| })
+    end
+  end
+
+  before(:all) do
+    @push = :send_push
+    @request = :send_request
+  end
+
+  context :initialize do
+    it "is a hash" do
+      pending_requests = RightScale::PendingRequests.new
+      pending_requests.should be_a(Hash)
+      pending_requests.size.should == 0
+    end
+  end
+
+  context :[]= do
+    it "stores pending request" do
+      pending_requests = RightScale::PendingRequests.new
+      pending_request = RightScale::PendingRequest.new(:send_request, Time.now, lambda { |_| })
+      pending_requests["token"] = pending_request
+      pending_requests["token"].should == pending_request
+    end
+
+    it "deletes old pending send_push requests" do
+      now = Time.now
+      age = RightScale::PendingRequests::MAX_PUSH_AGE + 21
+      flexmock(Time).should_receive(:now).and_return(now, now + 10, now + 10, now + 20, now + 20, now + age, now + age)
+      pending_requests = RightScale::PendingRequests.new
+      add_requests(pending_requests, [@request, @push, @push])
+      pending_requests.size.should == 2
+      pending_requests["token1"].should_not be_nil
+      pending_requests["token2"].should be_nil
+      pending_requests["token3"].should_not be_nil
+      pending_requests.instance_variable_get(:@last_cleanup).should == now + age
+    end
+  end
+
+  context :kind do
+    it "returns pending requests of specified kind" do
+      pending_requests = RightScale::PendingRequests.new
+      add_requests(pending_requests, [@request, @push, @push])
+      requests = pending_requests.kind(:send_request)
+      requests.size.should == 1
+      requests["token1"].should_not be_nil
+      requests = pending_requests.kind(:send_push)
+      requests.size.should == 2
+      requests["token2"].should_not be_nil
+      requests["token3"].should_not be_nil
+    end
+  end
+
+  context :youngest_age do
+    it "returns age of youngest pending request" do
+      now = Time.now
+      flexmock(Time).should_receive(:now).and_return(now, now + 10, now + 10, now + 20, now + 20, now + 30)
+      pending_requests = RightScale::PendingRequests.new
+      add_requests(pending_requests, [@request, @push])
+      pending_requests.youngest_age.should == 10
+    end
+  end
+
+  context :oldest_age do
+    it "returns age of oldest pending request" do
+      now = Time.now
+      flexmock(Time).should_receive(:now).and_return(now, now + 10, now + 10, now + 20, now + 20, now + 30)
+      pending_requests = RightScale::PendingRequests.new
+      add_requests(pending_requests, [@request, @push])
+      pending_requests.oldest_age.should == 20
+    end
+  end
+end

data/spec/platform/spec_helper.rb

@@ -0,0 +1,216 @@
+#
+# Copyright (c) 2009-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__)
+
+# reloads the Platform overrides for the current platform under test and then
+# restores the default platform to avoid breaking subsequent spec tests. works
+# because each implementation is expected to fully override the methods in the
+# base Platform class and so support multiple redefinition.
+#
+# requires the following to be defined by spec in a platform-specific manner:
+#  instrument_booted_at
+module PlatformSpecHelper
+
+  # references mocked Platform class and instance to simplify singleton testing.
+  attr_reader :file_class, :platform_class, :platform_instance
+
+  # resets the Platform singleton.
+  def reset_platform_singleton
+    # release any existing singleton to force full reload from source.
+    ::RightScale::Platform.instance_variable_set(:@singleton__instance__, nil)
+    true
+  end
+
+  # Invoke within a before(:all) in described class.
+  def before_all_platform_tests
+    return true if RUBY_VERSION =~ /^1\.8/  # see below
+
+    reset_platform_singleton
+
+    # redefine Platform#initialize_platform_specific to defeat load-upon-
+    # initialize behavior of singleton and give us a chance to set genus/species
+    # explicitly before any loading occurs.
+    ::RightScale::Platform.class_eval('def initialize_platform_specific; end')
+
+    instance = ::RightScale::Platform.instance
+    instance.instance_variable_set(:@genus, expected_genus)
+    instance.instance_variable_set(:@species, expected_species)
+
+    # invoke require logic for load-once behavior.
+    unless instance.send(:load_platform_specific)
+      # forcibly reload platform under test when require returns false.
+      load instance.send(:platform_base_path) + '.rb'
+      load instance.send(:platform_genus_path) + '.rb'
+      load instance.send(:platform_species_path) + '.rb'
+    end
+    ::RightScale::Platform.genus.should == expected_genus
+    ::RightScale::Platform.species.should == expected_species
+    true
+  end
+
+  # Invoke within a after(:all) in described class.
+  def after_all_platform_tests
+    return true if RUBY_VERSION =~ /^1\.8/  # see below
+
+    # 'restore' original singleton. this does not undefine any additional nested
+    # classes that are platform-specific (for other than the current platform)
+    # but they will not be invoked and so are harmless.
+    reset_platform_singleton
+    instance = ::RightScale::Platform.instance
+    load instance.send(:platform_base_path) + '.rb'
+    load instance.send(:platform_genus_path) + '.rb'
+    load instance.send(:platform_species_path) + '.rb'
+    instance.send(:initialize_genus)
+    instance.send(:initialize_species)
+    true
+  end
+
+  # Invoke within a before(:each) in described class.
+  def before_each_platform_test
+    # TEAL FIX might be that flexmock version is too new for ruby 1.8 to work,
+    # but not really important going forward.
+    if RUBY_VERSION =~ /^1\.8/
+      pending 'before(:all) mocks do not work in ruby 1.8'
+    end
+
+    # reset singleton again but no need to reload platform code at this point.
+    # the issue is that flexmock needs a fresh instance to mock out each time or
+    # else the mock teardown goes haywire and spews meaningless stack-traces to
+    # the console. the problem seems to be exacerbated by these tests redefining
+    # methods of Platform (out of necessity).
+    reset_platform_singleton
+    platform = ::RightScale::Platform
+    instance = platform.instance
+    instance.instance_variable_set(:@genus, expected_genus)
+    instance.instance_variable_set(:@species, expected_species)
+
+    # create mocks.
+    @file_class = flexmock(::File)
+    @platform_class = flexmock(platform)
+    @platform_instance = flexmock(instance)
+
+    # require normalize_path to be mocked during spec runs as it actually
+    # invokes APIs on Windows.
+    file_class.should_receive(:normalize_path).and_return do |*args|
+      raise ::NotImplementedError, "Must mock all calls to File.normalize_path: #{args.inspect}"
+    end.by_default
+
+    # defeat any shell execution by default (i.e. until properly mocked).
+    platform_class.should_receive(:execute).and_return do |*args|
+      raise ::NotImplementedError, "Must mock all calls to Platform.execute for class: #{args.inspect}"
+    end.by_default
+    platform_instance.should_receive(:execute).and_return do |*args|
+      raise ::NotImplementedError, "Must instrument all calls to Platform#execute for instance: #{args.inspect}"
+    end.by_default
+    ::RightScale::Platform.genus.should == expected_genus
+    ::RightScale::Platform.species.should == expected_species
+    expect { ::RightScale::Platform.execute(nil) }.to raise_error(::NotImplementedError)
+    expect { ::RightScale::Platform.instance.execute(nil) }.to raise_error(::NotImplementedError)
+    true
+  end
+
+  # Invoke within a after(:each) in described class.
+  def after_each_platform_test
+    @file_class = nil
+    @platform_class = nil
+    @platform_instance = nil
+    true
+  end
+
+end # PlatformSpecHelper
+
+shared_examples_for 'supports any platform shell' do
+  let(:minimum_uptime)     { 10 * 60 }
+  let(:expected_booted_at) { ::Time.now.to_i - minimum_uptime }
+
+  # Sleeps until timer ticks over. Note that sleep(1) does not guarantee
+  # a tick-over and it may take sleep(< 1) to observe the tick-over.
+  def wait_for_tick_change
+    start_tick = ::Time.now.to_i
+    while ::Time.now.to_i == start_tick
+      sleep 0.1
+    end
+    true
+  end
+
+  context '#format_redirect_stdout' do
+    it 'should format redirect of stdout' do
+      subject.format_redirect_stdout('foo bar').
+        should == "foo bar 1>#{subject.null_output_name}"
+      subject.format_redirect_stdout('bar foo', '/tmp/foo').
+        should == 'bar foo 1>/tmp/foo'
+    end
+  end # format_redirect_stdout
+
+  context '#format_redirect_stderr' do
+    it 'should format redirect of stderr' do
+      subject.format_redirect_stderr('foo bar').
+        should == "foo bar 2>#{subject.null_output_name}"
+      subject.format_redirect_stderr('bar foo', '/tmp/foo').
+        should == 'bar foo 2>/tmp/foo'
+    end
+  end # format_redirect_stderr
+
+  context '#format_redirect_both' do
+    it 'should format redirect of stderr' do
+      subject.format_redirect_both('foo bar').
+        should == "foo bar 1>#{subject.null_output_name} 2>&1"
+      subject.format_redirect_both('bar foo', '/tmp/foo').
+        should == 'bar foo 1>/tmp/foo 2>&1'
+    end
+  end # format_redirect_both
+
+  context '#uptime' do
+    it 'should be positive' do
+      instrument_booted_at(expected_booted_at) { minimum_uptime }
+      subject.uptime.should >= minimum_uptime
+    end
+
+    it 'should be strictly increasing' do
+      uptime = minimum_uptime
+      instrument_booted_at(expected_booted_at) { uptime }
+      u0 = subject.uptime
+      wait_for_tick_change  # uptime may use either system data or a relative time
+      uptime += 1
+      u1 = subject.uptime
+      (u1 - u0).should > 0.0
+    end
+  end # uptime
+
+  context '#booted_at' do
+    it 'should be some time in the past' do
+      instrument_booted_at(expected_booted_at) { minimum_uptime }
+      subject.booted_at.should == expected_booted_at
+    end
+
+    it 'should be constant' do
+      uptime = minimum_uptime
+      instrument_booted_at(expected_booted_at) { uptime }
+      b0 = subject.booted_at
+      wait_for_tick_change  # uptime may use either system data or a relative time
+      uptime += 1
+      b1 = subject.booted_at
+      b0.should == b1
+    end
+  end # booted_at
+end # supports any platform shell

data/spec/platform/unix/darwin/platform_spec.rb

@@ -0,0 +1,181 @@
+#
+# 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__)
+
+describe RightScale::Platform do
+  include PlatformSpecHelper
+
+  context 'unix/darwin' do
+
+    # required by before_all_platform_tests
+    # called by before(:all) so not defined using let().
+    def expected_genus; :unix; end
+    def expected_species; :darwin; 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 be linux' do
+        subject.unix?.should be_true
+        subject.windows?.should be_false
+        subject.linux?.should be_false
+        subject.darwin?.should be_true
+      end
+    end
+
+    context 'initialization' do
+
+      let(:sw_vers_cmd) { 'sw_vers -productVersion 2>&1' }
+
+      context 'when sw_vers is available' do
+        it 'should initialize from sw_vers data' do
+          platform_instance.
+            should_receive(:execute).
+            with(sw_vers_cmd).
+            and_return("10.8.5\n").
+            once
+          platform_instance.send(:initialize_species)
+          platform_instance.flavor.should == 'mac_os_x'
+          platform_instance.release.should == '10.8.5'
+          platform_instance.codename.should == ''
+        end
+      end # when lsb_release is available
+
+      context 'when sw_vers is not available' do
+        it 'should be unknown release' do
+          platform_instance.
+            should_receive(:execute).
+            with(sw_vers_cmd).
+            and_raise(described_class::CommandError).
+            once
+          platform_instance.send(:initialize_species)
+          platform_instance.flavor.should == 'mac_os_x'
+          platform_instance.release.should == 'unknown'
+          platform_instance.codename.should == 'unknown'
+        end
+      end # when lsb_release is not available
+    end # initialization
+
+    context :controller do
+      subject { described_class.controller }
+
+      context '#reboot' do
+        it 'should call shutdown -r now under darwin' do
+          platform_class.should_receive(:execute).with('shutdown -r now 2>&1', {}).and_return('')
+          subject.reboot.should be_true
+        end
+      end # reboot
+
+      context '#shutdown' do
+        it 'should call shutdown -h now under darwin' do
+          platform_class.should_receive(:execute).with('shutdown -h now 2>&1', {}).and_return('')
+          subject.shutdown.should be_true
+        end
+      end # shutdown
+    end # controller
+
+    context :filesystem do
+      subject { described_class.filesystem }
+
+      it_should_behave_like 'supports unix platform filesystem'
+    end
+
+    context :installer do
+      subject { described_class.installer }
+
+      context :install do
+        it 'should raise not implemented' do
+          expect { subject.install(%w[foo bar]) }.
+           to raise_error(
+             ::NotImplementedError, 'Not yet supporting Mac OS package install')
+        end
+      end # install
+    end # installer
+
+    context :shell do
+      subject { described_class.shell }
+
+      # required by 'supports any platform shell'
+      def instrument_booted_at(booted_at)
+        time = ::Time.at(booted_at.to_i)
+        platform_class.
+          should_receive(:execute).
+          with('sysctl kern.boottime', {}).
+          and_return("kern.boottime: { sec = #{time.to_i}, usec = 0 } #{time.to_s}")
+
+        # note that uptime is computed relative to boottime.
+        true
+      end
+
+      it_should_behave_like 'supports unix platform shell'
+    end
+
+    context :rng do
+      subject { described_class.rng }
+
+      it_should_behave_like 'supports unix platform rng'
+    end
+
+    context :process do
+      subject { described_class.process }
+
+      it_should_behave_like 'supports unix platform process'
+    end
+
+    context :volume_manager do
+      subject { platform_class.volume_manager }
+
+      context :volumes do
+        it 'should raise not implemented' do
+          expect { subject.volumes }.
+            to raise_error(
+             ::NotImplementedError, 'Not yet supporting Mac OS volume query')
+        end
+      end # volumes
+
+      context :mount_volume do
+        it 'should raise not implemented' do
+          expect { subject.volumes }.
+            to raise_error(
+             ::NotImplementedError, 'Not yet supporting Mac OS volume query')
+        end
+      end # mount_volume
+    end # volume_manager
+  end # under unix/darwin
+end # RightScale::Platform