Sha256: 1c435e243fec7e187b535134453fe06d1ed703b22c6b3c5de959ed0a925f0e4c

Contents?: true

Size: 1.69 KB

Versions: 28

Compression:

Stored size: 1.69 KB

Contents

# frozen_string_literal: true
#
# Copyright:: 2020, 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 Deprecations
        # In Chef Infra Client 13 and later you must set path env vars in execute resources using the `environment` property not the legacy `path` property.
        #
        # @example
        #
        #   #### incorrect
        #   execute 'some_cmd' do
        #     path '/foo/bar'
        #   end
        #
        #   #### correct
        #   execute 'some_cmd' do
        #     environment {path: '/foo/bar'}
        #   end
        #
        class ExecutePathProperty < Base
          include RuboCop::Chef::CookbookHelpers

          MSG = 'In Chef Infra Client 13 and later you must set path env vars in execute resources using the `environment` property not the legacy `path` property.'

          def on_block(node)
            match_property_in_resource?(:execute, 'path', node) do |offense|
              add_offense(offense, message: MSG, severity: :warning) # @todo: we could probably autocorrect this with some work
            end
          end
        end
      end
    end
  end
end

Version data entries

28 entries across 28 versions & 1 rubygems

Version Path
cookstyle-7.30.1 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.28.2 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.27.0 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.26.1 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.25.10 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.25.9 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.25.8 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.25.6 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.24.1 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.23.0 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.22.3 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.21.0 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.20.0 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.19.0 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.18.0 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.17.0 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.16.1 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.15.4 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.15.3 lib/rubocop/cop/chef/deprecation/execute_path_property.rb
cookstyle-7.15.2 lib/rubocop/cop/chef/deprecation/execute_path_property.rb