puppet-lint-template_file_extension-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c386f651f5d324b4ef4ee45599cca5e7d12349fe
+  data.tar.gz: 6f3677dfabf9e6a8dd418c8ccba30bafc4791a92
+SHA512:
+  metadata.gz: 358d8b7f6b3877b178061d4914d69cd9fd2cc540f2d2dc382c13f1f1216244833a4d940071ada74569f55afeed4a4e3e67084c023050fd1d6a536aa59651dc30
+  data.tar.gz: cc413fe0da5d88b9008cca8012d7162ae6fb2d54ac4608a1b1e1e404631dac435619c0ca9a0cc2b9157eb43fde1f1c4569ca243074ac6d162c871fe81b6a9b78

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 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,57 @@
+# puppet-lint template file extension check
+
+Extends puppet-lint to ensure all file names used in template and epp
+functions end with the string '.erb' or '.epp' respectively
+
+[![Build Status](https://travis-ci.org/deanwilson/puppet-lint-template_file_extension-check.svg?branch=master)](https://travis-ci.org/deanwilson/puppet-lint-template_file_extension-check)
+
+
+This plugin is an extension of our local style guide and may not suit
+your own code base. This sample would trigger the `puppet-lint` warning:
+
+    class valid_template_filename {
+      file { '/tmp/templated':
+        content => template('mymodule/single_file.config'),
+      }
+    }
+
+    # all template file names should end with .erb
+
+And this would trigger an EPP (Embedded Puppet) specific warning:
+
+    class epp_multi_templated_file {
+      file { '/tmp/templated':
+        content => epp('mymodule/first_file.epp', 'mymodule/second_file.conf'),
+      }
+    }
+
+    # all epp file names should end with .epp
+
+## Installation
+
+To use this plugin add the following line to your Gemfile
+
+    gem 'puppet-lint-template_file_extension-check'
+
+and then run `bundle install`.
+
+## Usage
+
+This plugin provides a new check to `puppet-lint`.
+
+    all template file names should end with .erb
+
+    all epp file names should end with .epp
+
+## Other puppet-lint plugins
+
+You can find a list of my `puppet-lint` plugins in the
+[unixdaemon puppet-lint-plugins](https://github.com/deanwilson/unixdaemon-puppet-lint-plugins) repo.
+
+### Author
+
+[Dean Wilson](https://www.unixdaemon.net)
+
+### License
+
+ * MIT

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

@@ -0,0 +1,45 @@
+PuppetLint.new_check(:template_file_extension) do
+  def check
+
+    template_extensions = {
+      epp: '.epp',
+      template: '.erb',
+    }
+
+    resource_indexes.each do |resource|
+      if resource[:type].value == 'file'
+        resource[:param_tokens].select { |param_token|
+          param_token.value == 'content'
+        }.each do |content_token|
+
+          value_token = content_token.next_code_token.next_code_token
+
+          if matched = value_token.value.match(/^(template|epp)$/)
+            template_function = matched[1]
+            extension = template_extensions[template_function.to_sym]
+
+            current_token = value_token.next_token
+
+            # iterate over all the code tokens until we hit the closing ')'
+            until current_token.type == :RPAREN
+              current_token = current_token.next_code_token
+
+              if current_token.type == :SSTRING && !current_token.value.end_with?(extension)
+
+                warning = "all #{template_function} file names should end with #{extension}"
+
+                notify :warning, {
+                  message:     warning,
+                  line:        value_token.line,
+                  column:      value_token.column,
+                  param_token: content_token,
+                  value_token: value_token,
+                }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe 'template_file_extension' do
+
+  ##########################
+  # Valid examples
+  ##########################
+
+  context 'template function with one valid file name' do
+    let(:code) do
+      <<-EOS
+        class valid_template_filename {
+          file { '/tmp/templated':
+            content => template('mymodule/single_file.erb'),
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'epp function with one valid file name' do
+    let(:code) do
+      <<-EOS
+        class valid_epp_template_filename {
+          file { '/tmp/templated':
+            content => epp('mymodule/single_file.epp'),
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+
+  ##########################
+  # Invalid examples
+  ##########################
+
+  let(:template_msg) { 'all template file names should end with .erb' }
+
+  context 'template function with single invalid file name' do
+    let(:code) do
+      <<-EOS
+        class multi_templated_file {
+          file { '/tmp/templated':
+            content => template('mymodule/first_file.erb', 'mymodule/second_file.conf'),
+          }
+        }
+      EOS
+    end
+
+    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(template_msg).on_line(3).in_column(24)
+    end
+  end
+
+  let(:epp_msg) { 'all epp file names should end with .epp' }
+
+  context 'epp function with single invalid file name' do
+    let(:code) do
+      <<-EOS
+        class epp_multi_templated_file {
+          file { '/tmp/templated':
+            content => epp('mymodule/first_file.epp', 'mymodule/second_file.conf'),
+          }
+        }
+      EOS
+    end
+
+    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(epp_msg).on_line(3).in_column(24)
+    end
+  end
+
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-template_file_extension-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-06 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-json_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: |2
+      Extends puppet-lint to ensure all filenames used in template and epp functions
+      end with the string '.erb' or '.epp' respectively
+email: dean.wilson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/template_file_extension.rb
+- spec/puppet-lint/plugins/puppet-lint-template_file_extension_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/deanwilson/puppet-lint-template_file_extension-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.5.2
+signing_key: 
+specification_version: 4
+summary: puppet-lint template_file_extension check
+test_files:
+- spec/puppet-lint/plugins/puppet-lint-template_file_extension_spec.rb
+- spec/spec_helper.rb
+has_rdoc: