puppet-lint-recurse_file-check 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66fff1c8a9e9dfe7ef77a0f08cca144a6868e683e6211dae569ff4aeed75800f
-  data.tar.gz: 366aa2da1673bfa501b7d7376b116e5c2e74e59f3439891677aff81d67b23bc7
+  metadata.gz: 7c6c735a24e0dd891461df7b40c7e807d39029c5cf2b12a0e697da29c1d197d4
+  data.tar.gz: 23cf243f5f520573574d1bed25f20a05594a16fd13a0a3b37c46ee6675604959
 SHA512:
-  metadata.gz: 289e1e3b2f56e73eea3f9ccd445b09c558a7fb200cf6841f54fd63ddbd8a313fc7345681ba64e3f4e6ca2492a7171e7ed7913a66171ac314ccf5f0a5f806a1e8
-  data.tar.gz: b0258ad6c28ccecf07bfed77c3710a79c2b1dcd9039c722e7c1fc686be11b48d3ce5c53bf510384d7ca9f5544e55384361d9c6bb7478e9fbea7a839bf479a25f
+  metadata.gz: db3ed6c3cf8dacecce87a06b1f2c7e01a45c5c642a8d6537789c73d455bc751d0ec682b6fe64f6b72dccb5779f29c5a54f7f82a18d45ed2c9b3253233efbbc8b
+  data.tar.gz: 7fbbf9ab4dc8874f6c64d190b5b7f0a999c291abd4e39aba0512e5df7001f223de54fd2c164405e51d85f4ba0e461eb97c3776a5f48aa9ca540cf4aea91af29c

data/.gitignore

@@ -1,6 +1,7 @@
 /.bundle/
 /vendor/gems/
 /Gemfile.lock
+/Gemfile.local
 pkg/
 .ruby-*
 puppet-lint-*.gem

data/.rubocop.yml

@@ -0,0 +1,37 @@
+---
+require:
+  - rubocop-rake
+  - rubocop-rspec
+AllCops:
+  NewCops: disable
+  DisplayCopNames: true
+  Include:
+  - "**/*.rb"
+  - "*.gemspec"
+  Exclude:
+  - bin/*
+  - ".vendor/**/*"
+  - "**/Gemfile"
+  - "**/Rakefile"
+  - pkg/**/*
+  - spec/fixtures/**/*
+  - vendor/**/*
+  - "**/Puppetfile"
+  - "**/Vagrantfile"
+  - "**/Guardfile"
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+RSpec/DescribeClass:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Max: 4
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false

data/Gemfile

@@ -1,17 +1,25 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
 group :test do
-  gem 'rake', '~> 10.0'
-  gem 'rspec-its', '~> 1.0'
-  gem 'rspec-collection_matchers', '~> 1.0'
-  gem 'rspec', '~> 3.0'
   gem 'json'
+  gem 'rake', '>= 12.3.3'
+  gem 'rspec', '>= 3.0'
+  gem 'rspec-collection_matchers', '>= 1.0'
+  gem 'rspec-its', '>= 1.0'
   gem 'rubocop'
-  gem 'simplecov', :require => false
+  gem 'rubocop-rspec'
+  gem 'rubocop-rake'
+  gem 'simplecov', require: false
 end
 
 group :development do
-  gem 'github_changelog_generator',                                 :require => false if RUBY_VERSION >= '2.2.2'
+  gem 'github_changelog_generator', require: false if RUBY_VERSION >= '2.2.2'
+end
+
+if File.file?('Gemfile.local') && File.readable?('Gemfile.local')
+  eval(File.read('Gemfile.local'), binding)
 end

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
@@ -7,4 +9,4 @@ RuboCop::RakeTask.new(:rubocop) do |t|
   t.options = ['--display-cop-names']
 end
 
-task :default => :spec
+task default: :spec

data/lib/puppet-lint/plugins/recurse_file.rb

@@ -1,26 +1,46 @@
+# frozen_string_literal: true
+
 # Public: Check the tokens of each File resource instance for a recurse
 # true parameter and if found, record a warning about the potential
 # performance impact.
 #
 # https://puppet.com/docs/puppet/latest/types/file.html#file-attribute-recurse
 PuppetLint.new_check(:recurse_file) do
-
   def check
     resource_indexes.each do |resource|
       next unless resource[:type].value == 'file'
 
-      resource[:param_tokens].select { |param_token|
-        param_token.value == 'recurse'
-      }.each do |param_token|
-        value_token = param_token.next_code_token.next_code_token
+      param_tokens = resource[:param_tokens].select do |param_token|
+        %w[recurse max_files].include? param_token.value
+      end
+
+      recurse = param_tokens.find do |t|
+        t.value == 'recurse' and %w[true remote].include? t.next_code_token.next_code_token.value
+      end
+
+      next if recurse.nil?
 
-        next unless value_token.value == 'true'
+      max_files = param_tokens.find do |t|
+        t.value == 'max_files'
+      end
+
+      if max_files.nil?
+        value_token = recurse.next_code_token.next_code_token
+        notify(
+          :warning,
+          message: 'Unbounded recurse file resources can cause decreased performance. See "max_files"',
+          line: value_token.line,
+          column: value_token.column,
+          token: value_token
+        )
+      elsif ['0', '-1'].include? max_files.next_code_token.next_code_token.value
+        value_token = max_files.next_code_token.next_code_token
         notify(
           :warning,
-          :message => 'recurse file resources can cause decreased performance',
-          :line    => value_token.line,
-          :column  => value_token.column,
-          :token   => value_token
+          message: 'Disabling warnings in recurse file resources using "max_files" is not recommended',
+          line: value_token.line,
+          column: value_token.column,
+          token: value_token
         )
       end
     end

data/puppet-lint-recurse_file-check.gemspec

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |s|
   s.name        = 'puppet-lint-recurse_file-check'
-  s.version     = '0.1.1'
+  s.version     = '0.2.0'
   s.homepage    = 'https://github.com/jarretlavallee/puppet-lint-recurse_file-check'
   s.license     = 'MIT'
   s.author      = 'Jarret Lavallee'
@@ -8,9 +10,7 @@ Gem::Specification.new do |s|
   s.files       = `git ls-files`.split("\n")
   s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.summary     = 'puppet-lint recurse_file check'
-  s.description = <<-EOF
-    Extends puppet-lint to ensure file resources do not have recurse enabled.
-  EOF
+  s.description = 'Extends puppet-lint to ensure file resources do not have recurse enabled.'
 
-  s.add_dependency             'puppet-lint', '>= 1.1', '< 3.0'
+  s.add_dependency 'puppet-lint', '>= 1.1', '< 3.0'
 end

data/spec/puppet-lint/plugins/recurse_file_spec.rb

@@ -1,39 +1,86 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'recurse_file' do
-  let(:msg) { 'recurse file resources can cause decreased performance' }
+  let(:msg) { 'Unbounded recurse file resources can cause decreased performance. See "max_files"' }
+  let(:maxfilesmsg) { 'Disabling warnings in recurse file resources using "max_files" is not recommended' }
+
+  context 'when recurse is enabled' do
+    let(:code) { "file { 'foo': recurse => true }" }
+
+    it 'detects a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'creates a warning' do
+      expect(problems).to contain_warning(msg).on_line(1).in_column(26)
+    end
+  end
+
+  context 'when recurse is remote' do
+    let(:code) { "file { 'foo': recurse => 'remote' }" }
+
+    it 'detects a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'creates a warning' do
+      expect(problems).to contain_warning(msg).on_line(1).in_column(26)
+    end
+  end
 
-    context 'recurse is enabled' do
-      let(:code) { "file { 'foo': recurse => true }" }
+  context 'when recurse is enabled with max_files set to a number' do
+    let(:code) { "file { 'foo': recurse => 'remote', max_files => 10 }" }
 
-      it 'should only detect a single problem' do
-        expect(problems).to have(1).problem
-      end
+    it 'does not detect any problems' do
+      expect(problems).to have(0).problem
+    end
+  end
+
+  context 'when recurse is enabled with max_files set to "0"' do
+    let(:code) { "file { 'foo': recurse => 'remote', max_files => 0 }" }
+
+    it 'detects a single problem' do
+      expect(problems).to have(1).problem
+    end
 
-      it 'should create a warning' do
-        expect(problems).to contain_warning(msg).on_line(1).in_column(26)
-      end
+    it 'creates a warning' do
+      expect(problems).to contain_warning(maxfilesmsg).on_line(1).in_column(49)
     end
+  end
+
+  context 'when recurse is enabled with max_files set to "-1"' do
+    let(:code) { "file { 'foo': recurse => 'remote', max_files => '-1' }" }
 
-    context 'recurse is disabled' do
-      let(:code) { "file { 'foo': recurse => false }" }
+    it 'detects a single problem' do
+      expect(problems).to have(1).problem
+    end
 
-      it 'should not detect any problems' do
-        expect(problems).to have(0).problems
-      end
+    it 'creates a warning' do
+      expect(problems).to contain_warning(maxfilesmsg).on_line(1).in_column(49)
     end
+  end
 
-    context 'recurse is not defined' do
-      let(:code) { "file { 'foo': }" }
+  context 'when recurse is disabled' do
+    let(:code) { "file { 'foo': recurse => false }" }
 
-      it 'should not detect any problems' do
-        expect(problems).to have(0).problems
-      end
+    it 'does not detect any problems' do
+      expect(problems).to have(0).problems
     end
+  end
 
-    context 'multi body file recurse selector' do
-      let(:code) do
-        <<-END
+  context 'when recurse is not defined' do
+    let(:code) { "file { 'foo': }" }
+
+    it 'does not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'with multi body file recurse selector' do
+    let(:code) do
+      <<-MANIFEST
           file {
             '/tmp/foo1':
               ensure => $foo ? { default => absent },
@@ -43,17 +90,17 @@ describe 'recurse_file' do
             '/tmp/foo3':
               recurse => true;
           }
-        END
-      end
+      MANIFEST
+    end
 
-      it 'should detect 3 problems' do
-        expect(problems).to have(3).problems
-      end
+    it 'detects 3 problems' do
+      expect(problems).to have(3).problems
+    end
 
-      it 'should create three warnings' do
-        expect(problems).to contain_warning(sprintf(msg)).on_line(4).in_column(26)
-        expect(problems).to contain_warning(sprintf(msg)).on_line(6).in_column(26)
-        expect(problems).to contain_warning(sprintf(msg)).on_line(8).in_column(26)
-      end
+    it 'creates three warnings' do
+      expect(problems).to contain_warning(sprintf(msg)).on_line(4).in_column(26)
+      expect(problems).to contain_warning(sprintf(msg)).on_line(6).in_column(26)
+      expect(problems).to contain_warning(sprintf(msg)).on_line(8).in_column(26)
     end
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet-lint'
 
 PuppetLint::Plugins.load_spec_helper

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-recurse_file-check
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jarret Lavallee
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-09 00:00:00.000000000 Z
+date: 2021-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -30,14 +30,14 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: "    Extends puppet-lint to ensure file resources do not have recurse
-  enabled.\n"
+description: Extends puppet-lint to ensure file resources do not have recurse enabled.
 email: jarret.lavallee@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -51,7 +51,7 @@ homepage: https://github.com/jarretlavallee/puppet-lint-recurse_file-check
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -66,9 +66,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: puppet-lint recurse_file check
 test_files: