puppet-lint-nine-check 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bd04cd6c797fc8dfcfa90947cf9fa8464765f17da05128333b5d60ef24d7bd5
-  data.tar.gz: ebbb400e531834f99523e76881e0b874c0d0b341323714ed20d6555bcca2c981
+  metadata.gz: 3dc35597d6a8c91070d3f0f897ad882a3e0d7f5baa26136c96f3c32de2447487
+  data.tar.gz: d3e419564fb15a1728a7885ea243cd61b03ced9676c49d79f9b59f6216352abb
 SHA512:
-  metadata.gz: a195b46f95951a594d854b5301e5093734d044f1d24fc1d4c3fd1f1c72bfa2c482e6feefd625df9cd331255c10724135aa8da5f43a610d2d06e270b263b13f9a
-  data.tar.gz: 632e08c48a1a0a1549c14c4b7738a7a77390c4d09d80e55a95d0b517b8c68186fe030587d1244faf613eb61cf5cf50cc319180586f9ba7c7fb97a57516d06e98
+  metadata.gz: adb7afff9bca164ff1a683528169113bd8066a4ab9b4b8272ea88a71f6ae6b13205ec653484ebb721fbc6af68932a7ae7f1129dee5e6281b6bafcecb0380bd1e
+  data.tar.gz: 1ce9cf998c731e36e11ed2a1c322905151df43c4a99aef80749c8617f29a3f4813486d432aab22d148da12cae5cfa1a4d0d13a28c3fdd3be990483712103bb33

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

@@ -0,0 +1,51 @@
+# https://github.com/deanwilson/puppet-lint-no_symbolic_file_modes-check/blob/bf06d542b222ba4748ec935346a95b628a527f00/lib/puppet-lint/plugins/no_symbolic_file_modes.rb
+#
+# 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.
+
+PuppetLint.new_check(:no_symbolic_file_modes) do
+  def ignore_type?(type)
+    Set[:VARIABLE, :UNDEF].include?(type)
+  end
+
+  def check
+    resource_indexes.each do |resource|
+      next unless resource[:type].value == "file"
+
+      param_tokens = resource[:param_tokens].select { |pt| pt.value == "mode" }
+
+      param_tokens.each do |param_token|
+        value_token = param_token.next_code_token.next_code_token
+
+        break if ignore_type?(value_token.type)
+        break if /^[0-7]{4}$/.match?(value_token.value)
+
+        notify :warning, {
+          message: "mode should be a 4 digit octal value, not a symbolic mode",
+          line: value_token.line,
+          column: value_token.column,
+          token: value_token
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# https://github.com/deanwilson/puppet-lint-template_file_extension-check/blob/ae9f1e850293e0c204f1abd876df4be4d560cf81/lib/puppet-lint/plugins/template_file_extension.rb
+#
+# 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.
+
+PuppetLint.new_check(:template_file_extension) do
+  def check
+    template_extensions = {
+      epp: ".epp",
+      template: ".erb"
+    }
+
+    # the types a filename may be in a `template()` call
+    name_types = %i[DQPOST SSTRING]
+
+    resource_indexes.each do |resource|
+      next unless resource[:type].value == "file"
+
+      param_tokens = resource[:param_tokens].select { |pt| pt.value == "content" }
+
+      param_tokens.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
+          current_token = current_token.next_token while current_token.type == :WHITESPACE
+
+          # iterate over all the code tokens until we hit the closing ')'
+          until current_token.type == :RPAREN || current_token.type == :LBRACE
+            current_token = current_token.next_code_token
+
+            if (name_types.include? current_token.type) && !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

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

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+describe "no_symbolic_file_modes" do
+  let(:msg) { "mode should be a 4 digit octal value, not a symbolic mode" }
+
+  context "when the manifest has no file resources" do
+    let(:code) do
+      <<-TEST_CLASS
+        class no_file_resource {
+          host { 'syslog':
+            ip => '10.10.10.10',
+          }
+        }
+      TEST_CLASS
+    end
+
+    it "does not detect any problems" do
+      expect(problems.size).to eq(0)
+    end
+  end
+
+  context "when file has an all octal mode" do
+    let(:code) do
+      <<-TEST_CLASS
+        class octal_file_mode {
+          file { '/tmp/octal-mode':
+            mode => '0600',
+          }
+        }
+      TEST_CLASS
+    end
+
+    it "does not detect any problems" do
+      expect(problems.size).to eq(0)
+    end
+  end
+
+  context "when file mode is specified in a variable" do
+    let(:code) do
+      <<-TEST_CLASS
+        class octal_file_mode {
+          $mode = 'ug=rw,o=rx'
+
+          file { '/tmp/octal-mode':
+            mode => $mode,
+          }
+        }
+      TEST_CLASS
+    end
+
+    it "does not detect any problems" do
+      expect(problems.size).to eq(0)
+    end
+  end
+
+  context "when file has a symbolic mode" do
+    let(:code) do
+      <<-TEST_CLASS
+        class symbolic_file_mode {
+          file { '/tmp/symbolic-mode':
+            mode => 'ug=rw,o=rx',
+          }
+        }
+      TEST_CLASS
+    end
+
+    it "detects a single problem" do
+      expect(problems.size).to eq(1)
+    end
+
+    it "creates a warning" do
+      expect(problems).to contain_warning(msg).on_line(3).in_column(21)
+    end
+  end
+end

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

@@ -0,0 +1,188 @@
+require "spec_helper"
+
+describe "template_file_extension" do
+  context "when the manifest has no file resources" do
+    let(:code) do
+      <<-TEST_CLASS
+        class no_file_resource {
+          host { 'syslog':
+            ip => '10.10.10.10',
+          }
+        }
+      TEST_CLASS
+    end
+
+    it "does not detect any problems" do
+      expect(problems.size).to eq(0)
+    end
+  end
+
+  context "when a non-template function is called" do
+    let(:code) do
+      <<-TEST_CLASS
+        class random_function {
+          file { '/tmp/templated':
+            content => random_name('mymodule/single_file.erb'),
+          }
+        }
+      TEST_CLASS
+    end
+
+    it "does not detect any problems" do
+      expect(problems.size).to eq(0)
+    end
+  end
+
+  context "when the template function is called with one valid file name" do
+    let(:code) do
+      <<-TEST_CLASS
+        class valid_template_filename {
+          file { '/tmp/templated':
+            content => template('mymodule/single_file.erb'),
+          }
+        }
+      TEST_CLASS
+    end
+
+    it "does not detect any problems" do
+      expect(problems.size).to eq(0)
+    end
+  end
+
+  context "when the epp function is called with one valid file name" do
+    let(:code) do
+      <<-TEST_CLASS
+        class valid_epp_template_filename {
+          file { '/tmp/templated':
+            content => epp('mymodule/single_file.epp'),
+          }
+        }
+      TEST_CLASS
+    end
+
+    it "does not detect any problems" do
+      expect(problems.size).to eq(0)
+    end
+  end
+
+  context "when the epp function is called with one valid file name and parameters" do
+    let(:code) do
+      <<-TEST_CLASS
+        class valid_epp_template_filename {
+          file { '/tmp/templated':
+            content => epp('mymodule/single_file.epp', {'key' => 'val'}),
+          }
+        }
+      TEST_CLASS
+    end
+
+    it "does not detect any problems" do
+      expect(problems.size).to eq(0)
+    end
+  end
+
+  context "when a space it present between the template function and opening paren" do
+    let(:code) do
+      <<-TEST_CLASS
+        class space_between_template_and_opening_paren {
+          file { '/tmp/templated':
+            content => template ('mymodule/a_file.erb'),
+          }
+        }
+      TEST_CLASS
+    end
+
+    it "does not detect any problems" do
+      expect(problems.size).to eq(0)
+    end
+  end
+
+  context "when the template function is called with a single invalid file name" do
+    let(:template_msg) { "all template file names should end with .erb" }
+    let(:code) do
+      <<-TEST_CLASS
+        class multi_templated_file {
+          file { '/tmp/templated':
+            content => template('mymodule/first_file.erb', 'mymodule/second_file.conf'),
+          }
+        }
+      TEST_CLASS
+    end
+
+    it "detects a single problem" do
+      expect(problems.size).to eq(1)
+    end
+
+    it "creates a warning" do
+      expect(problems).to contain_warning(template_msg).on_line(3).in_column(24)
+    end
+  end
+
+  context "when the epp function is called with a single invalid file name" do
+    let(:epp_msg) { "all epp file names should end with .epp" }
+
+    let(:code) do
+      <<-TEST_CLASS
+        class epp_multi_templated_file {
+          file { '/tmp/templated':
+            content => epp('mymodule/first_file', {'key' => 'val'}),
+          }
+        }
+      TEST_CLASS
+    end
+
+    it "detects a single problem" do
+      expect(problems.size).to eq(1)
+    end
+
+    it "creates a warning" do
+      expect(problems).to contain_warning(epp_msg).on_line(3).in_column(24)
+    end
+  end
+
+  context "when there is a space between the template function and opening paren, and no extension is provided" do
+    let(:template_msg) { "all template file names should end with .erb" }
+
+    let(:code) do
+      <<-TEST_CLASS
+        class space_between_template_and_opening_paren {
+          file { '/tmp/templated':
+            content => template ('mymodule/a_file'),
+          }
+        }
+      TEST_CLASS
+    end
+
+    it "detects a single problem" do
+      expect(problems.size).to eq(1)
+    end
+
+    it "creates a warning" do
+      expect(problems).to contain_warning(template_msg).on_line(3).in_column(24)
+    end
+  end
+
+  ## https://github.com/deanwilson/puppet-lint-template_file_extension-check/issues/48
+  context "when the paramater type is DQPOST not SSTRING and no extension is provided (issue #48)" do
+    let(:template_msg) { "all template file names should end with .erb" }
+
+    let(:code) do
+      <<-TEST_CLASS
+        class space_between_template_and_opening_paren {
+          file { "/etc/${package_name}.conf":
+            ensure  => file,
+            content => template("allknowingdns/${package_name}.conf"),
+          }
+        }
+      TEST_CLASS
+    end
+
+    it "detects a single problem" do
+      expect(problems.size).to eq(1)
+    end
+
+    it "creates a warning" do
+      expect(problems).to contain_warning(template_msg).on_line(4).in_column(24)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-nine-check
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Nine Internet Solutions AG
@@ -108,8 +108,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  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
-    A pupet-lint to check you are not using Nine legacy facts like `$::nine_location`
+    A pupet-lint to check to ensure you are not using Nine legacy facts like `$::nine_location`
     or `$facts['nine_location']`. You should use the new structured facts like
     `$facts['nine_metadata']['location']` instead.
 email:
@@ -123,11 +137,15 @@ files:
 - lib/puppet-lint/plugins/concatenated_template_files.rb
 - lib/puppet-lint/plugins/explicit_hiera_class_param_lookup.rb
 - lib/puppet-lint/plugins/nine_legacy_facts.rb
+- lib/puppet-lint/plugins/no_symbolic_file_modes.rb
+- lib/puppet-lint/plugins/template_file_extension.rb
 - lib/puppet-lint/plugins/trailing_newline.rb
 - lib/puppet-lint/plugins/world_writable_files.rb
 - spec/puppet-lint/plugins/concatenated_template_files_spec.rb
 - spec/puppet-lint/plugins/explicit_hiera_class_param_lookup_spec.rb
 - spec/puppet-lint/plugins/nine_legacy_facts_spec.rb
+- spec/puppet-lint/plugins/no_symbolic_file_modes_spec.rb
+- spec/puppet-lint/plugins/template_file_extension_spec.rb
 - spec/puppet-lint/plugins/trailing_newline_spec.rb
 - spec/puppet-lint/plugins/world_writable_files_spec.rb
 - spec/spec_helper.rb