right_agent 0.5.1

data/lib/right_agent/core_payload_types/cookbook_repository.rb

@@ -0,0 +1,116 @@
+#
+# 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
+
+  # Cookbook repository
+  class CookbookRepository
+
+    include Serializable
+
+    # List of characters used to build cookbooks sha1 hash path component
+    CHARS = ("a".."z").to_a + ("A".."Z").to_a + (0..9).to_a
+
+    # (Symbol) Type of repository: one of :git, :svn, :download or :local
+    # * :git denotes a 'git' repository that should be retrieved via 'git clone'
+    # * :svn denotes a 'svn' repository that should be retrieved via 'svn checkout'
+    # * :download denotes a tar ball that should be retrieved via HTTP GET (HTTPS if url starts with https://)
+    # * :local denotes an already available cookbook (useful for testing)
+    attr_accessor :repo_type
+
+    # (String) URI to repository (e.g. git://github.com/opscode/chef-repo.git)
+    attr_accessor :url
+
+    # (String) git commit or svn branch that should be used to retrieve repository
+    # Use 'master' for git and 'trunk' for svn if tag is nil.
+    # Not used for raw repositories.
+    attr_accessor :tag
+
+    # (Array) Path to cookbooks inside repostory
+    # Append to the location of the repository on disk prior to running chef.
+    # Optional (use location of repository as cookbook path if nil)
+    attr_accessor :cookbooks_path
+
+    # (String) Private SSH key used to retrieve git repositories
+    # Not used for svn and raw repositories.
+    attr_accessor :ssh_key
+
+    # (String) Username used to retrieve svn and raw repositories
+    # Not used for git repositories.
+    attr_accessor :username
+
+    # (String) Password used to retrieve svn and raw repositories
+    # Not used for git repositories.
+    attr_accessor :password
+
+    # Initialize fields from given arguments
+    def initialize(*args)
+      @repo_type      = args[0].to_sym
+      @url            = args[1] if args.size > 1
+      @tag            = args[2] if args.size > 2
+      @cookbooks_path = args[3] if args.size > 3
+      @ssh_key        = args[4] if args.size > 4
+      @username       = args[5] if args.size > 5
+      @password       = args[6] if args.size > 6
+    end
+
+    # Instantiate from hash
+    # Keys of hash should be the corresponding symolized field name
+    #
+    # === Parameters
+    # h(Hash):: Hash of values used to initialize cookbook repository
+    #
+    # === Return
+    # repo(RightScale::CookbookRepository):: Corresponding instance
+    def self.from_hash(h)
+      repo = new(h[:repo_type], h[:url], h[:tag], h[:cookbooks_path], h[:ssh_key], h[:username], h[:password])
+    end
+
+    # Array of serialized fields given to constructor
+    def serialized_members
+      [ @repo_type, @url, @tag, @cookbooks_path, @ssh_key, @username, @password ]
+    end
+
+    # Human friendly name used for audits
+    #
+    # === Return
+    # name(String):: Cookbook repository display name
+    def display_name
+      name = @url + (@tag && !@tag.empty? ? ":#{@tag}" : '')
+    end
+    alias :to_s :display_name
+
+    # SVN username or git SSH key
+    # Provide compatibility for scraper
+    def first_credential
+      @ssh_key || @username
+    end
+
+    # SVN password
+    # Provide compatibility for scraper
+    def second_credential
+      @password
+    end
+
+  end
+end

data/lib/right_agent/core_payload_types/cookbook_sequence.rb

@@ -0,0 +1,70 @@
+#--
+# 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
+  # Sequence of cookbooks and where to put them.
+  class CookbookSequence
+    include Serializable
+
+    # (Array) relative cookbook paths to use from the repository root.
+    attr_accessor :paths
+    # (Array) CookbookPosition objects for each cookbook.
+    attr_accessor :positions
+    # (String) Hash for the repository this came from
+    attr_accessor :hash
+
+    # Initialize fields from given arguments
+    def initialize(*args)
+      @paths     = args[0]
+      @positions = args[1] if args.size > 1
+      @hash      = args[2] if args.size > 2
+    end
+
+    # Array of serialized fields given to constructor
+    def serialized_members
+      [ @paths, @positions, @hash ]
+    end
+
+    # Reorder @positions so it respects @path.  The comparison rule is
+    # as follows:
+    # - for two pairs of cookbooks [a_pos, a_cookbook], [b_pos, b_cookbook]
+    #  - let a_index be the index of the first element of cookbooks_path that is a prefix for a_pos.
+    #  - let b_index be similarly defined on b_pos.
+    #  - if a_index != b_index, sort on a_index and b_index.
+    #  - otherwise lexically sort on a_pos and b_pos.
+    def sort_by_path!
+      indices = @positions.map {|a|
+        @paths.index(@paths.find {|p| a.position.start_with? p})
+      }
+      @positions = indices.zip(@positions).sort {|a, b|
+        aindex, acb = a
+        bindex, bcb = b
+        if aindex == bindex
+          acb.position <=> bcb.position
+        else
+          aindex <=> bindex
+        end
+      }.map {|p| p.last}
+    end
+  end
+end

data/lib/right_agent/core_payload_types/dev_repositories.rb

@@ -0,0 +1,90 @@
+#--
+# 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
+  # Sequence of cookbooks to be checked out on the instance.
+  class DevRepositories
+    include Serializable
+
+    attr_accessor :repositories
+
+    # Initialize fields from given arguments
+    def initialize(*args)
+      @repositories = args[0] || {}
+    end
+
+    # Array of serialized fields given to constructor
+    def serialized_members
+      [ @repositories ]
+    end
+
+    # Add a repository...
+    #
+    # === Parameters
+    # (Hash):: collection of repos to be checked out on the instance
+    # :repo_sha (String):: the hash id (SHA) of the repository
+    # :repo_detail (Hash):: info needed to checkout this repo
+    #   {
+    #     <Symbol> Type of repository: one of :git, :svn, :download or :local
+    #       * :git denotes a 'git' repository that should be retrieved via 'git clone'
+    #       * :svn denotes a 'svn' repository that should be retrieved via 'svn checkout'
+    #       * :download denotes a tar ball that should be retrieved via HTTP GET (HTTPS if uri starts with https://)
+    #       * :local denotes cookbook that is already local and doesn't need to be retrieved
+    #     :repo_type => <Symbol>,
+    #     <String> URL to repository (e.g. git://github.com/opscode/chef-repo.git)
+    #     :url => <String>,
+    #     <String> git commit or svn branch that should be used to retrieve repository
+    #       Optional, use 'master' for git and 'trunk' for svn if tag is nil.
+    #       Not used for raw repositories.
+    #     :tag => <String>,
+    #     <Array> Path to cookbooks inside repostory
+    #       Optional (use location of repository as cookbook path if nil)
+    #     :cookbooks_path => <Array>,
+    #     <String> Private SSH key used to retrieve git repositories
+    #       Optional, not used for svn and raw repositories.
+    #     :ssh_key => <String>,
+    #     <String> Username used to retrieve svn and raw repositories
+    #       Optional, not used for git repositories.
+    #     :username => <String>,
+    #     <String> Password used to retrieve svn and raw repositories
+    #       Optional, not used for git repositories.
+    #     :password => <String>
+    #  }
+    # :cookbook_positions (Array):: List of CookbookPositions to be developed.  Represents the subset of cookbooks identified as the "dev cookbooks"
+    #
+    # === Return
+    # result(Hash):: The entry added to the collection of repositories
+    def add_repo(repo_sha, repo_detail, cookbook_positions)
+      @repositories ||= {}
+      @repositories[repo_sha] = { :repo => repo_detail, :positions => cookbook_positions }
+    end
+
+    #
+    # === Return
+    # (Boolean):: true if there are no repositories, false otherwise
+    def empty?
+      @repositories.count == 0
+    end
+  end
+end
+

data/lib/right_agent/core_payload_types/event_categories.rb

@@ -0,0 +1,38 @@
+#
+# 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
+
+  # List of event categories used by auditor
+  # For now only support generic and security categories
+  class EventCategories
+
+    NONE                  = 'None'.freeze         # No notification
+    CATEGORY_NOTIFICATION = 'Notification'.freeze # Generic notification
+    CATEGORY_SECURITY     = 'Security'.freeze     # Security topic notification
+    CATEGORY_ERROR        = 'Error'.freeze        # Error event
+
+    CATEGORIES            = [ NONE, CATEGORY_NOTIFICATION, CATEGORY_SECURITY, CATEGORY_ERROR ]
+
+  end
+end

