right_agent 0.9.5 → 0.9.6

data/lib/right_agent.rb

@@ -43,7 +43,7 @@ require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'security'))
 require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'operation_result'))
 require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'subprocess'))
 require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'agent_identity'))
-require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'agent_tags_manager'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'agent_tag_manager'))
 require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'actor'))
 require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'actor_registry'))
 require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'dispatcher'))

data/lib/right_agent/agent_config.rb

@@ -98,6 +98,28 @@ module RightScale
     def self.valid_thread_name
       VALID_THREAD_NAME
     end
+    
+    # Default policy name when no policy is specified for an executable bundle.
+    DEFAULT_POLICY_NAME = nil
+    
+    # Default policy name when no policy is specified for an executable bundle.
+    #
+    # === Return
+    # (String):: default policy name...
+    def self.default_policy_name
+      DEFAULT_POLICY_NAME
+    end
+    
+    # Default period for policies
+    DEFAULT_POLICY_PERIOD = 60 * 60 * 24
+    
+    # Default audit period when a runlist policy does not specify a period.
+    #
+    # === Return
+    # (String):: default policy name...
+    def self.default_audit_period
+      DEFAULT_POLICY_PERIOD
+    end
 
     # Initialize path to root directory of agent
     #

data/lib/right_agent/{agent_tags_manager.rb → agent_tag_manager.rb}

@@ -25,7 +25,7 @@ require 'singleton'
 module RightScale
 
   # Agent tags management
-  class AgentTagsManager
+  class AgentTagManager
     include Singleton
 
     # (Agent) Agent being managed
@@ -33,14 +33,19 @@ module RightScale
 
     # Retrieve current agent tags and give result to block
     #
+    # === Parameters
+    # options(Hash):: Request options
+    #   :raw(Boolean):: true to yield raw tag response instead of deserialized tags
+    #   :timeout(Integer):: timeout in seconds before giving up and yielding an error message
+    #
     # === Block
     # Given block should take one argument which will be set with an array
     # initialized with the tags of this instance
     #
     # === Return
     # true:: Always return true
-    def tags
-      do_query(nil, @agent.identity) do |result|
+    def tags(options={})
+      do_query(nil, @agent.identity, options) do |result|
         if result.kind_of?(Hash)
           yield(result.size == 1 ? result.values.first['tags'] : [])
         else
@@ -54,6 +59,9 @@ module RightScale
     #
     # === Parameters
     # tags(Array):: tags to query or empty
+    # options(Hash):: Request options
+    #   :raw(Boolean):: true to yield raw tag response instead of deserialized tags
+    #   :timeout(Integer):: timeout in seconds before giving up and yielding an error message
     #
     # === Block
     # Given block should take one argument which will be set with an array
@@ -62,7 +70,14 @@ module RightScale
     # === Return
     # true:: Always return true
     def query_tags(*tags)
-      do_query(tags) { |result| yield result }
+      if tags.last.respond_to?(:keys)
+        tags = tags[0..-2]
+        options = tags.last
+      else
+        options = {}
+      end
+
+      do_query(tags, nil, options) { |result| yield result }
     end
 
     # Queries a list of servers in the current deployment which have one or more
@@ -71,14 +86,17 @@ module RightScale
     # === Parameters
     # tags(Array):: tags to query or empty
     # agent_ids(Array):: agent IDs to query or empty or nil
+    # options(Hash):: Request options
+    #   :timeout(Integer):: timeout in seconds before giving up and yielding an error message
     #
     # === Block
     # Given block should take one argument which will be set with the raw response
     #
     # === Return
     # true:: Always return true
-    def query_tags_raw(tags, agent_ids = nil)
-      do_query(tags, agent_ids, true) { |raw_response| yield raw_response }
+    def query_tags_raw(tags, agent_ids = nil, options={})
+      options = options.merge(:raw=>true)
+      do_query(tags, agent_ids, options) { |raw_response| yield raw_response }
     end
 
     # Add given tags to agent
@@ -168,7 +186,9 @@ module RightScale
     # === Parameters
     # tags(Array):: tags to query or empty or nil
     # agent_ids(Array):: agent IDs to query or empty or nil
-    # raw(Boolean):: true to yield raw tag response instead of deserialized tags
+    # options(Hash):: Request options
+    #   :raw(Boolean):: true to yield raw tag response instead of deserialized tags
+    #   :timeout(Integer):: timeout in seconds before giving up and yielding an error message
     #
     # === Block
     # Given block should take one argument which will be set with an array
@@ -176,12 +196,20 @@ module RightScale
     #
     # === Return
     # true:: Always return true
-    def do_query(tags = nil, agent_ids = nil, raw = false)
+    def do_query(tags = nil, agent_ids = nil, options={})
+      raw = options[:raw] || false
+      timeout = options[:timeout]
+
+      request_options = {}
+      request_options[:timeout] = timeout if timeout
+
       agent_check
       payload = {:agent_identity => @agent.identity}
       payload[:tags] = ensure_flat_array_value(tags) unless tags.nil? || tags.empty?
       payload[:agent_ids] = ensure_flat_array_value(agent_ids) unless agent_ids.nil? || agent_ids.empty?
-      request = RightScale::IdempotentRequest.new("/mapper/query_tags", payload)
+      request = RightScale::IdempotentRequest.new("/mapper/query_tags",
+                                                  payload,
+                                                  request_options)
       request.callback { |result| yield raw ? request.raw_response : result }
       request.errback do |message|
         Log.error("Failed to query tags: #{message}")
@@ -208,6 +236,10 @@ module RightScale
       value
     end
 
-  end # AgentTagsManager
+  end # AgentTagManager
 
+  # This class has been renamed as of RightAgent 0.9.6; provide an alias
+  # to the old typename
+  # TODO remove this alias for RightAgent 1.0
+  AgentTagsManager = AgentTagManager
 end # RightScale

data/lib/right_agent/core_payload_types.rb

@@ -38,6 +38,7 @@ require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'right_script
 require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'right_script_instantiation'))
 require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'login_policy'))
 require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'login_user'))
+require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'runlist_policy'))
 require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'secure_document'))
 require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'secure_document_location'))
 require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'planned_volume'))

data/lib/right_agent/core_payload_types/executable_bundle.rb

@@ -54,9 +54,6 @@ module RightScale
     # (String) Repose server to use
     attr_accessor :repose_servers
 
-    # (String) The name of the RIghtLink thread to run this bundle on
-    attr_accessor :thread_name
-
     # (Hash):: collection of repos to be checked out on the instance
     #   :key (String):: the hash id (SHA) of the repository
     #  :value (Hash):: repo and cookbook detail
@@ -89,6 +86,9 @@ module RightScale
     #     }
     #    :positions (Array):: List of CookbookPositions to be developed.  Represents the subset of cookbooks identified as the "dev cookbooks"
     attr_accessor :dev_cookbooks
+    
+    # (RunlistPolicy) The RightLink policy this bundle belongs to
+    attr_accessor :runlist_policy
 
     def initialize(*args)
       @executables           = args[0]
@@ -98,7 +98,7 @@ module RightScale
       @cookbooks             = args[4] if args.size > 4
       @repose_servers        = args[5] if args.size > 5
       @dev_cookbooks         = args[6] if args.size > 6
-      @thread_name           = args[7] if args.size > 7
+      @runlist_policy        = args[7] if args.size > 7
     end
 
     # Array of serialized fields given to constructor
@@ -110,7 +110,7 @@ module RightScale
         @cookbooks,
         @repose_servers,
         @dev_cookbooks,
-        @thread_name ]
+        @runlist_policy ]
     end
 
     # Human readable representation

data/lib/right_agent/core_payload_types/runlist_policy.rb

@@ -0,0 +1,44 @@
+#
+# Copyright (c) 2009-2012 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.
+#
+
+module RightScale
+
+  class RunlistPolicy
+    include Serializable
+    
+    attr_accessor :policy_name, :thread_name, :audit_period
+
+    # Initialize fields from given arguments
+    def initialize(*args)
+      @policy_name     = args[0]
+      @thread_name     = args[1]
+      @audit_period    = args[2]
+    end
+
+    # Array of serialized fields given to constructor
+    def serialized_members
+      [ @policy_name, @thread_name, @audit_period ]
+    end
+
+  end
+end

data/lib/right_agent/idempotent_request.rb

@@ -80,7 +80,7 @@ module RightScale
     #     increasing delay exponentially and decreasing this count exponentially, defaults to
     #     DEFAULT_RETRY_DELAY_COUNT
     #   :max_retry_delay(Fixnum):: Maximum number of seconds of retry delay, defaults to DEFAULT_MAX_RETRY_DELAY
-    #   :timeout(Fixnum):: Number of seconds with no response before error callback gets called with
+    #   :timeout(Fixnum):: Number of seconds with no response before error callback gets called, with
     #     -1 meaning never, defaults to DEFAULT_TIMEOUT
     #
     # === Raises

data/lib/right_agent/log.rb

@@ -131,6 +131,21 @@ module RightScale
       @logger.__send__(m, *args)
     end
 
+    # Determine whether this object, or its method_missing proxy, responds
+    # to the given method name. This follows the best practice of always
+    # overriding #respond_to? whenever one implements dynamic dispatch
+    # via #method_missing.
+    #
+    # === Parameters
+    # m(Symbol):: Forwarded method name
+    #
+    # === Return
+    # (true|false):: True if this object or its proxy responds to the names method, false otherwise
+    def respond_to?(m)
+      init unless @initialized
+      super(m) || @logger.respond_to?(m)
+    end
+
     # Log warning and optionally append exception information
     #
     # === Parameters
@@ -296,6 +311,22 @@ module RightScale
       @program_name = prog_name
     end
 
+    # Sets the syslog facility that will be used when emitting syslog messages.
+    # Can only be successfully called before logging is initialized
+    #
+    # === Parameters
+    # facility(String):: A syslog facility name, e.g. 'user' or 'local0'
+    #
+    # === Return
+    # program_name(String):: The input string
+    #
+    # === Raise
+    # RuntimeError:: If logger is already initialized
+    def facility=(facility)
+      raise 'Logger already initialized' if @initialized
+      @facility = facility
+    end
+
     # Sets the level for the Logger by symbol or by Logger constant
     #
     # === Parameters
