salt-lint 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c6fdd6bc0f61861da08a6749f212f70702f859f
-  data.tar.gz: 7cdfc50a058ea2233f81cfb7d08e0de6b19dcf73
+  metadata.gz: 1fe2637de60ccfaa599fdacd992bc4a82a52f9fb
+  data.tar.gz: a4c720a812c7a64c6f3ada177c1db9ec11e1af15
 SHA512:
-  metadata.gz: 914c047db9b1a65e441f058a96db6f9d65a659c8fc896ec3cc2d7c79b3148724c899d01c77c6caba17f956f1f2275c57b0e5fe56a2ae07e9b8e6ad39ac818ca8
-  data.tar.gz: 6629dc6f3f525536de001d603fa708d858ea3c00ec8785e0ae3e313dfa59a1d7b44f4e7d082f215f8ce95d4ce80a7183beaaa67245a380b00cbd21c2a6286fbb
+  metadata.gz: 04d2acece330ecdae9ae4d7cd677891a5fc1cccf8be3166b7523d2b1f9ec1a5a8b5f017a4405ebfc013df0ddcbc8ec70c29153c123675644db9d47d6f915c459
+  data.tar.gz: 82c711e2eef7ff31ef8bf39b354a716b11d9f76391e4492ea885496642d8d89746ad2d869329be275a7f960b0848f79b3512b160c9be6ffee374210b665a7e3a

data/.gitignore

@@ -1,3 +1,4 @@
 *.lock
 .DS_Store
-*.gem
+*.gem
+*.swp

data/Gemfile

@@ -1,8 +1,10 @@
 source 'https://rubygems.org'
 
-gem 'rspec'
+group :test do
+  gem 'rspec'
+  gem 'fuubar'
+end
 gem 'colorize'
 gem 'aruba-rspec'
-gem 'fuubar'
 gem 'trollop'
 gem 'awesome_print'

data/README.md

@@ -2,12 +2,15 @@
 
 Linter for Salt configuration management.
 
-[![Master: Build Status](https://api.shippable.com/projects/551cfc825ab6cc1352b491b3/badge?branchName=master)](https://app.shippable.com/projects/551cfc825ab6cc1352b491b3/builds/latest)
-[![Development: Build Status](https://api.shippable.com/projects/551cfc825ab6cc1352b491b3/badge?branchName=development)](https://app.shippable.com/projects/551cfc825ab6cc1352b491b3/builds/latest)
+Master: [![Master: Build Status](https://api.shippable.com/projects/551cfc825ab6cc1352b491b3/badge?branchName=master)](https://app.shippable.com/projects/551cfc825ab6cc1352b491b3/builds/latest)
+Development: [![Development: Build Status](https://api.shippable.com/projects/551cfc825ab6cc1352b491b3/badge?branchName=development)](https://app.shippable.com/projects/551cfc825ab6cc1352b491b3/builds/latest)
 
 
 [![Gem Version](https://badge.fury.io/rb/salt-lint.svg)](http://badge.fury.io/rb/salt-lint) 
 [![Code Climate](https://codeclimate.com/github/lukaszraczylo/salt-lint/badges/gpa.svg)](https://codeclimate.com/github/lukaszraczylo/salt-lint)
 [![Gratipay](https://img.shields.io/gratipay/lukaszraczylo.svg)](https://gratipay.com/lukaszraczylo/)
 
+## Documentation:
+Please see [documentation](doc/list_tests.md) to interpret any results returned.
+
 ## Do not use it until version >= 0.5

data/coverage/.last_run.json

@@ -0,0 +1,5 @@
+{
+  "result": {
+    "covered_percent": 100.0
+  }
+}

data/coverage/.resultset.json

@@ -0,0 +1,7 @@
+{
+  "RSpec": {
+    "coverage": {
+    },
+    "timestamp": 1428003706
+  }
+}

data/doc/list_tests.md

@@ -0,0 +1,47 @@
+# Salt-lint tests
+
+* [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
+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
+```
+dev:
+    "*"
+```
+
+##### Correct
+```
+dev:
+    '*'
+```
+
+### 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
+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
+```
+  python:
+    pkg:
+      - installed
+```
+
+##### Correct
+```
+    python:
+      pkg.installed
+```
+
+### 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).

data/lib/salt-lint/actions.rb

@@ -6,10 +6,11 @@ module SaltLint
     def self.check_rules(f)
       $invalid_yaml     = Hash.new
       $invalid_newline  = Hash.new
+      $invalid_oneword  = Hash.new
 
       checks_went_fine = true
       Printer.print('debug', "Checking file: #{f}", 5)
-      test_suite_methods = SaltLint::Tests.methods(false).sort
+      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|

data/lib/salt-lint/tests.rb

@@ -4,13 +4,28 @@ module SaltLint
   # Main class for all the tests.
   class Tests
 
-    # Test content: Checking given line for trailing whitespaces.
-    def self.check_trailing_whitespace(line_number, line, file)
+    # Helper: Checking for whitespaces
+    def self.check_for_regexp(line_number, line, file, regex, debug_msg, warning_msg)
       is_ok = true
-      Printer.print('debug', "Checking for trailing whitespaces: #{line_number}", 5)
-      line.match(/[ \t]+$/) ? is_ok = false : nil
+      Printer.print('debug', debug_msg, 5)
+      line.match(regex) ? is_ok = false : nil
       if ! is_ok
-        Printer.print('warning', "Trailing whitespace character found: #{file}:#{line_number}")
+        Printer.print('warning', warning_msg)
+      end
+      return is_ok
+    end
+
+    # 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
       end
       return is_ok
     end
@@ -54,16 +69,15 @@ module SaltLint
       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}")
+    end
+
     # Test content: Checking if given line contains double quoted content without
     # variable.
     def self.check_double_quotes(line_number, line, file)
-      is_ok = true
-      Printer.print('debug', "Checking for double quotes: #{line_number}", 5)
-      line.match(/\"(?!{+).*(?!}+)\"/) ? is_ok = false : nil
-      if ! is_ok
-        Printer.print('warning', "Using double quotes with no variables: #{file}:#{line_number}")
-      end
-      return is_ok
+      check_for_regexp(line_number, line, file, /\"(?!{+).*(?!}+)\"/, "Checking for double quotes: #{line_number}", "Using double quotes with no variables: #{file}:#{line_number}")
     end
   end
 end

data/lib/salt-lint/version.rb

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

data/shippable.yml

@@ -2,6 +2,10 @@ language: ruby
 install:
   - bundle install
 
+env:
+  global:
+    - secure: bFWu5rjnllXLSI7EqWqlvOQZ6mpKMv3RnFgq9DFM9aeCmkrd5tr5hH+SQDuX9W5okJDoytJX60xPcDtVShabgtTPcadEl4bSjgRgG+1Uof33TmNzhlLRBpiZ6auOtWxW3wHqUt9g7YNuj4/wFstdVnud7c8zBvClsy32V4KNrrUdhLl0Qyb2ULv82V1yBdgQ2wESdAa0La5OoP43+qTkD3lm8Z9D/X3qDJcKT59ylolnBwi25XQUDa+4v5YbC2zUK+HUyayNLgH7Rqc1tLYrQv6a1qogwE0yPRChd7Ig+y73MqRkWmCts6kTpkpOpKLaFW3sMxrwsftOhkZ4ns2GnQ==
+
 notifications:
   email:
     recipients:

data/spec/spec_helper.rb

@@ -1,11 +1,12 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-require 'salt-lint'
+
 require 'rspec'
+require 'ostruct'
+require 'salt-lint'
 require 'aruba/rspec'
 require 'pathname'
-require 'ostruct'
 
 require 'salt-lint/printer'
 require 'salt-lint/actions'

data/spec/tests_spec.rb

@@ -29,4 +29,12 @@ describe 'Tests suite checks if' do
   it 'won\'t allow to forget about newline at the end of the file' do
     expect(SaltLint::Tests.check_for_no_newline(0, 0, test_file_bad)).to eq false
   end
+
+  it 'won\'t allow to single word declarations' do
+    expect(SaltLint::Tests.check_if_single_word_declaration(5, "pkg:\n", test_file_bad)).to eq false
+  end
+
+  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

data/tests/file_with_multiple_errors.sls

@@ -1,3 +1,6 @@
 base:
-  "*":  
+  "*":
     - this_line_should_throw_an_error_as_it_is_longer_than_80_characters_which_trigger_alert
+  python:
+    pkg:
+      - installed

data/tests/well_formatted_top.sls

@@ -1,4 +1,6 @@
 base:
   '*':
     - core
+python:
+  pkg.installed
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: salt-lint
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Lukasz Raczylo
@@ -112,6 +112,9 @@ files:
 - README.md
 - Rakefile
 - bin/salt-lint
+- coverage/.last_run.json
+- coverage/.resultset.json
+- doc/list_tests.md
 - lib/salt-lint.rb
 - lib/salt-lint/actions.rb
 - lib/salt-lint/options.rb
@@ -125,7 +128,6 @@ files:
 - spec/files_spec.rb
 - spec/spec_helper.rb
 - spec/tests_spec.rb
-- tests/.well_formatted_top.sls.swp
 - tests/file_with_multiple_errors.sls
 - tests/non_yaml_file.sls
 - tests/well_formatted_top.sls