right_api_provision 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+*.tmproj
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+-fs

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 caryp
+
+MIT License
+
+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.md

@@ -0,0 +1,68 @@
+# RightApiProvision
+
+Basic helper gem for provisioning IaaS servers using the RightScale API.
+
+It is intended to be used by ruby applications that need to launch servers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'right_api_provision'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+See lib/right_api_provisioner/provisioner.rb for all public methods.
+
+Example:
+
+	require "right_api_provision"
+
+	# initialize rightscale provisioner
+	@rightscale =
+	  RightApiProvision::Provisioner.new("my_user@somewhere.com",	 // user
+	                                     "my_rightscale_password",   // password
+	                                     12345)						 // rightscale account ID
+
+	# setup some inputs
+	server_inputs = {
+       # open up port 8000
+       "sys_firewall/rule/enable" => "text:enable",
+       "sys_firewall/rule/port" => "text:8000",
+       "sys_firewall/rule/ip_address" => "text:any",
+       "sys_firewall/rule/protocol" => "text:tcp"
+    }
+
+	# provision a RightScale managed server from a ServerTemplate
+	@rightscale.provision("My Cool Server",
+	                      "ServerTemplate for Linux (v13.5)", // name or ID
+	                      "AWS US-East",
+	                      "My Deployment",
+	                      server_inputs)
+
+	# wait for server to be ready
+	state = @rightscale.wait_for_state("operational", 30)
+    if state != "operational"
+    	raise "Unexpected state. State: #{state}"
+    end
+
+	# Do stuff with your brand new server...
+
+
+## TODO
+
+1. document this readme
+2. add logger class
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  task :default => :spec
+
+  desc "Run all specs in spec directory"
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/**/*_spec.rb'
+  end
+
+rescue LoadError
+  STDERR.puts "\n*** RSpec not available. (sudo) gem install rspec to run unit tests. ***\n\n"
+end
+

data/lib/right_api_provision/api15.rb

@@ -0,0 +1,227 @@
+module RightApiProvision
+  class API15
+
+    attr_reader :client
+
+    def initialize
+      require "right_api_client"
+    end
+
+    def connection(email, password, account_id, api_url = nil)
+      begin
+        args = { :email => email, :password => password, :account_id => account_id }
+        @url = api_url
+        args[:api_url] = @url if @url
+        @connection ||= RightApi::Client.new(args)
+        @client = @connection
+      rescue Exception => e
+        args.delete(:password) # don't log password
+        puts "ERROR: could not connect to RightScale API.  Params: #{args.inspect}"
+        puts e.message
+        puts e.backtrace
+        raise e
+      end
+    end
+
+    def user_data(server)
+      @user_data ||= server.show.current_instance(:view=>"extended").show.user_data
+    end
+
+    def data_request_url(userdata)
+      data_hash = {}
+      entry = userdata.split('&').select { |entry| entry =~ /RS_rn_auth/i }
+      raise "ERROR: user data token not found. " +
+            "Does your MCI have a provides:rs_agent_type=right_link tag?" unless entry
+      token = entry.first.split('=')[1]
+      "#{@url}/servers/data_injection_payload/#{token}"
+    end
+
+    def find_server_by_name(name)
+      server_list = @connection.servers.index(:filter => ["name==#{name}"])
+      raise "More than one server with the name of '#{name}'. " +
+            "Please fix via the RightScale dashboard and retry." if server_list.size > 1
+      server_list.first
+    end
+
+    def find_deployment_by_name(name)
+      deployment = nil
+      deployments_list = @connection.deployments.index(:filter => ["name==#{name}"])
+      raise "More than one deployment with the name of '#{name}'. " +
+            "Please fix via the RightScale dashboard and retry." if deployments_list.size > 1
+      deployment = deployments_list.first unless deployments_list.empty?
+      deployment
+    end
+
+    def list_clouds
+      @connection.clouds.index
+    end
+
+    # returns:: String if cloud is found, nil if not found
+    def find_cloud_by_name(name)
+      cloud = nil
+      cloud_list = @connection.clouds.index(:filter => ["name==#{name}"])
+      raise "More than one cloud with the name of '#{name}'. " +
+            "Please fix via the RightScale dashboard and retry." if cloud_list.size > 1
+      cloud = cloud_list.first unless cloud_list.empty?
+      cloud
+    end
+
+    def find_mci_by_name(mci_name)
+      mci = nil
+      mci_list = @connection.multi_cloud_images.index(:filter => ["name==#{mci_name}"])
+      raise "More than one MultiCloud image with the name of '#{mci_name}'. " +
+            "Please fix via the RightScale dashboard and retry." if mci_list.size > 1
+      mci = mci_list.first unless mci_list.empty?
+      mci
+    end
+
+    def find_servertemplate(name_or_id)
+      server_template = nil; id = nil; name = nil
+
+      # detect if user passed in a name or an id
+      # there is probably a cleaner way to do this, but I am lazy ATM.
+      begin
+        id = Integer(name_or_id)
+      rescue Exception => e
+        name = name_or_id # Cannot be case to integer, assume a name was passed
+      end
+
+      if name
+        # find ServerTemplate by name
+        st_list = @connection.server_templates.index(:filter => ["name==#{name}"])
+        num_matching_sts = 0
+        st_list.each do |st|
+          if st.name == name
+            server_template = st
+            num_matching_sts += 1
+          end
+        end
+        raise "ERROR: Unable to find ServerTemplate with the name of '#{name}' found " unless server_template
+        raise "ERROR: More than one ServerTemplate with the name of '#{name}' found " +
+                  "in account. Please fix via the RightScale dashboard and retry." if num_matching_sts > 1
+
+      else
+        # find ServerTemplate by id
+        server_template = @connection.server_templates.index(:id => id)
+      end
+
+      server_template
+    end
+
+    def create_deployment(name)
+      @connection.deployments.create(:deployment => { :name => name, :decription => "Created by the Vagrant"})
+    end
+
+    def destroy_deployment(deployment)
+      deployment.destroy
+    end
+
+    def create_server(deployment, server_template, mci, cloud, name)
+      # check params
+      unless st_href = server_template.show.href
+        raise "ERROR: ServerTemplate parameter not initialized properly"
+      end
+
+      unless mci.nil?
+        unless mci_href = mci.show.href
+          raise "ERROR: Multi Cloud Image parameter not initialized properly"
+        end
+      end
+
+      unless d_href = deployment.show.href
+        raise "ERROR: Deployment parameter not initialized properly"
+      end
+
+      unless c_href = cloud.show.href
+        raise "ERROR: Deployment parameter not initialized properly"
+      end
+
+      # create server in deployment using specfied ST
+      create_params = {
+          :server => {
+          :name => name,
+          :decription => "Created by the Vagrant",
+          :deployment_href => d_href,
+          :instance => {
+            :cloud_href => c_href,
+            :server_template_href => st_href
+          }
+        }
+      }
+      # Use the MCI if provided otherwise let the API choose the default MCI
+      # in the ServerTemplate.
+      create_params[:server][:instance][:multi_cloud_image_href] = mci_href unless mci_href.nil?
+      server = @connection.servers.create(create_params)
+    end
+
+    def is_provisioned?(server)
+      server.show.api_methods.include?(:current_instance)
+    end
+
+    # @param(Hash) inputs Hash input name/value pairs i.e. { :name => "text:dummy"}
+    def launch_server(server, inputs = { :name => "text:dummy"})
+      server_name = server.show.name
+      server.launch(inputs) # TODO: parse inputs from Vagrantfile
+      # XXX: need to create a new server object after launch -- why? API bug?
+      find_server_by_name(server_name)
+    end
+
+    def terminate_server(server)
+      server.terminate
+    end
+
+    # Only use this *before* you launch the server
+    def set_server_inputs(server, inputs)
+      server.show.next_instance.show.inputs.multi_update({"inputs" => inputs})
+    end
+
+    def server_wait_for_state(server, target_state, delay = 10)
+      current_state = server_state(server)
+      while current_state != target_state
+        raise "Unexpected sever state: #{current_state}" if is_bad?(current_state)
+        puts "Server #{current_state}. Waiting for instance to be in #{target_state} state..."
+        sleep delay
+        current_state = server_state(server)
+      end
+    end
+
+    def set_bad_states(list_array)
+      @bad_states = list_array
+    end
+
+    def is_bad?(state)
+      @bad_states ||= []
+      @bad_states.select{|s| state =~ /#{s}/}.size > 0
+    end
+
+    def server_ready?(server)
+      server_state(server)  == "operational"
+    end
+
+    def server_cloud_name(server)
+      instance = instance_from_server(server)
+      cloud = cloud_from_instance(instance)
+      cloud.show.name
+    end
+
+  private
+
+    def server_state(server)
+      instance_from_server(server).show.state
+    end
+
+    def instance_from_server(server)
+      server_data = server.show
+      if is_provisioned?(server)
+        server_data.current_instance
+      else
+        server_data.next_instance
+      end
+    end
+
+    def cloud_from_instance(instance)
+      instance.show.cloud
+    end
+
+  end
+end

data/lib/right_api_provision/exception.rb

@@ -0,0 +1,31 @@
+#
+# Author:: Cary Penniman (<cary@rightscale.com>)
+# Copyright:: Copyright (c) 2013 RightScale, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module RightApiProvision
+  class RightScaleError < StandardError
+  end
+
+  class MultipleMatchesFound < RightScaleError
+    def initialize(resource, key, value)
+      key = key.to_s.delete("by_") # remove the 'by_' prefix
+      msg = "More than one #{resource} with the #{key} of '#{value}'. " +
+            "Please resolve via the RightScale dashboard and retry."
+      super msg
+    end
+  end
+end

data/lib/right_api_provision/provisioner.rb

@@ -0,0 +1,193 @@
+#
+# Author:: Cary Penniman (<cary@rightscale.com>)
+# Copyright:: Copyright (c) 2013 RightScale, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module RightApiProvision
+
+  #
+  # This is the main class to use to create a server on the RightScale platform.
+  # Use the {#provision} method to create and launch
+  # the server.
+  #
+  # The other methods are for checking server state and gathering information
+  # once the server is operational.
+  #
+  class Provisioner
+
+    require "logger"
+
+    RETRY_DELAY = 10 # seconds
+
+    def initialize(email, password, account_id, api_url = nil)
+      require_relative "exception"
+      require_relative "api15"
+      @logger = ::Logger.new(STDOUT)
+      @client = RightApiProvision::API15.new
+      @client.connection(email, password, account_id, api_url)
+    end
+
+    def logger(logger)
+      @logger = logger
+    end
+
+    def connection_url
+      raise "No server provisioned. No connection URL available." unless @server
+      unless @data_request_url
+        user_data = @server.current_instance.show(:view => "full").user_data
+        @data_request_url = @client.data_request_url(user_data)
+        @logger.debug "Data Request URL: #{@data_request_url}"
+      end
+      @data_request_url
+    end
+
+    def wait_for_state(desired_state, timeout_sec = RETRY_DELAY)
+      @client.server_wait_for_state(@server, desired_state, timeout_sec)
+    end
+
+    # Provision a server using RightScale
+    #
+    # @param server_name [String] the name to give the server that will be
+    #        created.
+    # @param server_template [String] the name or ID of the ServerTemplate to
+    #        create the server from.
+    # @param cloud_name [String] name of cloud to provision on.
+    # @param deployment_name [String] name of deployment to add the server to.
+    #        This will be created if it does not exist.
+    # @param server_inputs [Array] An array of {Input} objects.
+    # @param ssh_key_id [String] The resource_uuid of an ssh key from the
+    #        RightScale dashboard. Only required on EC2 and Eucalyptus.
+    # @param secgroup_id [Array] An array of security group IDs to place the
+    #        server in.
+    #
+    # @raise {RightApiProvisionException} if anything
+    #         goes wrong
+    def provision(
+      server_name,
+      server_template,
+      cloud_name,
+      deployment_name,
+      server_inputs,
+      multi_cloud_image_name,
+      ssh_key_id = nil,  #TODO: support me
+      secgroup_id = nil, #TODO: support me
+      datacenter = nil)  #TODO: support me
+
+
+      # fail if the requested cloud is not registered with RightScale account
+      @cloud = @client.find_cloud_by_name(cloud_name)
+      unless @cloud
+        clouds = @client.list_clouds.inject("") { |str, c| str == "" ? c.name : "#{str}, #{c.name}" }
+        raise RightScaleError, "ERROR: cannot find a cloud named: '#{cloud_name}'. " +
+              "Please check the spelling of the 'cloud_name' parameter in " +
+              "your Vagrant file and verify the cloud is registered with " +
+              "your RightScale account? Supported clouds: #{clouds}"
+      end
+
+      # check for existing deployment and server in RightScale account
+      @deployment = @client.find_deployment_by_name(deployment_name)
+      @logger.info "Deployment '#{deployment_name}' #{@deployment ? "found." : "not found."}"
+      @server = @client.find_server_by_name(server_name) if @deployment
+      @logger.info "Server '#{server_name}' #{@server ? "found." : "not found."}"
+
+      # XXX: fails if the server is not running -- fix me!
+      # if @server
+      #         # verify existing server is on the cloud we are requesting, if not fail.
+      #         cloud_name ||= Config::VAGRANT_CLOUD_NAME
+      #         actual_cloud_name = @client.server_cloud_name(@server)
+      #         raise RightScaleError, "ERROR: the server is in the '#{actual_cloud_name}' cloud, " +
+      #               "and not in the requested '#{cloud_name}' cloud.\n" +
+      #               "Please delete the server or pick and new server name." if cloud_name != actual_cloud_name
+      #       end
+
+      unless @deployment && @server
+        # we need to create a server, can we find the servertemplate?
+        begin
+          @servertemplate = @client.find_servertemplate(server_template)
+        rescue
+          raise RightScaleError, "ERROR: cannot find ServerTemplate '#{server_template}'. Did you import it?\n" +
+                "Visit http://bit.ly/VnOiA7 for more info.\n\n"
+          # can we find the MCI?
+        end
+      end
+
+      unless @deployment && @server
+        # We need to find the to be used in the server if the MCI name is given
+        begin
+          @mci =
+            if multi_cloud_image_name.nil? || multi_cloud_image_name.empty?
+              nil
+            else
+              @client.find_mci_by_name(multi_cloud_image_name)
+            end
+        rescue Exception => e
+          raise RightScaleError, "ERROR: Cannot find the mci '#{multi_cloud_image_name}'. Please make sure" +
+            " that you have the MCI under the server template selected." +
+            " Exception: #{e.inspect}"
+        end
+      end
+
+      # create deployment and server as needed
+      unless @deployment
+        @deployment = @client.create_deployment(deployment_name)
+        @logger.info "Created deployment."
+      end
+
+      unless @server
+        @server = @client.create_server(@deployment, @servertemplate, @mci, @cloud, server_name)
+        @logger.info "Created server."
+      end
+
+      unless @client.is_provisioned?(@server)
+
+        # setup any inputs
+        begin
+          @client.set_server_inputs(@server, server_inputs) if server_inputs && ! server_inputs.empty?
+        rescue Exception => e
+          raise RightScaleError, "Problem setting inputs. \n #{e.message}\n\n"
+          # can we find the MCI?
+          #TODO: @mci = @client.find_multicloudimage_by_name(@servertemplate, multi_cloud_image_name)
+        end
+
+        # launch server
+        @logger.info "Launching server..."
+        @server = @client.launch_server(@server, server_inputs)
+        @client.server_wait_for_state(@server, "booting")
+      end
+
+    end
+
+    # Register a custom progress indicator
+    #
+    # @example
+    #   do
+    #     @TODO: add an example
+    #   end
+    # @param progress_block [Block] block to execute before each loop iteration.
+    # @yield [Logger] A Logger object will be passed as a parameter into
+    #        your block.
+    def register_progress_indicator(&progress_block)
+      @progress_indicator = progress_block
+    end
+
+  end
+end
+
+
+
+
+
+

data/lib/right_api_provision/version.rb

@@ -0,0 +1,3 @@
+module RightApiProvision
+  VERSION = "0.1.0"
+end

data/lib/right_api_provision.rb

@@ -0,0 +1,4 @@
+require "right_api_provision/version"
+require "right_api_provision/api15"
+require "right_api_provision/provisioner"
+

data/right_api_provision.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'right_api_provision/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "right_api_provision"
+  gem.version       = RightApiProvision::VERSION
+  gem.authors       = ["caryp"]
+  gem.email         = ["cary@rightscale.com"]
+  gem.description   = %q{Simple ruby API for provisioning servers on the cloud with RightScale}
+  gem.summary       = %q{Simple ruby API for provisioning servers on the cloud with RightScale}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency "right_api_client"
+  %w(rspec-core rspec-expectations rspec-mocks rspec_junit_formatter rake).each { |rspec_gem| gem.add_development_dependency rspec_gem }
+end