X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fhas_interface_with.rb;h=fb9af42eb9ac76898e481447584348c0b70674db;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=f6cb74b2b8655460609cec64f451d024cdb94388;hpb=6963202b4b62c2816655ac9532521b018fdf83bd;p=mirror%2Fdsa-puppet.git diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/has_interface_with.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/has_interface_with.rb index f6cb74b2b..fb9af42eb 100644 --- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/has_interface_with.rb +++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/has_interface_with.rb @@ -1,30 +1,31 @@ # # has_interface_with # - module Puppet::Parser::Functions - newfunction(:has_interface_with, :type => :rvalue, :doc => <<-EOS -Returns boolean based on kind and value: - * macaddress - * netmask - * ipaddress - * network + newfunction(:has_interface_with, :type => :rvalue, :doc => <<-DOC + @summary + Returns boolean based on kind and value. + + @return + boolean values `true` or `false` + + Valid kinds are `macaddress`, `netmask`, `ipaddress` and `network`. -has_interface_with("macaddress", "x:x:x:x:x:x") -has_interface_with("ipaddress", "127.0.0.1") => true -etc. + @example **Usage** + has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false` + has_interface_with("ipaddress", "127.0.0.1") # Returns `true` -If no "kind" is given, then the presence of the interface is checked: -has_interface_with("lo") => true - EOS - ) do |args| + @example If no "kind" is given, then the presence of the interface is checked: + has_interface_with("lo") # Returns `true` + DOC + ) do |args| - raise(Puppet::ParseError, "has_interface_with(): Wrong number of arguments given (#{args.size} for 1 or 2)") if args.size < 1 or args.size > 2 + raise(Puppet::ParseError, "has_interface_with(): Wrong number of arguments given (#{args.size} for 1 or 2)") if args.empty? || args.size > 2 interfaces = lookupvar('interfaces') # If we do not have any interfaces, then there are no requested attributes - return false if (interfaces == :undefined || interfaces.nil?) + return false if interfaces == :undefined || interfaces.nil? interfaces = interfaces.split(',') @@ -41,7 +42,7 @@ has_interface_with("lo") => true catch :undefined_variable do factval = lookupvar(kind) end - rescue Puppet::ParseError # Eat the exception if strict_variables = true is set + rescue Puppet::ParseError # rubocop:disable Lint/HandleExceptions : Eat the exception if strict_variables = true is set end if factval == value return true @@ -57,7 +58,7 @@ has_interface_with("lo") => true catch :undefined_variable do factval = lookupvar("#{kind}_#{iface}") end - rescue Puppet::ParseError # Eat the exception if strict_variables = true is set + rescue Puppet::ParseError # rubocop:disable Lint/HandleExceptions : Eat the exception if strict_variables = true is set end if value == factval result = true