right_link 5.9.0

data/lib/instance/cook/audit_stub.rb

@@ -0,0 +1,142 @@
+#
+# 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
+
+  # Provides access to RightLink agent audit methods
+  class AuditStub
+
+    include RightSupport::Ruby::EasySingleton
+
+    # Initialize command protocol, call prior to calling any instance method
+    #
+    # === Parameters
+    # options[:listen_port]:: Command server listen port
+    # options[:cookie]:: Command protocol cookie
+    #
+    # === Return
+    # true:: Always return true
+    def init(options)
+      @agent_connection = EM.connect('127.0.0.1', options[:listen_port], AgentConnection, options[:cookie], options[:thread_name])
+      true
+    end
+
+    # Stop command client, wait for all pending commands to finish prior
+    # to calling given callback
+    #
+    # === Block
+    # called once all pending commands have completed
+    def stop(&callback)
+      if @agent_connection
+        # allow any pending audits to be sent prior to stopping agent connection
+        # by placing stop on the end of the next_tick queue.
+        EM.next_tick { @agent_connection.stop(&callback) }
+      else
+        callback.call
+      end
+    end
+
+    # Update audit summary
+    #
+    # === Parameters
+    # status(String):: New audit entry status
+    # options[:category](String):: Optional, must be one of RightScale::EventCategories::CATEGORIES
+    #
+    # === Return
+    # true:: Always return true
+    def update_status(status, options = nil)
+      send_command(:audit_update_status, status, options)
+    end
+
+    # Start new audit section
+    #
+    # === Parameters
+    # title(String):: Title of new audit section, will replace audit status as well
+    # options[:category](String):: Optional, must be one of RightScale::EventCategories::CATEGORIES
+    #
+    # === Return
+    # true:: Always return true
+    def create_new_section(title, options = nil)
+      send_command(:audit_create_new_section, title, options)
+    end
+
+    # Append output to current audit section
+    #
+    # === Parameters
+    # text(String):: Output to append to audit entry
+    #
+    # === Return
+    # true:: Always return true
+    def append_output(text, options = nil)
+      send_command(:audit_append_output, text, options)
+    end
+
+    # Append info text to current audit section. A special marker will be prepended to each line of audit to
+    # indicate that text is not some output. Text will be line-wrapped.
+    #
+    # === Parameters
+    # text(String):: Informational text to append to audit entry
+    # options[:category](String):: Optional, must be one of RightScale::EventCategories::CATEGORIES
+    #
+    # === Return
+    # true:: Always return true
+    def append_info(text, options = nil)
+      send_command(:audit_append_info, text, options)
+    end
+
+    # Append error message to current audit section. A special marker will be prepended to each line of audit to
+    # indicate that error message is not some output. Message will be line-wrapped.
+    #
+    # === Parameters
+    # text(String):: Error text to append to audit entry
+    #
+    # === Return
+    # true:: Always return true
+    def append_error(text, options = nil)
+      send_command(:audit_append_error, text, options)
+    end
+
+    protected
+
+    # Helper method used to send command client request to RightLink agent
+    #
+    # === Parameters
+    # cmd(String):: Command name
+    # content(String):: Audit content
+    # options(Hash):: Audit options or nil
+    #
+    # === Return
+    # true:: Always return true
+    def send_command(cmd, content, options)
+      begin
+        options ||= {}
+        cmd = { :name => cmd, :content => content, :options => options }
+        EM.next_tick { @agent_connection.send_command(cmd) }
+      rescue Exception => e
+        $stderr.puts 'Failed to audit'
+        $stderr.puts Log.format("Failed to audit '#{cmd[:name]}'", e, :trace)
+      end
+    end
+
+  end
+
+end