puppet-lint-no_erb_template-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8088bbada0b6269c1305217096d8133935a3feef
+  data.tar.gz: 1e8ec31a837808b64604a256098b82082891cedd
+SHA512:
+  metadata.gz: c02fd232a11bf53384c8e560f80c41d1cf67c98193c9f71f4a58e6cc03eaf49f5b2b8c6460c597f1178111b621fc51039547ee80e3d93fc4955e502be65dc868
+  data.tar.gz: 43a3ac6962d06eb3a3ec5b92193faa5fc738b3df3cdcc909050f4c54eab3a3500dba7c6bf91f6fac9179232d905796d910ab47ef7f0a272ef7f1b25ac4904937

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dean Wilson
+
+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,37 @@
+# puppet-lint no ERB templates check
+
+As part of the migration to a cleaner, Puppet 4 enhanced, code base one
+of the suggestions is to move from the old ERB (Embedded Ruby)
+templates to the newer, kinder, gentler `epp` (Embedded Puppet
+Programming) equivalents. You can find more details in the
+[Templating with Embedded Puppet Programming Language - EPP](http://puppet-on-the-edge.blogspot.co.uk/2014/03/templating-with-embedded-puppet.html) blog post.
+
+The lint check in this plugin will raise a warning anywhere a
+`template()` or `inline_template()` function call is found in your
+manifests. It's worth noting that this plugin will probably raise a lot
+of warnings if you use external modules that maintain Puppet 3
+compatibility; and will be of most use in new, Puppet 4 only code bases.
+
+## Installation
+
+To use this plugin add the following line to your Gemfile
+
+    gem 'puppet-lint-no_erb_template-check'
+
+and then run `bundle install`.
+
+## Usage
+
+This plugin provides two new checks to `puppet-lint`.
+
+    'inline_template() function call. Use inline_epp() instead'
+
+    'template() function call. Use epp() instead'
+
+#### Author
+
+[Dean Wilson](http://www.unixdaemon.net)
+
+### License
+
+ * MIT

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

@@ -0,0 +1,21 @@
+PuppetLint.new_check(:no_erb_template) do
+  def check
+    functions = ['template', 'inline_template']
+
+    tokens.select { |t| t.type == :NAME and functions.include? t.value }.each do |function_token|
+      next unless function_token.next_code_token.type == :LPAREN
+
+      key_token = function_token.next_code_token.next_code_token
+
+      # display the new, epp, version of the function
+      original_function = function_token.value
+      new_func = function_token.value.sub(/template/, 'epp')
+
+      notify :warning, {
+        message: "#{original_function}() function call. Use #{new_func}() instead",
+        line:    key_token.line,
+        column:  key_token.column,
+      }
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe 'no_erb_template' do
+  context 'class with no template calls' do
+    let(:code) do
+      <<-EOS
+        class no_template_calls {
+          file { '/tmp/foo':
+            content => 'bar',
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'class with an epp template call' do
+    let(:code) do
+      <<-EOS
+        class epp_call {
+          file { '/tmp/foo':
+            content => epp('mymodule/bar.epp'),
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  # and these should cause failiures
+
+  context 'class with a template call' do
+    let(:msg) { 'template() function call. Use epp() instead' }
+
+    let(:code) do
+      <<-EOS
+        class template_call {
+          file { '/tmp/foo':
+            content => template('mymodule/bar.epp'),
+          }
+        }
+      EOS
+    end
+
+    it 'should detect a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'should create an error' do
+      expect(problems).to contain_warning(msg).on_line(3).in_column(33)
+    end
+  end
+
+  context 'class with an inline_template call' do
+    let(:msg) { 'inline_template() function call. Use inline_epp() instead' }
+
+    let(:code) do
+      <<-EOS
+        class template_call {
+          file { '/tmp/foo':
+            content => inline_template('This is a rubbish template'),
+          }
+        }
+      EOS
+    end
+
+    it 'should detect a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'should create an error' do
+      expect(problems).to contain_warning(msg).on_line(3).in_column(40)
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-no_erb_template-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-04 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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
+      Extends puppet-lint to ensure there are no calls to the template
+      or inline_template function as an aid to migrating to epp templates.
+email: dean.wilson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/no_erb_template.rb
+- spec/puppet-lint/plugins/no_erb_template_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/deanwilson/puppet-lint-no_erb_template-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.4.8
+signing_key: 
+specification_version: 4
+summary: puppet-lint no_erb_template check
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/no_erb_template_spec.rb