# # Copyright:: 2020, Chef Software Inc. # Author:: Tim Smith () # # 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 # When setting a node attribute as a default value for a custom resource property, make sure to wrap the node attribute in `lazy {}` so that the node attribute is available when the resource executes. # # @example # # # bad # property :Something, String, default: node['hostname'] # # # good # property :Something, String, default: lazy { node['hostname'] } # class LazyEvalNodeAttributeDefaults < Cop include RuboCop::Chef::CookbookHelpers MSG = 'When setting a node attribute as a default value for a custom resource property, make sure to wrap the node attribute in `lazy {}` so that the node attribute is available when the resource executes.'.freeze def_node_matcher :non_lazy_node_attribute_default?, <<-PATTERN (send nil? :property (sym _) ... (hash <(pair (sym :default) $(send (send _ :node) :[] _) ) ...>)) PATTERN def on_send(node) non_lazy_node_attribute_default?(node) do |default| add_offense(default, location: :expression, message: MSG, severity: :refactor) end end def autocorrect(node) lambda do |corrector| corrector.replace(node.loc.expression, "lazy { #{node.loc.expression.source} }") end end end end end end end