Sha256: c95fe5b6a8e79fdd261fe8f055f3b7c9675194d063073823f716e15fabf3a5a2

Contents?: true

Size: 1.75 KB

Versions: 13

Compression:

Stored size: 1.75 KB

Contents

#
# Copyright:: 2019, Chef Software, Inc.
# Author:: Tim Smith (<tsmith@chef.io>)
#
# 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
        # The Ohai default recipe previously allowed a user to ship custom Ohai plugins to a system by including them
        # in a directory in the Ohai cookbook. This functionality was replaced with the ohai_plugin resource, which
        # should be used instead as it doesn't require forking the ohai cookbook.
        #
        # @example
        #
        #   # bad
        #   include_recipe 'ohai::default'
        #   include_recipe 'ohai'
        #
        class IncludingOhaiDefaultRecipe < Cop
          MSG = "Use the ohai_plugin resource to ship custom Ohai plugins instead of using the ohai::default recipe. If you're not shipping custom Ohai plugins, then you can remove this recipe entirely".freeze

          def_node_matcher :ohai_recipe_usage?, <<-PATTERN
            (send nil? :include_recipe (str {"ohai" "ohai::default"}))
          PATTERN

          def on_send(node)
            ohai_recipe_usage?(node) do
              add_offense(node, location: :expression, message: MSG, severity: :refactor)
            end
          end
        end
      end
    end
  end
end

Version data entries

13 entries across 13 versions & 1 rubygems

Version Path
cookstyle-5.14.1 lib/rubocop/cop/chef/correctness/ohai_default_recipe.rb
cookstyle-5.13.7 lib/rubocop/cop/chef/correctness/ohai_default_recipe.rb
cookstyle-5.12.13 lib/rubocop/cop/chef/correctness/ohai_default_recipe.rb
cookstyle-5.12.12 lib/rubocop/cop/chef/correctness/ohai_default_recipe.rb
cookstyle-5.11.0 lib/rubocop/cop/chef/correctness/ohai_default_recipe.rb
cookstyle-5.10.13 lib/rubocop/cop/chef/correctness/ohai_default_recipe.rb
cookstyle-5.10.11 lib/rubocop/cop/chef/correctness/ohai_default_recipe.rb
cookstyle-5.9.3 lib/rubocop/cop/chef/correctness/ohai_default_recipe.rb
cookstyle-5.8.1 lib/rubocop/cop/chef/correctness/ohai_default_recipe.rb
cookstyle-5.7.0 lib/rubocop/cop/chef/correctness/ohai_default_recipe.rb
cookstyle-5.6.5 lib/rubocop/cop/chef/correctness/ohai_default_recipe.rb
cookstyle-5.6.2 lib/rubocop/cop/chef/correctness/ohai_default_recipe.rb
cookstyle-5.5.7 lib/rubocop/cop/chef/correctness/ohai_default_recipe.rb