(PUP-11430) Exclude legacy facts by default for Puppet 8

This PR excludes legacy facts by default by setting :include_legacy_facts to false and updates tests to reflect this behavior.

Author: AriaXLi

lib/puppet/defaults.rb

@@ -1720,7 +1720,7 @@ def self.initialize_default_settings!(settings)
     },
     :include_legacy_facts => {
       :type       => :boolean,
-      :default    => true,
+      :default    => false,
       :desc       => "Whether to include legacy facts when requesting a catalog. This
         option can be set to false provided all puppet manifests, hiera.yaml and hiera
         configuration layers no longer access legacy facts, such as `$osfamily`, and

spec/integration/application/agent_spec.rb

@@ -908,6 +908,13 @@ def copy_fixtures(sources, dest)
       # `Facter.resolve` to omit legacy facts
       Puppet::Node::Facts.indirection.terminus_class = :facter
 
+      # need to use `Facter::OptionStore.reset` in order to reset
+      # Facter::OptionStore since Facter.clear does not reset it.
+      # Specifically, Options[:show_legacy] needs to be reset to
+      # true for legacy facts test below
+      Facter.clear
+      Facter::OptionStore.reset
+
       facter_dir = File.join(custom_dir, 'facter')
       FileUtils.mkdir_p(facter_dir)
       File.write(File.join(facter_dir, 'custom.rb'), <<~END)
@@ -962,9 +969,10 @@ def mounts
       }
     end
 
-    it "includes legacy facts by default" do
+    it "can include legacy facts" do
       server.start_server(mounts: mounts) do |port|
         Puppet[:serverport] = port
+        Puppet[:include_legacy_facts] = true
 
         agent.command_line.args << '--test'
         expect {
@@ -978,10 +986,9 @@ def mounts
       end
     end
 
-    it "can exclude legacy facts" do
+    it "excludes legacy facts by default" do
       server.start_server(mounts: mounts) do |port|
         Puppet[:serverport] = port
-        Puppet[:include_legacy_facts] = false
 
         agent.command_line.args << '--test'
         expect {

spec/integration/node/facts_spec.rb

@@ -30,7 +30,7 @@
     it "should be able to delegate to the :facter terminus" do
       allow(Puppet::Node::Facts.indirection).to receive(:terminus_class).and_return(:facter)
 
-      expect(Facter).to receive(:to_hash).and_return("facter_hash")
+      expect(Facter).to receive(:resolve).and_return("facter_hash")
       facts = Puppet::Node::Facts.new("me")
       expect(Puppet::Node::Facts).to receive(:new).with("me", "facter_hash").and_return(facts)
 

spec/unit/indirector/facts/facter_spec.rb

@@ -63,7 +63,7 @@
     end
 
     it "should return the Facter facts as the values in the Facts instance" do
-      expect(Facter).to receive(:to_hash).and_return("one" => "two")
+      expect(Facter).to receive(:resolve).and_return("one" => "two")
       facts = @facter.find(@request)
       expect(facts.values["one"]).to eq("two")
     end