puppet-lint-fileserver-check 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 722b51fc3ed0c18a55430a47c7fde2e6fa629517
+  data.tar.gz: c40f988cb66cda5c83c829b2ccb175abf30c0954
+SHA512:
+  metadata.gz: 62e4400749b9f814c77242c525fdc92a5c2be7179dffdfd73583193582dc320d04b74f2a50bacb3d368c6c4a05e8c5011ae64b2183287df117e670f77992956b
+  data.tar.gz: ff5e9562e3e317b255ee8c8541f0cfed458baeb16f1cc0d75ec7ed99e9d978a33b58357d210bd2f543eaa8e31b599c9b51699e94490b7ac23720d2ec93ffea71

data/README.md

@@ -0,0 +1,45 @@
+puppet-lint-fileserver-check
+=================================
+
+[![Build Status](https://travis-ci.org/camptocamp/puppet-lint-fileserver-check.svg)](https://travis-ci.org/camptocamp/puppet-lint-fileserver-check)
+
+A puppet-lint plugin to check that you use the `file()` function instead of the Puppet Fileserver.
+
+
+## Checks
+
+### Fileserver use
+
+Fileserver use is very slow and for small files (<16KB)
+
+#### What you have done
+
+```puppet
+file { 'foo':
+  ensure => file,
+  source => 'puppet:///modules/foo/bar',
+}
+```
+
+#### What you should have done
+
+```puppet
+file { 'foo':
+  ensure  => file,
+  content => file('foo/bar'),
+}
+```
+
+#### Disabling the check
+
+To disable this check, you can add `--no-fileserver-check` to your puppet-lint command line.
+
+```shell
+$ puppet-lint --no-fileserver-check path/to/file.pp
+```
+
+Alternatively, if you’re calling puppet-lint via the Rake task, you should insert the following line to your `Rakefile`.
+
+```ruby
+PuppetLint.configuration.send('disable_fileserver')
+```

data/lib/puppet-lint/plugins/check-fileserver.rb

@@ -0,0 +1,27 @@
+PuppetLint.new_check(:fileserver) do
+  def check
+    resource_indexes.each do |resource|
+      attr = resource[:tokens].select do |t|
+        t.prev_code_token && t.prev_code_token.type == :FARROW && t.value =~ %r{^puppet:///}
+      end
+      next if attr.empty?
+      notify :warning, {
+        :message  => 'expected file() instead of fileserver',
+        :line     => attr[0].line,
+        :column   => attr[0].column,
+        :token    => attr[0],
+        :resource => resource,
+      }
+    end
+  end
+
+  def fix(problem)
+    if problem[:resource][:type].value == 'file' && problem[:token].type == :SSTRING
+      problem[:token].prev_code_token.prev_code_token.value = 'content'
+      problem[:token].value.sub!(%r{^puppet:///modules/(.*)}, "file('\\1')")
+      problem[:token].type = :NAME
+    else
+      raise PuppetLint::NoFix, "Not fixing"
+    end
+  end
+end

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

@@ -0,0 +1,216 @@
+require 'spec_helper'
+
+describe 'fileserver' do
+  let(:msg) { 'expected file() instead of fileserver' }
+
+  context 'with fix disabled' do
+    context 'code using file()' do
+      let(:code) {
+        <<-EOS
+        file { 'foo':
+          ensure  => file,
+          content => file('foo/bar'),
+        }
+        EOS
+      }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'code using source with file:///' do
+      let(:code) {
+        <<-EOS
+        file { 'foo':
+          ensure => file,
+          source => 'file:///foo/bar',
+        }
+        EOS
+      }
+
+      it 'should detect a single problem' do
+        expect(problems).to have(0).problem
+      end
+    end
+
+    context 'code using fileserver with puppet:///' do
+      let(:code) {
+        <<-EOS
+        file { 'foo':
+          ensure => file,
+          source => 'puppet:///modules/foo/bar',
+        }
+        EOS
+      }
+
+      it 'should 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(3).in_column(21)
+      end
+    end
+
+    context 'code using $module_name' do
+      let(:code) {
+        <<-EOS
+        file { 'foo':
+          ensure => file,
+          source => "puppet:///modules/${module_name}/bar",
+        }
+        EOS
+      }
+
+      it 'should 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(3).in_column(21)
+      end
+    end
+
+    context 'when using fileserver not in file resource' do
+      let(:code) {
+        <<-EOS
+        foo { 'foo':
+          file_source => 'puppet:///modules/foo/bar',
+        }
+        EOS
+      }
+
+      it 'should 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(2).in_column(26)
+      end
+    end
+  end
+
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    context 'code using file()' do
+      let(:code) {
+        <<-EOS
+        file { 'foo':
+          ensure  => file,
+          content => file('foo/bar'),
+        }
+        EOS
+      }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+
+      it 'should not modify the manifest' do
+        expect(manifest).to eq(code)
+      end
+    end
+
+    context 'code using source with file:///' do
+      let(:code) {
+        <<-EOS
+        file { 'foo':
+          ensure => file,
+          source => 'file:///foo/bar',
+        }
+        EOS
+      }
+
+      it 'should detect a single problem' do
+        expect(problems).to have(0).problem
+      end
+
+      it 'should not modify the manifest' do
+        expect(manifest).to eq(code)
+      end
+    end
+
+    context 'code using fileserver with puppet:///' do
+      let(:code) {
+        <<-EOS
+        file { 'foo':
+          ensure => file,
+          source => 'puppet:///modules/foo/bar',
+        }
+        EOS
+      }
+
+      it 'should detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should fix the problem' do
+        expect(problems).to contain_fixed(msg).on_line(3).in_column(21)
+      end
+
+      it 'should add a newline to the end of the manifest' do
+        expect(manifest).to eq(
+          <<-EOS
+        file { 'foo':
+          ensure => file,
+          content => file('foo/bar'),
+        }
+        EOS
+        )
+      end
+    end
+
+    context 'code using $module_name' do
+      let(:code) {
+        <<-EOS
+        file { 'foo':
+          ensure => file,
+          source => "puppet:///modules/${module_name}/bar",
+        }
+        EOS
+      }
+
+      it 'should 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(3).in_column(21)
+      end
+
+      it 'should not modify the manifest' do
+        expect(manifest).to eq(code)
+      end
+    end
+
+    context 'when using fileserver not in file resource' do
+      let(:code) {
+        <<-EOS
+        foo { 'foo':
+          file_source => 'puppet:///modules/foo/bar',
+        }
+        EOS
+      }
+
+      it 'should 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(2).in_column(26)
+      end
+
+      it 'should not modify the manifest' do
+        expect(manifest).to eq(code)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-fileserver-check
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mickaël Canévet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-17 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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      A puppet-lint plugin to check if puppet:/// is used instead of file().
+email: mickael.canevet@camptocamp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/puppet-lint/plugins/check-fileserver.rb
+- spec/puppet-lint/plugins/check_fileserver_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/camptocamp/puppet-lint-fileserver-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.2.2
+signing_key: 
+specification_version: 4
+summary: A puppet-lint plugin to check if puppet:/// is used instead of file().
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/check_fileserver_spec.rb