module Onceover::CodeQuality::Syntax

Public Class Methods

puppet() click to toggle source
# File lib/onceover/codequality/syntax.rb, line 6
      def self.puppet
        status = true

        #
        # puppet-syntax
        #

        CodeQuality::Formatter.start_test("puppet-syntax rake task")
        # puppet-syntax seems to assign $stdout/$stderr internally in ways that
        # prevent capturing output. As a nasty hack, run it as inline ruby and
        # capture the output from the process...
        inline_ruby = <<-RUBY_CODE
          require 'puppet-syntax/tasks/puppet-syntax'
          PuppetSyntax.exclude_paths = ['vendor/**/*','spec/templates/*.erb']
          Rake::Task['syntax'].invoke
        RUBY_CODE
        #output, s = Open3.capture2e("ruby", "-e", inline_ruby)
        output, ok = CodeQuality::Executor.run("ruby", "-e", inline_ruby)
        status &= ok
        CodeQuality::Formatter.end_test(output, ok)

        #
        # python yaml
        #

        # Python gives us "better" validation of YAML data then ruby, eg:
        # ```yaml
        #  foo: bar
        # baz: clive
        # ```
        #
        # would parse only the foo key in ruby, throwing away the baz key due to
        # a perceived negative indent, whereas python would tell you to fix the
        # file and make it consistent. This is yaml implementation dependent but
        # users would be advised to fix the file, so lets _also_ validate yaml
        # files with python if available on our path...
        if system("python --version && python -c 'import yaml'", :err => File::NULL)
          CodeQuality::Formatter.start_test("Additional python YAML validation")
          script = File.join(File.dirname(File.expand_path(__FILE__)), "../../../res/validate_yaml.py")
          output, ok = CodeQuality::Executor.run("python #{script}")
          status &= ok
          CodeQuality::Formatter.end_test(output, ok)
        else
          logger.warn("Please install python and pyyaml for enhanced YAML validation (pip install pyyaml)")
        end

        status
      end