inspecstyle 0.1.3 → 0.2.1

data/doc/top-level-namespace.html

@@ -100,7 +100,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Jun 11 11:57:48 2020 by
+  Generated on Thu Jul  2 15:33:00 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.25 (ruby-2.6.6).
 </div>

data/lib/rubocop/cop/inspecstyle/apache.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # Do not use apache
+      #
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   # apache has been deprecated
+      #   # 'https://github.com/inspec/inspec/issues/3131'
+      #   # Since there are multiples replacements autocorrect is not supported.
+      #
+      #   # bad
+      #   apache
+      #
+      #   # good
+      #   azurerm_virtual_machine # use a specific resource pack resource
+      #
+      class Apache < Cop
+        MSG = 'Use a `apache_conf` instead of `#apache`. '\
+              'This resource will be removed in InSpec 5.'
+
+        def_node_matcher :spec?, <<-PATTERN
+          (block
+            (send nil? :describe ...)
+          ...)
+        PATTERN
+
+        def_node_matcher :apache?, <<~PATTERN
+          (send nil? :apache ...)
+        PATTERN
+
+        def on_send(node)
+          return unless apache?(node)
+
+          add_offense(node, location: :selector)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.selector, preferred_replacement)
+          end
+        end
+
+        private
+
+        def inside_spec?(root)
+          spec?(root)
+        end
+
+        def preferred_replacement
+          cop_config.fetch('PreferredReplacement')
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/inspecstyle/aws_iam_user_property.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # aws_iam_users resource properties `user|password|last_change|expiry_date|line` is deprecated in favor of `users|passwords|last_changes|expiry_dates|lines`
+      #
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   # Use users instead
+      #
+      #   # bad
+      #   describe aws_iam_user('/etc/my-custom-place/aws_iam_user') do
+      #     its('name') { should eq 'user' }
+      #   end
+      #
+      #   # good
+      #   describe aws_iam_user('/etc/my-custom-place/aws_iam_user') do
+      #     its('username') { should eq 'user' }
+      #   end
+      #
+      class AwsIamUserProperty < Cop
+        include RangeHelp
+
+        MSG = 'Use `:%<solution>s` instead of `:%<violation>s` as a property ' \
+        'for the `aws_iam_user` resource. This property will be removed in InSpec 5'
+
+        MAP = {
+          user: "aws_user_struct",
+          name: "username"
+        }
+
+        def_node_matcher :deprecated_aws_iam_users_property?, <<~PATTERN
+          (block
+            (send _ :its
+              (str ${"name" "user"}) ...)
+          ...)
+        PATTERN
+
+        def_node_matcher :spec?, <<-PATTERN
+          (block
+            (send nil? :describe ...)
+          ...)
+        PATTERN
+
+        def_node_matcher :aws_iam_users_resource?, <<-PATTERN
+          (block
+            (send nil? :describe
+              (send nil? :aws_iam_users ...)
+            ...)
+          ...)
+        PATTERN
+
+        def on_block(node)
+          return unless inside_aws_iam_users_spec?(node)
+          node.descendants.each do |descendant|
+            deprecated_aws_iam_users_property?(descendant) do |violation|
+              add_offense(
+                descendant,
+                location: offense_range(descendant),
+                message: format(
+                  MSG,
+                  violation: violation,
+                  solution: MAP[violation.to_sym]
+                )
+              )
+            end
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            case node.children[0].children[-1].inspect
+            when "s(:str, \"name\")"
+              corrector.replace(offense_range(node), 'username')
+            when "s(:str, \"user\")"
+              corrector.replace(offense_range(node), 'aws_user_struct')
+            else
+              break
+            end
+          end
+        end
+
+        private
+
+        def inside_aws_iam_users_spec?(root)
+          spec?(root) && aws_iam_users_resource?(root)
+        end
+
+        def offense_range(node)
+          source = node.children[0].children[-1].loc.expression
+          range_between(source.begin_pos+1, source.end_pos-1)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/inspecstyle/azure_generic_resource.rb

@@ -8,6 +8,7 @@ module RuboCop
       # @example EnforcedStyle: InSpecStyle (default)
       #   # azure_generic_resource has been deprecated
       #   # 'https://github.com/inspec/inspec/issues/3131'
+      #   # Since there are multiples replacements autocorrect is not supported.
       #
       #   # bad
       #   azure_generic_resource
@@ -26,7 +27,7 @@ module RuboCop
         def on_send(node)
           return unless azure_generic_resource?(node)
 
-          add_offense(node, location: node.loc.selector)
+          add_offense(node, location: :selector)
         end
       end
     end

data/lib/rubocop/cop/inspecstyle/deprecated_attributes.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# TODO: when finished, run `rake generate_cops_documentation` to update the docs
 module RuboCop
   module Cop
     module InSpecStyle
@@ -19,7 +18,8 @@ module RuboCop
       class DeprecatedAttributes < Cop
         include RangeHelp
 
-        MSG = 'Use `#input` instead of `#attribute`.'
+        MSG = 'Use `#input` instead of `#attribute`. This will be removed in '\
+              'InSpec 5'
 
         def_node_matcher :attribute?, <<~PATTERN
           (send nil? :attribute ...)

data/lib/rubocop/cop/inspecstyle/deprecated_attributes1.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # Checks if deprecated method attribute1 is used.
+      #
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   # Attributes have been deprecated for inputs
+      #   # https://github.com/inspec/inspec/issues/3802
+      #
+      #   # bad
+      #   attribute1('my_element', value: 10)
+      #
+      #   # good
+      #   input('my_element', value: 10)
+      #
+      class DeprecatedAttributes1 < Cop
+        include RangeHelp
+
+        MSG = 'Use `#input` instead of `#attribute1`. This will be removed in '\
+              'InSpec 5'
+
+        def_node_matcher :attribute1?, <<~PATTERN
+          (send nil? :attribute1 ...)
+        PATTERN
+
+        def on_send(node)
+          return unless attribute1?(node)
+
+          add_offense(node, location: node.loc.selector)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(offense_range(node), preferred_replacement)
+          end
+        end
+
+        private
+
+        def offense_range(node)
+          node.loc.selector
+        end
+
+        def preferred_replacement
+          cop_config.fetch('PreferredReplacement')
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/inspecstyle/file_be_mounted.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# NOTE TO SELF - this one works BUT not if other its statements are defined. Needs
+# to work in any arrangement. This is a powerful one to crack as this pattern
+# will be used in a LOT of other cops.
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # file resource deprecates matchers `be_mounted.with` and `be_mounted.only_with` in favor of the mount resource
+      #
+
+      class FileBeMounted < Cop
+        MSG = 'Use the `:mount` resource instead of `be_mounted.%<violation>s` ' \
+        "\nThis matcher will be removed in InSpec 5"
+
+        def_node_matcher :deprecated_file_matcher?, <<~PATTERN
+          (send
+            (send _ :be_mounted ...) ${:with :only_with}
+          ...)
+        PATTERN
+
+        def_node_matcher :spec?, <<-PATTERN
+          (block
+            (send nil? :describe ...)
+          ...)
+        PATTERN
+
+        def_node_matcher :file_resource?, <<-PATTERN
+          (block
+            (send nil? :describe
+              (send nil? :file ...)
+            ...)
+          ...)
+        PATTERN
+
+        def on_block(node)
+          return unless inside_file_spec?(node)
+          node.descendants.each do |descendant|
+            deprecated_file_matcher?(descendant) do |violation|
+              add_offense(
+                descendant,
+                location: offense_range(descendant),
+                message: format(
+                  MSG,
+                  violation: violation
+                )
+              )
+            end
+          end
+        end
+
+        private
+
+        def inside_file_spec?(root)
+          spec?(root) && file_resource?(root)
+        end
+
+        def offense_range(node)
+          node.loc.selector
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/inspecstyle/file_size.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   `size` property for `file` resource is deprecated for `size_kb` and will be removed in InSpec5
+      #
+      #   # bad
+      #   describe file('my_file.txt') do
+      #     its('size') { should eq 12345 }
+      #   end
+      #
+      #   # good
+      #   describe file('my_file.txt') do
+      #     its('size_kb') { should eq 12345 }
+      #   end
+      #
+      class FileSize < Cop
+        include RangeHelp
+
+        MSG = '`size` property for `file` resource is deprecated for `size_kb` and will be removed in InSpec5'
+
+        def_node_matcher :file_resource_size_property?, <<~PATTERN
+          (block
+            (send _ :its
+              (str "size") ...)
+          ...)
+        PATTERN
+
+        def_node_matcher :spec?, <<-PATTERN
+          (block
+            (send nil? :describe ...)
+          ...)
+        PATTERN
+
+        def_node_matcher :file_resource?, <<-PATTERN
+          (block
+            (send nil? :describe
+              (send nil? :file ...)
+            ...)
+          ...)
+        PATTERN
+
+
+        def on_block(node)
+          return unless inside_file_spec?(node)
+          node.descendants.each do |descendant|
+            next unless file_resource_size_property?(descendant)
+            add_offense(descendant, location: offense_range(descendant))
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(offense_range(node), preferred_replacement)
+          end
+        end
+
+        private
+
+        def inside_file_spec?(root)
+          spec?(root) && file_resource?(root)
+        end
+
+        def preferred_replacement
+          cop_config.fetch('PreferredReplacement')
+        end
+
+        def offense_range(node)
+          source = node.children[0].children[-1].loc.expression
+          range_between(source.begin_pos+1, source.end_pos-1)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/inspecstyle/host_proto.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   `proto` property for `host` resource is deprecated for `protocol` and will be removed in InSpec5
+      #
+      #   # bad
+      #   describe host('my_host.txt') do
+      #     its('proto') { should eq 12345 }
+      #   end
+      #
+      #   # good
+      #   describe host('my_host.txt') do
+      #     its('protocol') { should eq 12345 }
+      #   end
+      #
+      class HostProto < Cop
+        include RangeHelp
+
+        MSG = '`proto` property for `host` resource is deprecated for `protocol` and will be removed in InSpec5'
+
+        def_node_matcher :host_resource_proto_property?, <<~PATTERN
+          (block
+            (send _ :its
+              (str "proto") ...)
+          ...)
+        PATTERN
+
+        def_node_matcher :host_resource?, <<-PATTERN
+          (block
+            (send nil? :describe
+              (send nil? :host ...)
+            ...)
+          ...)
+        PATTERN
+
+
+        def on_block(node)
+          return unless inside_resource_spec?(node)
+          node.descendants.each do |descendant|
+            next unless host_resource_proto_property?(descendant)
+            add_offense(descendant, location: offense_range(descendant))
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(offense_range(node), preferred_replacement)
+          end
+        end
+
+        private
+
+        def inside_resource_spec?(root)
+          host_resource?(root)
+        end
+
+        def preferred_replacement
+          cop_config.fetch('PreferredReplacement')
+        end
+
+        def offense_range(node)
+          source = node.children[0].children[-1].loc.expression
+          range_between(source.begin_pos+1, source.end_pos-1)
+        end
+      end
+    end
+  end
+end