# frozen_string_literal: true # # 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 Modernize # Instead of using the execute or powershell_script resources to run the `tzutil` command, use Chef Infra Client's built-in timezone resource which is available in Chef Infra Client 14.6 and later. # # @example # # #### incorrect # execute 'set tz' do # command 'tzutil.exe /s UTC' # end # # execute 'tzutil /s UTC' # # powershell_script 'set windows timezone' do # code "tzutil.exe /s UTC" # not_if { shell_out('tzutil.exe /g').stdout.include?('UTC') } # end # # #### correct # timezone 'UTC' # class ExecuteTzUtil < Base include RuboCop::Chef::CookbookHelpers extend TargetChefVersion minimum_target_chef_version '14.6' MSG = 'Use the timezone resource included in Chef Infra Client 14.6+ instead of shelling out to tzutil' RESTRICT_ON_SEND = [:execute].freeze def_node_matcher :execute_resource?, <<-PATTERN (send nil? :execute $str) PATTERN def on_send(node) execute_resource?(node) do return unless node.arguments.first.value.match?(/^tzutil/i) add_offense(node, severity: :refactor) end end def on_block(node) match_property_in_resource?(:execute, 'command', node) do |code_property| next unless calls_tzutil?(code_property) add_offense(node, severity: :refactor) end match_property_in_resource?(:powershell_script, 'code', node) do |code_property| next unless calls_tzutil?(code_property) add_offense(node, severity: :refactor) end end private def calls_tzutil?(ast_obj) property_data = method_arg_ast_to_string(ast_obj) return true if property_data && property_data.match?(/^tzutil/i) end end end end end end