right_agent 0.6.2 → 0.6.3

data/lib/right_agent/command/command_runner.rb

@@ -22,10 +22,11 @@
 
 module RightScale
 
-  # Run commands exposed by an agent
-  # External processes can send commands through a socket with the specified port
+  # Run commands exposed by an agent.
+  # External processes can send commands through a socket with the specified port.
+  # Command runner accepts connections and deserializes commands using YAML.
+  # Each command is expected to be a hash containing the :name and :options keys.
   class CommandRunner
-
     class << self
       # (Integer) Port command runner is listening on
       attr_reader :listen_port
@@ -34,8 +35,7 @@ module RightScale
       attr_reader :cookie
     end
 
-    # Command runner listens to commands and deserializes them using YAML
-    # Each command is expected to be a hash containing the :name and :options keys
+    # Start a command runner listening on a local TCP port.
     #
     # === Parameters
     # socket_port(Integer):: Base socket port on which to listen for connection,
@@ -43,6 +43,11 @@ module RightScale
     # identity(String):: Agent identity
     # commands(Hash):: Commands exposed by agent
     #
+    # === Block
+    # If a block is provided, this method will yield after all setup has been completed,
+    # passing its PidFile to the block. This provides a customization hook, e.g. for
+    # changing the pid file's access mode or ownership.
+    #
     # === Return
     # cmd_options[:cookie](String):: Command protocol cookie
     # cmd_options[:listen_port](Integer):: Command server listen port
@@ -52,6 +57,7 @@ module RightScale
     def self.start(socket_port, identity, commands)
       cmd_options = nil
       @listen_port = socket_port
+
       begin
         CommandIO.instance.listen(socket_port) do |c, conn|
           begin
@@ -77,6 +83,7 @@ module RightScale
         pid_file = PidFile.new(identity)
         if pid_file.exists?
           pid_file.set_command_options(cmd_options)
+          yield(pid_file) if block_given?
         else
           Log.warning("Failed to update listen port in PID file - no pid file found for agent with identity #{identity}")
         end

data/lib/right_agent/core_payload_types/login_user.rb

@@ -29,18 +29,18 @@ module RightScale
     include Serializable
 
     attr_accessor :uuid, :username, :public_key, :public_keys, :common_name,
-                  :superuser, :expires_at, :home_archive_url
+                  :superuser, :expires_at, :profile_data
 
     # Initialize fields from given arguments
     def initialize(*args)
-      @uuid        = args[0]
-      @username    = args[1]
-      @public_key  = args[2]
-      @common_name = args[3] || ''
-      @superuser   = args[4] || false
-      @expires_at  = Time.at(args[5]) if args[5] && (args[5] != 0) # nil -> 0 because of expires_at.to_i below
-      @public_keys = args[6]
-      @home_archive_url = args[7]
+      @uuid         = args[0]
+      @username     = args[1]
+      @public_key   = args[2]
+      @common_name  = args[3] || ''
+      @superuser    = args[4] || false
+      @expires_at   = Time.at(args[5]) if args[5] && (args[5] != 0) # nil -> 0 because of expires_at.to_i below
+      @public_keys  = args[6]
+      @profile_data = args[7]
 
       # we now expect an array of public_keys to be passed while supporting the
       # singular public_key as a legacy member. when serialized back from a
@@ -57,7 +57,7 @@ module RightScale
 
     # Array of serialized fields given to constructor
     def serialized_members
-      [ @uuid, @username, @public_key, @common_name, @superuser, @expires_at.to_i, @public_keys, @home_archive_url ]
+      [ @uuid, @username, @public_key, @common_name, @superuser, @expires_at.to_i, @public_keys, @profile_data ]
     end
 
   end

data/lib/right_agent/pid_file.rb

@@ -33,7 +33,7 @@ module RightScale
 
     class AlreadyRunning < Exception; end
 
-    attr_reader :identity
+    attr_reader :identity, :pid_file, :cookie_file
 
     # Initialize pid file location from agent identity and pid directory
     def initialize(identity, pid_dir = nil)

data/right_agent.gemspec

@@ -24,7 +24,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name      = 'right_agent'
-  spec.version   = '0.6.2'
+  spec.version   = '0.6.3'
   spec.authors   = ['Lee Kirchhoff', 'Raphael Simon', 'Tony Spataro']
   spec.email     = 'lee@rightscale.com'
   spec.homepage  = 'https://github.com/rightscale/right_agent'

data/spec/command/command_runner_spec.rb

@@ -48,6 +48,30 @@ describe RightScale::CommandRunner do
     @socket_port = TEST_SOCKET_PORT
   end
 
+  context :start do
+    before(:each) do
+      @pid_file = flexmock(RightScale::PidFile)
+      @pid_file.should_receive(:exists?).and_return(true)
+      @pid_file.should_receive(:set_command_options).and_return(true)
+      flexmock(RightScale::PidFile).should_receive(:new).and_return(@pid_file)
+    end
+
+    context 'when a block is provided' do
+      before(:each) do
+        @block = Proc.new do |pid_file|
+          @callback_pid_file = pid_file
+        end
+      end
+
+      it 'should yield its PidFile' do
+        commands = { :test => lambda { |opt, _| } }
+        flexmock(RightScale::CommandIO).should_receive(:instance).and_return(RightScale::CommandIOMock.instance)
+        RightScale::CommandRunner.start(@socket_port, RightScale::AgentIdentity.generate, commands, &@block)
+        @callback_pid_file.should == @pid_file
+      end
+    end
+  end
+
   it 'should handle invalid formats' do
     flexmock(RightScale::CommandIO.instance).should_receive(:listen).and_yield(['invalid yaml'])
     flexmock(RightScale::Log).should_receive(:info).once

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: right_agent
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: false
   segments: 
   - 0
   - 6
-  - 2
-  version: 0.6.2
+  - 3
+  version: 0.6.3
 platform: ruby
 authors: 
 - Lee Kirchhoff
@@ -17,14 +17,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-16 00:00:00 -08:00
+date: 2011-11-21 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
-  name: right_support
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -34,12 +31,12 @@ dependencies:
         - 1
         - 0
         version: "1.0"
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
+  name: right_support
   prerelease: false
   type: :runtime
-  name: amqp
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -50,12 +47,12 @@ dependencies:
         - 7
         - 5
         version: 0.7.5
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
+  name: amqp
   prerelease: false
   type: :runtime
-  name: json
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -65,12 +62,12 @@ dependencies:
         - 1
         - 4
         version: "1.4"
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
+  name: json
   prerelease: false
   type: :runtime
-  name: eventmachine
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -81,12 +78,12 @@ dependencies:
         - 12
         - 10
         version: 0.12.10
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
+  name: eventmachine
   prerelease: false
   type: :runtime
-  name: right_popen
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -97,12 +94,12 @@ dependencies:
         - 0
         - 11
         version: 1.0.11
-  requirement: *id005
-- !ruby/object:Gem::Dependency 
+  name: right_popen
   prerelease: false
   type: :runtime
-  name: msgpack
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -113,7 +110,10 @@ dependencies:
         - 4
         - 4
         version: 0.4.4
-  requirement: *id006
+  name: msgpack
+  prerelease: false
+  type: :runtime
+  version_requirements: *id006
 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