puppet-lint-recurse_file-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6c9ff780d75c28be7c4c375c5a4ac7239acd62f88ba74bf8ff5cbbe13b9e24d
+  data.tar.gz: f91e2c4676e3a85131a92da6c6c2558bd5a93c3529c12d43ca0978f41d3dc959
+SHA512:
+  metadata.gz: 3b04ac436b64ed60d57b4f757f224691fe206d944fc55a8169ce78f2bb778381d2bae49c5d5805d0a78d2c586615916c0da76a721512772bfa95036fdc74db61
+  data.tar.gz: 68782dff257ce95c356b1c9e98fe8c51a2781ac7eacbc2cacd856ccecffbaba61b29b1af35341b7fed8df0225c24c8160e82203db203b660500a2973a68aae4a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/vendor/gems/
+/Gemfile.lock
+pkg/
+.ruby-*
+puppet-lint-*.gem
+coverage/
+/tmp/

data/.travis.yml

@@ -0,0 +1,13 @@
+---
+language: ruby
+sudo: false
+branches:
+bundler_args: --without development system_tests
+script:
+    - bundle exec rake $CHECK
+env:
+    - CHECK=spec
+rvm:
+  - 2.1.9
+  - 2.4.1
+  - 2.5.1

data/Gemfile

@@ -0,0 +1,17 @@
+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 'rubocop'
+  gem 'simplecov', :require => false
+end
+
+group :development do
+  gem 'github_changelog_generator',                                 :require => false if RUBY_VERSION >= '2.2.2'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jarret Lavallee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# puppet-lint recurse file check
+
+Extends puppet-lint to ensure that file resources do not have `recurse` enabled. This can lead to performance issues in Puppetserver and PuppetDB when there are thousands of subdirectories or files that are managed. It is suggested to use an alternate approach for managing those directories.
+
+This plug-in to `puppet-lint` will flag the a file resource that has `recurse => true` similar to the following.
+
+```
+  file { '/tmp/installer':
+    ensure => absent,
+    recurse => true,
+  }
+```
+
+Or something like the following.
+
+```
+  file { '/data':
+    owner => 'root',
+    recurse => true,
+  }
+```
+
+While the code above is functional, it will create a resource event for each file or directory under the `/tmp/installer` directory when it is being removed. This artificially bloats the report as the number of files increases. We have seen this done with directories of hundreds or thousands of files, which has created reports of over 256MB. An `exec` resource may be a better solution for this type of file management.
+
+## Installation
+
+To install this for the local `puppet-lint` command line utility it can be installed with the following.
+
+```
+gem install puppet-lint-recurse_file-check
+```
+
+To use this plug-in with `bundler`, add the following line to your Gemfile.
+
+```
+gem 'puppet-lint-recurse_file-check'
+```
+
+and then run `bundle install`.
+
+
+## Usage
+
+This plug-in provides a new check to `puppet-lint`. The following is the output which will be shown.
+
+> recurse file resources can cause decreased performance

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
+
+task :default => :spec

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

@@ -0,0 +1,28 @@
+# 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
+
+        next unless value_token.value == 'true'
+        notify(
+          :warning,
+          :message => 'recurse file resources can cause decreased performance',
+          :line    => value_token.line,
+          :column  => value_token.column,
+          :token   => value_token
+        )
+      end
+    end
+  end
+end

data/puppet-lint-no_file_path_attribute-check.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = 'puppet-lint-recurse_file-check'
+  s.version     = '0.1.0'
+  s.homepage    = 'https://github.com/jarretlavallee/puppet-recurse_file-check'
+  s.license     = 'MIT'
+  s.author      = 'Jarret Lavallee'
+  s.email       = 'jarret.lavallee@gmail.com'
+  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 recurse enabled.
+  EOF
+
+  s.add_dependency             'puppet-lint', '>= 1.1', '< 3.0'
+end

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

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe 'recurse_file' do
+  let(:msg) { 'recurse file resources can cause decreased performance' }
+
+    context 'recurse is enabled' do
+      let(:code) { "file { 'foo': recurse => true }" }
+
+      it 'should only detect 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
+    end
+
+    context 'recurse is disabled' do
+      let(:code) { "file { 'foo': recurse => false }" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'recurse is not defined' do
+      let(:code) { "file { 'foo': }" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'multi body file recurse selector' do
+      let(:code) do
+        <<-END
+          file {
+            '/tmp/foo1':
+              ensure => $foo ? { default => absent },
+              recurse => true;
+            '/tmp/foo2':
+              recurse => true;
+            '/tmp/foo3':
+              recurse => true;
+          }
+        END
+      end
+
+      it 'should detect 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
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'puppet-lint'
+
+PuppetLint::Plugins.load_spec_helper

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-recurse_file-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jarret Lavallee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: "    Extends puppet-lint to ensure file resources do not recurse enabled.\n"
+email: jarret.lavallee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/puppet-lint/plugins/recurse_file.rb
+- puppet-lint-no_file_path_attribute-check.gemspec
+- spec/puppet-lint/plugins/recurse_file_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jarretlavallee/puppet-recurse_file-check
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: puppet-lint recurse_file check
+test_files:
+- spec/puppet-lint/plugins/recurse_file_spec.rb
+- spec/spec_helper.rb