right_api_provision 0.1.0 → 0.2.0

data/README.md

@@ -45,10 +45,7 @@ Example:
 	                      server_inputs)
 
 	# wait for server to be ready
-	state = @rightscale.wait_for_state("operational", 30)
-    if state != "operational"
-    	raise "Unexpected state. State: #{state}"
-    end
+	state = @rightscale.wait_for_operational
 
 	# Do stuff with your brand new server...
 

data/RELEASES.md

@@ -0,0 +1,14 @@
+Release Notes
+=============
+
+0.2.0
+-----
+
+ * `wait_for_state` method changed to `wait_for_operational`
+ * added `server_ready?` method
+ * added `server_info` method
+ * ssh_keys_uuids and security groups now supported
+
+0.1.0
+-----
+Initial Release

data/lib/right_api_provision/api15.rb

@@ -1,3 +1,21 @@
+#
+# 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 API15
 
@@ -13,6 +31,9 @@ module RightApiProvision
         @url = api_url
         args[:api_url] = @url if @url
         @connection ||= RightApi::Client.new(args)
+        #@logger = Logger.new(STDOUT)
+        #@logger.level = Logger::DEBUG
+        #@connection.log(@logger)
         @client = @connection
       rescue Exception => e
         args.delete(:password) # don't log password
@@ -23,6 +44,48 @@ module RightApiProvision
       end
     end
 
+    # If the cloud reports ssh keys, then we assume it requires them to launch
+    # servers.
+    def requires_ssh_keys?(cloud)
+      begin
+        cloud.show.ssh_keys
+        true
+      rescue RightApi::Exceptions::ApiException => e
+        false # assume cloud does not require them
+      end
+    end
+
+    # Find SSH key
+    #
+    # EC2 and Eucalyptus require an SSH key to launch a server.  RightScale
+    # manages SSH keys for each user so just grabbing the first one is fine,
+    # however older configurations might relay on specific keys.  You will
+    # need to grab the resource UUID from the RightScale dashboard for the key
+    # that you want to use.
+    def find_ssh_key_by_uuid_or_first(cloud, ssh_uuid = nil)
+      ssh_key = nil
+      if ssh_uuid
+        # grab specific ssh key
+        sshkey = find_resource(:ssh_keys, :by_resource_uid, uuid)
+      else
+        # grab first key found
+        keys = cloud.show.ssh_keys
+        ssh_key = keys.index.first if keys
+      end
+      ssh_key
+    end
+
+    # If the cloud reports security groups then we assume it requires them to launch
+    # servers.
+    def requires_security_groups?(cloud)
+       begin
+        cloud.show.security_groups
+        true
+      rescue RightApi::Exceptions::ApiException => e
+        false # assume cloud does not require them
+      end
+    end
+
     def user_data(server)
       @user_data ||= server.show.current_instance(:view=>"extended").show.user_data
     end
@@ -36,43 +99,60 @@ module RightApiProvision
       "#{@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
+    def delete_server(name)
+      server = find_server_by_name(name)
+      server.terminate
+      begin
+        server_wait_for_state(server, "terminated")
+      rescue Exception => e
+
+      end
+      server.destroy
     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
+    def list_servers(filter_by, filter_value)
+      list_resources(:servers, filter_by, filter_value)
+    end
+
+    def list_deployments(filter_by, filter_value)
+      list_resources(:deployments, filter_by, filter_value)
+    end
+
+    def list_clouds(filter_by, filter_value)
+      list_resources(:clouds, filter_by, filter_value)
+    end
+
+    def list_servertemplates(filter_by, filter_value)
+      list_resources(:server_templates, filter_by, filter_value)
     end
 
-    def list_clouds
-      @connection.clouds.index
+    def list_security_groups(cloud, filter_by, filter_value)
+      list_subresources(cloud, :security_groups, filter_by, filter_value)
+    end
+
+    def list_multi_cloud_images(server_template, filter_by, filter_value)
+      list_subresources(server_template, :multi_cloud_images, filter_by, filter_value)
+    end
+
+    def find_security_group_by_name(cloud, security_group_name)
+      find_cloud_resource(cloud, :security_groups, :by_name, security_group_name)
+    end
+
+    def find_server_by_name(name)
+      find_resource(:servers, :by_name, name)
+    end
+
+    def find_deployment_by_name(name)
+      find_resource(:deployments, :by_name, name)
     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
+      find_resource(:clouds, :by_name, name)
     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
+    def find_mci_by_name(name)
+      find_resource(:multi_cloud_images, :by_name, name)
     end
 
     def find_servertemplate(name_or_id)
@@ -88,18 +168,18 @@ module RightApiProvision
 
       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
+        st_list = list_resources(:server_templates, :by_name, name)
+        revisions = st_list.map { |st| st.revision }
+
+        # check for duplicate revisions
+        duplicates = (revisions.size != revisions.uniq.size)
+        raise "ERROR: Duplicate ServerTemplate with the name of '#{name}' detected " +
+                  "in account -- there can be only one. Please fix via the RightScale dashboard and retry." if duplicates
 
+        # always use latest revision
+        latest_rev = revisions.sort.last
+        server_template = st_list.select { |st| st.revision == latest_rev}.first
+        raise "ERROR: Unable to find ServerTemplate with the name of '#{name}' found " unless server_template
       else
         # find ServerTemplate by id
         server_template = @connection.server_templates.index(:id => id)
@@ -116,7 +196,8 @@ module RightApiProvision
       deployment.destroy
     end
 
-    def create_server(deployment, server_template, mci, cloud, name)
+    def create_server(deployment, server_template, mci, cloud, name, ssh_key = nil, groups = nil)
+
       # check params
       unless st_href = server_template.show.href
         raise "ERROR: ServerTemplate parameter not initialized properly"
@@ -136,22 +217,44 @@ module RightApiProvision
         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
-          }
-        }
+      if ssh_key
+        unless ssh_key_href = ssh_key.show.href
+          raise "ERROR: ssh_key parameter not initialized properly"
+        end
+      end
+
+      security_group_hrefs = nil
+      if groups
+        security_group_hrefs = []
+        groups.each do |group|
+          unless group_href = group.show.href
+            raise "ERROR: ssh_key parameter not initialized properly"
+          end
+          security_group_hrefs << group_href
+        end
+      end
+
+      instance_hash = {
+        :cloud_href => c_href,
+        :server_template_href => st_href
       }
+      instance_hash[:ssh_key_href] = ssh_key_href if ssh_key
+      instance_hash[:security_group_hrefs] = security_group_hrefs if security_group_hrefs
+
       # 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)
+      instance_hash[:multi_cloud_image_href] = mci_href unless mci_href.nil?
+
+      # create server in deployment using specfied ST
+      server =
+        @connection.servers.create({
+              :server => {
+              :name => name,
+              :decription => "Created by the right_provision_api", #TODO: pass this as a param
+              :deployment_href => d_href,
+              :instance => instance_hash
+            }
+          })
     end
 
     def is_provisioned?(server)
@@ -204,6 +307,10 @@ module RightApiProvision
       cloud.show.name
     end
 
+    def server_info(server)
+      server.show.current_instance.show(:view => 'extended')
+    end
+
   private
 
     def server_state(server)
@@ -213,7 +320,11 @@ module RightApiProvision
     def instance_from_server(server)
       server_data = server.show
       if is_provisioned?(server)
-        server_data.current_instance
+        begin
+          server_data.current_instance
+        rescue
+          server_data.next_instance
+        end
       else
         server_data.next_instance
       end
@@ -223,5 +334,47 @@ module RightApiProvision
       instance.show.cloud
     end
 
+    def find_resource(api_resource, filter_key, filter_value)
+      resource = nil
+      list = list_resources(api_resource, filter_key, filter_value)
+      raise "More than one #{api_resource} with the #{filter_key} of '#{filter_value}'. " +
+            "Please resolve via the RightScale dashboard and retry." if list.size > 1
+      resource = list.first unless list.empty?
+      resource
+    end
+
+    def list_resources(api_resource, filter_key, filter_value)
+      raise ArgumentError.new("api_resource must be a symbol") unless api_resource.kind_of?(Symbol)
+      key = filter_key.to_s.delete("by_") # convert :by_name to "name"
+      filter = {}
+      filter = {:filter => ["#{key}==#{filter_value}"]} if filter_value
+      list = @connection.send(api_resource).index(filter)
+      list
+    end
+
+    def index_resource(api_resource, index_key, index_value)
+      raise ArgumentError.new("api_resource must be a symbol") unless api_resource.kind_of?(Symbol)
+      arry = @connection.send(api_resource).index(index_key => index_value)
+      arry
+    end
+
+    def find_cloud_resource(cloud, api_resource, filter_key, filter_value)
+      resource = nil
+      list = list_subresources(cloud, api_resource, filter_key, filter_value)
+      raise "More than one #{api_resource} with the #{filter_key} of '#{filter_value}'. " +
+            "Please resolve via the RightScale dashboard and retry." if list.size > 1
+      resource = list.first unless list.empty?
+      resource
+    end
+
+    def list_subresources(api_resource, subresource, filter_key, filter_value)
+      raise ArgumentError.new("subresource must be a symbol") unless subresource.kind_of?(Symbol)
+      key = filter_key.to_s.delete("by_") # convert :by_name to "name"
+      filter = {}
+      filter = {:filter => ["#{key}==#{filter_value}"]} if filter_value
+      list = api_resource.show.send(subresource).index(filter)
+      list
+    end
+
   end
-end
+end

data/lib/right_api_provision/provisioner.rb

@@ -31,13 +31,14 @@ module RightApiProvision
     require "logger"
 
     RETRY_DELAY = 10 # seconds
+    BAD_STATES_UP = [ "stranded", "terminated"]
 
     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)
+      @rsapi = RightApiProvision::API15.new
+      @rsapi.connection(email, password, account_id, api_url)
     end
 
     def logger(logger)
@@ -48,16 +49,12 @@ module RightApiProvision
       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)
+        @data_request_url = @rsapi.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
@@ -67,7 +64,7 @@ module RightApiProvision
     # @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 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
@@ -75,20 +72,17 @@ module RightApiProvision
     #
     # @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
-
+    def provision(servertemplate,
+                  server_name = "default",
+                  cloud_name = "ec2",
+                  deployment_name = "default",
+                  inputs = nil,
+                  multi_cloud_image_name = nil,
+                  ssh_key_uuid = nil,
+                  security_groups = nil)
 
       # fail if the requested cloud is not registered with RightScale account
-      @cloud = @client.find_cloud_by_name(cloud_name)
+      @cloud = @rsapi.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}'. " +
@@ -97,21 +91,36 @@ module RightApiProvision
               "your RightScale account? Supported clouds: #{clouds}"
       end
 
+      # Verify ssh key uuid, if required by cloud
+      if @rsapi.requires_ssh_keys?(@cloud)
+        @ssh_key = @rsapi.find_ssh_key_by_uuid_or_first(@cloud, ssh_key_uuid)
+        raise "ERROR: cannot find an ssh_key named: #{ssh_key_uuid}" unless @ssh_key
+      end
+
+      # Verify security group, if required by cloud
+      if @rsapi.requires_security_groups?(@cloud)
+        @sec_groups = []
+        security_groups ||= ["default"]
+        security_groups.each do |name|
+          group = @rsapi.find_security_group_by_name(@cloud, name)
+          raise "ERROR: cannot find an security group named: #{name}" unless group
+          @sec_groups << group
+        end
+      end
+
       # check for existing deployment and server in RightScale account
-      @deployment = @client.find_deployment_by_name(deployment_name)
+      @deployment = @rsapi.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
+      @server = @rsapi.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
+      if @server
+        # verify existing server is on the cloud we are requesting, if not fail.
+        actual_cloud_name = @rsapi.server_cloud_name(@server)
+        raise "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?
@@ -120,11 +129,8 @@ module RightApiProvision
         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 =
@@ -142,52 +148,51 @@ module RightApiProvision
 
       # create deployment and server as needed
       unless @deployment
-        @deployment = @client.create_deployment(deployment_name)
+        @deployment = @rsapi.create_deployment(deployment_name)
         @logger.info "Created deployment."
       end
 
       unless @server
-        @server = @client.create_server(@deployment, @servertemplate, @mci, @cloud, server_name)
+        @server = @rsapi.create_server(@deployment, @servertemplate, @mci, @cloud, server_name, @ssh_key, @sec_groups)
         @logger.info "Created server."
       end
 
-      unless @client.is_provisioned?(@server)
+      unless @rsapi.is_provisioned?(@server)
 
         # setup any inputs
         begin
-          @client.set_server_inputs(@server, server_inputs) if server_inputs && ! server_inputs.empty?
+          @client.set_server_inputs(@server, inputs) if inputs && ! 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")
+        @server = @rsapi.launch_server(@server, inputs)
+        @rsapi.set_bad_states(BAD_STATES_UP)
+        @rsapi.server_wait_for_state(@server, "booting", 30)
       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
+    def server_ready?
+      @rsapi.server_ready?(@server)
     end
 
-  end
-end
-
-
-
-
+    def wait_for_operational
+      @rsapi.set_bad_states(BAD_STATES_UP)
+      @rsapi.server_wait_for_state(@server, "operational", 30)
+    end
 
+    def server_info
+      info = @rsapi.server_info(@server)
+      while info.private_ip_addresses.empty?
+        @logger.info "Waiting for cloud to provide IP address..."
+        sleep 30
+        info = @rsapi.server_info(@server)
+      end
+      info
+    end
 
+  end
+end

data/lib/right_api_provision/version.rb

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

data/spec/right_api_provision/api15_spec.rb

@@ -68,7 +68,7 @@ describe "API15 object" do
   end
 
   it "should find servertemplate by name" do
-    servertemplatesStub = double("servertemplates", :index => [ double("servertemplate", :name => "my_fake_servertemplate") ])
+    servertemplatesStub = double("servertemplates", :index => [ double("servertemplate", :name => "my_fake_servertemplate", :revision => [0, 1, 2, 3, 4 ]) ])
     @api.instance_variable_get("@connection").should_receive(:server_templates).and_return(servertemplatesStub)
     @api.find_servertemplate("my_fake_servertemplate")
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: right_api_provision
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-20 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: right_api_client
@@ -119,6 +119,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASES.md
 - Rakefile
 - lib/right_api_provision.rb
 - lib/right_api_provision/api15.rb
@@ -145,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4414243138993754310
+      hash: -2827224809426864135
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -154,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4414243138993754310
+      hash: -2827224809426864135
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23