rs-mule 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDA0NmVlMGNmZWE4YTNjNmQ1NGZmM2ZiNTY0MGFjNjBjMzlmZmYyMg==
+    MDdkYTJkMjE5NjQ1ZGY5ZjY3ZDkyMjA5MTZhM2E4ODg4NTA4ZjZiMg==
   data.tar.gz: !binary |-
-    OTZlMTEwZjBlNzJjOWI2MzQ4MGY2ZWFjM2E4MGM2N2NhOWY0MDc0Yw==
+    OGExMjcwZGFmNmQxYTJlYTZiYjkzMjRmZTIyN2U5ZmVjNWJkNWNhNQ==
 SHA512:
   metadata.gz: !binary |-
-    MjQ4NTViOTgxZDQ2MmQ2YzJkMWE1NWJiZjgwNjBmNmFlMTNkMWZiMzExYmYz
-    OGQ5NjRhNjc0MWZiNjM3YjljNzk5YmEwOGI4MWRkOWVkNTg5NzBmY2E4M2E2
-    MDg3NzAyN2QyN2Y5NDNmNWMzZDFiMmY3MThhYzUwNTFjZmI3MWU=
+    ZmQ5MDNlMzYxYTc2OTc5NDVkMTU0NmVhOTRjN2IyNTkyNDVhMDliOGFhYzQ1
+    ZWJkMjE2NzQ1OGQ2MWJhMTg2NTJjM2M4MzU5Yzc0YzJiNmI1OTEyYTg2MGRi
+    NmFjZGI2ZjkzMzY4ZTYyNWYyNDgxZmI1NGIxZGM5NDYxMjAwZDI=
   data.tar.gz: !binary |-
-    NjY0NDgzMmI3ZGU4NjMyNTUyOTcxMjcxZDRjMDVjMmZjNDIxYzMwNjhjODkx
-    YjA1YTEzOGZmZDFhNmYwMGNkZGQ1OGI4MDkwY2U1Y2UyYWMzZmZjYWNkZGRm
-    NWZkN2EyNWMyYWFiZjUyZjAzNmMzODAyYWMyZDhkNWU5ZTk5ZmE=
+    MDI5NGZmYjllZTc4YmM3NTFmNzlmYTUyODRmZTFlYjNlOTRkMTNlMGZjNjll
+    Yzg3MWRmZDU4ZTA1MDhjZTMzZDljNzlhYWUyM2QxYjFlMGI5Y2ZlZGJiYmUz
+    MDkzYmI5OThkNWExNWQ2MjFlZWNiYjJmNzFlOTQ4N2Q1YWJmOGE=

data/README.md

@@ -132,6 +132,47 @@ Chef Recipe:
 rs-mule run_executable "cookbook::recipe" --executable-type=recipe_name --tags=tag1
 ```
 
+##### Script Inputs
+Of course you might want to pass some inputs to the script or recipe that you're
+executing.  Shockingly enough, you can!
+
+Passing INPUT_ONE and INPUT_TWO to a script RightScript:
+```
+rs-mule run_executable "Some RightScript Name" --tags=tag1 --inputs=INPUT_ONE:text:foo INPUT_TWO:text:bar
+```
+
+Passing some/chef/attribute1 and some/chef/attribute2 to a recipe:
+```
+rs-mule run_executable "cookbook::recipe" --tags=tag1 --inputs='some/chef/attribute:text:foo' 'some/chef/attribute2:text:bar'
+```
+
+Suppose you want to set those inputs so that they stick around after you've run
+the executable.  You can do that too.  You just need to specify where you want
+the inputs to be set.
+
+Saving the inputs on the current instance:
+```
+rs-mule run_executable "Some RightScript Name" --tags=tag1 --inputs=INPUT_ONE:text:foo INPUT_TWO:text:bar --update_inputs=current_instance
+```
+
+Saving the inputs on the next instance:
+```
+rs-mule run_executable "Some RightScript Name" --tags=tag1 --inputs=INPUT_ONE:text:foo INPUT_TWO:text:bar --update_inputs=next_instance
+```
+
+Saving the inputs on the deployment containing the instance:
+```
+rs-mule run_executable "Some RightScript Name" --tags=tag1 --inputs=INPUT_ONE:text:foo INPUT_TWO:text:bar --update_inputs=deployment
+```
+
+You can save the inputs on any mix of them as well, since the update_inputs
+option is an array.
+
+Saving the inputs on EVERYTHING:
+```
+rs-mule run_executable "Some RightScript Name" --tags=tag1 --inputs=INPUT_ONE:text:foo INPUT_TWO:text:bar --update_inputs=current_instance next_instance deployment
+```
+
 ## Library
 The library does all this cool stuff, and I'll document it, I swear...
 

data/lib/rs-mule.rb

@@ -0,0 +1,23 @@
+# Copyright (c) 2014 Ryan Geyer
+#
+# 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 'thor'
+require 'right_api_client'
+glob_path = File.expand_path(File.join(File.dirname(__FILE__), 'rs-mule')) + '/**/*.rb'
+Dir.glob(glob_path, &method(:require))

data/lib/rs-mule/cli.rb

@@ -0,0 +1,71 @@
+# Copyright (c) 2014 Ryan Geyer
+#
+# 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 'yaml'
+
+module RsMule
+  class Cli < Thor
+    no_commands {
+      def get_right_api_client()
+        client_auth_params = {}
+        thor_shell = Thor::Shell::Color.new
+        unless @options.keys.include?('rs_auth_file') | @options.keys.include?('rs_auth_hash')
+          message = <<EOF
+You must supply right_api_client authentication details as either a hash or
+a yaml authentication file!
+EOF
+          thor_shell.say(thor_shell.set_color(message, :red))
+          exit 1
+        end
+        if @options[:rs_auth_file]
+          client_auth_params = YAML.load_file(@options[:rs_auth_file])
+        end
+
+        if @options[:rs_auth_hash]
+          client_auth_params = options[:rs_auth_hash]
+        end
+
+        RightApi::Client.new(client_auth_params)
+      end
+    }
+
+    desc "run_executable", "Runs a specified recipe or RightScript on instances targeted by tag"
+    option :rs_auth_hash, :type => :hash, :desc => "A hash of right_api_client auth parameters in the form (email:foo@bar.baz password:password account_id:12345)"
+    option :rs_auth_file, :desc => "A yaml file containing right_api_client auth parameters to use for authentication"
+    option :tags, :type => :array, :required => true
+    option :tag_match_strategy, :desc => "If multiple tags are specified, this will determine how they are matched.  When set to \"all\" instances with all tags will be matched.  When set to \"any\" instances with any of the provided tags will be matched.  Defaults to \"all\""
+    option :executable_type, :desc => "What value is being provided for the executable parameter. One of [auto|right_script_name|right_script_href|recipe_name]"
+    option :right_script_revision, :desc => "When a RightScript name is provided, this can be used to specify which revision to use.  If not provided the latest revision will be used."
+    option :inputs, :type => :hash, :desc => "A hash where the keys are the name of an input and the value is the desired value for that input.  Uses Inputs 2.0 semantics."
+    option :update_inputs, :type => :array, :desc => "An array of values indicating which objects should be updated with the inputs supplied.  Can be empty in which case the inputs will be used only for this execution.  Acceptable values are [\"current_instance\",\"next_instance\",\"deployment\"]"
+    def run_executable(executable)
+      # Cover our bases with symbolized keys as well
+      new_options = {}
+      @options.each do |k,v|
+        new_options[k.to_sym] = v
+        new_options[k] = v
+      end
+
+      client = get_right_api_client
+
+      mule = RsMule::RunExecutable.new(client)
+      mule.run_executable(new_options[:tags], executable, new_options)
+    end
+  end
+end

data/lib/rs-mule/exception/right_script_not_found.rb

@@ -0,0 +1,26 @@
+# Copyright (c) 2014 Ryan Geyer
+#
+# 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 RsMule
+  module Exception
+    class RightScriptNotFound < ::Exception
+
+    end
+  end
+end

data/lib/rs-mule/run_executable.rb

@@ -0,0 +1,186 @@
+# Copyright (c) 2014 Ryan Geyer
+#
+# 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 RsMule
+  class RunExecutable
+
+    attr_accessor :right_api_client
+
+    # Initializes a new RunExecutable
+    #
+    # @param [RightApi::Client] right_api_client An instantiated and authenticated
+    #   RightApi::Client instance which will be used for making the request(s)
+    def initialize(right_api_client)
+      @right_api_client = right_api_client
+    end
+
+    # Runs a RightScript or Chef Recipe on all instances which have all of the
+    # specified tags.
+    #
+    # @param [String|Array<String>] tags An array of tags.  If a string is
+    #   supplied it will be converted to an array of Strings.
+    # @param [String] executable RightScript name or href, or the name of a
+    #   recipe.  This method will attempt to auto detect which it is, or you
+    #   can be friendly and provide a hint using the executable_type option.
+    # @param [Hash] options A list of options where the possible values are
+    #   - executable_type [String] One of ["auto","right_script_name","right_script_href","recipe_name"].  When set
+    #       to "auto" we will attempt to determine if an executable is a recipe,
+    #       a RightScript name, or a RightScript href. Defaults to "auto"
+    #   - right_script_revision [String] When a RightScript name or href is specified,
+    #       this can be used to declare the revision to use.  Can be a specific
+    #       revision number or "latest".  Defaults to "latest"
+    #   - tag_match_strategy [String] If multiple tags are specified, this will
+    #       determine how they are matched.  When set to "all" instances with all
+    #       tags will be matched.  When set to "any" instances with any of the
+    #       provided tags will be matched.  Defaults to "all"
+    #   - inputs [Hash] A hash where the keys are the name of an input and the
+    #       value is the desired value for that input.  Uses Inputs 2.0[http://reference.rightscale.com/api1.5/resources/ResourceInputs.html#multi_update]
+    #       semantics.
+    #   - update_inputs [Array<String>] An array of values indicating which
+    #       objects should be updated with the inputs supplied.  Can be empty in
+    #       which case the inputs will be used only for this execution.  Acceptable
+    #       values are ["current_instance","next_instance","deployment"]
+    # @raise [RightScriptNotFound] If the specified RightScript lineage does
+    #   not exist, or the specified revision is not available.
+    def run_executable(tags, executable, options={})
+      options = {
+          :executable_type => "auto",
+          :right_script_revision => "latest",
+          :tag_match_strategy => "all",
+          :inputs => {},
+          :update_inputs => []
+      }.merge(options)
+      execute_params = {}
+      tags = [tags] unless tags.is_a?(Array)
+      options[:update_inputs] = [options[:update_inputs]] unless options[:update_inputs].is_a?(Array)
+
+      case options[:executable_type]
+        when "right_script_href"
+          execute_params[:right_script_href] = executable
+        when "right_script_name"
+          scripts = find_right_script_lineage_by_name(executable)
+          execute_params[:right_script_href] = right_script_revision_from_lineage(scripts, options[:right_script_revision]).href
+        when "recipe_name"
+          execute_params[:recipe_name] = executable
+        when "auto"
+          is_recipe = executable =~ /.*::.*/
+          is_href = executable =~ /^\/api\/right_scripts\/[a-zA-Z0-9]*/
+          if is_recipe
+            execute_params[:recipe_name] = executable
+          else
+            if is_href
+              execute_params[:right_script_href] = executable
+            else
+              scripts = find_right_script_lineage_by_name(executable)
+              execute_params[:right_script_href] = right_script_revision_from_lineage(scripts, options[:right_script_revision]).href
+            end
+          end
+        else
+          raise ArgumentError.new("Unknown executable_type (#{options[:executable_type]})")
+      end
+
+      if options[:inputs].length > 0
+        execute_params[:inputs] = options[:inputs]
+      end
+
+      resources_by_tag = @right_api_client.tags.by_tag(
+        :resource_type => "instances",
+        :tags => tags,
+        :match_all => options[:tag_match_strategy] == "all" ? "true" : "false"
+      )
+
+      resources_by_tag.each do |res|
+        instance = @right_api_client.resource(res.links.first["href"])
+        instance.run_executable(execute_params)
+        options[:update_inputs].each do |update_type|
+          update_inputs(instance, options[:inputs], update_type)
+        end
+      end
+    end
+
+    private
+
+    # Fetches the entire lineage (all revisions) of a RightScript when provided
+    # with it's name
+    #
+    # @param [String] name The name (or partial name) of the RightScript
+    # @return [Array<RightApi::Resource>] An array of RightApi::Resource objects
+    #   of media type RightScript[http://reference.rightscale.com/api1.5/media_types/MediaTypeRightScript.html]
+    # @raise [RightScriptNotFound] If a lineage of RightScripts with the specified
+    #   name is not found.
+    def find_right_script_lineage_by_name(name)
+      lineage = @right_api_client.right_scripts(:filter => ["name==#{name}"]).index
+      if lineage.length == 0
+        raise Exception::RightScriptNotFound.new("No RightScripts with the name (#{name}) were found.")
+      end
+      lineage
+    end
+
+    # Gets the specified revision of a RightScript from it's lineage
+    #
+    # @param [Array<RightApi::Resource>] An array of RightApi::Resource objects
+    #   of media type RightScript[http://reference.rightscale.com/api1.5/media_types/MediaTypeRightScript.html]
+    # @param [String] An optional parameter for the desired lineage.  When set
+    #   to "latest" it will get the highest number committed revision. Specify
+    #   0 for the head revision.
+    # @raise [RightScriptNotFound] If the specified revision is not in the lineage
+    def right_script_revision_from_lineage(lineage, revision="latest")
+      right_script = nil
+      if revision == "latest"
+        latest_script = lineage.max_by{|rs| rs.revision}
+        right_script = latest_script
+      else
+        desired_script = lineage.select{|rs| rs.revision == revision}
+        if desired_script.length == 0
+          raise Exception::RightScriptNotFound.new("RightScript revision (#{revision}) was not found. Available revisions are (#{lineage.map{|rs| rs.revision}})")
+        end
+        right_script = desired_script.first
+      end
+      right_script
+    end
+
+    # Updates inputs on one of the objects related to the specified instance.
+    # This deliberately lacks error handling. If you attempt to set the input on
+    # the deployment of the matching instance(s) and there isn't a deployment,
+    # you'll get the exception.
+    #
+    # TODO: Maybe handle the error so that other instances in a matched set can
+    # have a chance to succeed.
+    #
+    # @param [RightApi::Resource] The RightApi::Resource of media type
+    #   Instance[http://reference.rightscale.com/api1.5/media_types/MediaTypeInstance.html]
+    #   which will be used to find related objects, or which will get it's inputs
+    #   updated.
+    # @param [Hash] inputs A hash where the keys are the name of an input and the
+    #   value is the desired value for that input.  Uses Inputs 2.0[http://reference.rightscale.com/api1.5/resources/ResourceInputs.html#multi_update]
+    #   semantics.
+    # @param [String] update_type Which object should be updated with the inputs
+    #   supplied.  Acceptable values are ["current_instance","next_instance","deployment"]
+    def update_inputs(instance, inputs, update_type)
+      case update_type
+        when "current_instance"
+          instance.inputs.multi_update(:inputs => inputs)
+        when "next_instance"
+          instance.parent.show.next_instance.show.inputs.multi_update(:inputs => inputs)
+        when "deployment"
+          instance.deployment.show.inputs.multi_update(:inputs => inputs)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rs-mule
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryan J. Geyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
+date: 2014-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: right_api_client
@@ -48,6 +48,10 @@ files:
 - LICENSE
 - README.md
 - bin/rs-mule
+- lib/rs-mule.rb
+- lib/rs-mule/cli.rb
+- lib/rs-mule/exception/right_script_not_found.rb
+- lib/rs-mule/run_executable.rb
 homepage: https://github.com/rgeyer/rs-mule
 licenses:
 - MIT