Rackspace plugin uses new shell_out helper.

2 files changed, 212 insertions, 139 deletions

diff --git a/lib/ohai/plugins/rackspace.rb b/lib/ohai/plugins/rackspace.rb
index 18a6216e..52612120 100644
--- a/lib/ohai/plugins/rackspace.rb
+++ b/lib/ohai/plugins/rackspace.rb
@@ -40,7 +40,7 @@ Ohai.plugin(:Rackspace) do
     if so.exitstatus == 0
       so.stdout.strip.downcase == "rackspace"
     end
-  rescue Errno::ENOENT
+  rescue Ohai::Exceptions::Exec
     false
   end
 
@@ -91,7 +91,7 @@ Ohai.plugin(:Rackspace) do
         rackspace[:region] = line.split[2].delete('\"') if line =~ /^region/
       end
     end
-  rescue Errno::ENOENT
+  rescue Ohai::Exceptions::Exec
     Ohai::Log.debug("rackspace plugin: Unable to find xenstore-ls, cannot capture region information for Rackspace cloud")
     nil
   end
@@ -103,7 +103,7 @@ Ohai.plugin(:Rackspace) do
     if so.exitstatus == 0
       rackspace[:instance_id] = so.stdout.gsub(/instance-/, "")
     end
-  rescue Errno::ENOENT
+  rescue Ohai::Exceptions::Exec
     Ohai::Log.debug("rackspace plugin: Unable to find xenstore-read, cannot capture instance ID information for Rackspace cloud")
     nil
   end
@@ -127,7 +127,7 @@ Ohai.plugin(:Rackspace) do
       networks.delete_if { |hash| hash["label"] == "private" }
       networks.delete_if { |hash| hash["label"] == "public" }
     end
-  rescue Errno::ENOENT
+  rescue Ohai::Exceptions::Exec
     Ohai::Log.debug("rackspace plugin: Unable to capture custom private networking information for Rackspace cloud")
     nil
   end
diff --git a/spec/unit/plugins/rackspace_spec.rb b/spec/unit/plugins/rackspace_spec.rb
index 8fb42167..f8b64b95 100644
--- a/spec/unit/plugins/rackspace_spec.rb
+++ b/spec/unit/plugins/rackspace_spec.rb
@@ -20,110 +20,118 @@ require "resolv"
 require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper.rb")
 
 describe Ohai::System, "plugin rackspace" do
+  let(:plugin) { get_plugin("rackspace") }
+
   before(:each) do
     allow(Resolv).to receive(:getname).and_return("1.2.3.4")
-    @plugin = get_plugin("rackspace")
-    @plugin[:hostname] = "katie"
-    @plugin[:network] = { :interfaces => { :eth0 => { "addresses" => {
-      "1.2.3.4" => {
-        "broadcast" => "67.23.20.255",
-        "netmask" => "255.255.255.0",
-        "family" => "inet",
-      },
-      "2a00:1a48:7805:111:e875:efaf:ff08:75" => {
-        "family" => "inet6",
-        "prefixlen" => "64",
-        "scope" => "Global",
-      },
-      "fe80::4240:95ff:fe47:6eed" => {
-        "scope" => "Link",
-        "prefixlen" => "64",
-        "family" => "inet6",
-      },
-      "40:40:95:47:6E:ED" => {
-        "family" => "lladdr",
-      },
-      } },
-    },
-  }
-
-    @plugin[:network][:interfaces][:eth1] = { :addresses => {
-      "fe80::4240:f5ff:feab:2836" => {
-        "scope" => "Link",
-        "prefixlen" => "64",
-        "family" => "inet6",
-      },
-      "5.6.7.8" => {
-        "broadcast" => "10.176.191.255",
-        "netmask" => "255.255.224.0",
-        "family" => "inet",
-      },
-      "40:40:F5:AB:28:36" => {
-        "family" => "lladdr",
-      },
-    } }
+
+    plugin[:hostname] = "katie"
+
+    plugin[:network] = {
+      :interfaces => {
+        :eth0 => {
+          "addresses" => {
+            "1.2.3.4" => {
+              "broadcast" => "67.23.20.255",
+              "netmask" => "255.255.255.0",
+              "family" => "inet",
+            },
+            "2a00:1a48:7805:111:e875:efaf:ff08:75" => {
+              "family" => "inet6",
+              "prefixlen" => "64",
+              "scope" => "Global",
+            },
+            "fe80::4240:95ff:fe47:6eed" => {
+              "scope" => "Link",
+              "prefixlen" => "64",
+              "family" => "inet6",
+            },
+            "40:40:95:47:6E:ED" => {
+              "family" => "lladdr"
+            }
+          }
+        }
+      }
+    }
+
+    plugin[:network][:interfaces][:eth1] = {
+      :addresses => {
+        "fe80::4240:f5ff:feab:2836" => {
+          "scope" => "Link",
+          "prefixlen" => "64",
+          "family" => "inet6",
+        },
+        "5.6.7.8" => {
+          "broadcast" => "10.176.191.255",
+          "netmask" => "255.255.224.0",
+          "family" => "inet",
+        },
+        "40:40:F5:AB:28:36" => {
+          "family" => "lladdr"
+        }
+      }
+    }
 
     # In olden days we could detect rackspace by a -rscloud suffix on the kernel
     # This is here to make #has_rackspace_kernel? fail until we remove that check
-    @plugin[:kernel] = { :release => "1.2.13-not-rackspace" }
+    plugin[:kernel] = { :release => "1.2.13-not-rackspace" }
 
     # We need a generic stub here for the later stubs with arguments to work
     # Because, magic.
-    allow(@plugin).to receive(:shell_out).and_return(mock_shell_out(1, "", ""))
+    allow(plugin).to receive(:shell_out).and_return(mock_shell_out(1, "", ""))
   end
 
   shared_examples_for "!rackspace" do
-    it "should NOT create rackspace" do
-      @plugin.run
-      expect(@plugin[:rackspace]).to be_nil
+    it "does not create rackspace" do
+      plugin.run
+      expect(plugin[:rackspace]).to be_nil
     end
   end
 
   shared_examples_for "rackspace" do
-
-    it "should create rackspace" do
-      @plugin.run
-      expect(@plugin[:rackspace]).not_to be_nil
+    it "creates rackspace" do
+      plugin.run
+      expect(plugin[:rackspace]).not_to be_nil
     end
 
-    it "should have all required attributes" do
-      @plugin.run
-      expect(@plugin[:rackspace][:public_ip]).not_to be_nil
-      expect(@plugin[:rackspace][:private_ip]).not_to be_nil
-      expect(@plugin[:rackspace][:public_ipv4]).not_to be_nil
-      expect(@plugin[:rackspace][:local_ipv4]).not_to be_nil
-      expect(@plugin[:rackspace][:public_ipv6]).not_to be_nil
-      expect(@plugin[:rackspace][:local_ipv6]).to be_nil
-      expect(@plugin[:rackspace][:local_hostname]).not_to be_nil
-      expect(@plugin[:rackspace][:public_hostname]).not_to be_nil
+    it "has all required attributes" do
+      plugin.run
+      expect(plugin[:rackspace][:public_ip]).not_to be_nil
+      expect(plugin[:rackspace][:private_ip]).not_to be_nil
+      expect(plugin[:rackspace][:public_ipv4]).not_to be_nil
+      expect(plugin[:rackspace][:local_ipv4]).not_to be_nil
+      expect(plugin[:rackspace][:public_ipv6]).not_to be_nil
+      expect(plugin[:rackspace][:local_ipv6]).to be_nil
+      expect(plugin[:rackspace][:local_hostname]).not_to be_nil
+      expect(plugin[:rackspace][:public_hostname]).not_to be_nil
     end
 
