(PUP-12077) Respect rich_data setting in base context

Since Puppet 6.0 "datafication" has inspected the context for the value
of rich_data. However, in only some code paths does the value in the
context get overridden with a value taken from the settings. This means
in some cases the rich_data value will always be true or always be
false, regardless of how the user has configured the rich_data setting.
And, in the case the simply calling `to_data_hash` on a resource the
rich_data value will always be false.

This updates the base_context to set rich_data to the settings value,
ensuring that the default value for rich_data in the context is the
value users have set.

Additional changes are primarily where tests still assumed the default
value of rich_data was false, with one exception - YAML serialization in
the resource application will break if the internal rich_data `__pcore`
values are output. This forces rich_data to be false for that code path
in the resource application.

Fixes GH #9470

Author: justinstoller

lib/puppet.rb

@@ -237,7 +237,7 @@ 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]
     }
   end
 

lib/puppet/application/resource.rb

@@ -155,7 +155,9 @@ def main
 
       if options[:to_yaml]
         data = resources.map do |resource|
-          resource.prune_parameters(:parameters_to_include => @extra_params).to_hiera_hash
+          Puppet.override(rich_data: false) do
+            resource.prune_parameters(:parameters_to_include => @extra_params).to_hiera_hash
+          end
         end.inject(:merge!)
         text = YAML.dump(type.downcase => data)
       else

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,11 +170,13 @@ def string
       expect { @resource_app.main }.not_to raise_error
     end
 
-    it "should raise an error when printing yaml by default" do
+    it "should raise an error when printing yaml if rich_data is off" 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'/)
+      Puppet.override(rich_data: false) do
+        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
     end
 
     it "should ensure all values to be printed are in the external encoding" do

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,26 @@ 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 'should do something' do
+      resource = compile_to_catalog('notify {"foo": message => Deferred("func", ["a", "b", "c"])}')
+
+      # This should be true by default
+      if Puppet[:rich_data]
+        expect(resource.to_data_hash.class).to be(Hash)
+      end
+
+      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 = {