puppet-lint-no_file_path_attribute-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb2751bd28f9b92acbc47870d6c78d8d7082bdbe
+  data.tar.gz: c02caa1719ea793d48ca0c5c0e6e065a15949e3e
+SHA512:
+  metadata.gz: c33fa5643ce3e9ec4adb3c0d6c7cf61efaeda750a851f21548f738074c27af2b474a5c3c5eafb8cb1cc008cef1b5284dc6504ef9323b87ba6f6a42de71d2ba52
+  data.tar.gz: adedca22595ab5066165c23004be9454b8594305bd1419f40df9d8a4823f37cab7c81bb097825ab34a4b75b116b8fd42370f7a204f7b2d43e0ed4c9ecef0dffc

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,44 @@
+# puppet-lint no file resource path attributes
+
+Extends puppet-lint to ensure all file resources use the resource
+title to indicate the file to manage rather than a symbolic name
+and the `path` attribute.
+
+Instead of this:
+
+    class path_attribute {
+      file { 'ssh_config_file':
+        path    => '/etc/ssh/sshd_config',
+        content => 'Bad path attribute, bad.',
+      }
+    }
+
+I think, and this check complains unless, you use this format:
+
+    class good_namevar {
+      file { '/etc/ssh/sshd_config':
+        content => 'Good namevar',
+      }
+    }
+
+There is nothing technically wrong with the first form but I'd rather
+know what the resource type is, and what it manages, without having to read further in to the resouece.
+Oddly I have no issues with `exec` resources with `command` attributes being
+[written in this style](http://www.puppetcookbook.com/posts/nicer-exec-names.html).
+
+## Installation
+
+To use this plugin add the following line to your Gemfile
+
+    gem 'puppet-lint-no_file_path_attribute-check'
+
+and then run `bundle install`.
+
+## Usage
+
+This plugin provides a new check to `puppet-lint`.
+
+    file resources should not have a path attribute. Use the title instead
+
+### Author
+[Dean Wilson](http://www.unixdaemon.net)

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

@@ -0,0 +1,22 @@
+PuppetLint.new_check(:no_file_path_attribute) do
+
+  def check
+    resource_indexes.each do |resource|
+      if resource[:type].value == 'file'
+        resource[:param_tokens].select { |param_token|
+          param_token.value == 'path'
+        }.each do |param_token|
+          value_token = param_token.next_code_token.next_code_token
+
+          notify :warning, {
+            message: 'file resources should not have a path attribute. Use the title instead',
+            line:    value_token.line,
+            column:  value_token.column,
+            token:   value_token
+          }
+        end
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe 'no_file_path_attribute' do
+
+  let(:msg) { 'file resources should not have a path attribute. Use the title instead' }
+
+  context 'file with a full path title' do
+    let(:code) do
+      <<-EOS
+        class good_namevar {
+          file { '/tmp/good_namevar':
+            content => 'Good namevar',
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'file with path attribute' do
+    let(:code) do
+      <<-EOS
+        class path_attribute {
+          file { 'bad_namevar':
+            path => '/tmp/bad_path_attr',
+          }
+        }
+      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(21)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-no_file_path_attribute-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-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'
+    - - "<"
+      - !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.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
+      Extends puppet-lint to ensure file resources do not have a path attribute.
+email: dean.wilson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/no_file_path_attribute.rb
+- spec/puppet-lint/plugins/puppet-lint-no_file_path_attribute_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/deanwilson/puppet-lint-no_file_path_attribute-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_file_path_attribute check
+test_files:
+- spec/puppet-lint/plugins/puppet-lint-no_file_path_attribute_spec.rb
+- spec/spec_helper.rb
+has_rdoc: