right_agent 2.0.7-x86-mingw32

data/spec/actor_spec.rb

@@ -0,0 +1,162 @@
+#
+# Copyright (c) 2009-2011 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::Actor do
+  class ::WebDocumentImporter
+    include RightScale::Actor
+    expose_non_idempotent :import, :cancel
+    expose_idempotent :special
+
+    def import; 1 end
+    def cancel; 0 end
+    def continue; 1 end
+    def special; 2 end
+    def more_special; 3 end
+  end
+
+  module ::Actors
+    class ComedyActor
+      include RightScale::Actor
+      expose :fun_tricks
+      def fun_tricks
+        :rabbit_in_the_hat
+      end
+    end
+  end
+
+  class ::Actors::InvalidActor
+    include RightScale::Actor
+    expose :non_existing
+  end
+
+  before :each do
+    @log = flexmock(RightScale::Log)
+    @log.should_receive(:warning).by_default.and_return { |m| raise RightScale::Log.format(*m) }
+    @log.should_receive(:error).by_default.and_return { |m| raise RightScale::Log.format(*m) }
+  end
+
+  describe "expose" do
+
+    before :each do
+      @exposed = WebDocumentImporter.instance_variable_get(:@exposed).dup
+    end
+
+    after :each do
+      WebDocumentImporter.instance_variable_set(:@exposed, @exposed)
+    end
+
+    context "idempotent" do
+
+      it "exposes as idempotent" do
+        WebDocumentImporter.expose_idempotent(:more_special)
+        WebDocumentImporter.provides_for("webfiles").sort.should == [
+          "/webfiles/cancel", "/webfiles/import", "/webfiles/more_special", "/webfiles/special"]
+        WebDocumentImporter.idempotent?(:special).should be_true
+        WebDocumentImporter.idempotent?(:more_special).should be_true
+      end
+
+      it "treats already exposed non-idempotent method as non-idempotent" do
+        @log.should_receive(:warning).with(/Method cancel declared both idempotent and non-idempotent/).once
+        WebDocumentImporter.expose_idempotent(:cancel)
+        WebDocumentImporter.provides_for("webfiles").sort.should == [
+          "/webfiles/cancel", "/webfiles/import", "/webfiles/special"]
+        WebDocumentImporter.idempotent?(:cancel).should be_false
+      end
+
+    end
+
+    context "non_idempotent" do
+
+      it "exposes as non-idempotent" do
+        WebDocumentImporter.expose_non_idempotent(:continue)
+        WebDocumentImporter.provides_for("webfiles").sort.should == [
+          "/webfiles/cancel", "/webfiles/continue", "/webfiles/import", "/webfiles/special"]
+        WebDocumentImporter.idempotent?(:import).should be_false
+        WebDocumentImporter.idempotent?(:cancel).should be_false
+        WebDocumentImporter.idempotent?(:continue).should be_false
+      end
+
+      it "treats already exposed idempotent method as non-idempotent" do
+        @log.should_receive(:warning).with(/Method special declared both idempotent and non-idempotent/).once
+        WebDocumentImporter.expose_non_idempotent(:special)
+        WebDocumentImporter.provides_for("webfiles").sort.should == [
+          "/webfiles/cancel", "/webfiles/import", "/webfiles/special"]
+        WebDocumentImporter.idempotent?(:special).should be_false
+      end
+
+      it "defaults expose method to declare non_idempotent" do
+        WebDocumentImporter.expose(:continue)
+        WebDocumentImporter.provides_for("webfiles").sort.should == [
+          "/webfiles/cancel", "/webfiles/continue", "/webfiles/import", "/webfiles/special"]
+        WebDocumentImporter.idempotent?(:continue).should be_false
+      end
+
+    end
+
+  end
+
+  describe "default_prefix" do
+
+    it "is calculated as default prefix as const path of class name" do
+      Actors::ComedyActor.default_prefix.should == "actors/comedy_actor"
+      WebDocumentImporter.default_prefix.should == "web_document_importer"
+    end
+
+  end
+
+  describe "provides_for" do
+
+    before :each do
+      @provides = Actors::ComedyActor.provides_for("money")
+    end
+
+    it "returns an array" do
+      @provides.should be_kind_of(Array)
+    end
+
+    it "maps exposed service methods to prefix" do
+      @provides.should == ["/money/fun_tricks"]
+      wdi_provides = WebDocumentImporter.provides_for("webfiles")
+      wdi_provides.should include("/webfiles/import")
+      wdi_provides.should include("/webfiles/cancel")
+      wdi_provides.should include("/webfiles/special")
+    end
+
+    it "excludes methods not existing in the actor class" do
+      @log.should_receive(:warning).with("Exposing non-existing method non_existing in actor money").once
+      Actors::InvalidActor.provides_for("money").should_not include("/money/non_existing")
+    end
+
+  end
+
+  describe "idempotent?" do
+
+    it "returns whether idempotent" do
+      WebDocumentImporter.idempotent?(:import).should be_false
+      WebDocumentImporter.idempotent?(:special).should be_true
+    end
+
+  end
+
+end

data/spec/agent_config_spec.rb

@@ -0,0 +1,235 @@
+#
+# Copyright (c) 2011 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::AgentConfig do
+
+  before(:all) do
+    @agent_config = RightScale::AgentConfig
+    @pwd_dir = Dir.pwd
+    @tmp_dir = RightScale::Platform.filesystem.temp_dir
+    @test_dir = File.join(@tmp_dir, 'agent_config_test')
+    @agent_id1 = "rs-agent-1-1"
+    FileUtils.mkdir_p(@root_dir1 = File.join(@test_dir, 'root1'))
+    FileUtils.mkdir_p(@root_dir2 = File.join(@test_dir, 'root2'))
+    FileUtils.mkdir_p(@root_dir3 = File.join(@test_dir, 'root3'))
+    FileUtils.mkdir_p(@init_dir1 = File.join(@root_dir1, 'init'))
+    FileUtils.mkdir_p(@init_dir2 = File.join(@root_dir2, 'init'))
+    FileUtils.mkdir_p(@init_dir3 = File.join(@root_dir3, 'init'))
+    FileUtils.touch([@config1 = File.join(@init_dir1, 'config.yml'), @config2 = File.join(@init_dir2, 'config.yml')])
+    FileUtils.touch([@init2 = File.join(@init_dir2, 'init.rb'), @init3 = File.join(@init_dir3, 'init.rb')])
+    FileUtils.mkdir_p(@actors1 = File.join(@root_dir1, 'actors'))
+    FileUtils.mkdir_p(@actors3 = File.join(@root_dir3, 'actors'))
+    @actors = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'right_agent', 'actors'))
+    FileUtils.mkdir_p(@certs1 = File.join(@root_dir1, 'certs'))
+    FileUtils.mkdir_p(@certs2 = File.join(@root_dir2, 'certs'))
+    FileUtils.touch([@router_cert1 = File.join(@certs1, 'router.cert')])
+    FileUtils.touch([@router_cert2 = File.join(@certs2, 'router.cert')])
+    FileUtils.touch([@agent_cert2 = File.join(@certs2, 'agent.cert')])
+    FileUtils.touch([@router_key2 = File.join(@certs2, 'router.key')])
+    FileUtils.mkdir_p(@lib1 = File.join(@root_dir1, 'lib'))
+    FileUtils.mkdir_p(@scripts3 = File.join(@root_dir3, 'scripts'))
+    FileUtils.mkdir_p(@cfg_dir = File.join(@test_dir, 'cfg'))
+    FileUtils.mkdir_p(@cfg_agent1_dir = File.join(@cfg_dir, 'agent_1'))
+    FileUtils.mkdir_p(@pid_dir = File.join(@test_dir, 'pid'))
+    @agent_options1 = {
+      :identity => @agent_id1,
+      :root_dir => [@root_dir1, @root_dir2],
+      :log_dir  => @tmp_dir,
+      :pid_dir  => @pid_dir
+    }
+    File.open(@cfg_agent1 = File.join(@cfg_agent1_dir, 'config.yml'), "w") { |f| f.puts(YAML.dump(@agent_options1)) }
+    @agent_id2 = "rs-agent-2-2"
+    @agent_options2 = {
+      :identity => @agent_id2,
+      :root_dir => @root_dir2,
+      :pid_dir  => @pid_dir
+    }
+    FileUtils.mkdir_p(@cfg_agent2_dir = File.join(@cfg_dir, 'agent_2'))
+    FileUtils.touch([@cfg_agent2 = File.join(@cfg_agent2_dir, 'config.yml')])
+    @pid = 12345
+    File.open(@cookie_file = File.join(@pid_dir, "#{@agent_id1}.pid"), "w") { |f| f.puts(@pid) }
+    @agent_cookie1 = {
+      :cookie      => "1a2b3c",
+      :listen_port => 70000
+    }
+    File.open(@cookie_file = File.join(@pid_dir, "#{@agent_id1}.cookie"), "w") { |f| f.puts(YAML.dump(@agent_cookie1)) }
+  end
+
+  after(:all) do
+    FileUtils.remove_dir(@test_dir)
+  end
+
+  it 'should return protocol version' do
+    @agent_config.protocol_version.should == RightScale::AgentConfig::PROTOCOL_VERSION
+  end
+
+  it 'should default root directory to current working directory' do
+    @agent_config.root_dir.should == @pwd_dir
+  end
+
+  it 'should set root directory to single directory' do
+    @agent_config.root_dir = @root_dir1
+    @agent_config.root_dir.should == @root_dir1
+  end
+
+  it 'should set root directory to list of directories' do
+    @agent_config.root_dir = [@root_dir1, @root_dir2]
+    @agent_config.root_dirs.should == [@root_dir1, @root_dir2]
+  end
+
+  it 'should be able to change root directory' do
+    @agent_config.root_dir = [@root_dir1, @root_dir2]
+    @agent_config.root_dir.should == [@root_dir1, @root_dir2]
+    @agent_config.root_dir = [@root_dir3, @root_dir2]
+    @agent_config.root_dir.should == [@root_dir3, @root_dir2]
+    @agent_config.root_dir = nil
+    @agent_config.root_dir.should == @pwd_dir
+  end
+
+  it 'should default configuration directory to platform specific directory' do
+    @agent_config.cfg_dir.should == RightScale::Platform.filesystem.right_agent_cfg_dir
+  end
+
+  it 'should set configuration directory' do
+    @agent_config.cfg_dir = @cfg_dir
+    @agent_config.cfg_dir.should == @cfg_dir
+  end
+
+  it 'should default process id directory to platform specific directory' do
+    @agent_config.pid_dir.should == RightScale::Platform.filesystem.pid_dir
+  end
+
+  it 'should set process id directory' do
+    @agent_config.pid_dir = @pid_dir
+    @agent_config.pid_dir.should == @pid_dir
+  end
+
+  it 'should return first init/init.rb file path found' do
+    @agent_config.root_dir = [@root_dir1, @root_dir2, @root_dir3]
+    @agent_config.init_file.should == @init2
+  end
+
+  it 'should return first init/config.yml file path found' do
+    @agent_config.root_dir = [@root_dir1, @root_dir2, @root_dir3]
+    @agent_config.init_cfg_file.should == @config1
+  end
+
+  it 'should return actors directory paths containing all in root directory paths with one from gem last' do
+    @agent_config.root_dir = [@root_dir1, @root_dir2, @root_dir3]
+    @agent_config.actors_dirs.should == [@actors1, @actors3, @actors]
+  end
+
+  it 'should return actors directory paths containing other actors directories' do
+    module RightScale
+      AgentConfig.module_eval { def self.other_actors_dirs; [RightScale::Platform.filesystem.temp_dir] end }
+    end
+    @agent_config.root_dir = [@root_dir1, @root_dir2]
+    @agent_config.actors_dirs.should == [@actors1, @tmp_dir, @actors]
+  end
+
+  it 'should return first certs file path found' do
+    @agent_config.root_dir = [@root_dir1, @root_dir2, @root_dir3]
+    @agent_config.certs_file('router.cert').should == @router_cert1
+    @agent_config.certs_file('router.key').should == @router_key2
+    @agent_config.certs_file('agent.key').should be_nil
+  end
+
+  it 'should return all certs file paths found without any duplicates and by root directory order' do
+    @agent_config.root_dir = [@root_dir1, @root_dir2, @root_dir3]
+    @agent_config.certs_files('*.cert').should == [@router_cert1, @agent_cert2]
+    @agent_config.certs_files('*.key').should == [@router_key2]
+    @agent_config.certs_files('*.abc').should == []
+  end
+
+  it 'should return the first lib directory path' do
+    @agent_config.root_dir = [@root_dir1, @root_dir2, @root_dir3]
+    @agent_config.lib_dir.should == @lib1
+  end
+
+  it 'should return the first scripts directory path' do
+    @agent_config.root_dir = [@root_dir1, @root_dir2, @root_dir3]
+    @agent_config.scripts_dir.should == @scripts3
+  end
+
+  it 'should return the configuration file path for an agent' do
+    @agent_config.cfg_dir = @cfg_dir
+    @agent_config.cfg_file('agent_1').should == @cfg_agent1
+    @agent_config.cfg_file('no_agent').should == File.join(@cfg_dir, 'no_agent', 'config.yml')
+  end
+
+  it 'should check if agent configuration file exists if requested to' do
+    @agent_config.cfg_dir = @cfg_dir
+    @agent_config.cfg_file('agent_1', exists = true).should == @cfg_agent1
+    @agent_config.cfg_file('no_agent', exists = true).should be_nil
+  end
+
+  it 'should return configuration file paths for all agents' do
+    @agent_config.cfg_dir = @cfg_dir
+    @agent_config.cfg_files.should =~ [@cfg_agent1, @cfg_agent2]
+  end
+
+  it 'should return a list of all configured agents' do
+    @agent_config.cfg_dir = @cfg_dir
+    @agent_config.cfg_agents.should =~ ['agent_1', 'agent_2']
+  end
+
+  it 'should return agent name for agent identity' do
+    @agent_config.cfg_dir = @cfg_dir
+    @agent_config.agent_name(@agent_id1).should == 'agent_1'
+    @agent_config.agent_name("rs-bogus-0-0").should be_nil
+  end
+
+  it 'should load agent options from a configuration file and symbolize the keys' do
+    @agent_config.cfg_dir = @cfg_dir
+    @agent_config.load_cfg('agent_1').should == @agent_options1
+    @agent_config.load_cfg("no_agent").should be_nil
+  end
+
+  it 'should store agent options in a configuration file in YAML format' do
+    @agent_config.cfg_dir = @cfg_dir
+    @agent_config.store_cfg("agent_2", @agent_options2) == @agent_config.cfg_file("agent_2")
+    @agent_config.load_cfg('agent_2').should == @agent_options2
+  end
+
+  it 'should return the process id file object for an agent' do
+    @agent_config.cfg_dir = @cfg_dir
+    @agent_config.pid_file('agent_1').identity.should == @agent_id1
+    @agent_config.pid_file('no_agent').should be_nil
+  end
+
+  it 'should return the agent options retrieved from the configuration file and associated pid file' do
+    @agent_config.cfg_dir = @cfg_dir
+    @agent_config.agent_options('agent_1').should == @agent_options1.merge(@agent_cookie1.merge(:pid => @pid, :log_path => @tmp_dir))
+    @agent_config.agent_options("no_agent").should == {}
+  end
+
+  it 'should return the name of agents that are running' do
+    flexmock(Process).should_receive(:getpgid).with(@pid).and_return(123)
+    @agent_config.cfg_dir = @cfg_dir
+    @agent_config.cfg_agents.should =~ ['agent_1', 'agent_2']
+    @agent_config.running_agents.should =~ ['agent_1']
+    @agent_config.running_agents(/core/).should =~ []
+  end
+
+end

