puppet-lint-concatenated_template_files-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 336f4fd9a668d6e19e5fd91f121e759aaf1c45e2
+  data.tar.gz: 239a8525f3537186f71c6693c28d7c24f9a087c0
+SHA512:
+  metadata.gz: 61f8e714b8a73b6ad5e8714670d08190f0a8a234aed0777c434fa1ade0a5b398e7bceb77ff2f2d593abb062b21ca53a4cfaeb19923508b5fb6e1b4587a8a8a8d
+  data.tar.gz: fc1a563fb2e2acedc3178ab775ba90c6aebc3b3daf57cdb27c4da73252f390184f1559922b8442cf3a670926024f3772ea0b403366065b6ef4071337be5017bf

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,57 @@
+# puppet-lint concatenated template files check
+
+Extends puppet-lint to ensure all `template` functions expand a single
+file, rather than unexpectedly concatenating multiple template files in
+to a single string.
+
+There is a slightly obscure difference in the way that puppet handles
+multiple file names when calling the `file` or `template` functions. In
+the case of the `file` function it will return the contents of the first
+file found from those given, skipping any that don’t exist. The
+`template` function on the other hand will evaluate all of the specified
+templates and return their outputs concatenated into a single string.
+
+This is very rarely what you want. Assuming absent_file is, well absent,
+and real_file is in the correct place this will return the content of real_file.
+
+    class multi_templated_file {
+      file { '/tmp/symbolic-mode':
+        content => file('mymodule/absent_file.erb', 'mymodule/real_file.erb'),
+      }
+    }
+
+However if both of these files exist then the contents will be
+concatenated and the combination of all given files will be returned to
+`content`.
+
+    class multi_templated_file {
+      file { '/tmp/symbolic-mode':
+        content => template('mymodule/first_file.erb', 'mymodule/second_file.erb'),
+      }
+    }
+
+If you do want to select from multiple templates then
+[puppet-multitemplate](https://github.com/deanwilson/puppet-multitemplate)
+will give you a new function that behaves as you'd expect.
+
+## Installation
+
+To use this plugin add the following line to your Gemfile
+
+    gem 'puppet-lint-concatenated_template_files-check'
+
+and then run `bundle install`.
+
+## Usage
+
+This plugin provides a new check to `puppet-lint`.
+
+    calling "template" with multiple files concatenates them into a single string
+
+#### Author
+
+[Dean Wilson](http://www.unixdaemon.net)
+
+### License
+
+ * MIT

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

@@ -0,0 +1,39 @@
+PuppetLint.new_check(:concatenated_template_files) do
+
+  def check
+    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 value_token.value == 'template'
+
+            file_names = []
+
+            current_token = value_token.next_token
+            until current_token.type == :RPAREN
+              current_token = current_token.next_code_token
+              file_names << current_token.value if current_token.type == :SSTRING
+            end
+
+            if file_names.length > 1
+
+              warning = 'calling "template" with multiple files concatenates them into a single string'
+
+              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

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

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe 'concatenated_template_files' do
+  let(:msg) { 'calling "template" with multiple files concatenates them into a single string' }
+
+  context 'template function with one filename' do
+    let(:code) do
+      <<-EOS
+        class single_templated_file {
+          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 'template function with multiple filenames' do
+    let(:code) do
+      <<-EOS
+        class multi_templated_file {
+          file { '/tmp/templated':
+            content => template('mymodule/first_file.erb', 'mymodule/second_file.erb'),
+          }
+        }
+      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(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,152 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-concatenated_template_files-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-27 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 all template functions expand a single
+      file, rather than unexpectedly concatenating multiple template files in
+      to a single string.
+email: dean.wilson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/concatenated_template_files.rb
+- spec/puppet-lint/plugins/puppet-lint-concatenated_template_files_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/deanwilson/puppet-lint-concatenated_template_files-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 concatenated_template_files check
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/puppet-lint-concatenated_template_files_spec.rb
+has_rdoc: