inspecstyle 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c05d8e13dc59b97ef50ee7e38f9e728dc3e52ade3e648c4dc73241d3f32d60f
-  data.tar.gz: be29a3ae8643a818ef62e7f0a491cc161940b9a675641ae34343cdc082470ec2
+  metadata.gz: c51bedfaba90e6e4cf18d3a51f66198bf2fa16a497b49b0df0463090f8405104
+  data.tar.gz: '090fe9248bb711be0f8c77c845317c98a1acc66dd377c6f7f24923338afd9638'
 SHA512:
-  metadata.gz: 460c48ff0252cbfff1fb0a1b0245366eba8ae3ed939c03dc418a0561ce9d8d31fc8d9beefaf941fe24ea93f52681057104e6ec8863b58b248399ea1072c7a3dd
-  data.tar.gz: e8bb21c13461a344f7ed3b75ef55634755adb454d0530672024ef8fb60d15fdfb3d0c06aedb60322ca864e7520f88cc65e4913979d5a76051467e3f44dafe49a
+  metadata.gz: 0fa18de10357a081e004f385a8635d658eb878779468db447d2584f8bc4697a6b6a6a7f348811a697cfce61cd61c7928669dbd779331bc0585f93b4079ac42a6
+  data.tar.gz: b3082f4bc9201180cd09aa31bcfde73e2ec6c6ac157da1b6307e50eb83161cc97c8943ba4eec6ebeb691e4296a31846bc5322c4adca85789170471be5a9ebbe1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    inspecstyle (0.1.3)
+    inspecstyle (0.2.0)
       rubocop
 
 GEM

data/README.md

@@ -1,3 +1,6 @@
+# WIP: This gem is __not__ live, but we would love your help and input! Core issue here: https://github.com/inspec/inspec/issues/5095
+
+
 # InSpecStyle
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubocop/inspecstyle`. To experiment with that code, run `bin/console` for an interactive prompt.

data/config/default.yml

@@ -1,3 +1,14 @@
+InSpecStyle/Apache:
+  Description: 'Use apache_conf instead of apache'
+  Enabled: true
+  VersionAdded: '0.82'
+  PreferredReplacement: 'apache_conf'
+
+InSpecStyle/AwsIamUserProperty:
+  Description: 'For the aws_iam_users resource name and user properties are deprecated. Use username and aws_user_struct instead'
+  Enabled: true
+  VersionAdded: '0.82'
+
 InSpecStyle/AzureGenericResource:
   Description: 'Do not use azure_generic_resource'
   Enabled: true
@@ -11,17 +22,82 @@ InSpecStyle/DeprecatedAttributes:
   StyleGuide: 'https://github.com/inspec/inspec/issues/3802'
   PreferredReplacement: 'input'
 
+InSpecStyle/FileBeMounted:
+  Description: 'aws_iam_users resource name and user properties are deprecated for username and aws_user_struct'
+  Enabled: true
+  VersionAdded: '0.82'
+
+InSpecStyle/FileSize:
+  Description: '`size` property for `file` resource is deprecated for `size_kb` and will be removed in InSpec5'
+  Enabled: true
+  VersionAdded: '0.82'
+  PreferredReplacement: 'size_kb'
+
+InSpecStyle/HostProto:
+  Description: 'Proto property for host has been deprecated for protocol'
+  Enabled: true
+  VersionAdded: '0.82'
+  PreferredReplacement: 'protocol'
+
+InSpecStyle/IisWebsite:
+  Description: 'iis_website resource has been deprecated for iis_site'
+  Enabled: true
+  VersionAdded: '0.82'
+  PreferredReplacement: 'iis_site'
+
+InSpecStyle/LinuxKernelParameter:
+  Description: 'linux_kernel_parameter resource has been deprecated for kernel_parameter'
+  Enabled: true
+  VersionAdded: '0.82'
+  PreferredReplacement: 'kernel_parameter'
+
+InSpecStyle/MSSQLSessionPass:
+  Description: 'mssql_session resource parameter pass is deprecated for password'
+  Enabled: true
+  VersionAdded: '0.82'
+
 InSpecStyle/OracleDbSessionPass:
-  Description: 'Use `pass` instead of `password`'
+  Description: 'Use `password` instead of `pass`'
+  Enabled: true
+  VersionAdded: '0.82'
+  PreferredReplacement: 'password'
+
+InSpecStyle/PPAResource:
+  Description: 'The ppa resource is deprecated in favor of the apt resource'
+  Enabled: true
+  VersionAdded: '0.82'
+  PreferredReplacement: 'apt'
+
+InSpecStyle/ProcessesList:
+  Description: 'list property on processes resource is deprecated for entries'
   Enabled: true
   VersionAdded: '0.82'
+  PreferredReplacement: 'entries'
+
+InSpecStyle/ScriptResource:
+  Description: 'Use powershell instead of script'
+  Enabled: true
+  VersionAdded: '0.82'
+  PreferredReplacement: 'powershell'
 
 InSpecStyle/ShadowProperties:
-  Description: '`user` attribute for shadow resources is deprecated for `users`'
+  Description: 'Deprecated properties for the shadow resource'
+  Enabled: true
+  VersionAdded: '0.82'
+
+InSpecStyle/UsersResourceMatchers:
+  Description: 'Deprecated matchers for the users resource'
+  Enabled: true
+  VersionAdded: '0.82'
+
+InSpecStyle/WindowsRegistryKey:
+  Description: 'The windows_registry_key resource is deprecated for registry_key'
   Enabled: true
   VersionAdded: '0.82'
+  PreferredReplacement: 'registry_key'
 
-InspecStyle/FirstCop:
-  Description: 'This first cop is a sandbox for exploring new InspecStyle cops.'
+InSpecStyle/WmiWmisClass:
+  Description: "wmi('wmisclass') is deprecated for wmi({class: wmisclass})"
   Enabled: true
   VersionAdded: '0.82'
+  PreferredReplacement: "wmi({class: 'wmisclass'})"

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/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

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   # iis_website has been deprecated as a resource. Use iis_site instead
+      #
+      class IisWebsite < Cop
+        MSG = 'Use `iis_site` instead of `iis_website`. '\
+              'This resource will be removed in InSpec 5.'
+
+        def_node_matcher :iis_website?, <<~PATTERN
+          (send _ :iis_website ...)
+        PATTERN
+
+        def on_send(node)
+          return unless iis_website?(node)
+          add_offense(node, location: :selector)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.selector, preferred_replacement)
+          end
+        end
+
+        private
+
+        def preferred_replacement
+          cop_config.fetch('PreferredReplacement')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   # linux_kernel_parameter has been deprecated as a resource. Use kernel_parameter instead
+      #
+      class LinuxKernelParameter < Cop
+        MSG = 'Use `kernel_parameter` instead of `linux_kernel_parameter`. '\
+              'This resource will be removed in InSpec 5.'
+
+        def_node_matcher :linux_kernel_parameter?, <<~PATTERN
+          (send nil? :linux_kernel_parameter ...)
+        PATTERN
+
+        def on_send(node)
+          return unless linux_kernel_parameter?(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/mssql_session_pass.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Note: highlighting could possibly be better
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      #
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   # Description of the `bar` style.
+      #
+      #   # bad
+      #   sql = mssql_session(user: 'my_user', pass: 'password')
+      #
+      #   # good
+      #   sql = mssql_session(user: 'my_user', password: 'password
+      #
+      class MSSQLSessionPass < Cop
+        include MatchRange
+        MSG = 'Use `:password` instead of `:pass`. This will be removed in '\
+              'InSpec 5'
+
+        def_node_matcher :mssql_session_pass?, <<~PATTERN
+          (send _ :mssql_session
+            (hash
+              ...
+              (pair
+                (sym $:pass)
+                ...)))
+        PATTERN
+
+        # Getting location was a bit tricky on this one, looking at docs perhaps
+        # convention does allow highlighting an entire line.
+        def on_send(node)
+          return unless result = mssql_session_pass?(node)
+          add_offense(node, message: MSG)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(offense_range(node), preferred_replacement)
+          end
+        end
+
+        private
+
+        def offense_range(node)
+          node.descendants.map do |x|
+            x.descendants.find {|y| y.inspect == "s(:sym, :pass)"}
+          end.compact.first.source_range
+        end
+
+        def preferred_replacement
+          cop_config.fetch('PreferredReplacement')
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Note: highlighting could possibly be better
+
 module RuboCop
   module Cop
     module InSpecStyle
@@ -11,7 +13,8 @@ module RuboCop
       #   sql = oracledb_session(user: 'my_user', pass: 'password')
       #
       #   # good
-      #   sql = oracledb_session(user: 'my_user', password: 'password')
+      #   sql = oracledb_session(user: 'my_user', password: 'password
+      #
       class OracleDbSessionPass < Cop
         include MatchRange
         MSG = 'Use `:password` instead of `:pass`. This will be removed in '\
@@ -32,6 +35,24 @@ module RuboCop
           return unless result = oracledb_session_pass?(node)
           add_offense(node, message: MSG)
         end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(offense_range(node), preferred_replacement)
+          end
+        end
+
+        private
+
+        def offense_range(node)
+          node.descendants.map do |x|
+            x.descendants.find {|y| y.inspect == "s(:sym, :pass)"}
+          end.compact.first.source_range
+        end
+
+        def preferred_replacement
+          cop_config.fetch('PreferredReplacement')
+        end
       end
     end
   end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   # ppa has been deprecated as a resource. Use apt instead
+      #
+      class PPAResource < Cop
+        MSG = 'Use `apt` instead of `ppa`. '\
+              'This resource will be removed in InSpec 5.'
+
+        def_node_matcher :ppa?, <<~PATTERN
+          (send _ :ppa ...)
+        PATTERN
+
+        def on_send(node)
+          return unless ppa?(node)
+          add_offense(node, location: :selector)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.selector, preferred_replacement)
+          end
+        end
+
+        private
+
+        def preferred_replacement
+          cop_config.fetch('PreferredReplacement')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   `list` property for `processes` resource is deprecated for `entries` and will be removed in InSpec5
+      #
+      #   # bad
+      #   describe processes('my_processes.txt') do
+      #     its('list') { should eq 12345 }
+      #   end
+      #
+      #   # good
+      #   describe processes('my_processes.txt') do
+      #     its('entries') { should eq 12345 }
+      #   end
+      #
+      class ProcessesList < Cop
+        include RangeHelp
+
+        MSG = '`list` property for `processes` resource is deprecated for `entries` and will be removed in InSpec5'
+
+        def_node_matcher :processes_resource_list?, <<~PATTERN
+          (block
+            (send _ :its
+              (str "list") ...)
+          ...)
+        PATTERN
+
+        def_node_matcher :spec?, <<-PATTERN
+          (block
+            (send nil? :describe ...)
+          ...)
+        PATTERN
+
+        def_node_matcher :processes_resource?, <<-PATTERN
+          (block
+            (send nil? :describe
+              (send nil? :processes ...)
+            ...)
+          ...)
+        PATTERN
+
+
+        def on_block(node)
+          return unless inside_processes_spec?(node)
+          node.descendants.each do |descendant|
+            next unless processes_resource_list?(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_processes_spec?(root)
+          spec?(root) && processes_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/script_resource.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   # script has been deprecated as a resource. Use powershell instead
+      #
+      class ScriptResource < Cop
+        MSG = 'Use `powershell` instead of `script`. '\
+              'This resource will be removed in InSpec 5.'
+
+        def_node_matcher :spec?, <<-PATTERN
+          (block
+            (send nil? :describe ...)
+          ...)
+        PATTERN
+
+        def_node_matcher :script?, <<~PATTERN
+          (send nil? :script ...)
+        PATTERN
+
+        def on_send(node)
+          return unless inside_spec?(node)
+          return unless script?(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/shadow_properties.rb

@@ -1,13 +1,9 @@
 # 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
-      # Shadow resource property user is deprecated in favor of `users`
+      # Shadow 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
@@ -23,37 +19,63 @@ module RuboCop
       #   end
       #
       class ShadowProperties < Cop
-        # TODO: Implement the cop in here.
-        #
-        # In many cases, you can use a node matcher for matching node pattern.
-        # See https://github.com/rubocop-hq/rubocop-ast/blob/master/lib/rubocop/node_pattern.rb
-        #
-        # For example
-        MSG = 'Use `:%<modifier>ss` instead of `:%<modifier>s` as a property ' \
+        include RangeHelp
+
+        MSG = 'Use `:%<violation>ss` instead of `:%<violation>s` as a property ' \
         'for the `shadow` resource. This property will be removed in InSpec 5'
 
-        def_node_matcher :shadow_resource_user_property?, <<~PATTERN
+        def_node_matcher :deprecated_shadow_property?, <<~PATTERN
           (block
-            (send _ :describe
-              (send _ :shadow ...) ...)
-            (args ...)
-            (block
-              (send _ :its
-                (str ${"user" "password" "last_change" "expiry_date" "line"} ...) ...) ...) ...)
+            (send _ :its
+              (str ${"user" "password" "last_change" "expiry_date" "line"}) ...)
+          ...)
+        PATTERN
+
+        def_node_matcher :spec?, <<-PATTERN
+          (block
+            (send nil? :describe ...)
+          ...)
+        PATTERN
+
+        def_node_matcher :shadow_resource?, <<-PATTERN
+          (block
+            (send nil? :describe
+              (send nil? :shadow ...)
+            ...)
+          ...)
         PATTERN
 
         def on_block(node)
-          return unless shadow_resource_user_property?(node) do |modifier|
-            message = format(MSG, modifier: modifier)
-            range = locate_range(modifier, node)
-            add_offense(node, message: message, location: range)
+          return unless inside_shadow_spec?(node)
+          node.descendants.each do |descendant|
+            deprecated_shadow_property?(descendant) do |violation|
+              add_offense(
+                descendant,
+                location: offense_range(descendant),
+                message: format(
+                  MSG,
+                  violation: violation
+                )
+              )
+            end
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.insert_after(offense_range(node), 's')
           end
         end
 
         private
 
-        def locate_range(modifier, node)
-          node.children.find { |child| child.type == :block }.children.first.children.find{|x| x == s(:str, modifier)}.source_range
+        def inside_shadow_spec?(root)
+          spec?(root) && shadow_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

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

@@ -0,0 +1,98 @@
+# 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
+      # Users resource deprecated matchers
+      #
+      # @example EnforcedStyle: InSpecStyle (default)
+      #
+      #   # bad
+      #   describe users('/etc/my-custom-place/users') do
+      #     its('has_home_directory?') { should eq 'foo' }
+      #   end
+      #
+      #   # good
+      #   describe users('/etc/my-custom-place/users') do
+      #     its('users') { should eq 'foo' }
+      #   end
+      #
+      class UsersResourceMatchers < Cop
+        MSG = 'Use `%<solution>s` instead of `%<violation>s` as a matcher ' \
+        "for the `users` resource. \nThis matcher will be removed in InSpec 5"
+
+        MAP = {
+            has_home_directory?: "its('home')",
+            has_login_shell?: "its('shell')",
+            has_authorized_key?: "another matcher",
+            maximum_days_between_password_change: :maxdays,
+            has_uid?: "another matcher",
+            minimum_days_between_password_change: "mindays"
+          }
+
+        def_node_matcher :deprecated_users_matcher?, <<~PATTERN
+          (send _ ${#{MAP.keys.map(&:inspect).join(' ')}} ...)
+        PATTERN
+
+        def_node_matcher :spec?, <<-PATTERN
+          (block
+            (send nil? :describe ...)
+          ...)
+        PATTERN
+
+        def_node_matcher :users_resource?, <<-PATTERN
+          (block
+            (send nil? :describe
+              (send nil? :users ...)
+            ...)
+          ...)
+        PATTERN
+
+        def on_block(node)
+          return unless inside_users_spec?(node)
+          node.descendants.each do |descendant|
+            deprecated_users_matcher?(descendant) do |violation|
+              add_offense(
+                descendant,
+                location: offense_range(descendant),
+                message: format(
+                  MSG,
+                  violation: violation,
+                  solution: MAP[violation]
+                )
+              )
+            end
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            # Only these two matchers are autocorrectable
+            [
+              'maximum_days_between_password_change',
+              'minimum_days_between_password_change'
+            ].map do |violation|
+              if node.inspect.include?(violation)
+                corrector.replace(node.loc.selector, MAP[violation.to_sym])
+              end
+            end
+          end
+        end
+
+        private
+
+        def inside_users_spec?(root)
+          spec?(root) && users_resource?(root)
+        end
+
+        def offense_range(node)
+          node.loc.selector
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   # windows_registry_key has been deprecated as a resource. Use registry_key instead
+      #
+      class WindowsRegistryKey < Cop
+        MSG = 'Use `registry_key` instead of `windows_registry_key`. '\
+              'This resource will be removed in InSpec 5.'
+
+        def_node_matcher :windows_registry_key?, <<~PATTERN
+          (send _ :windows_registry_key ...)
+        PATTERN
+
+        def on_send(node)
+          return unless windows_registry_key?(node)
+          add_offense(node, location: :selector)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.selector, preferred_replacement)
+          end
+        end
+
+        private
+
+        def preferred_replacement
+          cop_config.fetch('PreferredReplacement')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   # wmi_wmis_class has been deprecated as a resource. Use iis_site instead
+      #
+      class WmiWmisClass < Cop
+        MSG = 'Use `iis_site` instead of `wmi_wmis_class`. '\
+              'This resource will be removed in InSpec 5.'
+
+        def_node_matcher :wmi_wmis_class?, <<~PATTERN
+          (send _ :wmi
+            (str "wmisclass") ...)
+        PATTERN
+
+        def on_send(node)
+          return unless wmi_wmis_class?(node)
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.source_range, preferred_replacement)
+          end
+        end
+
+        private
+
+        def preferred_replacement
+          cop_config.fetch('PreferredReplacement')
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/inspecstyle_cops.rb

@@ -1,6 +1,19 @@
 # frozen_string_literal: true
-require_relative 'inspecstyle/first_cop'
 require_relative 'inspecstyle/deprecated_attributes'
 require_relative 'inspecstyle/azure_generic_resource'
 require_relative 'inspecstyle/shadow_properties'
 require_relative 'inspecstyle/oracle_db_session_pass'
+require_relative 'inspecstyle/file_size'
+require_relative 'inspecstyle/apache'
+require_relative 'inspecstyle/script_resource'
+require_relative 'inspecstyle/users_resource_matchers'
+require_relative 'inspecstyle/iis_website'
+require_relative 'inspecstyle/host_proto'
+require_relative 'inspecstyle/linux_kernel_parameter'
+require_relative 'inspecstyle/mssql_session_pass'
+require_relative 'inspecstyle/ppa_resource'
+require_relative 'inspecstyle/processes_list'
+require_relative 'inspecstyle/windows_registry_key'
+require_relative 'inspecstyle/aws_iam_user_property'
+require_relative 'inspecstyle/file_be_mounted'
+require_relative 'inspecstyle/wmi_wmis_class'

data/lib/rubocop/inspecstyle/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module InSpecStyle
-    VERSION = "0.1.6"
+    VERSION = "0.2.0"
   end
 end

data/notes-for-development.md

@@ -45,4 +45,11 @@ node.source
 NodePattern.new('(send ...)').match(node) # => true
 ```
 
+- Implement CI
+
 Correction docs at rubocop's: lib/rubocop/cop/corrector.rb
+
+### Great Repos for cop examples
+- rubocop-ast
+- rubocop-rspec
+- rubocop

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspecstyle
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Nick Schwaderer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2020-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -71,11 +71,24 @@ files:
 - doc/top-level-namespace.html
 - inspecstyle.gemspec
 - lib/inspecstyle.rb
+- lib/rubocop/cop/inspecstyle/apache.rb
+- lib/rubocop/cop/inspecstyle/aws_iam_user_property.rb
 - lib/rubocop/cop/inspecstyle/azure_generic_resource.rb
 - lib/rubocop/cop/inspecstyle/deprecated_attributes.rb
-- lib/rubocop/cop/inspecstyle/first_cop.rb
+- lib/rubocop/cop/inspecstyle/file_be_mounted.rb
+- lib/rubocop/cop/inspecstyle/file_size.rb
+- lib/rubocop/cop/inspecstyle/host_proto.rb
+- lib/rubocop/cop/inspecstyle/iis_website.rb
+- lib/rubocop/cop/inspecstyle/linux_kernel_parameter.rb
+- lib/rubocop/cop/inspecstyle/mssql_session_pass.rb
 - lib/rubocop/cop/inspecstyle/oracle_db_session_pass.rb
+- lib/rubocop/cop/inspecstyle/ppa_resource.rb
+- lib/rubocop/cop/inspecstyle/processes_list.rb
+- lib/rubocop/cop/inspecstyle/script_resource.rb
 - lib/rubocop/cop/inspecstyle/shadow_properties.rb
+- lib/rubocop/cop/inspecstyle/users_resource_matchers.rb
+- lib/rubocop/cop/inspecstyle/windows_registry_key.rb
+- lib/rubocop/cop/inspecstyle/wmi_wmis_class.rb
 - lib/rubocop/cop/inspecstyle_cops.rb
 - lib/rubocop/inspecstyle.rb
 - lib/rubocop/inspecstyle/inject.rb

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

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module InSpecStyle
-      # TODO: Write cop description and example of bad / good code. For every
-      # `SupportedStyle` and unique configuration, there needs to be examples.
-      # Examples must have valid Ruby syntax. Do not use upticks.
-      #
-      # @example EnforcedStyle: bar (default)
-      #   # Description of the `bar` style.
-      #
-      #   # bad
-      #   bad_bar_method
-      #
-      #   # bad
-      #   bad_bar_method(args)
-      #
-      #   # good
-      #   good_bar_method
-      #
-      #   # good
-      #   good_bar_method(args)
-      #
-      # @example EnforcedStyle: foo
-      #   # Description of the `foo` style.
-      #
-      #   # bad
-      #   bad_foo_method
-      #
-      #   # bad
-      #   bad_foo_method(args)
-      #
-      #   # good
-      #   good_foo_method
-      #
-      #   # good
-      #   good_foo_method(args)
-      #
-      class FirstCop < Cop
-        # TODO: Implement the cop in here.
-        #
-        # In many cases, you can use a node matcher for matching node pattern.
-        # See https://github.com/rubocop-hq/rubocop/blob/master/lib/rubocop/node_pattern.rb
-        #
-        # For example
-        MSG = 'Use `#good_method` instead of `#bad_method`. %<example_insertion>'
-
-        def_node_matcher :bad_method?, <<~PATTERN
-          (send nil? :bad_method ...)
-        PATTERN
-
-        def on_send(node)
-          return unless bad_method?(node)
-          message = format(MSG, example_insertion: node.first.source)
-          add_offense(node, message: message)
-        end
-
-        def autocorrect(node)
-          ->(corrector) do
-            corrector.insert_before(node.source_range, 'good_method')
-            corrector.remove(node.source_range)
-          end
-        end
-      end
-    end
-  end
-end