# # Copyright:: 2019, 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 ChefDeprecations # With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several properties in the yum_repository resource were renamed. url -> baseurl, keyurl -> gpgkey, and mirrorexpire -> mirror_expire. # # @example # # # bad # yum_repository 'OurCo' do # description 'OurCo yum repository' # url 'http://artifacts.ourco.org/foo/bar' # keyurl 'http://artifacts.ourco.org/pub/yum/RPM-GPG-KEY-OURCO-6' # mirrorexpire 1440 # action :create # end # # # good # yum_repository 'OurCo' do # description 'OurCo yum repository' # baseurl 'http://artifacts.ourco.org/foo/bar' # gpgkey 'http://artifacts.ourco.org/pub/yum/RPM-GPG-KEY-OURCO-6' # mirror_expire 1440 # action :create # end # class DeprecatedYumRepositoryProperties < Cop include RuboCop::Chef::CookbookHelpers extend TargetChefVersion minimum_target_chef_version '12.14' MSG = 'With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several properties in the yum_repository resource were renamed. url -> baseurl, keyurl -> gpgkey, and mirrorexpire -> mirror_expire.'.freeze def on_block(node) %w(url keyurl mirrorexpire).each do |prop| match_property_in_resource?(:yum_repository, prop, node) do |prop_node| add_offense(prop_node, location: :expression, message: MSG, severity: :refactor) end end end def autocorrect(node) lambda do |corrector| corrector.replace(node.loc.expression, node.loc.expression.source.gsub(/^url/, 'baseurl').gsub(/^keyurl/, 'gpgkey').gsub(/^mirrorexpire/, 'mirror_expire')) end end end end end end end