salt-lint 0.1.2 → 0.1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fe2637de60ccfaa599fdacd992bc4a82a52f9fb
-  data.tar.gz: a4c720a812c7a64c6f3ada177c1db9ec11e1af15
+  metadata.gz: 06b6748f8fb4a05737347e3b730b460e62804f43
+  data.tar.gz: 916bad67abd80bc6f01e3ceb4ac0669a7d03e8f4
 SHA512:
-  metadata.gz: 04d2acece330ecdae9ae4d7cd677891a5fc1cccf8be3166b7523d2b1f9ec1a5a8b5f017a4405ebfc013df0ddcbc8ec70c29153c123675644db9d47d6f915c459
-  data.tar.gz: 82c711e2eef7ff31ef8bf39b354a716b11d9f76391e4492ea885496642d8d89746ad2d869329be275a7f960b0848f79b3512b160c9be6ffee374210b665a7e3a
+  metadata.gz: 56db23b66967baa8f52f5e0b121c4dbae2a59afcd3c9f45e54bf63bf3b7f449b733605ea07e088f05f949bb4478933e47878b841e49ffcce163a58052196f55e
+  data.tar.gz: 6f7b73c95725063538f928039062ede88e123c49abde456627a676221728773781393cb5fdae94ed2b06bce599388d11f6d82f78bb68cfed4c2f387398110cc5

data/README.md

@@ -13,4 +13,10 @@ Development: [![Development: Build Status](https://api.shippable.com/projects/55
 ## Documentation:
 Please see [documentation](doc/list_tests.md) to interpret any results returned.
 
+## Running within git repo with its git files only
+
+```
+git ls-files | grep sls | xargs -I {} salt-lint -f {}
+```
+
 ## Do not use it until version >= 0.5

data/doc/list_tests.md

@@ -1,12 +1,13 @@
-# Salt-lint tests
+# Salt-lint tests results.
 
-* [Using double quotes with no variables](#Using double quotes with no variables)
-* [Line length above 80 characters](#Line length above 80 characters)
-* [Found single line declaration](#Found single line declaration)
-* [No newline at the end of the file](#No newline at the end of the file)
-* [Trailing whitespace character found](#Trailing whitespace character found)
+* [Using double quotes with no variables](#double-quotes)
+* [Line length above 80 characters](#line-length)
+* [Found single line declaration](#single-declaration)
+* [No newline at the end of the file](#no-newline)
+* [Trailing whitespace character found](#trailing-whitespace)
+* [Found tabs used instead of spaces](#found-tabs)
 
-### Using double quotes with no variables
+### <a name="double-quotes"></a>Using double quotes with no variables
 In general - it's a bad idea. All the strings which does not contain dynamic content ( variables ) should use single quote instead of double.
 
 ##### Bad
@@ -21,10 +22,10 @@ dev:
     '*'
 ```
 
-### Line length above 80 characters
+### <a name="line-length"></a>Line length above 80 characters
 As a 'standard code width limit' and for historical reasons - [IBM punch card](http://en.wikipedia.org/wiki/Punched_card) had exactly 80 columns.
 
-### Found single line declaration
+### <a name="single-declaration"></a>Found single line declaration
 Avoid extending your code by adding single-line declarations. It makes your code much cleaner and easier to parse / grep while searching for those declarations.
 
 ##### Bad
@@ -40,8 +41,17 @@ Avoid extending your code by adding single-line declarations. It makes your code
       pkg.installed
 ```
 
-### No newline at the end of the file
+### <a name="no-newline"></a>No newline at the end of the file
 Each line should be terminated in a newline character, including the last one. Some programs have problems processing the last line of a file if it isn't newline terminated. [Stackoverflow thread](http://stackoverflow.com/questions/729692/why-should-files-end-with-a-newline)
 
-### Trailing whitespace character found
-Trailing whitespaces take more spaces than necessary, any regexp based searches won't return lines as a result due to trailing whitespace(s).
+### <a name="trailing-whitespace"></a>Trailing whitespace character found
+Trailing whitespaces take more spaces than necessary, any regexp based searches won't return lines as a result due to trailing whitespace(s).
+
+### <a name="quoted-booleans"></a>Quoted boolean found
+Boolean values behave differently when quoted as they're interpreted as strings which you obviously don't want.
+
+### <a name="filename-quoted"></a>Unquoted file mode found
+Unquoted file modes are interpreted as integers and evaluated as octal.
+
+### <a name="found-tabs"></a>Found tabs used instead of spaces
+[PEP-8](http://legacy.python.org/dev/peps/pep-0008/#tabs-or-spaces) says "spaces" so we require those instead of tabs as Salt is python-friendly ( said guy who wrote a Salt linter in Ruby ).

data/lib/salt-lint/actions.rb

@@ -1,3 +1,5 @@
+require 'find'
+
 module SaltLint
   # Executing appropriate actions
   # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -13,10 +15,30 @@ module SaltLint
       test_suite_methods = SaltLint::Tests.methods(false).sort - [ :check_for_regexp ]
       line_counter = 1
       File.readlines(f).each do |l|
-        test_suite_methods.each do |m|
-          if ! $invalid_yaml[f]
-            checks_went_fine_tmp = SaltLint::Tests.send(m, line_counter, l, f)
-            checks_went_fine_tmp == false ? checks_went_fine = false : nil
+        skip = false
+        tmp_l = l.gsub(/\s+/, '')
+        # Comments
+        if tmp_l =~ /\{?#(.+)?\}?/
+          skip = true
+        # Empty lines
+        elsif tmp_l =~ /^$/
+          skip = true
+        # Functions
+        elsif tmp_l =~ /\{+.+\(.+\).+\}+/
+          skip = true
+        # Variables
+        elsif tmp_l =~ /\{\{.+\}\}/
+          l = l.gsub(/\{\{.+\}\}/, 'random_string')
+        # If / Else blocks
+        elsif tmp_l =~ /^\{\%.*\%\}$/
+          skip = true
+        end
+        if ! skip
+          test_suite_methods.each do |m|
+            if ! $invalid_yaml[f]
+              checks_went_fine_tmp = SaltLint::Tests.send(m, line_counter, l, f)
+              checks_went_fine_tmp == false ? checks_went_fine = false : nil
+            end
           end
         end
         line_counter += 1
@@ -27,9 +49,15 @@ module SaltLint
 
     # Scans folder specified as argument --scan for SLS files and returns array
     def self.scan
-      files = Dir.glob( $arguments.scan + "**/*.sls")
-      if files and files.count > 0
-        return files
+      # files = Dir.glob( $arguments.scan + "**/*")
+      files_to_return = Array.new
+      Find.find($arguments.scan).to_a.each do |f|
+        if f =~ /.*\.sls$/
+          files_to_return.push(f)
+        end
+      end
+      if files_to_return.count > 0
+        return files_to_return
       else
         Printer.print('error', 'No salt state files found.')
         exit 1

data/lib/salt-lint/options.rb

@@ -14,6 +14,8 @@ module SaltLint
             SaltLint::Actions.check_rules(f)
           end
         end
+      elsif $arguments.file_given
+        SaltLint::Actions.check_rules($arguments.file)
       end
     end
 
@@ -32,6 +34,16 @@ EOS
         opt :debug,   'Enable debug mode', default: 0
         opt :file,    'File to check against', type: :string
         opt :scan,    'Traversal scan of current directory and sub dirs', type: :string
+
+        opt :check_newlines, 'Check for newline at the end of the file', default: true, short: :none
+        opt :check_double_quotes, 'Check for double quotes without variables', default: true, short: :none
+        opt :check_whitespaces, 'Check for whitespaces at the end of the line', default: true, short: :none
+        opt :check_line_length, 'Check lines length', default: true, short: :none
+        opt :check_single_word, 'Check for single word declaration', default: true, short: :none
+        opt :check_quoted_boolean, 'Check for quoted booleans', default: true, short: :none
+        opt :check_quoted_file_mode, 'Check for unquoted file modes', default: true, short: :none
+        opt :check_tabs, 'Check if tabs used instead of spaces', default: true, short: :none
+
       end
       $debug = opts.debug.to_i
       return opts

data/lib/salt-lint/tests.rb

@@ -6,9 +6,8 @@ module SaltLint
 
     # Helper: Checking for whitespaces
     def self.check_for_regexp(line_number, line, file, regex, debug_msg, warning_msg)
-      is_ok = true
       Printer.print('debug', debug_msg, 5)
-      line.match(regex) ? is_ok = false : nil
+      ! (line =~ Regexp.new(regex)).nil? ? is_ok = false : is_ok = true
       if ! is_ok
         Printer.print('warning', warning_msg)
       end
@@ -18,14 +17,16 @@ module SaltLint
     # Test content: Check context and block all the single-word declarations
     def self.check_if_single_word_declaration(line_number, line, file)
       is_ok = true
-      Printer.print('debug', "Looking for single word declarations in #{file}", 5)
-      if line =~ /(pkg|file|service):\n/
-          f = File.readlines(file)[line_number-1..line_number+2]
-          ( f[2] =~ /^\n$/ && f[1] =~ /- \w+\n$/ ) ? is_ok = true : is_ok = false
-          if ! $invalid_oneword.has_key?(file) && is_ok == false
-            Printer.print('warning', "Found single line declaration in #{file}:#{line_number-1}-#{line_number+2}")
-            $invalid_oneword[file] = is_ok
-          end
+      if $arguments.check_single_word
+        Printer.print('debug', "Looking for single word declarations in #{file}", 5)
+        if line =~ /(pkg|file|service):\n/
+            f = File.readlines(file)[line_number-1..line_number+2]
+            ( f[2] =~ /^\n$/ && f[1] =~ /- \w+\n$/ ) ? is_ok = true : is_ok = false
+            if ! $invalid_oneword.has_key?(file) && is_ok == false
+              Printer.print('warning', "Found single line declaration in #{file}:#{line_number-1}-#{line_number+1}")
+              $invalid_oneword[file] = is_ok
+            end
+        end
       end
       return is_ok
     end
@@ -33,51 +34,76 @@ module SaltLint
     # Test content: Checking given file for no newline at the end of the file.
     def self.check_for_no_newline(line_number, line, file)
       is_ok = true
-      Printer.print('debug', "Checking for no-newline at the end of the file in file #{file}", 5)
-      f = File.readlines(file).last
-      f.match(/^\n$/) ? is_ok = true : is_ok = false
-      if ! $invalid_newline.has_key?(file) && is_ok == false
-        Printer.print('warning', "No newline at the end of the file #{file}")
-        $invalid_newline[file] = is_ok
+        if $arguments.check_newlines
+        Printer.print('debug', "Checking for no-newline at the end of the file in file #{file}", 5)
+        f = File.readlines(file).last
+        f.match(/^\n$/) ? is_ok = true : is_ok = false
+        if ! $invalid_newline.has_key?(file) && is_ok == false
+          Printer.print('warning', "No newline at the end of the file #{file}")
+          $invalid_newline[file] = is_ok
+        end
       end
       return is_ok
     end
 
-    # Test content: Checking if given file is a valid YAML file.
-    def self.check_if_proper_yaml(line_number, line, file)
+    # Test content: Checking if given line isn't longer than 80 characters.
+    def self.check_line_length(line_number, line, file)
       is_ok = true
-      begin
-        YAML.load_file(file)
-      rescue Psych::SyntaxError
-        is_ok = false
-        if ! $invalid_yaml.has_key?(file)
-          Printer.print('warning', "File #{file} is not YAML. Unable to parse.")
-          $invalid_yaml[file] = true
+      if $arguments.check_line_length
+        Printer.print('debug', "Checking line length: #{line_number}", 5)
+        line.length > 80 ? is_ok = false : nil
+        if ! is_ok
+          Printer.print('warning', "Line length above 80 characters: #{file}:#{line_number}")
         end
       end
       return is_ok
     end
 
-    # Test content: Checking if given line isn't longer than 80 characters.
-    def self.check_line_length(line_number, line, file)
-      is_ok = true
-      Printer.print('debug', "Checking line length: #{line_number}", 5)
-      line.length > 80 ? is_ok = false : nil
-      if ! is_ok
-        Printer.print('warning', "Line length above 80 characters: #{file}:#{line_number}")
+
+    # Test content: Check for tabs used instead of spaces.
+    def self.check_if_tabs_used(line_number, line, file)
+      if $arguments.check_tabs
+        check_for_regexp(line_number, line, file, /^[\t]+/, "Checking for tabs presence: #{line_number}", "Found tabs used instead of spaces: #{file}:#{line_number}")
+      else
+        return true
       end
-      return is_ok
     end
 
     # Test content: Checking given line for trailing whitespaces.
     def self.check_trailing_whitespace(line_number, line, file)
-      check_for_regexp(line_number, line, file, /[ \t]+$/, "Checking for trailing whitespaces: #{line_number}", "Trailing whitespace character found: #{file}:#{line_number}")
+      if $arguments.check_whitespaces
+        check_for_regexp(line_number, line, file, /[ \t]+$/, "Checking for trailing whitespaces: #{line_number}", "Trailing whitespace character found: #{file}:#{line_number}")
+      else
+        return true
+      end
     end
 
     # Test content: Checking if given line contains double quoted content without
     # variable.
     def self.check_double_quotes(line_number, line, file)
-      check_for_regexp(line_number, line, file, /\"(?!{+).*(?!}+)\"/, "Checking for double quotes: #{line_number}", "Using double quotes with no variables: #{file}:#{line_number}")
+      if $arguments.check_double_quotes
+        check_for_regexp(line_number, line, file, /\"(?!{+).*(?!}+)\"/, "Checking for double quotes: #{line_number}", "Using double quotes with no variables: #{file}:#{line_number}")
+      else
+        return true
+      end
+    end
+
+    # Test content: Checking if there's quoted boolean value present.
+    def self.check_quoted_boolean(line_number, line, file)
+      if $arguments.check_quoted_boolean
+        check_for_regexp(line_number, line, file, /\s+(\"|\')(true|false)(\"|\')$/, "Checking for quoted booleans: #{line_number}", "Quoted boolean found: #{file}:#{line_number}")
+      else
+        return true
+      end
+    end
+
+    # Test content: Check if file mode with leading zero is wrapped into single quotes
+    def self.check_file_mode_single_quotes(line_number, line, file)
+      if $arguments.check_quoted_file_mode
+        check_for_regexp(line_number, line, file, /mode\:\s\d{3,4}$/, "Checking if file mode is wrapped in single quotes: #{line_number}", "Unquoted file mode found: #{file}:#{line_number}")
+      else
+        return true
+      end
     end
   end
 end

data/lib/salt-lint/version.rb

@@ -1,3 +1,3 @@
 module SaltLint
-  VERSION = '0.1.2'
+  VERSION = '0.1.4.1'
 end

data/shippable.yml

@@ -1,3 +1,4 @@
+cache: true
 language: ruby
 install:
   - bundle install

data/spec/files_spec.rb

@@ -1,22 +1,31 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
+$arguments = OpenStruct.new({ file: 'tests/file_with_multiple_errors.sls', file_given: true,
+     check_newlines: true, check_double_quotes: true, check_whitespaces: true,
+     check_line_length: true, check_single_word: true, check_quoted_booleans: true })
+
+$debug = 0
+
 describe 'Files operations' do
 
   it 'scans all the files within "tests" directory' do
-    $arguments = OpenStruct.new({ scan: 'tests', scan_given: true })
+    $arguments.file_given = false
+    $arguments.scan_given = true
+    $arguments.scan = 'tests'
     list_of_sls_files = SaltLint::Actions.scan
     expect(list_of_sls_files.grep(/well_formatted_top\.sls/).any?).to eq true
   end
 
   it 'checks well formatted file' do
-    $arguments = OpenStruct.new({ file: 'tests/well_formatted_top.sls', file_given: true })
-    $debug = 0
+    $arguments.file = 'tests/well_formatted_top.sls'
+    $arguments.file_given = true
+    $arguments.scan_given = false
     expect(SaltLint::Actions.check_rules($arguments.file)).to eq true
   end
 
   it 'checks file with multiple errors' do
-    $arguments = OpenStruct.new({ file: 'tests/file_with_multiple_errors.sls', file_given: true })
-    $debug = 0
+    $arguments.scan_given = false
+    $arguments.file = 'tests/file_with_multiple_errors.sls'
     expect(SaltLint::Actions.check_rules($arguments.file)).to eq false
   end
 end

data/spec/tests_spec.rb

@@ -1,18 +1,15 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
+$arguments = OpenStruct.new({ file: 'tests/file_with_multiple_errors.sls', file_given: true,
+     check_newlines: true, check_double_quotes: true, check_whitespaces: true,
+     check_line_length: true, check_single_word: true, check_quoted_boolean: true,
+     check_quoted_file_mode: true, check_tabs: true })
+
 test_file_good      = 'tests/well_formatted_top.sls'
 test_file_bad_yaml  = 'tests/non_yaml_file.sls'
 test_file_bad       = 'tests/file_with_multiple_errors.sls'
 
 describe 'Tests suite checks if' do
-  it 'file is in YAML format (incorrect)' do
-    expect(SaltLint::Tests.check_if_proper_yaml(0, 0, test_file_bad_yaml)).to eq false
-  end
-
-  it 'file is in YAML format (correct)' do
-    expect(SaltLint::Tests.check_if_proper_yaml(0, 0, test_file_good)).to eq true
-  end
-
   it 'won\'t allow lines longer than 80 characters' do
     expect(SaltLint::Tests.check_line_length(0, 'xG9H2z8dOK0n3fTX1g4bWS5a6lRI7t6jCsY58mLJ2pqU9N3k4rBD0woA17iMyP90eEZ2u3cFbQ47uYD5lmM16' , test_file_good)).to eq false
   end
@@ -37,4 +34,20 @@ describe 'Tests suite checks if' do
   it 'will allow condensed declarations' do
     expect(SaltLint::Tests.check_if_single_word_declaration(5, "pkg.installed\n", test_file_good)).to eq true
   end
-end
+
+  it 'won\'t allow quoted booleans' do
+    expect(SaltLint::Tests.check_quoted_boolean(5, 'potato: "true"', test_file_bad)).to eq false
+  end
+
+  it 'won\'t allow unquoted file modes' do
+    expect(SaltLint::Tests.check_file_mode_single_quotes(8, 'mode: 0744', test_file_bad)).to eq false
+  end
+
+  it 'won\'t allow using tabs instead of spaces' do
+    expect(SaltLint::Tests.check_if_tabs_used(8, "\ttest_value", test_file_bad)).to eq false
+  end
+
+  it 'will allow using spaces instead of tabs' do
+    expect(SaltLint::Tests.check_if_tabs_used(8, "  test_value", test_file_good)).to eq true
+  end
+end

data/tests/file_with_multiple_errors.sls

@@ -4,3 +4,5 @@ base:
   python:
     pkg:
       - installed
+      - value: 'false'
+					- mode: 0644

data/tests/well_formatted_top.sls

@@ -3,4 +3,6 @@ base:
     - core
 python:
   pkg.installed
+  value: true
+  mode: '0644'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salt-lint
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4.1
 platform: ruby
 authors:
 - Lukasz Raczylo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-02 00:00:00.000000000 Z
+date: 2015-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -151,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Salt linter written in Ruby
@@ -160,4 +160,3 @@ test_files:
 - spec/files_spec.rb
 - spec/spec_helper.rb
 - spec/tests_spec.rb
-has_rdoc: