halyard-puppet-lint 1.2.0

data/lib/puppet-lint/bin.rb

@@ -0,0 +1,79 @@
+require 'puppet-lint/optparser'
+
+# Internal: The logic of the puppet-lint bin script, contained in a class for
+# ease of testing.
+class PuppetLint::Bin
+  # Public: Initialise a new PuppetLint::Bin.
+  #
+  # args - An Array of command line argument Strings to be passed to the option
+  #        parser.
+  #
+  # Examples
+  #
+  #   PuppetLint::Bin.new(ARGV).run
+  def initialize(args)
+    @args = args
+  end
+
+  # Public: Run puppet-lint as a command line tool.
+  #
+  # Returns an Integer exit code to be passed back to the shell.
+  def run
+    opts = PuppetLint::OptParser.build
+
+    begin
+      opts.parse!(@args)
+    rescue OptionParser::InvalidOption
+      puts "puppet-lint: #{$!.message}"
+      puts "puppet-lint: try 'puppet-lint --help' for more information"
+      return 1
+    end
+
+    if PuppetLint.configuration.display_version
+      puts "puppet-lint #{PuppetLint::VERSION}"
+      return 0
+    end
+
+    if @args[0].nil?
+      puts "puppet-lint: no file specified"
+      puts "puppet-lint: try 'puppet-lint --help' for more information"
+      return 1
+    end
+
+    begin
+      path = @args[0]
+      if File.directory?(path)
+        path = Dir.glob("#{path}/**/*.pp")
+      else
+        path = @args
+      end
+
+      if path.length > 1
+        PuppetLint.configuration.with_filename = true
+      end
+
+      return_val = 0
+      path.each do |f|
+        l = PuppetLint.new
+        l.file = f
+        l.run
+        l.print_problems
+        if l.errors? or (l.warnings? and PuppetLint.configuration.fail_on_warnings)
+          return_val = 1
+        end
+
+        if PuppetLint.configuration.fix && !l.problems.any? { |e| e[:check] == :syntax }
+          File.open(f, 'w') do |fd|
+            fd.write l.manifest
+          end
+        end
+      end
+      return return_val
+
+    rescue PuppetLint::NoCodeError
+      puts "puppet-lint: no file specified or specified file does not exist"
+      puts "puppet-lint: try 'puppet-lint --help' for more information"
+      return 1
+    end
+  end
+end

data/lib/puppet-lint/checkplugin.rb

