inspecstyle 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b906208d63efff19eb182ce0a3b066206556695ca72e229b6b0afa60d74d91e4
-  data.tar.gz: e9a707ede42ac3da35c82019fd24cc8bb3dcf495a4853df54fead8bfa003bb85
+  metadata.gz: c51bedfaba90e6e4cf18d3a51f66198bf2fa16a497b49b0df0463090f8405104
+  data.tar.gz: '090fe9248bb711be0f8c77c845317c98a1acc66dd377c6f7f24923338afd9638'
 SHA512:
-  metadata.gz: 589110f446bf5b0dc7ebf5538619a3e3d67717f27cebaaa6042730b2e88bef920d2344bbfbcd1631be42476961ddf5bb99533a1ed16ed6f4e3efc1dd0b154617
-  data.tar.gz: f14685e321ef3919d3bcbab64a87a703fbf799e314bd4064851500c1dac4d21d16457a8b7a025a858406be363522f8f6a0cb3f321307543ba6cb03881a95ac17
+  metadata.gz: 0fa18de10357a081e004f385a8635d658eb878779468db447d2584f8bc4697a6b6a6a7f348811a697cfce61cd61c7928669dbd779331bc0585f93b4079ac42a6
+  data.tar.gz: b3082f4bc9201180cd09aa31bcfde73e2ec6c6ac157da1b6307e50eb83161cc97c8943ba4eec6ebeb691e4296a31846bc5322c4adca85789170471be5a9ebbe1

data/.gitignore

@@ -2,7 +2,6 @@
 /.yardoc
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/

data/Gemfile

@@ -6,3 +6,4 @@ gemspec
 gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
 gem 'rspec'
+gem 'yard'

data/Gemfile.lock

@@ -1,21 +1,21 @@
 PATH
   remote: .
   specs:
-    inspecstyle (0.1.0)
+    inspecstyle (0.2.0)
       rubocop
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
+    ast (2.4.1)
     diff-lcs (1.3)
-    jaro_winkler (1.5.4)
     minitest (5.14.1)
     parallel (1.19.1)
-    parser (2.7.1.2)
+    parser (2.7.1.3)
       ast (~> 2.4.0)
     rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (1.7.1)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -30,25 +30,30 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.81.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.85.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
+      rubocop-ast (>= 0.0.3)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
     unicode-display_width (1.7.0)
+    yard (0.9.25)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  inspecstyle!
   minitest (~> 5.0)
   rake (~> 12.0)
   rspec
-  inspecstyle!
+  yard
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,8 +1,12 @@
+# 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.
 
-TODO: Delete this and the text above, and describe your gem
+## Full Documentation
+https://rubydoc.info/gems/inspecstyle
 
 ## Installation
 
@@ -39,6 +43,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/Rakefile

@@ -15,6 +15,9 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
+require 'yard'
+YARD::Rake::YardocTask.new
+
 desc 'Generate a new cop with a template'
 task :new_cop, [:cop] do |_task, args|
   require 'rubocop'

data/config/default.yml

@@ -1,10 +1,103 @@
+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
+  VersionAdded: '0.82'
+  StyleGuide: 'https://github.com/inspec/inspec/issues/3131'
+
 InSpecStyle/DeprecatedAttributes:
   Description: 'Attributes are deprecated in favor of inputs'
   Enabled: true
   VersionAdded: '0.82'
   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 `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: '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/doc/RuboCop.html

@@ -0,0 +1,128 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: RuboCop
+  
+    &mdash; Documentation by YARD 0.9.25
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "RuboCop";
+  relpath = '';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="_index.html">Index (R)</a> &raquo;
+    
+    
+    <span class="title">RuboCop</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: RuboCop
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/rubocop/inspecstyle/inject.rb<span class="defines">,<br />
+  lib/rubocop/inspecstyle.rb,<br /> lib/rubocop/inspecstyle/version.rb,<br /> lib/rubocop/cop/inspecstyle/first_cop.rb,<br /> lib/rubocop/cop/inspecstyle/deprecated_attributes.rb,<br /> lib/rubocop/cop/inspecstyle/azure_generic_resource.rb</span>
+</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>TODO: when finished, run `rake generate_cops_documentation` to update the docs</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="RuboCop/Cop.html" title="RuboCop::Cop (module)">Cop</a></span>, <span class='object_link'><a href="RuboCop/InSpecStyle.html" title="RuboCop::InSpecStyle (module)">InSpecStyle</a></span>
+    
+  
+    
+  
+</p>
+
+
+
+
+
+
+
+
+
+</div>
+
+      <div id="footer">
+  Generated on Thu Jun 11 11:57:48 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>
+
+    </div>
+  </body>
+</html>

data/doc/RuboCop/Cop.html

@@ -0,0 +1,117 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: RuboCop::Cop
+  
+    &mdash; Documentation by YARD 0.9.25
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "RuboCop::Cop";
+  relpath = '../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../_index.html">Index (C)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../RuboCop.html" title="RuboCop (module)">RuboCop</a></span></span>
+     &raquo; 
+    <span class="title">Cop</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: RuboCop::Cop
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/rubocop/cop/inspecstyle/first_cop.rb<span class="defines">,<br />
+  lib/rubocop/cop/inspecstyle/deprecated_attributes.rb,<br /> lib/rubocop/cop/inspecstyle/azure_generic_resource.rb</span>
+</dd>
+  </dl>
+  
+</div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Cop/InSpecStyle.html" title="RuboCop::Cop::InSpecStyle (module)">InSpecStyle</a></span>
+    
+  
+    
+  
+</p>
+
+
+
+
+
+
+
+
+
+</div>
+
+      <div id="footer">
+  Generated on Thu Jun 11 11:57:48 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>
+
+    </div>
+  </body>
+</html>