(#13974) Add predicate functions for interface facts

If one wishes to test if a host has a particular IP address (such as a floating
virtual address) or has an interface on a particular network (such as a
secondary management network), the facts that provide this information are
difficult to use within Puppet.

This patch addresses these needs by implementing functions
‘has_ip_address(value)’ and ‘has_ip_network(value)’. These functions look
through all interfaces for ipaddress_<interface> and network_<interface>
(respectively) having the requested <value>.

These functions are implemented on top of a lower-level predicate
function, ‘has_interface_with(kind, value)’, which iterates through the
interfaces in the ‘interfaces’ fact and checks the facts <kind>_<interface>
looking for <value>.

Additionally, the existence of a particular named interface can be checked for
by calling with only a single argument: has_interface_with(interface).

A Boolean is returned in all cases.

3 files changed, 139 insertions, 0 deletions

diff --git a/spec/unit/puppet/parser/functions/has_interface_with_spec.rb b/spec/unit/puppet/parser/functions/has_interface_with_spec.rb
new file mode 100755
index 0000000..c5264e4
--- /dev/null
+++ b/spec/unit/puppet/parser/functions/has_interface_with_spec.rb
@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby -S rspec
+require 'spec_helper'
+
+describe Puppet::Parser::Functions.function(:has_interface_with) do
+
+  let(:scope) do
+    PuppetlabsSpec::PuppetInternals.scope
+  end
+
+  # The subject of these examples is the method itself.
+  subject do
+    function_name = Puppet::Parser::Functions.function(:has_interface_with)
+    scope.method(function_name)
+  end
+
+  # We need to mock out the Facts so we can specify how we expect this function
+  # to behave on different platforms.
+  context "On Mac OS X Systems" do
+    before :each do
+      scope.stubs(:lookupvar).with("interfaces").returns('lo0,gif0,stf0,en1,p2p0,fw0,en0,vmnet1,vmnet8,utun0')
+    end
+    it 'should have loopback (lo0)' do
+      subject.call(['lo0']).should be_true
+    end
+    it 'should not have loopback (lo)' do
+      subject.call(['lo']).should be_false
+    end
+  end
+  context "On Linux Systems" do
+    before :each do
+      scope.stubs(:lookupvar).with("interfaces").returns('eth0,lo')
+      scope.stubs(:lookupvar).with("ipaddress").returns('10.0.0.1')
+      scope.stubs(:lookupvar).with("ipaddress_lo").returns('127.0.0.1')
+      scope.stubs(:lookupvar).with("ipaddress_eth0").returns('10.0.0.1')
+      scope.stubs(:lookupvar).with('muppet').returns('kermit')
+      scope.stubs(:lookupvar).with('muppet_lo').returns('mspiggy')
+      scope.stubs(:lookupvar).with('muppet_eth0').returns('kermit')
+    end
+    it 'should have loopback (lo)' do
+      subject.call(['lo']).should be_true
+    end
+    it 'should not have loopback (lo0)' do
+      subject.call(['lo0']).should be_false
+    end
+    it 'should have ipaddress with 127.0.0.1' do
+      subject.call(['ipaddress', '127.0.0.1']).should be_true
+    end
+    it 'should have ipaddress with 10.0.0.1' do
+      subject.call(['ipaddress', '10.0.0.1']).should be_true
+    end
+    it 'should not have ipaddress with 10.0.0.2' do
+      subject.call(['ipaddress', '10.0.0.2']).should be_false
+    end
+    it 'should have muppet named kermit' do
+      subject.call(['muppet', 'kermit']).should be_true
+    end
+    it 'should have muppet named mspiggy' do
+      subject.call(['muppet', 'mspiggy']).should be_true
+    end
+    it 'should not have muppet named bigbird' do
+      subject.call(['muppet', 'bigbird']).should be_false
+    end
+  end
+end
diff --git a/spec/unit/puppet/parser/functions/has_ip_address_spec.rb b/spec/unit/puppet/parser/functions/has_ip_address_spec.rb
new file mode 100755
index 0000000..5a68460
--- /dev/null
+++ b/spec/unit/puppet/parser/functions/has_ip_address_spec.rb
@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby -S rspec
+require 'spec_helper'
+
+describe Puppet::Parser::Functions.function(:has_ip_address) do
+
+  let(:scope) do
+    PuppetlabsSpec::PuppetInternals.scope
+  end
+
+  subject do
+    function_name = Puppet::Parser::Functions.function(:has_ip_address)
+    scope.method(function_name)
+  end
+
+  context "On Linux Systems" do
+    before :each do
+      scope.stubs(:lookupvar).with('interfaces').returns('eth0,lo')
+      scope.stubs(:lookupvar).with('ipaddress').returns('10.0.2.15')
+      scope.stubs(:lookupvar).with('ipaddress_eth0').returns('10.0.2.15')
+      scope.stubs(:lookupvar).with('ipaddress_lo').returns('127.0.0.1')
+    end
+
+    it 'should have primary address (10.0.2.15)' do
+      subject.call(['10.0.2.15']).should be_true
+    end
+
+    it 'should have lookupback address (127.0.0.1)' do
+      subject.call(['127.0.0.1']).should be_true
+    end
+
+    it 'should not have other address' do
+      subject.call(['192.1681.1.1']).should be_false
+    end
+
+    it 'should not have "mspiggy" on an interface' do
+      subject.call(['mspiggy']).should be_false
+    end
+  end
+end
diff --git a/spec/unit/puppet/parser/functions/has_ip_network_spec.rb b/spec/unit/puppet/parser/functions/has_ip_network_spec.rb
new file mode 100755
index 0000000..c3a289e
--- /dev/null
+++ b/spec/unit/puppet/parser/functions/has_ip_network_spec.rb
@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby -S rspec
+require 'spec_helper'
+
+describe Puppet::Parser::Functions.function(:has_ip_network) do
+
+  let(:scope) do
+    PuppetlabsSpec::PuppetInternals.scope
+  end
+
+  subject do
+    function_name = Puppet::Parser::Functions.function(:has_ip_network)
+    scope.method(function_name)
+  end
+
+  context "On Linux Systems" do
+    before :each do
+      scope.stubs(:lookupvar).with('interfaces').returns('eth0,lo')
+      scope.stubs(:lookupvar).with('network').returns(:undefined)
+      scope.stubs(:lookupvar).with('network_eth0').returns('10.0.2.0')
+      scope.stubs(:lookupvar).with('network_lo').returns('127.0.0.1')
+    end
+
+    it 'should have primary network (10.0.2.0)' do
+      subject.call(['10.0.2.0']).should be_true
+    end
+
+    it 'should have loopback network (127.0.0.0)' do
+      subject.call(['127.0.0.1']).should be_true
+    end
+
+    it 'should not have other network' do
+      subject.call(['192.168.1.0']).should be_false
+    end
+  end
+end
+