Merge pull request #8753 from joshcooper/write_catalog_summary_1042

(PUP-1042) Add setting for puppet apply to write catalog summary

Author: GabrielNagy

lib/puppet/application/agent.rb

@@ -334,6 +334,10 @@ def help
   specifying a time of 0.
   (This is a Puppet setting, and can go in puppet.conf.)
 
+* --write_catalog_summary
+  After compiling the catalog saves the resource list and classes list to the node
+  in the state directory named classes.txt and resources.txt
+  (This is a Puppet setting, and can go in puppet.conf.)
 
 EXAMPLE
 -------

lib/puppet/application/apply.rb

@@ -16,7 +16,9 @@ class Puppet::Application::Apply < Puppet::Application
   option("--use-nodes")
   option("--detailed-exitcodes")
 
-  option("--write-catalog-summary")
+  option("--write-catalog-summary") do |arg|
+    Puppet[:write_catalog_summary] = arg
+  end
 
   option("--catalog catalog",  "-c catalog") do |arg|
     options[:catalog] = arg
@@ -169,6 +171,7 @@ def help
   def app_defaults
     super.merge({
       :default_file_terminus => :file_server,
+      :write_catalog_summary => false
     })
   end
 
@@ -247,7 +250,22 @@ def main
 
         catalog.retrieval_duration = Time.now - starttime
 
-        if options[:write_catalog_summary]
+        # We accept either the global option `--write_catalog_summary`
+        # corresponding to the new setting, or the application option
+        # `--write-catalog-summary`. The latter is needed to maintain backwards
+        # compatibility.
+        #
+        # Puppet settings parse global options using PuppetOptionParser, but it
+        # only recognizes underscores, not dashes.
+        # The base application parses app specific options using ruby's builtin
+        # OptionParser. As of ruby 2.4, it will accept either underscores or
+        # dashes, but prefer dashes.
+        #
+        # So if underscores are used, the PuppetOptionParser will parse it and
+        # store that in Puppet[:write_catalog_summary]. If dashes are used,
+        # OptionParser will parse it, and set Puppet[:write_catalog_summary]. In
+        # either case, settings will contain the correct value.
+        if Puppet[:write_catalog_summary]
           catalog.write_class_file
           catalog.write_resource_file
         end

lib/puppet/configurer.rb

@@ -118,8 +118,11 @@ def convert_catalog(result, duration, facts, options = {})
       catalog = result.to_ral
       catalog.finalize
       catalog.retrieval_duration = duration
-      catalog.write_class_file
-      catalog.write_resource_file
+
+      if Puppet[:write_catalog_summary]
+        catalog.write_class_file
+        catalog.write_resource_file
+      end
     end
     options[:report].add_times(:convert_catalog, catalog_conversion_time) if options[:report]
 

lib/puppet/defaults.rb

@@ -1638,6 +1638,12 @@ def self.initialize_default_settings!(settings)
       :mode => "0750",
       :desc => "The directory in which serialized data is stored on the client."
     },
+    :write_catalog_summary => {
+      :default => true,
+      :type => :boolean,
+      :desc => "Whether to write the `classfile` and `resourcefile` after applying
+        the catalog. It is enabled by default, except when running `puppet apply`.",
+    },
     :classfile => {
       :default => "$statedir/classes.txt",
       :type => :file,