salt-lint 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c6fdd6bc0f61861da08a6749f212f70702f859f
+  data.tar.gz: 7cdfc50a058ea2233f81cfb7d08e0de6b19dcf73
+SHA512:
+  metadata.gz: 914c047db9b1a65e441f058a96db6f9d65a659c8fc896ec3cc2d7c79b3148724c899d01c77c6caba17f956f1f2275c57b0e5fe56a2ae07e9b8e6ad39ac818ca8
+  data.tar.gz: 6629dc6f3f525536de001d603fa708d858ea3c00ec8785e0ae3e313dfa59a1d7b44f4e7d082f215f8ce95d4ce80a7183beaaa67245a380b00cbd21c2a6286fbb

data/.gitignore

@@ -0,0 +1,3 @@
+*.lock
+.DS_Store
+*.gem

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rspec'
+gem 'colorize'
+gem 'aruba-rspec'
+gem 'fuubar'
+gem 'trollop'
+gem 'awesome_print'

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Lukasz Raczylo
+
+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,13 @@
+# salt-lint
+
+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)
+
+
+[![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/)
+
+## Do not use it until version >= 0.5

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+task default: :spec
+desc 'Run all salt-lint gem specs'
+task :spec do
+  exec 'rspec -c spec'
+end

data/bin/salt-lint

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require 'pathname'
+bin_file = Pathname.new(__FILE__).realpath
+
+$:.unshift File.expand_path("../../lib", bin_file)
+
+require 'salt-lint/runner'
+SaltLint::Runner.new(*ARGV)

data/lib/salt-lint/actions.rb

@@ -0,0 +1,38 @@
+module SaltLint
+  # Executing appropriate actions
+  # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  class Actions
+    # Check if files comply with linter rules
+    def self.check_rules(f)
+      $invalid_yaml     = Hash.new
+      $invalid_newline  = Hash.new
+
+      checks_went_fine = true
+      Printer.print('debug', "Checking file: #{f}", 5)
+      test_suite_methods = SaltLint::Tests.methods(false).sort
+      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
+          end
+        end
+        line_counter += 1
+      end
+      checks_went_fine ? Printer.print('success', "File looks fine: #{f}") : Printer.print('error', "Found errors in file: #{f}")
+      return checks_went_fine
+    end
+
+    # 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
+      else
+        Printer.print('error', 'No salt state files found.')
+        exit 1
+      end
+    end
+  end
+end

data/lib/salt-lint/options.rb

@@ -0,0 +1,40 @@
+require 'trollop'
+
+module SaltLint
+  # Parsing user arguments / parameters class
+  # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  class Options
+    # Actions based on parsed command line arguments
+    def self.act
+      # Scanning for files in
+      if $arguments.scan_given
+        list_of_files = SaltLint::Actions.scan
+        if list_of_files.count > 0
+          SaltLint::Actions.scan.each do |f|
+            SaltLint::Actions.check_rules(f)
+          end
+        end
+      end
+    end
+
+
+    # Parsing command line arguments
+    def self.parse(args)
+      opts = Trollop::options do
+        version "salt-lint #{SaltLint::VERSION} (c) 2015 Lukasz Raczylo <lukasz@raczylo.com>\nVisit https://github.com/lukaszraczylo/salt-lint for source code"
+        banner <<-EOS
+salt-lint is a first linter for Salt state files.
+Usage:
+  $ salt-lint [options]
+
+where [options] are:
+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
+      end
+      $debug = opts.debug.to_i
+      return opts
+    end
+  end
+end

data/lib/salt-lint/printer.rb

@@ -0,0 +1,49 @@
+# Printer module
+# ~~~~~~~~~~~~~~
+# It's responsible for printing, duh.
+
+require 'colorize'
+
+module Printer
+  def self.print(msg_type = 'info', message = 'no message specified', debug_level = 0)
+    prefix  = nil
+    show    = true
+    kill    = false
+    case msg_type
+      when 'debug'
+        prefix  = '[d]'
+        color   = 'light_black'
+        show    = false
+      when 'warning'
+        prefix  = '[!]'
+        color   = 'yellow'
+      when 'error'
+        prefix  = '[!!!]'
+        color   = 'red'
+        kill    = true
+      when 'question'
+        prefix  = '[?]'
+        color   = 'light_blue'
+      when 'success'
+        prefix  = '[:)]'
+        color   = 'light_green'
+      else
+        prefix  = '[i]'
+        color   = 'white'
+    end
+
+    # If debug message requested - check if debug flag has been enabled and which
+    # level of debug if so. If global debug level is higher or equal to message
+    # debug level - print it out.
+    if msg_type == 'debug' and $debug != false and debug_level <= $debug
+      show = true
+    end
+
+    if show == true
+      puts "#{prefix} #{message}".send(color.to_sym)
+    end
+
+    # Kill switch for error messages. Using this one to abort script run as
+    # something went really wrong there.
+  end
+end

data/lib/salt-lint/runner.rb

@@ -0,0 +1,20 @@
+require 'salt-lint/version'
+require 'salt-lint/options'
+require 'salt-lint/printer'
+require 'salt-lint/actions'
+require 'salt-lint/tests'
+
+require 'awesome_print'
+
+module SaltLint
+  # Main class executed on every run. Just to spin things up.
+  # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  class Runner
+    def initialize(*args)
+      $arguments = SaltLint::Options.parse(args)
+      # ap $arguments
+      # ap $debug
+      SaltLint::Options.act
+    end
+  end
+end

data/lib/salt-lint/tests.rb

@@ -0,0 +1,69 @@
+require 'yaml'
+
+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)
+      is_ok = true
+      Printer.print('debug', "Checking for trailing whitespaces: #{line_number}", 5)
+      line.match(/[ \t]+$/) ? is_ok = false : nil
+      if ! is_ok
+        Printer.print('warning', "Trailing whitespace character found: #{file}:#{line_number}")
+      end
+      return is_ok
+    end
+
+    # 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
+      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)
+      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
+        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}")
+      end
+      return is_ok
+    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
+    end
+  end
+end

data/lib/salt-lint/version.rb

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

data/lib/salt-lint.rb

@@ -0,0 +1,10 @@
+require 'salt-lint/version'
+require 'salt-lint/runner'
+require 'salt-lint/tests'
+
+# Main salt-lint module declaration.
+module SaltLint
+  def self.runner
+    @runner ||= SaltLint::Runner.new(*ARGV)
+  end
+end

data/salt-lint.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'salt-lint/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'salt-lint'
+  spec.version = SaltLint::VERSION
+  spec.authors = ['Lukasz Raczylo']
+  spec.email = ['lukasz@raczylo.com']
+  spec.summary = %q{Salt linter written in Ruby}
+  spec.description = 'Created as nobody from Salt community created one till today.'
+  spec.homepage = 'https://github.com/lukaszraczylo/salt-lint'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>=1.9.2'
+  spec.add_development_dependency 'awesome_print', '~> 1.2.0', '>= 1.2.0'
+  spec.add_development_dependency 'trollop','2.1.2', '>= 2.1.2'
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 10.0', '>= 10.0.0'
+  spec.add_development_dependency 'rspec', '~> 2.6'
+end

data/shippable.yml

@@ -0,0 +1,10 @@
+language: ruby
+install:
+  - bundle install
+
+notifications:
+  email:
+    recipients:
+      - shippable@raczylo.com
+    on_success: change
+    on_failure: always

data/spec/basic_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'Basic commands' do
+  # Running the same with -h argument should display help
+  it 'arg -h displays help' do
+    expect(`salt-lint -h`).to include 'Usage:'
+  end
+end

data/spec/files_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'Files operations' do
+
+  it 'scans all the files within "tests" directory' do
+    $arguments = OpenStruct.new({ scan: 'tests', scan_given: true })
+    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
+    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
+    expect(SaltLint::Actions.check_rules($arguments.file)).to eq false
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'salt-lint'
+require 'rspec'
+require 'aruba/rspec'
+require 'pathname'
+require 'ostruct'
+
+require 'salt-lint/printer'
+require 'salt-lint/actions'
+
+RSpec.configure do |c|
+  c.fail_fast = true
+  c.include ArubaDoubles
+
+  c.before :each do
+    Aruba::RSpec.setup
+  end
+
+  c.after :each do
+    Aruba::RSpec.teardown
+  end
+
+  c.before(:all, &:silence_output)
+  c.after(:all,  &:enable_output)
+end
+
+root_path = Pathname.new(__FILE__).parent.parent
+ENV['PATH'] = "#{root_path.join('bin').to_s}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+
+public
+
+def silence_output
+  # Store the original stderr and stdout in order to restore them later
+  @original_stderr = $stderr
+  @original_stdout = $stdout
+
+  # Redirect stderr and stdout
+  $stderr = File.new(File.join('/dev', 'null'), 'w')
+  $stdout = File.new(File.join('/dev', 'null'), 'w')
+end
+
+# Replace stderr and stdout so anything else is output correctly
+def enable_output
+  $stderr = @original_stderr
+  $stdout = @original_stdout
+  @original_stderr = nil
+  @original_stdout = nil
+end

data/spec/tests_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+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
+
+  it 'won\'t allow double quotes' do
+    expect(SaltLint::Tests.check_double_quotes(0, 'There\'s one "potato"', test_file_good)).to eq false
+  end
+
+  it 'won\'t allow trailing whitespace' do
+    expect(SaltLint::Tests.check_trailing_whitespace(0, 'This text looks okay ', test_file_good)).to eq false
+    expect(SaltLint::Tests.check_trailing_whitespace(0, "This text looks okay\t", test_file_good)).to eq false
+  end
+
+  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
+end

data/tests/file_with_multiple_errors.sls

@@ -0,0 +1,3 @@
+base:
+  "*":  
+    - this_line_should_throw_an_error_as_it_is_longer_than_80_characters_which_trigger_alert

data/tests/non_yaml_file.sls

@@ -0,0 +1,3 @@
+potato:
+ banana
+        foo: somebody said I should put a colon here: so I did

data/tests/well_formatted_top.sls

@@ -0,0 +1,4 @@
+base:
+  '*':
+    - core
+

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: salt-lint
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Lukasz Raczylo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Created as nobody from Salt community created one till today.
+email:
+- lukasz@raczylo.com
+executables:
+- salt-lint
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/salt-lint
+- lib/salt-lint.rb
+- lib/salt-lint/actions.rb
+- lib/salt-lint/options.rb
+- lib/salt-lint/printer.rb
+- lib/salt-lint/runner.rb
+- lib/salt-lint/tests.rb
+- lib/salt-lint/version.rb
+- salt-lint.gemspec
+- shippable.yml
+- spec/basic_spec.rb
+- 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
+homepage: https://github.com/lukaszraczylo/salt-lint
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Salt linter written in Ruby
+test_files:
+- spec/basic_spec.rb
+- spec/files_spec.rb
+- spec/spec_helper.rb
+- spec/tests_spec.rb
+has_rdoc: