puppet-lint-no_symbolic_file_modes-check 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a879d214278d7ede417115e5ea44ae4fd240d56a
+  data.tar.gz: 826315192d79abbda51de1034b50234fcbfa0832
+SHA512:
+  metadata.gz: 027096ef8f757bf084d5a37dc490078eb56b951141f29b8a0af50609e85fd536004a662ac7011bec470022f5232e8d970b3c510efc0936063c8edf37bf76bcf2
+  data.tar.gz: 3e8dd08019faa700e593d1306438cf61657e8a783608945c575bf36defb271459099cc2c19d6cae8f0fcfc5453257c7a6f28bbb6e32eeec126ce9db479b72c94

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,43 @@
+# puppet-lint no symbolic file modes check
+
+Extends puppet-lint to ensure all file resource modes are defined as octal
+values and not symbolic ones.
+
+While symbolic modes can be more flexible than numeric modes they allow
+you to become less absolute about the permissions a file will end up
+with. `mode => 'ug+w'` for example will set the user and group write
+bits, without affecting any other bits, leaving you unable to determine
+the files final permissions from just reading the puppet code.
+
+    # a good, octal mode.
+    class octal_file_mode {
+      file { '/tmp/octal-mode':
+        mode => '0600',
+      }
+    }
+
+    # A bad, symbolic mode.
+    class symbolic_file_mode {
+      file { '/tmp/symbolic-mode':
+        mode => 'ug=rw,o=rx',
+      }
+    }
+
+## Installation
+
+To use this plugin add the following line to your Gemfile
+
+    gem 'puppet-lint-no_symbolic_file_modes-check'
+
+and then run `bundle install`.
+
+## Usage
+
+This plugin provides a new check to `puppet-lint`.
+
+    mode should be a 4 digit octal value, not a symbolic mode
+
+## Notes
+
+The code for this was heavily borrowed/stolen from the original,
+including in puppet-lint, file mode check written by @rodjek

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

@@ -0,0 +1,28 @@
+PuppetLint.new_check(:no_symbolic_file_modes) do
+
+  IGNORE_TYPES = Set[:VARIABLE, :UNDEF]
+  WARNING = 'mode should be a 4 digit octal value, not a symbolic mode'
+
+  def check
+    resource_indexes.each do |resource|
+      if resource[:type].value == "file"
+        resource[:param_tokens].select { |param_token|
+          param_token.value == 'mode'
+        }.each do |param_token|
+          value_token = param_token.next_code_token.next_code_token
+
+          break if IGNORE_TYPES.include?(value_token.type)
+          break if value_token.value =~ /^[0-7]{4}$/
+
+          notify :warning, {
+            :message => WARNING,
+            :line    => value_token.line,
+            :column  => value_token.column,
+            :token   => value_token,
+          }
+        end
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe 'no_symbolic_file_modes' do
+
+  let(:msg) { 'mode should be a 4 digit octal value, not a symbolic mode' }
+
+  context 'file with all octal mode' do
+    let(:code) do
+      <<-EOS
+        class octal_file_mode {
+          file { '/tmp/octal-mode':
+            mode => '0600',
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'file with a symbolic mode' do
+    let(:code) do
+      <<-EOS
+        class symbolic_file_mode {
+          file { '/tmp/symbolic-mode':
+            mode => 'ug=rw,o=rx',
+          }
+        }
+      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,122 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-no_symbolic_file_modes-check
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dean Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-20 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'
+description: "    Extends puppet-lint to ensure all file resource modes are defined
+  as octal\n    values and not symbolic ones. \n"
+email: dean.wilson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/no_symbolic_file_modes.rb
+- spec/puppet-lint/plugins/puppet-lint-no_symbolic_file_modes_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/deanwilson/puppet-lint-no_symbolic_file_modes-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_symbolic_file_modes check
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/puppet-lint-no_symbolic_file_modes_spec.rb
+has_rdoc: