inspecstyle 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3f8cb06cac386264652e1005a6b23e975308fbd1887b469f20f528bdbb88563
-  data.tar.gz: 24503e8b29b8f1876682f39c07e0e53080b03be08a295c885e8c49485f8137ba
+  metadata.gz: 0bb0e545b5334db0eea3a814b9a3c1c190faf6ed830283ae30e20d2ffca09d18
+  data.tar.gz: '0926fd1659d8c3902c687f5b8316dc6871320e8ea4c123ba74fd170798d45728'
 SHA512:
-  metadata.gz: 40a105f93aa52b6ce4b36d972bf24750150e2c0ee3399483f4ec1675f94573c4df821a61ee6fa10a4fcd161fa4a87d0efdb73084aafe424f32813cc56dd67ba3
-  data.tar.gz: 59288f41742905617e98f76f53290110636bc05c9b7c328bad78c12f07f5b059a28769ab9a30f56986e92cca9b5d6248cb3cd790ddcc7655f86f72a53fe79f47
+  metadata.gz: '0585d52d51d05c5962359ffc981547dc5b87e9561eec671c248833ee537ea29f207a9347d08bd8bf5802a585b1c6b275a365b43b0c8267afec1d7a6a960ce163'
+  data.tar.gz: 93a55953bd3e49b2072eb9a85fd82230c2dbb8ce78b7b6cb84cd6a7c12cadaadc4cb87c85ba90874f9d8d0e1e6b8bb24939c494784e734b6a3edfa7e60b98995

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    inspecstyle (0.1.2)
+    inspecstyle (0.1.3)
       rubocop
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
+    ast (2.4.1)
     diff-lcs (1.3)
     minitest (5.14.1)
     parallel (1.19.1)

data/README.md

@@ -40,6 +40,40 @@ To only run these cops on your local rubocop run, execute:
 ## TODO:
 
 - Instead of referencing issues in the cops, point to a general `inspecstyle.guide`
+- Known issue, resources that work on manual runs but not in `atom` package: [
+  - AzureGenericResource
+]
+- Cop ideas:
+```
+its('minimum_days_between_password_change') { should eq 0 } becomes 'mindays'
+its('maximum_days_between_password_change') { should eq 0 } becomes 'maxdays'
+Inspec.deprecate(:resource_user_serverspec_compat, "The user resource `has_home_directory?` matcher is deprecated. Please use `its('home')`.")
+Inspec.deprecate(:resource_user_serverspec_compat, "The user resource `has_authorized_key?` matcher is deprecated. There is no currently implemented alternative")
+
+
+shadow resource deprecations
+(e.g.)
+describe shadow('/etc/my-custom-place/shadow') do
+  its('count') { should eq 32 }
+end
+
+property deprecations:
+
+user -> users
+password -> passwords
+last_change -> last_changes
+expiry_date -> expiry_dates
+lines (no replacement)
+
+e.g.
+
+sql = oracledb_session(user: 'my_user', pass: 'password')
+      describe sql.query(\"SELECT UPPER(VALUE) AS VALUE FROM V$PARAMETER WHERE UPPER(NAME)='AUDIT_SYS_OPERATIONS'\").row(0).column('value') do
+        its('value') { should eq 'TRUE' }
+      end
+
+oracledb_session deprecated `pass`, use `password` instead
+```
 
 ## Development
 

data/config/default.yml

@@ -11,6 +11,16 @@ InSpecStyle/DeprecatedAttributes:
   StyleGuide: 'https://github.com/inspec/inspec/issues/3802'
   PreferredReplacement: 'input'
 
+InSpecStyle/OracleDbSessionPass:
+  Description: 'Use `pass` instead of `password`'
+  Enabled: true
+  VersionAdded: '0.82'
+
+InSpecStyle/ShadowProperties:
+  Description: '`user` attribute for shadow resources is deprecated for `users`'
+  Enabled: true
+  VersionAdded: '0.82'
+
 InspecStyle/FirstCop:
   Description: 'This first cop is a sandbox for exploring new InspecStyle cops.'
   Enabled: true

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

data/lib/rubocop/cop/inspecstyle/first_cop.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

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+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`.'
+
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# NOTE TO SELF - this one isn't currently working even though my pattern works in Rubocop's bin/console
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # Shadow resource property user is deprecated in favor of `users`
+      #
+      # @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
+        # 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 `#users` instead of `#user`. This property will be removed '\
+              'in InSpec 5'
+
+        def_node_matcher :shadow_resource_user_property?, <<~PATTERN
+          (block
+            (send _ :describe
+              (send _ :shadow ...) ...)
+            (args ...)
+            (block
+              (send _ :its
+                (str ${"user" "password" "last_change" "expiry_date" "line"} ...) ...) ...) ...)
+        PATTERN
+
+        def on_send(node)
+          return unless shadow_resource_user_property?(node)
+          require 'pry'
+          binding.pry
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/inspecstyle_cops.rb

@@ -2,3 +2,5 @@
 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'

data/lib/rubocop/inspecstyle/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module InSpecStyle
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inspecstyle
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Nick Schwaderer
@@ -74,6 +74,8 @@ files:
 - 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/oracle_db_session_pass.rb
+- lib/rubocop/cop/inspecstyle/shadow_properties.rb
 - lib/rubocop/cop/inspecstyle_cops.rb
 - lib/rubocop/inspecstyle.rb
 - lib/rubocop/inspecstyle/inject.rb