-    it "should resolve hostname if reverse dns is set" do
+    it "resolves hostname if reverse dns is set" do
       allow(Resolv).to receive(:getname).and_return("1234.resolved.com")
-      @plugin.run
-      expect(@plugin[:rackspace][:public_hostname]).to eq("1234.resolved.com")
+      plugin.run
+      expect(plugin[:rackspace][:public_hostname]).to eq("1234.resolved.com")
     end
 
     [Resolv::ResolvError, Resolv::ResolvTimeout].each do |exception|
-      it "should return ip address when reverse dns returns exception: #{exception}" do
+      it "returns ip address when reverse dns returns exception: #{exception}" do
         allow(Resolv).to receive(:getname).and_raise(exception)
-        @plugin.run
-        expect(@plugin[:rackspace][:public_hostname]).to eq("1.2.3.4")
+        plugin.run
+        expect(plugin[:rackspace][:public_hostname]).to eq("1.2.3.4")
       end
     end
 
-    it "should have correct values for all attributes" do
-      @plugin.run
-      expect(@plugin[:rackspace][:public_ip]).to eq("1.2.3.4")
-      expect(@plugin[:rackspace][:private_ip]).to eq("5.6.7.8")
-      expect(@plugin[:rackspace][:public_ipv4]).to eq("1.2.3.4")
-      expect(@plugin[:rackspace][:local_ipv4]).to eq("5.6.7.8")
-      expect(@plugin[:rackspace][:public_ipv6]).to eq("2a00:1a48:7805:111:e875:efaf:ff08:75")
-      expect(@plugin[:rackspace][:local_hostname]).to eq("katie")
-      expect(@plugin[:rackspace][:public_hostname]).to eq("1.2.3.4")
+    it "has correct values for all attributes" do
+      plugin.run
+      expect(plugin[:rackspace][:public_ip]).to eq("1.2.3.4")
+      expect(plugin[:rackspace][:private_ip]).to eq("5.6.7.8")
+      expect(plugin[:rackspace][:public_ipv4]).to eq("1.2.3.4")
+      expect(plugin[:rackspace][:local_ipv4]).to eq("5.6.7.8")
+      expect(plugin[:rackspace][:public_ipv6]).to eq("2a00:1a48:7805:111:e875:efaf:ff08:75")
+      expect(plugin[:rackspace][:local_hostname]).to eq("katie")
+      expect(plugin[:rackspace][:public_hostname]).to eq("1.2.3.4")
     end
 
-    it "should capture region information" do
+    it "captures region information" do
       provider_data = <<-OUT
 provider = "Rackspace"
 service_type = "cloudServers"
@@ -131,21 +139,53 @@ server_id = "21301000"
 created_at = "2012-12-06T22:08:16Z"
 region = "dfw"
 OUT
-      allow(@plugin).to receive(:shell_out).with("xenstore-ls vm-data/provider_data").and_return(mock_shell_out(0, provider_data, ""))
-      @plugin.run
-      expect(@plugin[:rackspace][:region]).to eq("dfw")
+      allow(plugin).to receive(:shell_out).with("xenstore-ls vm-data/provider_data").and_return(mock_shell_out(0, provider_data, ""))
+      plugin.run
+      expect(plugin[:rackspace][:region]).to eq("dfw")
     end
 
-    it "should capture instance ID information" do
+    it "logs a debug message when region info cannot be collected" do
+      expect(plugin).
+        to receive(:shell_out).
+        with("xenstore-ls vm-data/provider_data").
+        and_raise(Ohai::Exceptions::Exec)
+
+      expect(Ohai::Log).
+        to receive(:debug).
+        with("rackspace plugin: Unable to find xenstore-ls, cannot capture " \
+             "region information for Rackspace cloud")
+
+      plugin.run
+
+      expect(plugin[:rackspace]).not_to have_key(:region)
+    end
+
+    it "captures instance ID information" do
       provider_data = "instance-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
