right_agent 2.0.7-x86-mingw32

data/LICENSE

@@ -0,0 +1,20 @@
+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.

data/README.rdoc

@@ -0,0 +1,82 @@
+= RightAgent
+
+= DESCRIPTION
+
+== Synopsis
+
+RightAgent provides a foundation for running an agent on a server to interface
+in a secure fashion with other agents in the RightScale system using RightNet,
+which operates in either HTTP or AMQP mode. When using HTTP, RightAgent
+makes requests to RightApi servers and receives requests using long-polling or
+WebSockets via the RightNet router. To respond to requests it posts to the
+HTTP router. When using AMQP, RightAgent uses RabbitMQ as the message bus and
+the RightNet router as the routing node to make requests; to receives requests
+routed to it by the RightNet router, it establishes a queue on startup. The
+packets are structured to invoke services in the agent represented by actors
+and methods. The RightAgent may respond to these requests with a result packet
+that the router then routes to the originator.
+
+Refer to the wiki (https://github.com/rightscale/right_agent/wikis) for up-to-date
+documentation.
+
+Also use the built-in issues tracker (https://github.com/rightscale/right_agent/issues)
+to report issues.
+
+Maintained by the RightScale Teal Team
+
+== Interface
+
+A RightAgent exposes its services via actors and methods that are invoked by requests
+packets it receives via its message queue. All RightAgents have a general purpose actor
+named agent_manager that provides the following services:
+
+* <b>agent_manager/ping</b>: Respond with basic status information to indicate that active
+* <b>agent_manager/stats</b>: Retrieve statistics about agent operation
+* <b>agent_manager/set_log_level</b>: Change log level of agent
+* <b>agent_manager/execute</b>: Eval code in context of agent
+* <b>agent_manager/connect</b>: Connect agent to additional broker or reconnect it to one
+* <b>agent_manager/disconnect</b>: Disconnect agent from broker
+
+RightAgent comes with several library modules for forming basic command line tools:
+
+* <b>agent_deployer</b>: Build a configuration file for running the agent (rad tool)
+* <b>agent_controller</b>: Manage an agent that has been configured (rnac tool)
+* <b>stats_manager</b>: Display operation statistics for an agent (rstat tool)
+* <b>log_level_manager</b>: Retrieve and set log level for an agent (rlog tool)
+
+== Supported Configuration
+
+RightAgent has been tested on EC2 instances running CentOS 5.2 and Ubuntu 8.10.
+
+== Work in Progress
+
+RightAgent is work in progress, expect more documentation and examples in the near future.
+
+= ADDITIONAL RESOURCES
+
+* [1] RabbitMQ is http://www.rabbitmq.com/documentation.html
+
+= LICENSE
+
+<b>RightAgent</b>
+
+Copyright:: 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.

data/Rakefile

@@ -0,0 +1,113 @@
+#--  -*-ruby-*-
+# Copyright: Copyright (c) 2010 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 'rubygems'
+require 'bundler/setup'
+require 'fileutils'
+require 'rake'
+require 'rspec/core/rake_task'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/clean'
+
+task :default => 'spec'
+
+# == Gem packaging == #
+module RightScale
+  class MultiPlatformGemTask
+    def self.gem_platform_override
+      @gem_platform_override
+    end
+
+    def self.define(gem_platforms, spec_path, &callback)
+      gem_platforms.each do |gem_platform|
+        @gem_platform_override = gem_platform
+        callback.call(::Gem::Specification.load(spec_path))
+      end
+    ensure
+      @gem_platform_override = nil
+    end
+  end
+end
+
+# multiply define gem and package task(s) using a gemspec with overridden gem
+# platform value. this works because rake accumulates task actions instead of
+# redefining them, so accumulated gem tasks will gem up all platforms. we need
+# to produce multiple platform-specific .gem files because otherwise the gem
+# dependencies for non-Linux platforms (i.e. Windows) are lost from the default
+# .gem file produced on a Linux platform.
+gemtask = nil
+::RightScale::MultiPlatformGemTask.define(%w[linux mingw], 'right_agent.gemspec') do |spec|
+  gemtask = ::Rake::GemPackageTask.new(spec) do |gpt|
+    gpt.package_dir = ENV['PACKAGE_DIR'] || 'pkg'
+
+    # the following are used by 'package' task (but not by 'gem' task)
+    gpt.need_zip = !`which zip`.strip.empty? # not present on Windows by default
+    gpt.need_tar = true  # some form of tar is required on Windows and Linux
+  end
+end
+
+directory gemtask.package_dir
+
+CLEAN.include(gemtask.package_dir)
+
+# == Unit tests == #
+spec_opts_file = "\"#{File.dirname(__FILE__)}/spec/spec.opts\""
+spec_opts_file = "\"#{File.dirname(__FILE__)}/spec/spec.win32.opts\"" if RUBY_PLATFORM =~ /mingw|mswin32/
+RSPEC_OPTS = ['--options', spec_opts_file]
+
+desc 'Run unit tests'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = RSPEC_OPTS
+end
+
+namespace :spec do
+  desc 'Run unit tests with RCov'
+  RSpec::Core::RakeTask.new(:rcov) do |t|
+    t.rspec_opts = RSPEC_OPTS
+    t.rcov = true
+    t.rcov_opts = %q[--exclude "spec"]
+  end
+
+  desc 'Print Specdoc for all unit tests'
+  RSpec::Core::RakeTask.new(:doc) do |t|
+    t.rspec_opts = ["--format", "documentation"]
+  end
+end
+
+# == Documentation == #
+
+desc 'Generate API documentation to doc/rdocs/index.html'
+Rake::RDocTask.new do |rd|
+  rd.rdoc_dir = 'doc/rdocs'
+  rd.main = 'README.rdoc'
+  rd.rdoc_files.include 'README.rdoc', 'lib/**/*.rb'
+end
+CLEAN.include('doc/rdocs')
+
+# == Emacs integration ==
+
+desc 'Rebuild TAGS file for emacs'
+task :tags do
+  sh 'rtags -R lib spec'
+end

data/lib/right_agent.rb

@@ -0,0 +1,59 @@
+#
+# 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.
+
+# reuse minimal loader to ensure right_agent can safely be required after minimal.
+require File.expand_path(File.join(File.dirname(__FILE__), 'right_agent', 'minimal'))
+
+require 'json'
+require 'openssl'
+require 'right_amqp'
+
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'monkey_patches'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'protocol_version_mixin'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'payload_formatter'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'packets'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'enrollment_result'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'console'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'daemonize'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'exceptions'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'multiplexer'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'tracer'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'audit_formatter'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'serialize'))
+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_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'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'dispatched_cache'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'pending_requests'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'offline_handler'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'connectivity_checker'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'sender'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'secure_identity'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'retryable_request'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'history'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'clients'))
+require File.normalize_path(File.join(RIGHT_AGENT_BASE_DIR, 'agent'))

