(PUP-11078) Puppet generate should return non-zero when failing

Previously, puppet generate would return an exit code with the value of
0 even when failing to generate a new custom type.
```
> puppet generate types
Notice: Generating Puppet resource types.
Error: <envpath>/modules/my_module/lib/puppet/type/my_module.rb: title patterns that use procs are not supported.
> echo $?
0
```
This commit fixes this issue by creating a new Puppet::Generator method
that checks whether a type has raised an error or not. Since we want to
continue checking inputs even if one has failed, this comes in handy
since we can exit at the end of the run, keeping the functionality the
same.

Author: BobosilaVictor

lib/puppet/face/generate.rb

@@ -58,6 +58,8 @@
       Puppet::FileSystem::mkpath(outputdir)
 
       generator.generate(inputs, outputdir, options[:force])
+
+      exit(1) if generator.bad_input?
       nil
     end
   end

lib/puppet/generate/type.rb

@@ -134,6 +134,9 @@ def self.find_inputs(format = :pcore, environment = Puppet.lookup(:current_envir
         inputs.sort_by! { |input| input.path }
       end
 
+      def self.bad_input?
+        @bad_input
+      end
       # Generates files for the given inputs.
       # If a file is up to date (newer than input) it is kept.
       # If a file is out of date it is regenerated.
@@ -170,6 +173,8 @@ def self.generate(inputs, outputdir = nil, force = false)
         }
 
         up_to_date = true
+        @bad_input = false
+
         Puppet.notice _('Generating Puppet resource types.')
         inputs.each do |input|
           if !force && input.up_to_date?(outputdir)
@@ -187,6 +192,7 @@ def self.generate(inputs, outputdir = nil, force = false)
             raise
           rescue Exception => e
             # Log the exception and move on to the next input
+            @bad_input = true
             Puppet.log_exception(e, _("Failed to load custom type '%{type_name}' from '%{input}': %{message}") % { type_name: type_name, input: input, message: e.message })
             next
           end
@@ -205,6 +211,7 @@ def self.generate(inputs, outputdir = nil, force = false)
           begin
             model = Models::Type::Type.new(type)
           rescue Exception => e
+            @bad_input = true
             # Move on to the next input
             Puppet.log_exception(e, "#{input}: #{e.message}")
             next
@@ -214,6 +221,7 @@ def self.generate(inputs, outputdir = nil, force = false)
           begin
             result = model.render(templates[input.template_path])
           rescue Exception => e
+            @bad_input = true
             Puppet.log_exception(e)
             raise
           end
@@ -227,6 +235,7 @@ def self.generate(inputs, outputdir = nil, force = false)
               file.write(result)
             end
           rescue Exception => e
+            @bad_input = true
             Puppet.log_exception(e, _("Failed to generate '%{effective_output_path}': %{message}") % { effective_output_path: effective_output_path, message: e.message })
             # Move on to the next input
             next

spec/unit/face/generate_spec.rb

@@ -221,6 +221,70 @@ module Puppet
       end
 
     end
+
+    context "in an environment with a faulty type" do
+      let(:dir) do
+        dir_containing('environments', { 'testing_generate2' => {
+          'environment.conf' => "modulepath = modules",
+          'manifests' => { 'site.pp' => "" },
+          'modules' => {
+            'm3' => {
+              'lib' => { 'puppet' => { 'type' => {
+                'test3.rb' => <<-EOF
+                module Puppet
+                Type.newtype(:test3) do
+                  @doc = "Docs for resource"
+                  def self.title_patterns
+                    identity = lambda {|x| x}
+                    [
+                      [
+                      /^(.*)_(.*)$/,
+                        [
+                          [:name, identity ]
+                        ]
+                      ]
+                    ]
+                  end
+                  newproperty(:message) do
+                    desc "Docs for 'message' property"
+                  end
+                  newparam(:name) do
+                    desc "Docs for 'name' parameter"
+                    isnamevar
+                  end
+                end; end
+                EOF
+               } }
+            }
+          }
+        }}})
+      end
+
+      let(:modulepath) do
+        File.join(dir, 'testing_generate2', 'modules')
+      end
+
+      let(:m3) do
+        File.join(modulepath, 'm3')
+      end
+
+      around(:each) do |example|
+        Puppet.settings.initialize_global_settings
+        Puppet[:manifest] = ''
+        loader = Puppet::Environments::Directories.new(dir, [])
+        Puppet.override(:environments => loader) do
+          Puppet.override(:current_environment => loader.get('testing_generate2')) do
+            example.run
+          end
+        end
+      end
+
+      it 'fails when using procs for title patterns' do
+        expect {
+          genface.types(:format => 'pcore')
+        }.to exit_with(1)
+      end
+    end
   end
 
   def from_an_interactive_terminal