Merge pull request #662 from domcleal/validate-string-undef

Permit undef passed as `nil` to validate_string

Author: DavidS

lib/puppet/parser/functions/validate_string.rb

@@ -30,7 +30,7 @@ module Puppet::Parser::Functions
     end
 
     args.each do |arg|
-      unless arg.is_a?(String)
+      unless arg.is_a?(String) || arg.nil?
         raise Puppet::ParseError, ("#{arg.inspect} is not a string.  It looks to be a #{arg.class}")
       end
     end

spec/acceptance/is_string_spec.rb

@@ -95,6 +95,17 @@
         expect(r.stdout).to match(/Notice: output correct/)
       end
     end
+    it 'is_strings undef' do
+      pp = <<-EOS
+      $a = undef
+      $o = is_string($a)
+      notice(inline_template('is_string is <%= @o.inspect %>'))
+      EOS
+
+      apply_manifest(pp, :catch_failures => true) do |r|
+        expect(r.stdout).to match(/is_string is true/)
+      end
+    end
   end
   describe 'failure' do
     it 'handles improper argument counts'

spec/acceptance/validate_string_spec.rb

@@ -20,6 +20,13 @@
 
       apply_manifest(pp, :catch_failures => true)
     end
+    it 'validates undef' do
+      pp = <<-EOS
+      validate_string(undef)
+      EOS
+
+      apply_manifest(pp, :catch_failures => true)
+    end
     it 'validates a non-string' do
       {
         %{validate_string({ 'a' => 'hash' })} => "Hash",

spec/aliases/string_spec.rb

@@ -6,6 +6,7 @@
       [
         '',
         'one',
+        nil,
       ].each do |value|
         describe value.inspect do
           let(:params) {{ value: value }}
@@ -23,7 +24,7 @@
       ].each do |value|
         describe value.inspect do
           let(:params) {{ value: value }}
-          it { is_expected.to compile.and_raise_error(/parameter 'value' expects a Stdlib::Compat::String = String/) }
+          it { is_expected.to compile.and_raise_error(/parameter 'value' expects a String/) }
         end
       end
     end

spec/functions/validate_string_spec.rb

@@ -18,6 +18,7 @@
 
     describe 'valid inputs' do
       it { is_expected.to run.with_params('') }
+      it { is_expected.to run.with_params(nil) }
       it { is_expected.to run.with_params('one') }
       it { is_expected.to run.with_params('one', 'two') }
     end

types/compat/string.pp

@@ -1,2 +1,2 @@
 # Emulate the is_string and validate_string functions
-type Stdlib::Compat::String = String
+type Stdlib::Compat::String = Optional[String]