@@ -403,7 +434,9 @@ module RightScale
           logger.formatter.datetime_format = "%b %d %H:%M:%S"
         else
           $stderr.puts "Logging to syslog" if opts[:print]
-          logger = RightSupport::Log::SystemLogger.new(@program_name || identity || 'RightAgent')
+          program_name = @program_name || identity || 'RightAgent'
+          facility = @facility || 'local0'
+          logger = RightSupport::Log::SystemLogger.new(program_name, :facility=>facility)
         end
 
         @logger = Multiplexer.new(logger)

data/lib/right_agent/multiplexer.rb

@@ -87,5 +87,16 @@ module RightScale
       res[0]
     end
 
+    # Determine whether this object, or ALL of its targets, responds to
+    # the named method.
+    #
+    # === Parameters
+    # m(Symbol):: Forwarded method name
+    #
+    # === Return
+    # (true|false):: True if this object, or ALL targets, respond to the names method; false otherwise
+    def respond_to?(m)
+      super(m) || @targets.all? { |t| t.respond_to?(m) }
+    end
   end
 end

data/lib/right_agent/platform/darwin.rb

@@ -118,10 +118,6 @@ module RightScale
         '/var/run'
       end
 
-      def right_link_dir
-        '/opt/rightscale/right_link'
-      end
-
       # Path to right link configuration and internal usage scripts
       def private_bin_dir
         '/opt/rightscale/bin'

data/lib/right_agent/platform/linux.rb

@@ -169,10 +169,6 @@ module RightScale
         '/var/run'
       end
 
-      def right_link_dir
-        '/opt/rightscale/right_link'
-      end
-
       # Path to right link configuration and internal usage scripts
       def private_bin_dir
         '/opt/rightscale/bin'

data/lib/right_agent/platform/windows.rb

@@ -212,13 +212,9 @@ module RightScale
         @right_link_home_dir
       end
 
-      def right_link_dir
-        return pretty_path(File.join(right_link_home_dir, 'right_link'))
-      end
-
       # Path to right link configuration and internal usage scripts
       def private_bin_dir
-        return pretty_path(File.join(right_link_dir, 'scripts', 'windows'))
+        return pretty_path(File.join(right_link_home_dir, 'right_link', 'scripts', 'windows'))
       end
 
       def sandbox_dir

data/right_agent.gemspec

@@ -24,8 +24,8 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name      = 'right_agent'
-  spec.version   = '0.9.5'
-  spec.date      = '2012-03-17'
+  spec.version   = '0.9.6'
+  spec.date      = '2012-03-23'
   spec.authors   = ['Lee Kirchhoff', 'Raphael Simon', 'Tony Spataro']
   spec.email     = 'lee@rightscale.com'
   spec.homepage  = 'https://github.com/rightscale/right_agent'

data/spec/core_payload_types/executable_bundle_spec.rb

@@ -27,7 +27,7 @@ require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lib', 'r
 module RightScale
   describe ExecutableBundle do
     context 'serialized_members' do
-      it 'contains 8 elements' do
+      it 'contains 9 elements' do
         ExecutableBundle.new.serialized_members.count.should == 8
       end
     end
@@ -54,6 +54,14 @@ module RightScale
           bundle.serialized_members[6].should be_nil
         end
       end
+      
+      context 'runlist policy' do
+        let(:bundle) { ExecutableBundle.new(nil, nil, nil, nil, nil, nil, nil, RunlistPolicy.new) }
+        
+        it 'should serialize into a runlist policy object' do
+          bundle.serialized_members[7].should be_an_instance_of(RunlistPolicy)
+        end
+      end
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: right_agent
 version: !ruby/object:Gem::Version 
-  hash: 49
+  hash: 55
   prerelease: false
   segments: 
   - 0
   - 9
-  - 5
-  version: 0.9.5
+  - 6
+  version: 0.9.6
 platform: ruby
 authors: 
 - Lee Kirchhoff
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-17 00:00:00 -07:00
+date: 2012-03-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -155,7 +155,7 @@ files:
 - lib/right_agent/agent.rb
 - lib/right_agent/agent_config.rb
 - lib/right_agent/agent_identity.rb
-- lib/right_agent/agent_tags_manager.rb
+- lib/right_agent/agent_tag_manager.rb
 - lib/right_agent/audit_formatter.rb
 - lib/right_agent/command.rb
 - lib/right_agent/command/agent_manager_commands.rb
@@ -182,6 +182,7 @@ files:
 - lib/right_agent/core_payload_types/repositories_bundle.rb
 - lib/right_agent/core_payload_types/right_script_attachment.rb
 - lib/right_agent/core_payload_types/right_script_instantiation.rb
+- lib/right_agent/core_payload_types/runlist_policy.rb
 - lib/right_agent/core_payload_types/secure_document.rb
 - lib/right_agent/core_payload_types/secure_document_location.rb
 - lib/right_agent/core_payload_types/software_repository_instantiation.rb