data/lib/right_agent/actor.rb

@@ -0,0 +1,182 @@
+#
+# 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.
+
+module RightScale
+
+  # This mixin provides agent actor functionality.
+  #
+  # To use it simply include it your class containing the functionality to be exposed:
+  #
+  #   class Foo
+  #     include RightScale::Actor
+  #     expose :bar
+  #
+  #     def bar(payload)
+  #       # ...
+  #     end
+  #
+  #   end
+  module Actor
+
+    # Callback invoked whenever Actor is included in another module or class.
+    #
+    # === Parameters
+    # base(Module):: Module that included Actor module
+    #
+    # === Return
+    # true:: Always return true
+    def self.included(base)
+      base.send :include, InstanceMethods
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+
+      # Construct default prefix by which actor is identified in requests
+      #
+      # === Return
+      # prefix(String):: Default prefix
+      def default_prefix
+        prefix = to_s.to_const_path
+      end
+
+      # Add methods to list of services supported by actor and mark these methods
+      # as idempotent
+      #
+      # === Parameters
+      # methods(Array):: Symbol names for methods being exposed as actor idempotent services
+      #
+      # === Return
+      # true:: Always return true
+      def expose_idempotent(*methods)
+        @exposed ||= {}
+        methods.each do |m|
+          if @exposed[m] == false
+            Log.warning("Method #{m} declared both idempotent and non-idempotent, assuming non-idempotent")
+          else
+            @exposed[m] = true
+          end
+        end
+        true
+      end
+
+      # Add methods to list of services supported by actor
+      # By default these methods are not idempotent
+      #
+      # === Parameters
+      # meths(Array):: Symbol names for methods being exposed as actor services
+      #
+      # === Return
+      # true:: Always return true
+      def expose_non_idempotent(*methods)
+        @exposed ||= {}
+        methods.each do |m|
+          Log.warning("Method #{m} declared both idempotent and non-idempotent, assuming non-idempotent") if @exposed[m]
+          @exposed[m] = false
+        end
+        true
+      end
+
+      alias :expose :expose_non_idempotent
+
+      # Get /prefix/method paths that actor responds to
+      #
+      # === Parameters
+      # prefix(String):: Prefix by which actor is identified in requests
+      #
+      # === Return
+      # (Array):: /prefix/method strings
+      def provides_for(prefix)
+        return [] unless @exposed
+        @exposed.each_key.select do |method|
+          if instance_methods.include?(method.to_s) or instance_methods.include?(method.to_sym)
+            true
+          else
+            Log.warning("Exposing non-existing method #{method} in actor #{prefix}")
+            false
+          end
+        end.map { |method| "/#{prefix}/#{method}".squeeze('/') }
+      end
+
+      # Determine whether actor method is idempotent
+      #
+      # === Parameters
+      # method(Symbol):: Name for actor method
+      #
+      # === Return
+      # (Boolean):: true if idempotent, false otherwise
+      def idempotent?(method)
+        @exposed[method] if @exposed
+      end
+
+      # Set method called when dispatching to this actor fails
+      #
+      # The callback method is required to accept the following parameters:
+      #   method(Symbol):: Actor method being dispatched to
+      #   deliverable(Packet):: Packet delivered to dispatcher
+      #   exception(Exception):: Exception raised
+      #
+      # === Parameters
+      # proc(Proc|Symbol|String):: Procedure to be called on exception
+      #
+      # === Block
+      # Block to be executed if no Proc provided
+      #
+      # === Return
+      # @exception_callback(Proc):: Callback procedure
+      def on_exception(proc = nil, &blk)
+        raise 'No callback provided for on_exception' unless proc || blk
+        @exception_callback = proc || blk
+      end
+
+      # Get exception callback procedure
+      #
+      # === Return
+      # @exception_callback(Proc):: Callback procedure
+      def exception_callback
+        @exception_callback
+      end
+      
+    end # ClassMethods     
+    
+    module InstanceMethods
+
+      # Agents using actors are required to define a Sender class providing linkage
+      # to a class that can perform the following send functions
+
+      # Helper method to send a request to one or more targets with no response expected
+      def send_push(*args)
+        Sender.instance.send_push(*args)
+      end
+
+      # Helper method to send a request to a single target with a response expected
+      # The request is retried if the response is not received in a reasonable amount of time
+      # The request is allowed to expire per the agent's configured time-to-live, typically 1 minute
+      def send_request(*args, &blk)
+        Sender.instance.send_request(*args, &blk)
+      end
+
+    end # InstanceMethods
+    
+  end # Actor
+
+end # RightScale