knife-cloud 1.0.0.rc.0

data/lib/chef/knife/cloud/server/create_options.rb

@@ -0,0 +1,80 @@
+#
+# Copyright:: Copyright (c) 2013 Opscode, 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.
+#
+
+require 'chef/knife/cloud/chefbootstrap/bootstrap_options'
+require 'chef/knife/cloud/server/options'
+
+class Chef
+  class Knife
+    class Cloud
+      module ServerCreateOptions
+
+        def self.included(includer)
+          includer.class_eval do
+            include ServerOptions
+            include BootstrapOptions
+            option :image,
+              :short => "-I IMAGE",
+              :long => "--image IMAGE",
+              :description => "A regexp matching an image name or an image ID for the server",
+              :proc => Proc.new { |i| Chef::Config[:knife][:image] = i }
+
+            option :image_os_type,
+              :short => "-T IMAGE_OS_TYPE",
+              :long => "--image-os-type IMAGE_OS_TYPE",
+              :description => "The image os type. options [windows/linux]. Only required when cloud does not provide a way to identify image os",
+              :default => "linux",
+              :proc => Proc.new { |i| Chef::Config[:knife][:image_os_type] = i }
+
+            option :flavor,
+              :short => "-f FLAVOR_ID",
+              :long => "--flavor FLAVOR_ID",
+              :description => "The flavor name or ID of server",
+              :proc => Proc.new { |f| Chef::Config[:knife][:flavor] = f }
+
+            option :bootstrap_protocol,
+              :long => "--bootstrap-protocol protocol",
+              :description => "Protocol to bootstrap servers. options: winrm/ssh. For linux servers always use ssh.",
+              :default => 'ssh',
+              :proc => Proc.new { |b| Chef::Config[:knife][:bootstrap_protocol] = b}
+
+            option :server_create_timeout,
+              :long => "--server-create-timeout timeout",
+              :description => "How long to wait until the server is ready; default is 600 seconds",
+              :default => 600,
+              :proc => Proc.new { |v| Chef::Config[:knife][:server_create_timeout] = v}
+            
+            option :delete_server_on_failure,
+              :long => "--delete-server-on-failure",
+              :boolean => true,
+              :default => false,
+              :description => "Destroy corresponding server in case of failure"
+
+            option :chef_node_name_prefix,
+              :long => "--chef-node-name-prefix PREFIX_FOR_NODE_NAME",
+              :description => "The prefix for chef node name",
+              :default => includer.snake_case_name.split('_').first,
+              :proc => Proc.new { |key| Chef::Config[:knife][:chef_node_name_prefix] = key }
+
+          end
+        end
+
+      end # module end
+    end
+  end
+end
+

data/lib/chef/knife/cloud/server/delete_command.rb

@@ -0,0 +1,68 @@
+#
+# Author:: Kaustubh Deorukhkar (<kaustubh@clogeny.com>)
+# Copyright:: Copyright (c) 2013 Opscode, 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.
+#
+
+require 'chef/knife/cloud/command'
+# These two are needed for the '--purge' deletion case
+require 'chef/node'
+require 'chef/api_client'
+
+class Chef
+  class Knife
+    class Cloud
+      class ServerDeleteCommand < Command
+
+        def execute_command
+          @name_args.each do |server_name|
+            service.delete_server(server_name)
+            delete_from_chef(server_name)
+          end
+        end
+
+        def delete_from_chef(server_name)
+          # delete the node from Chef if purge requested.
+          if config[:purge]
+            thing_to_delete = config[:chef_node_name] || server_name
+            destroy_item(Chef::Node, thing_to_delete, "node")
+            destroy_item(Chef::ApiClient, thing_to_delete, "client")
+          else
+            ui.warn("Corresponding node and client for the #{server_name} server were not deleted and remain registered with the Chef Server")
+            end
+        end
+
+        # Extracted from Chef::Knife.delete_object, because it has a
+        # confirmation step built in... By specifying the '--purge'
+        # flag (and also explicitly confirming the server destruction!)
+        # the user is already making their intent known.  It is not
+        # necessary to make them confirm two more times.
+        def destroy_item(klass, name, type_name)
+          begin
+            object = klass.load(name)
+            object.destroy
+            ui.warn("Deleted #{type_name} #{name}")
+          rescue Net::HTTPServerException => e
+            error_message = "#{e.message}. Could not find a #{type_name} named #{name} to delete!"
+            ui.warn(error_message)
+            raise CloudExceptions::ServerDeleteError, error_message
+          end
+        end
+
+      end # class ServerDeleteCommand
+    end
+  end
+end
+

data/lib/chef/knife/cloud/server/delete_options.rb

@@ -0,0 +1,42 @@
+#
+# Author:: Kaustubh Deorukhkar (<kaustubh@clogeny.com>)
+# Copyright:: Copyright (c) 2013 Opscode, 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.
+#
+
+require 'chef/knife/cloud/server/options'
+
+class Chef
+  class Knife
+    class Cloud
+      module ServerDeleteOptions
+        def self.included(includer)
+          includer.class_eval do
+            include ServerOptions
+
+            option :purge,
+              :short => "-P",
+              :long => "--purge",
+              :boolean => true,
+              :default => false,
+              :description => "Destroy corresponding node and client on the Chef Server, in addition to destroying the Cloud node itself. Assumes node and client have the same name as the server (if not, add the '--node-name' option)."
+
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/chef/knife/cloud/server/list_command.rb

@@ -0,0 +1,84 @@
+require 'chef/knife/cloud/list_resource_command'
+require 'chef/knife/cloud/exceptions'
+
+class Chef
+  class Knife
+    class Cloud
+      class ServerListCommand < ResourceListCommand
+        
+        def before_exec_command
+          if config[:chef_data]
+            begin
+              # Chef::Node.list(inflate = true) to use Solr search.
+              @node_list = Chef::Node.list(true)
+            rescue Errno::ECONNREFUSED => e
+              error_message = "Connection error with Chef server. #{e}"
+              ui.warn(error_message)
+              raise CloudExceptions::ChefServerError, error_message
+            end
+            
+            @chef_data_col_info = [
+              {:label => 'Chef Node Name', :key => 'name'},
+              {:label => 'Environment', :key => 'chef_environment'},
+              {:label => 'FQDN', :key => 'fqdn'},
+              {:label => 'Runlist', :key => 'run_list'},
+              {:label => 'Tags', :key => 'tags'},
+              {:label => 'Platform', :key => 'platform'},
+            ]
+
+            if config[:chef_node_attribute]
+              @chef_data_col_info << {:label => "#{config[:chef_node_attribute]}", :key => "#{config[:chef_node_attribute]}"}
+            end
+            @columns_with_info.concat(@chef_data_col_info)
+          end
+        end
+
+        # Override from base to display chef node data along with server list display.
+        def get_resource_col_val(server)
+          list = []
+          @columns_with_info.each do |col_info|
+            if config[:chef_data] && @chef_data_col_info.include?(col_info)
+              server_name = service.get_server_name(server)
+              if @node_list.include?(server_name)
+                node =  @node_list[server_name]
+                # Raise serverlisting error on invalid chef_node_attribute.
+                if col_info[:key] == config[:chef_node_attribute] && ! node.attribute?(col_info[:key])
+                  error_message = "The Node does not have a #{col_info[:key]} attribute."
+                  ui.error(error_message)
+                  raise CloudExceptions::CloudAPIException, error_message
+                else
+                  value = (col_info[:value_callback].nil? ? node.send(col_info[:key]).to_s : col_info[:value_callback].call(node.send(col_info[:key])))
+                end
+              else
+                # Set chef data value for those server which is not part chef server.
+                value = ""
+              end
+            else
+              value = (col_info[:value_callback].nil? ? server.send(col_info[:key]).to_s : col_info[:value_callback].call(server.send(col_info[:key])))
+            end
+            list << value
+          end
+          list
+        end
+
+        def query_resource
+          @service.list_servers
+        end
+
+        def format_server_state(state)
+           state = state.to_s.downcase
+           state_color =  case state
+                          when 'shutting-down','terminated','stopping','stopped','error','shutoff'
+                            :red
+                          when 'pending','build','paused','suspended','hard_reboot'
+                            :yellow
+                          else
+                            :green
+                          end
+            ui.color(state, state_color)              
+        end
+
+      end # class ServerListCommand
+    end
+  end
+end

data/lib/chef/knife/cloud/server/list_options.rb

@@ -0,0 +1,43 @@
+#
+# Author:: Siddheshwar More (<siddheshwar.more@clogeny.com>)
+# Copyright:: Copyright (c) 2013 Opscode, 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.
+#
+
+class Chef
+  class Knife
+    class Cloud
+      module ServerListOptions
+        def self.included(includer)
+          includer.class_eval do
+
+            option :chef_data,
+              :long => "--chef-data",
+              :boolean => true,
+              :default => false,
+              :description => "Display chef node data which include chef node name, environment name, fqdn, platform, runlist and tags."
+
+            option :chef_node_attribute,
+              :long => "--chef-node-attribute CHEF_NODE_ATTRIBUTE_NAME",
+              :description => "Used with --chef-data option. It display node attributes details by adding new column in server list display.",
+              :proc => Proc.new { |i| Chef::Config[:knife][:chef_node_attribute] = i }
+              
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/chef/knife/cloud/server/options.rb

@@ -0,0 +1,39 @@
+#
+# Author:: Kaustubh Deorukhkar (<kaustubh@clogeny.com>)
+# Copyright:: Copyright (c) 2013 Opscode, 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.
+#
+
+class Chef
+  class Knife
+    class Cloud
+      module ServerOptions
+        def self.included(includer)
+          includer.class_eval do
+            option :chef_node_name,
+              :short => "-N NAME",
+              :long => "--node-name NAME",
+              :description => "The name of the node and client to delete, if it differs from the server name. Only has meaning when used with the '--purge' option."
+
+            option :custom_attributes,
+              :long => "--custom-attributes CUSTOM_ATTRIBUTES",
+              :description => "Custom attributes to be passed to Fog.",
+              :proc => Proc.new {|args| Chef::Config[:knife][:custom_attributes] =  args.split(';').map{|keys| keys.split('=')}.map{|j| Hash[*j.map{|k| k.strip}]}}  
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/cloud/server/show_command.rb

@@ -0,0 +1,55 @@
+#
+# Copyright:: Copyright (c) 2013 Opscode, 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.
+#
+
+require 'chef/knife/cloud/command'
+require 'chef/knife/cloud/exceptions'
+
+class Chef
+  class Knife
+    class Cloud
+      class ServerShowCommand < Command
+
+        def initialize(argv=[])
+          super argv
+          # columns_with_info is array of hash with label, key and attribute extraction callback, ex [{:label => "Label text", :key => 'key', value_callback => callback_method to extract/format the required value}, ...]
+          @columns_with_info = []
+        end
+
+        def validate_params!
+          errors = []
+          config[:instance_id] = @name_args.first
+          if locate_config_value(:instance_id).nil?
+            errors << "You must provide a valid Instance Id"
+          end
+          error_message = ""
+          raise CloudExceptions::ValidationError, error_message if errors.each{|e| ui.error(e); error_message = "#{error_message} #{e}."}.any?
+        end
+
+        def execute_command
+          server = service.get_server(locate_config_value(:instance_id))
+          if server.nil?
+            error_message = "Server doesn't exists for this #{locate_config_value(:instance_id)} instance id."
+            ui.error(error_message)
+            raise CloudExceptions::ServerShowError, error_message
+          else
+            service.server_summary(server, @columns_with_info)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/cloud/server/show_options.rb

@@ -0,0 +1,36 @@
+#
+# Copyright:: Copyright (c) 2013 Opscode, 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.
+#
+
+class Chef
+  class Knife
+    class Cloud
+      module ServerShowOptions
+        def self.included(includer)
+          includer.class_eval do
+
+            option :instance_id,
+              :long => "--instance-id INSTANCE_ID",
+              :description => "Required. Instance Id of Server",
+              :proc => Proc.new { |i| Chef::Config[:knife][:instance_id] = i }
+              
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/chef/knife/cloud/service.rb

@@ -0,0 +1,91 @@
+#
+# Author:: Kaustubh Deorukhkar (<kaustubh@clogeny.com>)
+# Copyright:: Copyright (c) 2013 Opscode, 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.
+#
+
+require 'chef/knife/cloud/exceptions'
+require "chef/knife/cloud/helpers"
+
+class Chef
+  class Knife
+    class Cloud
+      class Service
+        include Cloud::Helpers
+        attr_accessor :ui
+
+        def initialize(options = {})
+          @auth_params = options[:auth_params]
+        end
+
+        def connection
+          # Fog or cloud specific connection object must be created in derived.
+          raise Chef::Exceptions::Override, "You must override connection in #{self.to_s}"
+        end
+
+        # override in cloud specific derived classes
+        def list_resource_allocations
+        end
+
+        # Do nothing or override in cloud specific derived classes for pre-vm-creation setup steps
+        def create_server_dependencies
+        end
+
+        # Do nothing or override in cloud specific derived classes for pre-vm-creation setup steps
+        def delete_server_dependencies
+        end
+
+        def delete_server_on_failure(server = nil)
+          raise Chef::Exceptions::Override, "You must override delete_server_on_failure in #{self.to_s} to delete server"
+        end
+
+        # cloud server specific implementation methods for commands.
+        def create_server(options = {})
+          raise Chef::Exceptions::Override, "You must override create_server in #{self.to_s}"
+        end
+
+        def delete_server(server_name)
+          raise Chef::Exceptions::Override, "You must override delete_server in #{self.to_s}"
+        end
+
+        def list_servers
+          raise Chef::Exceptions::Override, "You must override list_servers in #{self.to_s}"
+        end
+
+        def list_images(image_filters)
+          raise Chef::Exceptions::Override, "You must override list_images in #{self.to_s}"
+        end
+
+        def list_resource_configurations
+          raise Chef::Exceptions::Override, "You must override list_resource_configurations in #{self.to_s}"
+        end
+
+        def get_server(server_name)
+          raise Chef::Exceptions::Override, "You must override get_server in #{self.to_s}"
+        end
+
+        def server_summary(server, columns_with_info = [])
+          raise Chef::Exceptions::Override, "You must override server_summary in #{self.to_s}"
+        end
+
+        def add_custom_attributes(server_def)
+          Chef::Config[:knife][:custom_attributes].map{|args| args.map{|k,v| server_def.merge!(k.to_sym => v)}} unless Chef::Config[:knife][:custom_attributes].nil?
+        end
+
+      end # class service
+    end
+  end
+end
+

data/lib/knife-cloud/version.rb

@@ -0,0 +1,6 @@
+module Knife
+  module Cloud
+    VERSION = "1.0.0.rc.0"
+    MAJOR, MINOR, TINY = VERSION.split('.')
+  end
+end

data/lib/test/fixtures/knife.rb

@@ -0,0 +1,9 @@
+current_dir = File.dirname(__FILE__)
+node_name                "chef0"
+client_key               "#{current_dir}/validation.pem"
+validation_client_name   "validation"
+validation_key           "#{current_dir}/validation.pem"
+chef_server_url          "http://localhost:8889"
+cache_type               'BasicFile'
+cache_options( :path => "#{ENV['HOME']}/.chef/checksums" )
+cookbook_path            ["#{current_dir}/chef-repo/cookbooks"]

data/lib/test/fixtures/validation.pem

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEogIBAAKCAQEA7TfhToresZudM5gaBfzM/eHrGuJtN8uMaG51fLk9rNVwOxIw
+eb9AmWJSQgftRj4AJSnt8Jv+QyAafjg79rEmCpd2K+toN1fXiVsf/ld/VdMI5vCd
+usJc8aC4OFIVrLetm9eq+joXiCSLfEYP1w4d1gc9wqr54rnGVgQdWv31NhqXX7Tl
+2bHRoEsfIFM7Vr5zC9Rv6XEtrwezSpzQ+ru707UOCOHNnH1TDxNDz+L71xJnGXD6
+uh596hVm2GiXJ8lyCVJTs/RZ+HKtRuxYOJztdCQAXbd6DDjTBax/cCEzzoxK/LMc
+1K/zWCKN8yM/XpiFqNuBB0yrqS5Y4zlROY0ssQIDAQABAoIBAQDmC1HYvD1YGePq
+O+/IrK8S6jr4WGq4OBIS2EPhTzbrXBU5g9s0xe7ckIfa9xr4CnpTkATqWCzMZd6r
+Vtd31bVhgh6cWu829F3WG2O8YJfg4AX7B46+pWxC+qyMGbZhR8L5pb1ualWVtnL6
+cms8D7mJbH5NQUeRwrz/f4AEVNGuw165PhglXnRq3zxs97jdNH6av0na1VLAmUeR
+vmYToLoIsK5yLeNzMfRRrQkq4ndUvad2ahqsz+p/xUjfYneBz4uujE/PcCgi423Q
+FMH1NtPpzmuZuABU53wUMW4BXsSGv+34UMhRTazcBPRBYjKT6l6F7Tt9wPFxrtVn
+KYI9dI0tAoGBAPzBwLsUuyEJtSd2zW63f7EhhG/2rSBm1g9Bcs1sHZtXIX3JN51X
+hd+ckXQcLgQYn8syGW1+WcuaHGyp7v3G0yr6b38FWwEnmD85Mq5da1dyio2udBdK
+Xm8MfY94yP8qSH3bUDKEl+cV9X5rtzbQAorMXb/Qkc4vErWfABVBKeLPAoGBAPBD
+FjGxER9YU4hFV2vn5qElfxa799Vl0uSvao0lSkTpA/sHFxAkRQc/mo1PBClaH0ba
+Hqr141o5pGUDgLqpO3kEY5vYBOaFXLFdFCcL+1YUR6t0bX+WCHuq21Cs6Gu4+qNA
+D4dpsSPDXfatyXWM5PF2d4FwO2XnL25Yt+rg6dh/AoGAbEfk9UCQWjr6bImswH3E
+KnIddonK6VKk6aw0LmTe2imdo3GMbc+M/prohUF9RSv3aOlxk0LJ3TuMadDzHa0L
+0iGvmk8FCZ2Yz50FZUWIMtJTIRdXjJLDmfdT4x7vnMDUhXZrCPlcyhbSMPKcbtL2
+A9hBYWdMz3PDJCOVuYVNGGkCgYEAhSxKUwTYfs1Qj8oPqOoDdfL4vLs3pfsoqEVr
+BA1VW1jlMfE+IV5ZPKlOm2De56TijT09nnloqYwlyS/l3JENPAjoxWs5XCUzucPj
+9bi4eYAIMcr5Hq0kypdrtQ4CTiNcGbzaXq6A11fk72RotFWCWSzXFNIGuncoXTuj
+xfcg5zUCf3TQrwpcBB1Hf9hm6lUVpptvUZJAQtkWoaWXUPRY0CjcVdDc5ak4xqL2
+FcAuJwV95b3qLyPESJ8zUBLOg3DcT1X9mrvRuKgC/Ie6k4R+oxU/nXi4vsPXlvg4
+yap6MUYSjPOa7eCrhg2zFZiqO6VLEogPc1nsjb9Zl2UWLLYyCVz=
+-----END RSA PRIVATE KEY-----

data/lib/test/knife-utils/helper.rb

@@ -0,0 +1,39 @@
+require "securerandom"
+require 'tmpdir'
+require 'fileutils'
+require File.expand_path(File.dirname(__FILE__) + '/knife_test_utils')
+require File.expand_path(File.dirname(__FILE__) + '/matchers')
+
+module KnifeTestHelper
+  extend RSpec::KnifeTestUtils
+  def temp_dir
+    @_temp_dir ||= Dir.mktmpdir
+  end
+
+  def match_status(test_run_expect)
+    if "#{test_run_expect}" == "should fail"
+      should_not have_outcome :status => 0
+    elsif "#{test_run_expect}" == "should succeed"
+      should have_outcome :status => 0
+    elsif "#{test_run_expect}" == "should return empty list"
+      should have_outcome :status => 0
+    else
+      should have_outcome :status => 0
+    end
+  end
+
+  def match_stdout(test_run_expect)
+    should have_outcome :stdout => test_run_expect
+  end
+
+  def create_file(file_dir, file_name, data_to_write_file_path)
+    puts "Creating: #{file_name}"
+    begin
+      data_to_write = File.read(File.expand_path("#{data_to_write_file_path}", __FILE__))
+      File.open("#{file_dir}/#{file_name}", 'w') {|f| f.write(data_to_write)}
+    rescue
+      puts "Error while creating file - #{file_name}"
+    end
+  end
+  
+end

data/lib/test/knife-utils/knife_test_utils.rb

@@ -0,0 +1,40 @@
+require 'mixlib/shellout'
+
+module RSpec
+  module KnifeTestUtils
+
+    def self.included(base)
+      base.class_eval do
+        subject { knife_run }
+        let(:knife_run) { run command }
+        let(:command)   { fail 'Define let(:command) in the spec' }
+        let(:cmd_output) { @op }
+      end
+    end
+    
+    # Convenience method for actually running a knife command in our
+    # testing repository.  Returns the Mixlib::Shellout object ready for
+    # inspection.
+    def run(command_line)
+      shell_out = Mixlib::ShellOut.new("#{command_line}")
+      shell_out.timeout = 3000
+      shell_out.tap(&:run_command)
+      @op = shell_out.exitstatus == 1 ? shell_out.stderr : shell_out.stdout
+      return shell_out
+    end
+
+    def knife(knife_command)
+      run "knife #{knife_command}"
+    end
+
+    # Convenience function for grabbing a hash of several important
+    # Mixlib::Shellout command configuration parameters.
+    def self.command_setting(shellout_command)
+      keys = [:cwd, :user, :group, :umask, :timeout, :valid_exit_codes, :environment]
+      keys.inject({}) do |hash, attr|
+        hash[attr] = shellout_command.send(attr)
+        hash
+      end
+    end
+  end
+end