right_api_helper 1.1.0 → 1.1.1

data/Rakefile

@@ -5,3 +5,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
 
+desc "Run functional tests. Requires RightScale account information in knife.rb file."
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+end

data/lib/right_api_helper/api15.rb

@@ -144,20 +144,22 @@ module RightApiHelper
       end
 
       if name
+        @log.info "ServerTemplate name detected."
         # find ServerTemplate by name
         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 " +
+        raise RightScaleError, "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
+        raise RightScaleError, "ERROR: Unable to find ServerTemplate with the name of '#{name}' found " unless server_template
       else
+        @log.info "Looking up ServerTemplate by ID."
         # find ServerTemplate by id
         server_template = @client.server_templates.index(:id => id)
       end

data/lib/right_api_helper/exception.rb

@@ -0,0 +1,30 @@
+#
+# Author: cary@rightscale.com
+# Copyright 2014 RightScale, Inc.
+#
+# 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 RightApiHelper
+  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_helper/provisioner.rb

@@ -74,11 +74,11 @@ module RightApiHelper
     end
 
     def connection_url
-      raise "No server provisioned. No connection URL available." unless @server
+      raise RightScaleError, "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 = @api_shim.data_request_url(user_data)
-        @logger.debug "Data Request URL: #{@data_request_url}"
+        @log.debug "Data Request URL: #{@data_request_url}"
       end
       @data_request_url
     end
@@ -100,8 +100,8 @@ module RightApiHelper
     #
     # @raise {RightApiProvisionException} if anything
     #         goes wrong
-    def provision(servertemplate,
-                  server_name = "default",
+    def provision(server_name = "default",
+                  server_template = nil,
                   cloud_name = "ec2",
                   deployment_name = "default",
                   inputs = nil,
@@ -122,30 +122,33 @@ module RightApiHelper
       # Verify ssh key uuid, if required by cloud
       if @api_shim.requires_ssh_keys?(@cloud)
         @ssh_key = @api_shim.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
+        raise RightScaleError, "ERROR: cannot find an ssh_key named: #{ssh_key_uuid}" unless @ssh_key
       end
 
       # Verify security group, if required by cloud
       if @api_shim.requires_security_groups?(@cloud)
         @sec_groups = []
+        if !security_groups.nil? && !security_groups.is_a?(Array)
+          raise RightScaleError, "security_groups must be an array.  You passed a #{security_groups.class}"
+        end
         security_groups ||= ["default"]
         security_groups.each do |name|
           group = @api_shim.find_security_group_by_name(@cloud, name)
-          raise "ERROR: cannot find an security group named: #{name}" unless group
+          raise RightScaleError, "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 = @api_shim.find_deployment_by_name(deployment_name)
-      @logger.info "Deployment '#{deployment_name}' #{@deployment ? "found." : "not found."}"
+      @log.info "Deployment '#{deployment_name}' #{@deployment ? "found." : "not found."}"
       @server = @api_shim.find_server_by_name(server_name) if @deployment
-      @logger.info "Server '#{server_name}' #{@server ? "found." : "not found."}"
+      @log.info "Server '#{server_name}' #{@server ? "found." : "not found."}"
 
       if @server
         # verify existing server is on the cloud we are requesting, if not fail.
         actual_cloud_name = @api_shim.server_cloud_name(@server)
-        raise "ERROR: the server is in the '#{actual_cloud_name}' cloud, " +
+        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
@@ -153,8 +156,8 @@ module RightApiHelper
       unless @deployment && @server
         # we need to create a server, can we find the servertemplate?
         begin
-          @servertemplate = @client.find_servertemplate(server_template)
-        rescue
+          @servertemplate = @api_shim.find_servertemplate(server_template)
+        rescue RightScaleError
           raise RightScaleError, "ERROR: cannot find ServerTemplate '#{server_template}'. Did you import it?\n" +
                 "Visit http://bit.ly/VnOiA7 for more info.\n\n"
         end
@@ -177,12 +180,12 @@ module RightApiHelper
       # create deployment and server as needed
       unless @deployment
         @deployment = @api_shim.create_deployment(deployment_name)
-        @logger.info "Created deployment."
+        @log.info "Created deployment."
       end
 
       unless @server
         @server = @api_shim.create_server(@deployment, @servertemplate, @mci, @cloud, server_name, @ssh_key, @sec_groups)
-        @logger.info "Created server."
+        @log.info "Created server."
       end
 
       unless @api_shim.is_provisioned?(@server)
@@ -195,7 +198,7 @@ module RightApiHelper
         end
 
         # launch server
-        @logger.info "Launching server..."
+        @log.info "Launching server..."
         @server = @api_shim.launch_server(@server, inputs)
         @api_shim.set_bad_states(BAD_STATES_UP)
         @api_shim.server_wait_for_state(@server, "booting", 30)
@@ -215,7 +218,7 @@ module RightApiHelper
     def server_info
       info = @api_shim.server_info(@server)
       while info.private_ip_addresses.empty?
-        @logger.info "Waiting for cloud to provide IP address..."
+        @log.info "Waiting for cloud to provide IP address..."
         sleep 30
         info = @api_shim.server_info(@server)
       end

data/lib/right_api_helper/version.rb

@@ -1,3 +1,3 @@
 module RightApiHelper
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/lib/right_api_helper.rb

@@ -19,6 +19,7 @@ require "right_api_client"
 require "yaml"
 
 require 'right_api_helper/version'
+require 'right_api_helper/exception'
 require 'right_api_helper/base'
 require 'right_api_helper/cache'
 require 'right_api_helper/session'

data/test/provisioner_test.rb

@@ -0,0 +1,39 @@
+require 'right_api_helper'
+require 'yaml'
+
+describe RightApiHelper::Provisioner do
+
+  before(:all) do
+    @user_secrets = YAML.load(File.read(File.join(ENV['HOME'], '.right_api_client', 'login.yml')))
+    @config =  {
+      :servertemplate => 328222001, # "Base ServerTemplate for Linux Alpha (v14.0.0)"
+      :deployment_name => "CP: right_api_provision testbed -- deleteme!",
+      :server_name => "CP: Test: API Provisioned Server",
+      :cloud_name => "EC2 us-east-1"
+    }
+  end
+
+  it "provisions a server" do
+    puts "Provisioning server in '#{@user_secrets[:account_id]}' account..."
+
+    right_api_client = RightApiHelper::Session.new.create_client_from_file("~/.right_api_client/login.yml")
+
+    # initialize rightscale provisioner
+    @rightscale =
+      RightApiHelper::Provisioner.new(right_api_client)
+
+    # provision a RightScale managed server from a ServerTemplate
+    @rightscale.provision(@config[:server_name],
+                          @config[:servertemplate],
+                          @config[:cloud_name],
+                          @config[:deployment_name],
+                          @config[:server_inputs],
+                          @config[:multi_cloud_image_name],
+                          nil, # ssh_key_id not yet supported
+                          ["default"]) # secgroup_id not yet supported
+
+    @rightscale.wait_for_operational()
+  end
+
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: right_api_helper
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -178,6 +178,7 @@ files:
 - lib/right_api_helper/base.rb
 - lib/right_api_helper/cache.rb
 - lib/right_api_helper/deployments.rb
+- lib/right_api_helper/exception.rb
 - lib/right_api_helper/instances.rb
 - lib/right_api_helper/provisioner.rb
 - lib/right_api_helper/scripts/deployments_creator.rb
@@ -193,6 +194,7 @@ files:
 - spec/scripts/deployments_creator_spec.rb
 - spec/session_spec.rb
 - spec/spec_helper.rb
+- test/provisioner_test.rb
 homepage: ''
 licenses:
 - MIT
@@ -228,4 +230,5 @@ test_files:
 - spec/scripts/deployments_creator_spec.rb
 - spec/session_spec.rb
 - spec/spec_helper.rb
+- test/provisioner_test.rb
 has_rdoc: