add exceptions to ohai/exception.rb

prein · Oct 29, 2013 · 4418bc0 · 4418bc0
1 parent 5ed9d01
commit 4418bc0
Show file tree

Hide file tree

Showing 10 changed files with 26 additions and 36 deletions.
diff --git a/lib/ohai.rb b/lib/ohai.rb
@@ -19,4 +19,4 @@
 require 'ohai/version'
 require 'ohai/config'
 require 'ohai/system'
-
+require 'ohai/exception'
diff --git a/lib/ohai/dsl/plugin.rb b/lib/ohai/dsl/plugin.rb
@@ -38,9 +38,6 @@ def self.strict_const_defined?(const)
     end
   end
 
-  class PluginDefinitionError < Exception
-  end
-
   def self.plugin(name, &block)
     plugin = nil
     if NamedPlugin.strict_const_defined?(name)
@@ -173,7 +170,7 @@ def self.depends(*attrs)
         def self.collect_data(platform = :default, *other_platforms, &block)
           [platform, other_platforms].flatten.each do |plat|
             if data_collector.has_key?(plat)
-              raise Ohai::PluginDefinitionError, "collect_data already defined on platform #{plat}"
+              raise Ohai::Exceptions::IllegalPluginDefinition, "collect_data already defined on platform #{plat}"
             else
               data_collector[plat] = block
             end

diff --git a/lib/ohai/exception.rb b/lib/ohai/exception.rb
@@ -19,5 +19,8 @@
 module Ohai
   module Exceptions
     class Exec < RuntimeError; end
+    class IllegalPluginDefinition < Exception; end
+    class AttributeNotFound < Exception; end
+    class DependencyCycle < Exception; end
   end
 end
diff --git a/lib/ohai/loader.rb b/lib/ohai/loader.rb
@@ -47,8 +47,8 @@ def load_plugin(plugin_path, plugin_name=nil)
           plugin = klass.new(@controller, plugin_path) unless klass.nil?
         rescue SystemExit, Interrupt
           raise
-        rescue PluginDefinitionError => e
-          Ohai::Log.warn("Plugin at #{plugin_path} is not properly defined: #{e.message}") 
+        rescue Ohai::Exceptions::IllegalPluginDefinition => e
+          Ohai::Log.warn("Plugin at #{plugin_path} is not properly defined: #{e.inspect}") 
         rescue NoMethodError => e
           Ohai::Log.warn("[UNSUPPORTED OPERATION] Plugin at #{plugin_path} used unsupported operation \'#{e.name.to_s}\'")
         rescue Exception, Errno::ENOENT => e

diff --git a/lib/ohai/runner.rb b/lib/ohai/runner.rb
@@ -20,12 +20,6 @@
 require 'ohai/dsl/plugin'
 
 module Ohai
-  class NoAttributeError < Exception
-  end
-
-  class DependencyCycleError < Exception
-  end
-
   class Runner
     # safe_run: set to true if this runner will run plugins in
     # safe-mode. default false.
@@ -45,7 +39,7 @@ def run_plugin(plugin, force = false)
         next if p.has_run? unless force
 
         if visited.include?(p)
-          raise DependencyCycleError, "Dependency cycle detected. Please refer to the following plugins: #{get_cycle(visited, p).join(", ") }"
+          raise Ohai::Exceptions::DependencyCycle, "Dependency cycle detected. Please refer to the following plugins: #{get_cycle(visited, p).join(", ") }"
         end
 
         dependency_providers = fetch_plugins(p.dependencies)
@@ -66,7 +60,8 @@ def fetch_plugins(attributes)
         attrs = @attributes
         parts = attribute.split('/')
         parts.each do |part|
-          raise NoAttributeError, "Cannot find plugin providing attribute \'#{attribute}\'" unless attrs[part]
+          next if part == Ohai::Mixin::OS.collect_os
+          raise Ohai::Exceptions::AttributeNotFound, "Cannot find plugin providing attribute \'#{attribute}\'" unless attrs[part]
           attrs = attrs[part]
         end
         plugins << attrs[:_plugins]

diff --git a/lib/ohai/system.rb b/lib/ohai/system.rb
@@ -70,12 +70,7 @@ def load_plugins
           if md
             plugin_name = md[1].gsub(File::SEPARATOR, "::")
             unless @v6_dependency_solver.has_key?(plugin_name)
-              begin
-                plugin = @loader.load_plugin(file, plugin_name)
-              rescue PluginDefinitionError => e
-                Ohai::Log.error("Encountered error while loading plugin #{file}: #{e.inspect}")
-                raise
-              end
+              plugin = @loader.load_plugin(file, plugin_name)
               @v6_dependency_solver[plugin_name] = plugin unless plugin.nil?
             else
               Ohai::Log.debug("Already loaded plugin at #{file}")