@@ -0,0 +1,176 @@
+# Public: A class that contains and provides information for the puppet-lint
+# checks.
+#
+# This class should not be used directly, but instead should be inherited.
+#
+# Examples
+#
+#   class PuppetLint::Plugin::CheckFoo < PuppetLint::CheckPlugin
+#   end
+class PuppetLint::CheckPlugin
+  # Internal: Initialise a new PuppetLint::CheckPlugin.
+  def initialize
+    @problems = []
+  end
+
+  # Internal: Check the manifest for problems and filter out any problems that
+  # should be ignored.
+  #
+  # Returns an Array of problem Hashes.
+  def run
+    check
+
+    @problems.each do |problem|
+      if PuppetLint::Data.ignore_overrides[problem[:check]].has_key?(problem[:line])
+        problem[:kind] = :ignored
+        problem[:reason] = PuppetLint::Data.ignore_overrides[problem[:check]][problem[:line]]
+        next
+      end
+    end
+
+    @problems
+  end
+
+  # Internal: Fix any problems the check plugin has detected.
+  #
+  # Returns an Array of problem Hashes.
+  def fix_problems
+    @problems.reject { |problem| problem[:kind] == :ignored }.each do |problem|
+      if self.respond_to?(:fix)
+        begin
+          fix(problem)
+        rescue PuppetLint::NoFix
+          # noop
+        else
+          problem[:kind] = :fixed
+        end
+      end
+    end
+
+    @problems
+  end
+
+  private
+
+  # Public: Provides the tokenised manifest to the check plugins.
+  #
+  # Returns an Array of PuppetLint::Lexer::Token objects.
+  def tokens
+    PuppetLint::Data.tokens
+  end
+
+  # Public: Provides the resource titles to the check plugins.
+  #
+  # Returns an Array of PuppetLint::Lexer::Token objects.
+  def title_tokens
+    PuppetLint::Data.title_tokens
+  end
+
+  # Public: Provides positional information for any resource declarations in
+  # the tokens array to the check plugins.
+  #
+  # Returns an Array of Hashes containing the position information.
+  def resource_indexes
+    PuppetLint::Data.resource_indexes
+  end
+
+  # Public: Provides positional information for any class definitions in the
+  # tokens array to the check plugins.
+  #
+  # Returns an Array of Hashes containing the position information.
+  def class_indexes
+    PuppetLint::Data.class_indexes
+  end
+
+  # Public: Provides positional information for any defined type definitions in
+  # the tokens array to the check plugins.
+  #
+  # Returns an Array of Hashes containing the position information.
+  def defined_type_indexes
+    PuppetLint::Data.defined_type_indexes
+  end
+
+  # Public: Provides positional information for any node definitions in the
+  # tokens array to the check plugins.
+  #
+  # Returns an Array of Hashes containing the position information.
+  def node_indexes
+    PuppetLint::Data.node_indexes
+  end
+
+  # Public: Provides the expanded path of the file being analysed to check
+  # plugins.
+  #
+  # Returns the String path.
+  def fullpath
+    PuppetLint::Data.fullpath
+  end
+
+  # Public: Provides the path of the file being analysed as it was provided to
+  # puppet-lint to the check plugins.
+  #
+  # Returns the String path.
+  def path
+    PuppetLint::Data.path
+  end
+
+  # Public: Provides the name of the file being analysed to the check plugins.
+  #
+  # Returns the String file name.
+  def filename
+    PuppetLint::Data.filename
+  end
+
+  # Public: Provides a list of formatting tokens to the check plugins.
+  #
+  # Returns an Array of Symbol token types.
+  def formatting_tokens
+    PuppetLint::Data.formatting_tokens
+  end
+
+  # Public: Provides a list of manifest lines to the check plugins.
+  #
+  # Returns an Array of manifest lines.
+  def manifest_lines
+    PuppetLint::Data.manifest_lines
+  end
+
+  # Internal: Prepare default problem report information.
+  #
+  # Returns a Hash of default problem information.
+  def default_info
+    @default_info ||= {
+      :check      => self.class.const_get('NAME'),
+      :fullpath   => fullpath,
+      :path       => path,
+      :filename   => filename,
+    }
+  end
+
+  # Public: Report a problem with the manifest being checked.
+  #
+  # kind    - The Symbol problem type (:warning or :error).
+  # problem - A Hash containing the attributes of the problem
+  #   :message - The String message describing the problem.
+  #   :line    - The Integer line number of the location of the problem.
+  #   :column  - The Integer column number of the location of the problem.
+  #   :check   - The Symbol name of the check that detected the problem.
+  #
+  # Returns nothing.
+  def notify(kind, problem)
+    problem[:kind] = kind
+    problem.merge!(default_info) { |key, v1, v2| v1 }
+
+    unless [:warning, :error, :fixed].include? kind
+      raise ArgumentError, "unknown value passed for kind"
+    end
+
+    [:message, :line, :column, :check].each do |attr|
+      unless problem.has_key? attr
+        raise ArgumentError, "problem hash must contain #{attr.inspect}"
+      end
+    end
+
+    @problems << problem
+  end
+end

data/lib/puppet-lint/checks.rb

@@ -0,0 +1,91 @@
+require 'puppet-lint/checkplugin'
+
+# Internal: Various methods that orchestrate the actions of the puppet-lint
+# check plugins.
+class PuppetLint::Checks
+  # Public: Get an Array of problem Hashes.
+  attr_accessor :problems
+
+  # Public: Initialise a new PuppetLint::Checks object.
+  def initialize
+    @problems = []
+  end
+
+  # Internal: Tokenise the manifest code and prepare it for checking.
+  #
+  # path    - The path to the file as passed to puppet-lint as a String.
+  # content - The String manifest code to be checked.
+  #
+  # Returns nothing.
+  def load_data(path, content)
+    lexer = PuppetLint::Lexer.new
+    PuppetLint::Data.path = path
+    PuppetLint::Data.manifest_lines = content.split("\n", -1)
+    begin
+      PuppetLint::Data.tokens = lexer.tokenise(content)
+      PuppetLint::Data.parse_control_comments
+    rescue PuppetLint::LexerError => e
+      problems << {
+        :kind     => :error,
+        :check    => :syntax,
+        :message  => 'Syntax error (try running `puppet parser validate <file>`)',
+        :line     => e.line_no,
+        :column   => e.column,
+        :fullpath => PuppetLint::Data.fullpath,
+        :path     => PuppetLint::Data.path,
+        :filename => PuppetLint::Data.filename,
+      }
+      PuppetLint::Data.tokens = []
+    end
+  end
+
+  # Internal: Run the lint checks over the manifest code.
+  #
+  # fileinfo - A Hash containing the following:
+  #   :fullpath - The expanded path to the file as a String.
+  #   :filename - The name of the file as a String.
+  #   :path     - The original path to the file as passed to puppet-lint as
+  #               a String.
+  # data     - The String manifest code to be checked.
+  #
+  # Returns an Array of problem Hashes.
+  def run(fileinfo, data)
+    load_data(fileinfo, data)
+
+    checks_run = []
+    enabled_checks.each do |check|
+      klass = PuppetLint.configuration.check_object[check].new
+      problems = klass.run
+
+      if PuppetLint.configuration.fix
+        checks_run << klass
+      else
+        @problems.concat(problems)
+      end
+    end
+
+    checks_run.each do |check|
+      @problems.concat(check.fix_problems)
+    end
+
+    @problems
+  end
+
+  # Internal: Get a list of checks that have not been disabled.
+  #
+  # Returns an Array of String check names.
+  def enabled_checks
+    @enabled_checks ||= Proc.new do
+      PuppetLint.configuration.checks.select { |check|
+        PuppetLint.configuration.send("#{check}_enabled?")
+      }
+    end.call
+  end
+
+  # Internal: Render the fixed manifest.
+  #
+  # Returns the manifest as a String.
+  def manifest
+    PuppetLint::Data.tokens.map { |t| t.to_manifest }.join('')
+  end
+end

data/lib/puppet-lint/configuration.rb

@@ -0,0 +1,153 @@
+class PuppetLint
+  # Public: A singleton class to store the running configuration of
+  # puppet-lint.
+  class Configuration
+    # Internal: Add helper methods for a new check to the
+    # PuppetLint::Configuration object.
+    #
+    # check - The String name of the check.
+    #
+    # Returns nothing.
+    #
+    # Signature
+    #
+    #   <check>_enabled?
+    #   disable_<check>
+    #   enable_<check>
+    def self.add_check(check)
+      # Public: Determine if the named check is enabled.
+      #
+      # Returns true if the check is enabled, otherwise return false.
+      define_method("#{check}_enabled?") do
+        settings["#{check}_disabled"] == true ? false : true
+      end
+
+      # Public: Disable the named check.
+      #
+      # Returns nothing.
+      define_method("disable_#{check}") do
+        settings["#{check}_disabled"] = true
+      end
+
+      # Public: Enable the named check.
+      #
+      # Returns nothing.
+      define_method("enable_#{check}") do
+        settings["#{check}_disabled"] = false
+      end
+    end
+
+    # Public: Catch situations where options are being set for the first time
+    # and create the necessary methods to get & set the option in the future.
+    #
+    # args   - An Array of values to set the option to.
+    # method - The String name of the option.
+    # block  - Unused.
+    #
+    # Returns nothing.
+    #
+    # Signature
+    #
+    #   <option>=(value)
+    def method_missing(method, *args, &block)
+      if method.to_s =~ /^(\w+)=$/
+        option = $1
+        add_option(option.to_s) if settings[option].nil?
+        settings[option] = args[0]
+      else
+        nil
+      end
+    end
+
+    # Internal: Add options to the PuppetLint::Configuration object from inside
+    # the class.
+    #
+    # option - The String name of the option.
+    #
+    # Returns nothing.
+    #
+    # Signature
+    #
+    #   <option>
+    #   <option>=(value)
+    def add_option(option)
+      self.class.add_option(option)
+    end
+
+    # Public: Add an option to the PuppetLint::Configuration object from
+    # outside the class.
+    #
+    # option - The String name of the option.
+    #
+    # Returns nothing.
+    #
+    # Signature
+    #
+    #   <option>
+    #   <option>=(value)
+    def self.add_option(option)
+      # Public: Set the value of the named option.
+      #
+      # value - The value to set the option to.
+      #
+      # Returns nothing.
+      define_method("#{option}=") do |value|
+        settings[option] = value
+      end
+
+      # Public: Get the value of the named option.
+      #
+      # Returns the value of the option.
+      define_method(option) do
+        settings[option]
+      end
+    end
+
+    # Internal: Register a new check.
+    #
+    # check - The String name of the check
+    # klass - The Class containing the check logic.
+    #
+    # Returns nothing.
+    def add_check(check, klass)
+      self.class.add_check(check)
+      check_object[check] = klass
+    end
+
+    # Internal: Access the internal storage for settings.
+    #
+    # Returns a Hash containing all the settings.
+    def settings
+      @settings ||= {}
+    end
+
+    # Internal: Access the internal storage for check method blocks.
+    #
+    # Returns a Hash containing all the check blocks.
+    def check_object
+      @check_object ||= {}
+    end
+
+    # Public: Get a list of all the defined checks.
+    #
+    # Returns an Array of String check names.
+    def checks
+      check_object.keys
+    end
+
+    # Public: Clear the PuppetLint::Configuration storage and set some sane
+    # default values.
+    #
+    # Returns nothing.
+    def defaults
+      settings.clear
+      self.with_filename = false
+      self.fail_on_warnings = false
+      self.error_level = :all
+      self.log_format = ''
+      self.with_context = false
+      self.fix = false
+      self.show_ignored = false
+    end
+  end
+end