data/spec/agent_identity_spec.rb

@@ -0,0 +1,78 @@
+#
+# Copyright (c) 2009-2011 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::AgentIdentity do
+
+  it 'should create a token if none is provided' do
+    id = RightScale::AgentIdentity.new('prefix', 'agent_type', 1)
+    id.token.should_not be_nil
+  end
+
+  it 'should create unique tokens' do
+    id = RightScale::AgentIdentity.new('prefix', 'agent_type', 1)
+    id.token.should_not be_nil
+    id2 = RightScale::AgentIdentity.new('prefix', 'agent_type', 1)
+    id2.token.should_not be_nil
+    id.token.should_not == id2.token
+  end
+
+  it 'should use preset tokens' do
+    id = RightScale::AgentIdentity.new('prefix', 'agent_type', 1, 'token')
+    id.token.should == 'token'
+  end
+
+  it 'should serialize' do
+    id = RightScale::AgentIdentity.new('prefix', 'agent_type', 1, 'token')
+    id2 = RightScale::AgentIdentity.parse(id.to_s)
+    id2.prefix.should == id.prefix
+    id2.agent_type.should == id.agent_type
+    id2.base_id.should == id.base_id
+    id2.token.should == id.token
+  end
+
+  it 'should validate' do
+    id = RightScale::AgentIdentity.new('prefix', 'agent_type', 1, 'token')
+    RightScale::AgentIdentity.valid?(id.to_s).should be_true
+  end
+
+  it "should treat serialized id with nanite, mapper, or router prefix as valid" do
+    RightScale::AgentIdentity.valid?("nanite-prefix-agent_type-token-1").should be_true
+    RightScale::AgentIdentity.valid?("mapper-prefix-agent_type-token-1").should be_true
+    RightScale::AgentIdentity.valid?("router-prefix-agent_type-token-1").should be_true
+  end
+
+  it "should parse serialized id with nanite, mapper, or router prefix but discard this prefix" do
+    RightScale::AgentIdentity.parse("nanite-prefix-agent_type-token-1").to_s.should == "prefix-agent_type-token-1"
+    RightScale::AgentIdentity.parse("mapper-prefix-agent_type-token-1").to_s.should == "prefix-agent_type-token-1"
+    RightScale::AgentIdentity.parse("router-prefix-agent_type-token-1").to_s.should == "prefix-agent_type-token-1"
+  end
+
+  it 'should prefix with nanite to make backward compatible' do
+    id = RightScale::AgentIdentity.new('prefix', 'agent_type', 1, 'token')
+    RightScale::AgentIdentity.compatible_serialized(id.to_s, version_can_handle_non_nanite_ids).should == "prefix-agent_type-token-1"
+    RightScale::AgentIdentity.compatible_serialized(id.to_s, version_cannot_handle_non_nanite_ids).should == "nanite-prefix-agent_type-token-1"
+    RightScale::AgentIdentity.compatible_serialized(id.to_s).should == "prefix-agent_type-token-1"
+  end
+
+end