@@ -100,7 +95,7 @@ def run_plugins(safe = false, force = false)
       plugins = collect_plugins(@attributes)
       begin
         plugins.each { |plugin| @runner.run_plugin(plugin, force) }
-      rescue DependencyCycleError, NoAttributeError => e
+      rescue Ohai::Exceptions::AttributeNotFound, Ohai::Exceptions::DependencyCycle => e
         Ohai::Log.error("Encountered error while running plugins: #{e.inspect}")
         raise
       end

diff --git a/spec/ohai/dsl/plugin_spec.rb b/spec/ohai/dsl/plugin_spec.rb
@@ -207,7 +207,7 @@
           collect_data { }
           collect_data { }
         }
-      }.to raise_error(Ohai::PluginDefinitionError, /collect_data already defined/)
+      }.to raise_error(Ohai::Exceptions::IllegalPluginDefinition, /collect_data already defined/)
     end
 
     it "should fail if a platform has already been defined in another plugin file" do
@@ -216,7 +216,7 @@
         Ohai.plugin(@name) {
           collect_data { }
         }
-      }.to raise_error(Ohai::PluginDefinitionError, /collect_data already defined/)
+      }.to raise_error(Ohai::Exceptions::IllegalPluginDefinition, /collect_data already defined/)
     end
   end
 

diff --git a/spec/unit/loader_spec.rb b/spec/unit/loader_spec.rb
@@ -68,7 +68,7 @@
       plugin.version.should eql(:version7)
     end
 
-    it "should log a warning from PluginDefinitionError when plugin poorly defined" do
+    it "should log a warning when plugin poorly defined" do
       contents = <<EOF
 Ohai.plugin(:#{@name}) do
   collect_data(:darwin) do

diff --git a/spec/unit/runner_spec.rb b/spec/unit/runner_spec.rb
@@ -69,12 +69,12 @@
         @plugin = klass.new(@ohai, "/tmp/plugins/thing.rb")
       end
 
-      it "should raise a NoAttributeError" do
-        expect { @runner.run_plugin(@plugin) }.to raise_error(Ohai::NoAttributeError)
+      it "should raise Ohai::Excpetions::AttributeNotFound" do
+        expect { @runner.run_plugin(@plugin) }.to raise_error(Ohai::Exceptions::AttributeNotFound)
       end
 
       it "should not run the plugin" do
-        expect { @runner.run_plugin(@plugin) }.to raise_error(Ohai::NoAttributeError)
+        expect { @runner.run_plugin(@plugin) }.to raise_error(Ohai::Exceptions::AttributeNotFound)
         @plugin.has_run?.should be_false
       end
     end
@@ -251,10 +251,10 @@
       @plugin1, @plugin2 = @plugins
     end
 
-    it "should raise a DependencyCycleError" do
-      @runner.stub(:fetch_plugins).with(["thing"]).and_return([@plugin1])
-      @runner.stub(:fetch_plugins).with(["other"]).and_return([@plugin2])
-      expect { @runner.run_plugin(@plugin1) }.to raise_error(Ohai::DependencyCycleError)
+    it "should raise Ohai::Exceptions::DependencyCycle" do
+      @runner.stub(:fetch_providers).with(["thing"]).and_return([@plugin1])
+      @runner.stub(:fetch_providers).with(["other"]).and_return([@plugin2])
+      expect { @runner.run_plugin(@plugin1) }.to raise_error(Ohai::Exceptions::DependencyCycle)
     end
   end
 

diff --git a/spec/unit/system_spec.rb b/spec/unit/system_spec.rb
@@ -131,11 +131,11 @@
           @ohai.stub(:collect_plugins).and_return([plugin])
         end
 
-        describe "when a NoAttributeError is received" do
+        describe "when AttributeNotFound is received" do
           it "should write an error to Ohai::Log" do
-            @runner.stub(:run_plugin).and_raise(Ohai::NoAttributeError)
-            Ohai::Log.should_receive(:error).with(/NoAttributeError/)
-            expect { @ohai.run_plugins }.to raise_error(Ohai::NoAttributeError)
+            @runner.stub(:run_plugin).and_raise(Ohai::Exceptions::AttributeNotFound)
+            Ohai::Log.should_receive(:error).with(/Ohai::Exceptions::AttributeNotFound/)
+            expect { @ohai.run_plugins }.to raise_error(Ohai::Exceptions::AttributeNotFound)
           end
         end
       end