data/lib/right_agent/core_payload_types/executable_bundle.rb

@@ -0,0 +1,138 @@
+#
+# 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
+
+  # Boot, operation or decommission executable bundle, includes:
+  # * RightScripts with associated packages, parameters and attachments
+  # * Recipes with associated JSON
+  # * Cookbook repositories with associated attributes
+  # * Audit id
+  # Recipes and RightScripts instantiations are interspersed and ordered into one collection
+  # The instance agent can use the audit created by the core agent to audit messages
+  # associated with the processing of the software repositories
+  class ExecutableBundle
+
+    include Serializable
+
+    # Default thread name when no thread is specified for an executable bundle.
+    DEFAULT_THREAD_NAME = 'default'
+
+    # (Array) Collection of RightScripts and chef recipes instantiations
+    attr_accessor :executables
+
+    # (Array) Chef cookbook repositories
+    attr_accessor :cookbook_repositories
+
+    # (Integer) ID of corresponding audit entry
+    attr_accessor :audit_id
+
+    # (Boolean) Whether a full or partial converge should be done
+    # Note: Obsolete as of r_s_version 8, kept for backwards compatibility
+    attr_accessor :full_converge
+
+    # (Array) Chef cookbooks
+    attr_accessor :cookbooks
+
+    # (String) Repose server to use
+    attr_accessor :repose_servers
+
+    # (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
+    #    :repo (Hash):: repo details
+    #     {
+    #       <Symbol> Type of repository: one of :git, :svn, :download or :local
+    #         * :git denotes a 'git' repository that should be retrieved via 'git clone'
+    #         * :svn denotes a 'svn' repository that should be retrieved via 'svn checkout'
+    #         * :download denotes a tar ball that should be retrieved via HTTP GET (HTTPS if uri starts with https://)
+    #         * :local denotes cookbook that is already local and doesn't need to be retrieved
+    #       :repo_type => <Symbol>,
+    #       <String> URL to repository (e.g. git://github.com/opscode/chef-repo.git)
+    #       :url => <String>,
+    #       <String> git commit or svn branch that should be used to retrieve repository
+    #         Optional, use 'master' for git and 'trunk' for svn if tag is nil.
+    #         Not used for raw repositories.
+    #       :tag => <String>,
+    #       <Array> Path to cookbooks inside repostory
+    #         Optional (use location of repository as cookbook path if nil)
+    #       :cookbooks_path => <Array>,
+    #       <String> Private SSH key used to retrieve git repositories
+    #         Optional, not used for svn and raw repositories.
+    #       :ssh_key => <String>,
+    #       <String> Username used to retrieve svn and raw repositories
+    #         Optional, not used for git repositories.
+    #       :username => <String>,
+    #       <String> Password used to retrieve svn and raw repositories
+    #         Optional, not used for git repositories.
+    #       :password => <String>
+    #     }
+    #    :positions (Array):: List of CookbookPositions to be developed.  Represents the subset of cookbooks identified as the "dev cookbooks"
+    attr_accessor :dev_cookbooks
+
+    def initialize(*args)
+      @executables           = args[0]
+      @cookbook_repositories = args[1] if args.size > 1
+      @audit_id              = args[2] if args.size > 2
+      @full_converge         = args[3] if args.size > 3
+      @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
+    end
+
+    # Array of serialized fields given to constructor
+    def serialized_members
+      [ @executables,
+        @cookbook_repositories,
+        @audit_id,
+        @full_converge,
+        @cookbooks,
+        @repose_servers,
+        @dev_cookbooks,
+        @thread_name ]
+    end
+
+    # Human readable representation
+    #
+    # === Return
+    # desc(String):: Auditable description
+    def to_s
+      desc = @executables.collect { |e| e.nickname }.join(', ') if @executables
+      desc ||= 'empty bundle'
+    end
+
+    # Gets the thread name from a bundle, if any. Uses the default thread name for
+    # when a thread name is not specified (for backward compatibility, etc.).
+    #
+    # === Parameters
+    # bundle(ExecutableBundle):: bundle to inspect
+    #
+    # === Return
+    # thread_name(String):: thread name for bundle execution
+    def thread_name(value = nil)
+      @thread_name = value if value
+      return @thread_name || DEFAULT_THREAD_NAME
+    end
+  end
+end