Merge pull request #9471 from justinstoller/thats-rich

Author: joshcooper

lib/puppet.rb

@@ -237,7 +237,11 @@ def self.base_context(settings)
       :ssl_context => proc { Puppet.runtime[:http].default_ssl_context },
       :http_session => proc { Puppet.runtime[:http].create_session },
       :plugins => proc { Puppet::Plugins::Configuration.load_plugins },
-      :rich_data => false
+      :rich_data => Puppet[:rich_data],
+      # `stringify_rich` controls whether `rich_data` is stringified into a lossy format
+      # instead of a lossless format. Catalogs should not be stringified, though to_yaml
+      # and the resource application have uses for a lossy, user friendly format.
+      :stringify_rich => false
     }
   end
 

lib/puppet/application/resource.rb

@@ -146,7 +146,11 @@ def main
     # If the specified environment does not exist locally, fall back to the default (production) environment
     env = Puppet.lookup(:environments).get(Puppet[:environment]) || create_default_environment
 
-    Puppet.override(:current_environment => env, :loaders => Puppet::Pops::Loaders.new(env)) do
+    Puppet.override(
+      current_environment: env,
+      loaders: Puppet::Pops::Loaders.new(env),
+      stringify_rich: true
+    ) do
       type, name, params = parse_args(command_line.args)
 
       raise _("Editing with Yaml output is not supported") if options[:edit] and options[:to_yaml]

lib/puppet/resource.rb

@@ -112,7 +112,7 @@ def to_data_hash
     # To get stringified parameter values the flag :stringify_rich can be set
     # in the puppet context.
     #
-    stringify = Puppet.lookup(:stringify_rich) { false }
+    stringify = Puppet.lookup(:stringify_rich)
     converter = stringify ? Puppet::Pops::Serialization::ToStringifiedConverter.new : nil
 
     params = {}

spec/integration/application/apply_spec.rb

@@ -447,6 +447,12 @@ def bogus()
         Puppet[:strict] = :warning
       end
 
+      around :each do |test|
+        Puppet.override(rich_data: false) do
+          test.run
+        end
+      end
+
       it 'will notify a string that is the result of Regexp#inspect (from Runtime3xConverter)' do
         catalog = compile_to_catalog(execute, node)
         apply.command_line.args = ['--catalog', file_containing('manifest', catalog.to_json)]

spec/unit/application/resource_spec.rb

@@ -170,13 +170,6 @@ def string
       expect { @resource_app.main }.not_to raise_error
     end
 
-    it "should raise an error when printing yaml by default" do
-      @resource_app.options[:to_yaml] = true
-      allow(@resource_app.command_line).to receive(:args).and_return(['stringify', 'hello', 'ensure=present', 'string=asd'])
-      expect { @resource_app.main }.to raise_error( Puppet::PreformattedError,
-        /Stringify\[hello\]\['string'\] contains a Puppet::Util::Execution::ProcessOutput value. It will be converted to the String 'test'/)
-    end
-
     it "should ensure all values to be printed are in the external encoding" do
       resources = [
         Puppet::Type.type(:user).new(:name => "\u2603".force_encoding(Encoding::UTF_8)).to_resource,

spec/unit/resource/catalog_spec.rb

@@ -965,10 +965,15 @@ class {'multi_param_class':
 
     context 'and rich_data is disabled' do
       before(:each) do
-        Puppet[:rich_data] = false 
         Puppet[:strict] = :warning # do not want to stub out behavior in tests
       end
 
+      around(:each) do |test|
+        Puppet.override(rich_data: false) do
+          test.run
+        end
+      end
+
       let(:catalog_w_regexp)  { compile_to_catalog("notify {'foo': message => /[a-z]+/ }") }
 
       it 'should not generate rich value hash for parameter values that are not Data' do

spec/unit/resource_spec.rb

@@ -906,6 +906,27 @@ def inject_and_set_defaults(resource, scope)
     # Note: to_stringified_spec.rb has tests for all other data types
   end
 
+  describe 'when serializing resources' do
+    require 'puppet_spec/compiler'
+    include PuppetSpec::Compiler
+
+    it 'serializes rich data' do
+      resource = compile_to_catalog('notify {"foo": message => Deferred("func", ["a", "b", "c"])}')
+
+      # This assume rich_data is true by default
+      expect(resource.to_data_hash.class).to be(Hash)
+    end
+
+    it 'raises when rich data is disabled' do
+      resource = compile_to_catalog('notify {"foo": message => Deferred("func", ["a", "b", "c"])}')
+      expect {
+        Puppet.override(rich_data: false) do
+          resource.to_data_hash
+        end
+      }.to raise_error(Puppet::PreformattedError)
+    end
+  end
+
   describe "when converting from json" do
     before do
       @data = {