cookstyle 5.0.4 → 5.1.19

data/lib/rubocop/cop/chef/deprecation/depends_poise.rb

@@ -0,0 +1,42 @@
+#
+# 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
+      # Cookbooks should not depend on the deprecated Poise framework. They should instead
+      # be refactored as standard custom resources.
+      #
+      # @example
+      #
+      #   # bad
+      #   depends 'poise'
+      class CookbookDependsOnPoise < Cop
+        MSG = 'Cookbooks should not depend on the deprecated Poise framework'.freeze
+
+        def_node_matcher :depends_method?, <<-PATTERN
+          (send nil? :depends $str)
+        PATTERN
+
+        def on_send(node)
+          depends_method?(node) do |arg|
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if arg == s(:str, 'poise')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/easy_install.rb

@@ -0,0 +1,39 @@
+#
+# 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
+      # Don't use the deprecated easy_install resource removed in Chef 13
+      #
+      # @example
+      #
+      #   # bad
+      #   easy_install "my_thing" do
+      #     bar
+      #   end
+      #
+      class EasyInstallResource < Cop
+        MSG = "Don't use the deprecated easy_install resource removed in Chef 13".freeze
+
+        def on_send(node)
+          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :easy_install
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/epic_fail.rb

@@ -0,0 +1,50 @@
+#
+# 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
+      # Make sure ignore_failure is used instead of epic_fail
+      #
+      # @example
+      #
+      #   # bad
+      #   package "foo" do
+      #     epic_fail true
+      #   end
+      #
+      #   # good
+      #   package "foo" do
+      #     ignore_failure true
+      #   end
+      #
+      class EpicFail < Cop
+        MSG = 'Use ignore_failure method instead of the deprecated epic_fail method'.freeze
+
+        def on_send(node)
+          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :epic_fail
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.expression, 'ignore_failure true')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/erl_call.rb

@@ -0,0 +1,39 @@
+#
+# 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
+      # Don't use the deprecated erl_call resource
+      #
+      # @example
+      #
+      #   # bad
+      #   erl_call "foo" do
+      #     bar
+      #   end
+      #
+      class ErlCallResource < Cop
+        MSG = "Don't use the deprecated erl_call resource removed in Chef 13".freeze
+
+        def on_send(node)
+          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :erl_call
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/{node_set.rb → deprecation/node_set.rb}

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2019-2019, Chef Software Inc.
+# Copyright:: Copyright 2019, Chef Software Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -38,7 +38,7 @@ module RuboCop
 
         def on_send(node)
           node_set?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :warning)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
           end
         end
 

data/lib/rubocop/cop/chef/deprecation/node_set_unless.rb

@@ -0,0 +1,53 @@
+#
+# Copyright:: Copyright 2019-2019, Chef Software Inc.
+#
+# 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
+      # The node.set_unless method has been removed in Chef-13 and must be replaced by node.normal_unless.
+      #
+      # Note that node.normal_unless keeps the semantics identical, but the use of node.normal is
+      # also discouraged.
+      #
+      # @example
+      #
+      #   # bad
+      #   node.set_unless['foo'] = true
+      #
+      #   # good
+      #   node.normal_unless['foo'] = true
+      #
+      class NodeSetUnless < Cop
+        MSG = 'Do not use node.set_unless. Replace with node.normal_unless to keep identical behavior.'.freeze
+
+        def_node_matcher :node_set_unless?, <<-PATTERN
+          (send (send _ :node) :set_unless)
+        PATTERN
+
+        def on_send(node)
+          node_set_unless?(node) do
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.expression, 'node.normal_unless')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/provides_metadata.rb

@@ -0,0 +1,44 @@
+#
+# 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
+      # Don't use the deprecated 'provides' metadata value
+      #
+      # @example
+      #
+      #   # bad in metadata.rb:
+      #
+      #   provides "some_thing"
+      #
+      class ProvidesMetadata < Cop
+        MSG = "Don't use the deprecated 'provides' metadata value".freeze
+
+        def on_send(node)
+          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :provides
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(node.loc.expression)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/replaces_metadata.rb

@@ -0,0 +1,44 @@
+#
+# 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
+      # Don't use the deprecated 'replaces' metadata value
+      #
+      # @example
+      #
+      #   # bad in metadata.rb:
+      #
+      #   replaces "another_cookbook"
+      #
+      class ReplacesMetadata < Cop
+        MSG = "Don't use the deprecated 'replaces' metadata value".freeze
+
+        def on_send(node)
+          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :replaces
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(node.loc.expression)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/suggests_metadata.rb

@@ -0,0 +1,44 @@
+#
+# 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
+      # Don't use the deprecated 'suggests' metadata value
+      #
+      # @example
+      #
+      #   # bad in metadata.rb:
+      #
+      #   suggests "another_cookbook"
+      #
+      class SuggestsMetadata < Cop
+        MSG = "Don't use the deprecated 'suggests' metadata value".freeze
+
+        def on_send(node)
+          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :suggests
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(node.loc.expression)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/effortless/data_bags.rb

@@ -0,0 +1,36 @@
+#
+# Copyright:: 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
+      # Data bags cannot be used with the Effortless Infra pattern
+      #
+      # @example
+      #
+      #   # bad
+      #   data_bag_item('admins', login)
+      #   data_bag(data_bag_name)
+      class CookbookUsesDatabags < Cop
+        MSG = 'Cookbook uses data bags, which cannot be used in the Effortless Infra pattern'.freeze
+
+        def on_send(node)
+          add_offense(node, location: :expression, message: MSG, severity: :refactor) if %i(data_bag data_bag_item).include?(node.method_name)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/effortless/search_used.rb

@@ -0,0 +1,36 @@
+#
+# Copyright:: 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
+      # Search is not compatible with the Effortless Infra pattern
+      #
+      # @example
+      #
+      #   # bad
+      #   search(:node, 'run_list:recipe\[bacula\:\:server\]')
+      #
+      class CookbookUsesSearch < Cop
+        MSG = 'Cookbook uses search, which cannot be used in the Effortless Infra pattern'.freeze
+
+        def on_send(node)
+          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :search
+        end
+      end
+    end
+  end
+end