-      allow(@plugin).to receive(:shell_out).with("xenstore-read name").and_return(mock_shell_out(0, provider_data, ""))
-      @plugin.run
-      expect(@plugin[:rackspace][:instance_id]).to eq("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
+      allow(plugin).to receive(:shell_out).with("xenstore-read name").and_return(mock_shell_out(0, provider_data, ""))
+      plugin.run
+      expect(plugin[:rackspace][:instance_id]).to eq("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
+    end
+
+    it "logs error if instance id cannot be found" do
+      expect(plugin).
+        to receive(:shell_out).
+        with("xenstore-read name").
+        and_raise(Ohai::Exceptions::Exec)
+
+      expect(Ohai::Log).
+        to receive(:debug).
+        with("rackspace plugin: Unable to find xenstore-read, cannot capture " \
+             "instance ID information for Rackspace cloud")
+
+      plugin.run
+
+      expect(plugin[:rackspace]).not_to have_key(:instance_id)
     end
   end
 
   describe "with rackspace cloud file" do
-    it_should_behave_like "rackspace"
+    it_behaves_like "rackspace"
 
     before(:each) do
       allow(Resolv).to receive(:getname).and_raise(Resolv::ResolvError)
@@ -160,34 +200,34 @@ OUT
     describe "with no public interfaces (empty eth0)" do
       before do
         # unset public (eth0) addresses
-        @plugin[:network][:interfaces][:eth0]["addresses"] = {}
+        plugin[:network][:interfaces][:eth0]["addresses"] = {}
       end
 
-      it "should have all required attributes" do
-        @plugin.run
+      it "has all required attributes" do
+        plugin.run
         # expliticly nil
-        expect(@plugin[:rackspace][:public_ip]).to be_nil
-        expect(@plugin[:rackspace][:public_ipv4]).to be_nil
-        expect(@plugin[:rackspace][:public_ipv6]).to be_nil
-        expect(@plugin[:rackspace][:public_hostname]).to be_nil
+        expect(plugin[:rackspace][:public_ip]).to be_nil
+        expect(plugin[:rackspace][:public_ipv4]).to be_nil
+        expect(plugin[:rackspace][:public_ipv6]).to be_nil
+        expect(plugin[:rackspace][:public_hostname]).to be_nil
         # per normal
-        expect(@plugin[:rackspace][:private_ip]).not_to be_nil
-        expect(@plugin[:rackspace][:local_ipv4]).not_to be_nil
-        expect(@plugin[:rackspace][:local_ipv6]).to be_nil
-        expect(@plugin[:rackspace][:local_hostname]).not_to be_nil
+        expect(plugin[:rackspace][:private_ip]).not_to be_nil
+        expect(plugin[:rackspace][:local_ipv4]).not_to be_nil
+        expect(plugin[:rackspace][:local_ipv6]).to be_nil
+        expect(plugin[:rackspace][:local_hostname]).not_to be_nil
       end
 
-      it "should have correct values for all attributes" do
-        @plugin.run
-        expect(@plugin[:rackspace][:private_ip]).to eq("5.6.7.8")
-        expect(@plugin[:rackspace][:local_ipv4]).to eq("5.6.7.8")
-        expect(@plugin[:rackspace][:local_hostname]).to eq("katie")
+      it "has correct values for all attributes" do
+        plugin.run
+        expect(plugin[:rackspace][:private_ip]).to eq("5.6.7.8")
+        expect(plugin[:rackspace][:local_ipv4]).to eq("5.6.7.8")
+        expect(plugin[:rackspace][:local_hostname]).to eq("katie")
       end
     end
   end
 
   describe "without cloud file" do
-    it_should_behave_like "!rackspace"
+    it_behaves_like "!rackspace"
 
     before(:each) do
       allow(File).to receive(:exist?).with("/etc/chef/ohai/hints/rackspace.json").and_return(false)
@@ -196,7 +236,7 @@ OUT
   end
 
   describe "with ec2 cloud file" do
-    it_should_behave_like "!rackspace"
+    it_behaves_like "!rackspace"
 
     before(:each) do
       allow(File).to receive(:exist?).with("/etc/chef/ohai/hints/ec2.json").and_return(true)
@@ -210,29 +250,60 @@ OUT
   end
 
   describe "xenstore provider returns rackspace" do
-    it_should_behave_like "rackspace"
+    it_behaves_like "rackspace"
 
     before(:each) do
       stdout = "Rackspace\n"
-      allow(@plugin).to receive(:shell_out).with("xenstore-read vm-data/provider_data/provider").and_return(mock_shell_out(0, stdout, "" ))
+      allow(plugin).to receive(:shell_out).with("xenstore-read vm-data/provider_data/provider").and_return(mock_shell_out(0, stdout, "" ))
     end
   end
 
   describe "xenstore provider does not return rackspace" do
-    it_should_behave_like "!rackspace"
+    it_behaves_like "!rackspace"
 
     before(:each) do
       stdout = "cumulonimbus\n"
-      allow(@plugin).to receive(:shell_out).with("xenstore-read vm-data/provider_data/provider").and_return(mock_shell_out(0, stdout, "" ))
+      allow(plugin).to receive(:shell_out).with("xenstore-read vm-data/provider_data/provider").and_return(mock_shell_out(0, stdout, "" ))
+    end
+  end
+
+  describe "xenstore provider does not exist" do
+    it_behaves_like "!rackspace"
+
+    before(:each) do
+      allow(plugin).
+        to receive(:shell_out).
+        with("xenstore-read vm-data/provider_data/provider").
+        and_raise(Ohai::Exceptions::Exec)
+    end
+  end
+
+  describe "when private networks shell out fails" do
+    it "logs an error and does not collect private_networks" do
+      allow(plugin).to receive(:hint?).with("rackspace").and_return(true)
+
+      expect(plugin).
+        to receive(:shell_out).
+        with("xenstore-ls vm-data/networking").
+        and_raise(Ohai::Exceptions::Exec)
+
+      expect(Ohai::Log).
+        to receive(:debug).
+        with("rackspace plugin: Unable to capture custom private networking " \
+             "information for Rackspace cloud")
+
+      plugin.run
+
+      expect(plugin[:rackspace]).not_to have_key(:private_networks)
     end
   end
 
   describe "does not have private networks" do
     before do
       stdout = 'BC764E20422B = "{"label": "public"}"\n'
-      allow(@plugin).to receive(:shell_out).with("xenstore-ls vm-data/networking").and_return(mock_shell_out(0, stdout, "" ))
+      allow(plugin).to receive(:shell_out).with("xenstore-ls vm-data/networking").and_return(mock_shell_out(0, stdout, "" ))
       stdout = '{"label": "public", "broadcast": "9.10.11.255", "ips": [{"ip": "9.10.11.12", "netmask": "255.255.255.0", "enabled": "1", "gateway": null}], "mac": "BC:76:4E:20:42:2B", "dns": ["69.20.0.164", "69.20.0.196"], "gateway": null}'
-      allow(@plugin).to receive(:shell_out).with("xenstore-read vm-data/networking/BC764E20422B").and_return(mock_shell_out(0, stdout, "" ))
+      allow(plugin).to receive(:shell_out).with("xenstore-read vm-data/networking/BC764E20422B").and_return(mock_shell_out(0, stdout, "" ))
 
       allow(File).to receive(:exist?).with("/etc/chef/ohai/hints/rackspace.json").and_return(true)
       allow(File).to receive(:read).with("/etc/chef/ohai/hints/rackspace.json").and_return("")
@@ -240,33 +311,35 @@ OUT
       allow(File).to receive(:read).with('C:\chef\ohai\hints/rackspace.json').and_return("")
     end
 
-    it "should not have private_networks object" do
-      @plugin.run
-      expect(@plugin[:rackspace][:private_networks]).to eq([])
+    it "does not have private_networks object" do
+      plugin.run
+      expect(plugin[:rackspace][:private_networks]).to eq([])
     end
   end
 
   describe "has private networks" do
     before do
-      @plugin[:network][:interfaces][:eth2] = { :addresses => {
-        "fe80::be76:4eff:fe20:422b" => {
-          "scope" => "Link",
-          "prefixlen" => "64",
-          "family" => "inet6",
-       },
-        "9.10.11.12" => {
-          "broadcast" => "9.10.11.255",
-          "netmask" => "255.255.255.0",
-          "family" => "inet",
-        },
-        "BC:76:4E:20:42:2B" => {
-          "family" => "lladdr",
-        },
-      } }
+      plugin[:network][:interfaces][:eth2] = {
+        :addresses => {
+          "fe80::be76:4eff:fe20:422b" => {
+            "scope" => "Link",
+            "prefixlen" => "64",
+            "family" => "inet6",
+         },
+          "9.10.11.12" => {
+            "broadcast" => "9.10.11.255",
+            "netmask" => "255.255.255.0",
+            "family" => "inet",
+          },
+          "BC:76:4E:20:42:2B" => {
+            "family" => "lladdr"
+          }
+        }
+      }
       stdout = 'BC764E20422B = "{"label": "private-network"}"\n'
-      allow(@plugin).to receive(:shell_out).with("xenstore-ls vm-data/networking").and_return(mock_shell_out(0, stdout, "" ))
+      allow(plugin).to receive(:shell_out).with("xenstore-ls vm-data/networking").and_return(mock_shell_out(0, stdout, "" ))
       stdout = '{"label": "private-network", "broadcast": "9.10.11.255", "ips": [{"ip": "9.10.11.12", "netmask": "255.255.255.0", "enabled": "1", "gateway": null}], "mac": "BC:76:4E:20:42:2B", "dns": ["69.20.0.164", "69.20.0.196"], "gateway": null}'
-      allow(@plugin).to receive(:shell_out).with("xenstore-read vm-data/networking/BC764E20422B").and_return(mock_shell_out(0, stdout, "" ))
+      allow(plugin).to receive(:shell_out).with("xenstore-read vm-data/networking/BC764E20422B").and_return(mock_shell_out(0, stdout, "" ))
 
       allow(File).to receive(:exist?).with("/etc/chef/ohai/hints/rackspace.json").and_return(true)
       allow(File).to receive(:read).with("/etc/chef/ohai/hints/rackspace.json").and_return("")
@@ -274,16 +347,16 @@ OUT
       allow(File).to receive(:read).with('C:\chef\ohai\hints/rackspace.json').and_return("")
     end
 
-    it "should private_networks object" do
-      @plugin.run
-      expect(@plugin[:rackspace][:private_networks]).not_to be_nil
+    it "has private_networks object" do
+      plugin.run
+      expect(plugin[:rackspace][:private_networks]).not_to be_nil
     end
 
-    it "should have correct values for all attributes" do
-      @plugin.run
-      expect(@plugin[:rackspace][:private_networks][0][:label]).to eq("private-network")
-      expect(@plugin[:rackspace][:private_networks][0][:broadcast]).to eq("9.10.11.255")
-      expect(@plugin[:rackspace][:private_networks][0][:mac]).to eq("BC:76:4E:20:42:2B")
+    it "has correct values for all attributes" do
+      plugin.run
+      expect(plugin[:rackspace][:private_networks][0][:label]).to eq("private-network")
+      expect(plugin[:rackspace][:private_networks][0][:broadcast]).to eq("9.10.11.255")
+      expect(plugin[:rackspace][:private_networks][0][:mac]).to eq("BC:76:4E:20:42:2B")
     end
 
   end