Add digital_ocean ohai plugin

2 files changed, 292 insertions, 0 deletions

diff --git a/lib/ohai/plugins/digital_ocean.rb b/lib/ohai/plugins/digital_ocean.rb
new file mode 100644
index 00000000..e42be4f0
--- /dev/null
+++ b/lib/ohai/plugins/digital_ocean.rb
@@ -0,0 +1,81 @@
+#
+# Author:: Stafford Brunk (<stafford.brunk@gmail.com>)
+# 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 'ohai/util/ip_helper'
+
+Ohai.plugin(:DigitalOcean) do
+  include Ohai::Util::IpHelper
+
+  DIGITALOCEAN_FILE = '/etc/digitalocean'
+
+  provides "digital_ocean"
+
+  depends "network/interfaces"
+
+  def extract_droplet_ip_addresses
+    addresses = Mash.new({'v4' => [], 'v6' => []})
+    network[:interfaces].each_value do |iface|
+      iface[:addresses].each do |address, details|
+        next if loopback?(address) || details[:family] == 'lladdr'
+
+        ip = IPAddress(address)
+        type = digital_ocean_address_type(ip)
+        address_hash = build_address_hash(ip, details)
+        addresses[type] << address_hash
+      end 
+    end
+    addresses
+  end
+
+  def build_address_hash(ip, details)
+    address_hash = Mash.new({
+      'ip_address' => ip.address,
+      'type' => private_address?(ip.address) ? 'private' : 'public'
+    })
+
+    if ip.ipv4?
+      address_hash['netmask'] = details[:netmask]
+    elsif ip.ipv6?
+      address_hash['cidr'] = ip.prefix
+    end
+    address_hash
+  end
+
+  def digital_ocean_address_type(ip)
+    ip.ipv4? ? 'v4' : 'v6'
+  end
+
+  def looks_like_digital_ocean?
+    hint?('digital_ocean') || File.exist?(DIGITALOCEAN_FILE)
+  end
+
+  collect_data do
+    if looks_like_digital_ocean?
+      digital_ocean Mash.new
+      hint = hint?('digital_ocean') || {}
+      hint.each {|k, v| digital_ocean[k] = v unless k == 'ip_addresses'}
+
+      # Extract actual ip addresses
+      # The networks sub-hash is structured similarly to how
+      # Digital Ocean's v2 API structures things:
+      # https://developers.digitalocean.com/#droplets
+      digital_ocean[:networks] = extract_droplet_ip_addresses
+    else
+      Ohai::Log.debug("No hints present for digital_ocean.")
+      false
+    end
+  end
+end
diff --git a/spec/unit/plugins/digital_ocean_spec.rb b/spec/unit/plugins/digital_ocean_spec.rb
new file mode 100644
index 00000000..d73e1960
--- /dev/null
+++ b/spec/unit/plugins/digital_ocean_spec.rb
@@ -0,0 +1,211 @@
+#
+# Author:: Stafford Brunk (<stafford.brunk@gmail.com>)
+# 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 'ipaddress'
+require 'spec_helper'
+
+describe Ohai::System, "plugin digital_ocean" do
+  let(:hint_path_nix) { '/etc/chef/ohai/hints/digital_ocean.json' }
+  let(:hint_path_win) { 'C:\chef\ohai\hints/digital_ocean.json' }
+  let(:digitalocean_path) { '/etc/digitalocean' }
+  let(:hint) {
+    '{
+      "droplet_id": 12345678,
+      "name": "example.com",
+      "image_id": 3240036,
+      "size_id": 66,
+      "region_id": 4,
+      "ip_addresses": {
+        "public": "1.2.3.4",
+        "private": "5.6.7.8"
+      }
+    }'
+  }
+
+  before do
+    @plugin = get_plugin("digital_ocean")
+    @plugin[:network] = {
+      "interfaces"=> {
+        "eth0"=> {
+          "addresses"=> {
+            "1.2.3.4"=> {
+              "netmask"=> "255.255.255.0"
+            },
+            "2400:6180:0000:00d0:0000:0000:0009:7001"=> {}
+          }
+        }
+      }
+    }
+
+    File.stub(:exist?).with(hint_path_nix).and_return(true)
+    File.stub(:read).with(hint_path_nix).and_return(hint)
+    File.stub(:exist?).with(hint_path_win).and_return(true)
+    File.stub(:read).with(hint_path_win).and_return(hint)
+  end
+
+
+  shared_examples_for "!digital_ocean"  do
+    before(:each) do
+      @plugin.run
+    end
+
+    it "does not create the digital_ocean mash" do
+      @plugin[:digital_ocean].should be_nil
+    end
+  end
+
+  shared_examples_for "digital_ocean_networking" do
+    it "creates the networks attribute" do
+      @plugin[:digital_ocean][:networks].should_not be_nil
+    end
+
+    it "pulls ip addresses from the network interfaces" do
+      @plugin[:digital_ocean][:networks][:v4].should == [{"ip_address" => "1.2.3.4",
+                                                         "type" => "public",
+                                                         "netmask" => "255.255.255.0"}]
+      @plugin[:digital_ocean][:networks][:v6].should == [{"ip_address"=>"2400:6180:0000:00d0:0000:0000:0009:7001",
+                                                          "type"=>"public",
+                                                          "cidr"=>128}]
+    end
+  end
+
+  shared_examples_for "digital_ocean" do
+    before(:each) do
+      @plugin.run
+    end
+
+    it "creates a digital_ocean mash" do
+      @plugin[:digital_ocean].should_not be_nil
+    end
+
+    it "has all hint attributes" do
+      @plugin[:digital_ocean][:droplet_id].should_not be_nil
+      @plugin[:digital_ocean][:name].should_not be_nil
+      @plugin[:digital_ocean][:image_id].should_not be_nil
+      @plugin[:digital_ocean][:size_id].should_not be_nil
+      @plugin[:digital_ocean][:region_id].should_not be_nil
+    end
+
+    it "skips the ip_addresses hint attribute" do
+      @plugin[:digital_ocean][:ip_addresses].should be_nil
+    end
+
+    it "has correct values for all hint attributes" do
+      @plugin[:digital_ocean][:droplet_id].should == 12345678
+      @plugin[:digital_ocean][:name].should == "example.com"
+      @plugin[:digital_ocean][:image_id].should == 3240036
+      @plugin[:digital_ocean][:size_id].should == 66
+      @plugin[:digital_ocean][:region_id].should == 4
+    end
+
+    include_examples 'digital_ocean_networking'
+  end
+
+  describe "with digital_ocean hint file" do
+    before do
+      File.stub(:exist?).with(hint_path_nix).and_return(true)
+      File.stub(:exist?).with(hint_path_win).and_return(true)
+    end
+
+    context "without private networking enabled" do
+      it_should_behave_like "digital_ocean"
+    end
+
+    context "with private networking enabled" do
+      before do
+        @plugin[:network][:interfaces][:eth1] = {
+          "addresses"=> {
+            "10.128.142.89" => {
+              "netmask" => "255.255.255.0"
+            },
+            "fdf8:f53b:82e4:0000:0000:0000:0000:0053" => {}
+          }
+        }
+
+        @plugin.run
+      end
+
+      it "should extract the private networking ips" do
+        @plugin[:digital_ocean][:networks][:v4].should == [{"ip_address" => "1.2.3.4",
+                                                            "type" => "public",
+                                                            "netmask" => "255.255.255.0"},
+                                                            {"ip_address" => "10.128.142.89",
+                                                            "type" => "private",
+                                                            "netmask" => "255.255.255.0"}]
+        @plugin[:digital_ocean][:networks][:v6].should == [{"ip_address"=>"2400:6180:0000:00d0:0000:0000:0009:7001",
+                                                            "type"=>"public",
+                                                            "cidr"=>128},
+                                                           {"ip_address"=>"fdf8:f53b:82e4:0000:0000:0000:0000:0053",
+                                                            "type"=>"private",
+                                                            "cidr"=>128}]
+      end
+    end
+  end
+
+  describe "without digital_ocean hint file" do
+    before do
+      File.stub(:exist?).with(hint_path_nix).and_return(false)
+      File.stub(:exist?).with(hint_path_win).and_return(false)
+    end
+
+
+    describe "with the /etc/digitalocean file" do
+      before do
+        File.stub(:exist?).with(digitalocean_path).and_return(true)
+        @plugin.run
+      end
+      it_should_behave_like "digital_ocean_networking"
+    end
+
+    describe "without the /etc/digitalocean file" do
+      before do
+        File.stub(:exist?).with(digitalocean_path).and_return(false)
+      end
+      it_should_behave_like "!digital_ocean"
+    end
+  end
+
+  context "with ec2 hint file" do
+    let(:ec2_hint_path_nix) { '/etc/chef/ohai/hints/ec2.json' }
+    let(:ec2_hint_path_win) { 'C:\chef\ohai\hints/ec2.json' }
+
+    before do
+      File.stub(:exist?).with(hint_path_nix).and_return(false)
+      File.stub(:exist?).with(hint_path_win).and_return(false)
+
+      File.stub(:exist?).with(ec2_hint_path_nix).and_return(true)
+      File.stub(:read).with(ec2_hint_path_nix).and_return('')
+      File.stub(:exist?).with(ec2_hint_path_win).and_return(true)
+      File.stub(:read).with(ec2_hint_path_win).and_return('')
+    end
+
+    describe "with the /etc/digitalocean file" do
+      before do
+        File.stub(:exist?).with(digitalocean_path).and_return(true)
+        @plugin.run
+      end
+      it_should_behave_like "digital_ocean_networking"
+    end
+
+    describe "without the /etc/digitalocean file" do
+      before do
+        File.stub(:exist?).with(digitalocean_path).and_return(false)
+      end
+      it_should_behave_like "!digital_ocean"
+    end
+  end
+end