inspecstyle 0.1.2 → 0.2.0

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

@@ -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 = oracledb_session(user: 'my_user', pass: 'password')
+      #
+      #   # good
+      #   sql = oracledb_session(user: 'my_user', password: 'password
+      #
+      class OracleDbSessionPass < Cop
+        include MatchRange
+        MSG = 'Use `:password` instead of `:pass`. This will be removed in '\
+              'InSpec 5'
+
+        def_node_matcher :oracledb_session_pass?, <<~PATTERN
+          (send _ :oracledb_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 = 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
+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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # 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
+      #
+      #   # bad
+      #   describe shadow('/etc/my-custom-place/shadow') do
+      #     its('user') { should eq 'user' }
+      #   end
+      #
+      #   # good
+      #   describe shadow('/etc/my-custom-place/shadow') do
+      #     its('users') { should eq 'user' }
+      #   end
+      #
+      class ShadowProperties < Cop
+        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 :deprecated_shadow_property?, <<~PATTERN
+          (block
+            (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 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 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
+  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