Contents

# frozen_string_literal: true
#
# Copyright:: Copyright 2020, Chef Software Inc.
# Author:: Tim Smith (<[e-mail]>)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
module RuboCop
  module Cop
    module Chef
      module ChefCorrectness
        # Use raise to force Chef Infra Client to fail instead of using Chef::Application.fatal, which masks the full stack trace of the failure and makes debugging difficult.
        #
        # @example
        #
        #   # bad
        #   Chef::Application.fatal!('Something horrible happened!')
        #
        #   # good
        #   raise "Something horrible happened!"
        #
        class ChefApplicationFatal < Base
          extend AutoCorrector

          MSG = 'Use raise to force Chef Infra Client to fail instead of using Chef::Application.fatal'

          def_node_matcher :application_fatal?, <<-PATTERN
            (send
              (const
                (const nil? :Chef) :Application) :fatal!
              $( ... ))
          PATTERN

          def on_send(node)
            application_fatal?(node) do |val|
              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                corrector.replace(node, "raise(#{val.source})")
              end
            end
          end
        end
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
cookstyle-6.19.5	lib/rubocop/cop/chef/correctness/chef_application_fatal.rb