right_agent 0.5.1

data/lib/right_agent/command/command_parser.rb

@@ -0,0 +1,87 @@
+#
+# 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.
+#
+
+module RightScale
+
+  class CommandParser
+
+    # Register callback block
+    #
+    # === Block
+    # Block that will get called back whenever a command is successfully parsed
+    #
+    # === Raise
+    # (RightScale::Exceptions::Argument): If block is missing
+    def initialize &block
+      raise RightScale::Exceptions::Argument, 'Missing handler block' unless block
+      @callback = block
+      @buildup = ''
+    end
+
+    # Parse given input
+    # May cause multiple callbacks if multiple commands are successfully parsed
+    # Callback happens in next EM tick
+    #
+    # === Parameters
+    # chunk(String):: Chunck of serialized command(s) to be parsed
+    #
+    # === Return
+    # true:: If callback was called at least once
+    # false:: Otherwise
+    def parse_chunk(chunk)
+      @buildup << chunk
+      chunks = @buildup.split(CommandSerializer::SEPARATOR, -1)
+      if do_call = chunks.size > 1
+        commands = []
+        (0..chunks.size - 2).each do |i|
+          begin
+            commands << CommandSerializer.load(chunks[i])
+          rescue Exception => e
+            # log any exceptions caused by serializing individual chunks instead
+            # of halting EM. each command is discrete so we need to keep trying
+            # so long as there are more commands to process (although subsequent
+            # commands may lack context if previous commands failed).
+            Log.error("Failed parsing command chunk", e, :trace)
+          end
+        end
+        commands.each do |cmd|
+          EM.next_tick do
+            begin
+              @callback.call(cmd)
+            rescue Exception => e
+              # log any exceptions raised by callback instead of halting EM.
+              Log.error("Failed executing parsed command", e, :trace)
+            end
+          end
+        end
+        @buildup = chunks.last
+      end
+      do_call
+    rescue Exception => e
+      # log any other exceptions instead of halting EM.
+      Log.error("Failed parsing command chunk", e, :trace)
+    end
+
+  end # CommandParser
+
+end # RightScale

data/lib/right_agent/command/command_runner.rb

@@ -0,0 +1,105 @@
+#
+# 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.
+
+module RightScale
+
+  # Run commands exposed by an agent
+  # External processes can send commands through a socket with the specified port
+  class CommandRunner
+
+    class << self
+      # (Integer) Port command runner is listening on
+      attr_reader :listen_port
+
+      # (String) Cookie used by command protocol
+      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
+    #
+    # === Parameters
+    # socket_port(Integer):: Base socket port on which to listen for connection,
+    #                        increment and retry if port already taken
+    # identity(String):: Agent identity
+    # commands(Hash):: Commands exposed by agent
+    #
+    # === Return
+    # cmd_options[:cookie](String):: Command protocol cookie
+    # cmd_options[:listen_port](Integer):: Command server listen port
+    #
+    # === Raise
+    # (RightScale::Exceptions::Application):: If +start+ has already been called and +stop+ hasn't since
+    def self.start(socket_port, identity, commands)
+      cmd_options = nil
+      @listen_port = socket_port
+      begin
+        CommandIO.instance.listen(socket_port) do |c, conn|
+          begin
+            cmd_cookie = c[:cookie]
+            if cmd_cookie == @cookie
+              cmd_name = c[:name].to_sym
+              if commands.include?(cmd_name)
+                commands[cmd_name].call(c, conn)
+              else
+                Log.warning("Unknown command '#{cmd_name}', known commands: #{commands.keys.join(', ')}")
+              end
+            else
+              Log.error("Invalid cookie used by command protocol client (#{cmd_cookie})")
+            end
+          rescue Exception => e
+            Log.warning("Command failed (#{e.message}) at\n#{e.backtrace.join("\n")}")
+          end
+        end
+
+        @cookie = AgentIdentity.generate
+        cmd_options = { :listen_port => @listen_port, :cookie => @cookie }
+        # Now update pid file with command port and cookie
+        pid_file = PidFile.new(identity)
+        if pid_file.exists?
+          pid_file.set_command_options(cmd_options)
+        else
+          Log.warning("Failed to update listen port in PID file - no pid file found for agent with identity #{identity}")
+        end
+
+        Log.info("[setup] Command server started listening on port #{@listen_port}")
+      rescue Exceptions::IO
+        # Port already taken, increment and retry
+        cmd_options = start(socket_port + 1, identity, commands)
+      end
+
+      cmd_options
+    end
+
+    # Stop command runner, cleanup all opened file descriptors and delete pipe
+    #
+    # === Return
+    # true:: If command listener was listening
+    # false:: Otherwise
+    def self.stop
+      CommandIO.instance.stop_listening
+      Log.info("[stop] Command server stopped listening")
+    end
+
+  end
+
+end

data/lib/right_agent/command/command_serializer.rb

@@ -0,0 +1,63 @@
+#
+# 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.
+#
+
+module RightScale
+
+  class CommandSerializer
+
+    # String appended to serialized data to delimit between commands
+    SEPARATOR = "\n#GO\n"
+
+    # Serialize given command so it can be sent to command listener
+    #
+    # === Parameters
+    # command(Object):: Command to serialize
+    #
+    # === Return
+    # data(String):: Corresponding serialized data
+    def self.dump(command)
+      data = YAML::dump(command)
+      data += SEPARATOR
+    end
+
+    # Deserialize command that was previously serialized with +dump+
+    #
+    # === Parameters
+    # data(String):: String containing serialized data
+    #
+    # === Return
+    # command(Object):: Deserialized command
+    #
+    # === Raise
+    # (RightScale::Exceptions::IO): If serialized data is incorrect
+    def self.load(data)
+      command = YAML::load(data)
+      raise RightScale::Exceptions::IO, "Invalid serialized command:\n#{data}" unless command
+      command
+    rescue RightScale::Exceptions::IO
+      raise
+    rescue Exception => e
+      raise RightScale::Exceptions::IO, "Invalid serialized command: #{e.message}\n#{data}"
+    end
+  end
+end

data/lib/right_agent/console.rb

@@ -0,0 +1,65 @@
+#
+# 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.
+
+module RightScale
+
+  module ConsoleHelper
+    def self.included(base)
+      @@base = base
+    end
+    
+    def start_console
+      puts "Starting #{@@base.name.split(":").last.downcase} console (#{self.identity})"
+      Thread.new do
+        Console.start(self)
+      end
+    end
+
+  end # ConsoleHelper
+  
+  module Console
+    class << self; attr_accessor :instance; end
+
+    def self.start(binding, quit_on_exit=true)
+      require 'irb'
+      old_args = ARGV.dup
+      ARGV.replace ["--simple-prompt"]
+
+      IRB.setup(nil)
+      self.instance = IRB::Irb.new(IRB::WorkSpace.new(binding))
+
+      @CONF = IRB.instance_variable_get(:@CONF)
+      @CONF[:IRB_RC].call self.instance.context if @CONF[:IRB_RC]
+      @CONF[:MAIN_CONTEXT] = self.instance.context
+
+      catch(:IRB_EXIT) { self.instance.eval_input }
+    ensure
+      ARGV.replace old_args
+      # Clean up tty settings in some evil, evil cases
+      begin; catch(:IRB_EXIT) { irb_exit }; rescue Exception; end
+      # Make agent exit when irb does
+      EM.stop if EM.reactor_running? && quit_on_exit
+    end
+
+  end # Console
+
+end # RightScale

data/lib/right_agent/core_payload_types.rb

@@ -0,0 +1,42 @@
+#
+# 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.
+#
+
+CORE_PAYLOAD_TYPES_BASE_DIR = File.join(File.dirname(__FILE__), 'core_payload_types')
+
+require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'cookbook'))
+require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'cookbook_repository'))
+require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'cookbook_sequence'))
+require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'cookbook_position'))
+require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'dev_repositories'))
+require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'executable_bundle'))
+require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'event_categories'))
+require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'recipe_instantiation'))
+require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'repositories_bundle'))
+require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'software_repository_instantiation'))
+require File.normalize_path(File.join(CORE_PAYLOAD_TYPES_BASE_DIR, 'right_script_attachment'))
+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, '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/cookbook.rb

@@ -0,0 +1,61 @@
+#
+# 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.
+#
+
+module RightScale
+
+  # Individual cookbook
+  class Cookbook
+
+    include Serializable
+
+    # (String) Cookbook SHA hash.
+    attr_accessor :hash
+
+    # (String) Authentication token
+    attr_accessor :token
+
+    # (String) User readable cookbook name
+    attr_accessor :name
+
+    # Initialize fields from given arguments
+    def initialize(*args)
+      @hash  = args[0] if args.size > 0
+      @token = args[1] if args.size > 1
+      @name  = args[2] if args.size > 2
+    end
+
+    # Array of serialized fields given to constructor
+    def serialized_members
+      [ @hash, @token, @name ]
+    end
+
+    # Human friendly name used for audits
+    #
+    # === Return
+    # name(String):: Cookbook repository display name
+    def display_name
+      name = "Cookbook #{@name}:#{@hash}"
+    end
+    alias :to_s :display_name
+  end
+end

data/lib/right_agent/core_payload_types/cookbook_position.rb

@@ -0,0 +1,46 @@
+#--
+# Copyright: Copyright (c) 2010-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.
+#++
+
+module RightScale
+  # Cookbook / position pairs.
+  class CookbookPosition
+    include Serializable
+
+    # (String) relative position in the filesystem that the cookbook
+    # should be expanded at.
+    attr_accessor :position
+    # (Cookbook) cookbook to expand.
+    attr_accessor :cookbook
+
+    # Initialize fields from given arguments
+    def initialize(*args)
+      @position = args[0]
+      @cookbook = args[1] if args.size > 1
+    end
+
+    # Array of serialized fields given to constructor
+    def serialized_members
+      [ @position, @cookbook ]
+    end
+  end
+end