ci-syntax-tool 0.1.0

data/test/features/support/feature_helper.rb

@@ -0,0 +1,142 @@
+require_relative '../../../lib/ci-syntax-tool'
+require 'minitest'
+
+require 'byebug'
+
+module CI
+  module Syntax
+    module Tool
+      module FeatureHelpers
+
+        include MiniTest::Assertions
+
+        attr_writer :assertions
+        def assertions
+          @assertions ||= 0
+        end
+        
+        def run_check(command_line_args)
+
+          # puts "RAW CLI: " + command_line_args.inspect # DEBUG
+          
+          # Capture any stdout and stderr
+          sio_out = StringIO.new
+          old_stdout = $stdout
+          $stdout = sio_out
+          sio_err = StringIO.new
+          old_stderr = $stderr
+          $stderr = sio_err
+
+          overall_result = nil
+          cli_opts = CI::Syntax::Tool::CommandLine.new(command_line_args)
+          # puts "COOKED CLI: " + cli_opts.options.inspect # DEBUG
+          if cli_opts.runnable?
+            checker = CI::Syntax::Tool::Checker.new(cli_opts)
+            exit_status = checker.run()
+            overall_result = checker.overall_result
+          else
+            exit_status = cli_opts.non_runnable_exit_status
+          end
+          
+          $stdout = old_stdout
+          $stderr = old_stderr
+
+          result = {
+            stdout: sio_out.string,
+            stderr: sio_err.string,
+            exit_status: exit_status,
+            overall_result: overall_result,
+          }
+          # puts "Results: " + result.inspect # DEBUG
+          return result
+          
+        end
+
+        def list_cli_opts
+          return [
+            {s: 'V', l: 'version', d: 'Show ci-syntax-tool version'},
+            {s: 'h', l: 'help',    d: 'Show this help message'},
+            {s: 'l', l: 'lang LANG',    d: 'Select this language for checking.  Repeatable.  Default, all languages.'},
+            {        l: 'list-languages',    d: 'List available languages and exit.'},
+            {s: 'f', l: 'format FORMAT',    d: 'Use this format for output.  Repeatable, but if repeated, must have an equal number of --output options.'},
+            {s: 'o', l: 'output PATH',    d: 'Write formatted output to this location.  Use "-" to represent STDOUT.  Defaults to STDOUT if zero or one --format option used.  Repeatable with an equal number of --format options.'},
+            {        l: 'list-formats',    d: 'List available formats and exit.'},
+            {s: 'r', l: 'require RUBYFILE', d: 'Load additional Ruby code, perhaps for a custom language or format.  Repeatable.'},
+            {s: 'd', l: 'debug', d: 'Provide debug-level output to STDOUT.'},
+          ]          
+        end
+
+        def list_core_languages
+          return [
+            'YAML',
+          ]
+        end
+
+        def list_core_formats
+          return [
+            'JUnit',
+            'Progress',
+          ]
+        end
+
+        def assert_usage_message
+          list_cli_opts.each do |opt|
+            re = '\s+'
+            re += '-'     if opt[:s]
+            re += opt[:s] if opt[:s]
+            re += ','     if opt[:s]
+            re += '\s+'
+            re += '--' + opt[:l]
+            re += '\s+'
+            re += opt[:d]
+            re += '\s+'
+            assert_match(Regexp.new(re), @run_result[:stdout], "The '#{opt[:l]}' option should be present")
+          end
+          # TODO - check for spurious options?
+        end
+
+        def assert_language_list
+          seen = @run_result[:stdout].split("\n").sort
+          expected = list_core_languages.sort
+          assert_equal(expected, seen, 'The list of supported languages should match')
+        end
+
+        def assert_format_list
+          seen = @run_result[:stdout].split("\n").sort
+          expected = list_core_formats.sort
+          assert_equal(expected, seen, 'The list of supported formats should match')
+        end
+
+        def assert_class_loaded(klass)
+          begin
+            Kernel.const_get(klass)
+          rescue NameError => e
+            flunk("Expected Class #{klass} to have been loaded")
+          rescue StandardError => e
+            raise
+          end
+        end
+
+        def files_matching_language(files, lang_name)
+          globs = LanguageFactory.create(lang_name).combined_globs
+          matches = []
+          globs.each do |glob|
+            re = glob.gsub('.', '\.')
+            re = glob.gsub('**/', '.+')
+            re = re.gsub('*', '.+')
+            re += '$'
+            re = Regexp.new(re)
+            files.select {|fn1| fn1.match(re) }.each do |fn2|
+              matches << fn2
+            end
+          end
+          matches
+        end
+        
+      end
+    end
+  end
+end
+
+
+World(CI::Syntax::Tool::FeatureHelpers)

data/test/fixtures/files/clean/README.md

@@ -0,0 +1,6 @@
+# A Test Markdown File
+
+## With a section
+
+    and some block
+    quotes

data/test/fixtures/files/clean/ansiblish.yaml

@@ -0,0 +1,12 @@
+---
+- name: A pretend play
+  hosts: the_mostest
+  tasks:
+    - name: Do something
+      command: tap-dance to stardom
+
+    - name: touch something
+      file:
+        path: /tmp/hearts-and-minds-of-our-nations-youth
+        action: touch
+        

data/test/fixtures/files/clean/kitchenish.yml

@@ -0,0 +1,17 @@
+---
+driver:
+  name: vagrant
+
+provisioner:
+  name: chef_zero
+
+platforms:
+  - name: ubuntu-14.04
+    driver_config:
+      network:
+        - ["forwarded_port", {guest: 80, host: 8080, auto_correct: true}]
+
+suites:
+  - name: default
+    run_list:
+      - recipe[awesomesauce::default]

data/test/fixtures/files/clean/rubocopish.yaml

@@ -0,0 +1,11 @@
+Style/FileName:
+  Enabled: False
+
+Metrics/MethodLength:
+  Max: 25
+
+Style/TrailingWhitespace:
+  Enabled: False
+
+Style/TrailingComma:
+  Enabled: False

data/test/fixtures/files/error/bad-indentation.yaml

@@ -0,0 +1,5 @@
+---
+name: Indented zero spaces
+  name: indented two spaces
+   name: indented three spaces
+ name: indented one space, wth

data/test/fixtures/files/error/missing-array-element.yaml

@@ -0,0 +1,5 @@
+---
+Here:
+  -
+  name: foo
+  - nope

data/test/fixtures/files/error/unquoted-jinja-template.yaml

@@ -0,0 +1,3 @@
+---
+- name: A typical rookie ansible mistake
+  value: {{ this_will_bite_it }}

data/test/fixtures/files/error/very-high-yaml-version.yaml

@@ -0,0 +1,3 @@
+%YAML 9.9
+---
+name: Yeah right

data/test/fixtures/require/invalid.rb

@@ -0,0 +1,6 @@
+module CI
+  module Syntax
+    module Tool
+      module Test
+        class InvalidRequire
+          # Intentionally syntactically bad

data/test/fixtures/require/mock_format.rb

@@ -0,0 +1,10 @@
+module CI
+  module Syntax
+    module Tool
+      module Format
+        class MockFormat < Format::Base
+        end
+      end
+    end
+  end
+end

data/test/fixtures/require/second.rb

@@ -0,0 +1,10 @@
+module CI
+  module Syntax
+    module Tool
+      module Test
+        class SecondRequire
+        end
+      end
+    end
+  end
+end

data/test/fixtures/require/valid.rb

@@ -0,0 +1,10 @@
+module CI
+  module Syntax
+    module Tool
+      module Test
+        class ValidRequire
+        end
+      end
+    end
+  end
+end

data/test/unit/format_factory_spec.rb

@@ -0,0 +1,46 @@
+require_relative './spec_helper'
+
+RSpec.describe CI::Syntax::Tool::FormatFactory, "#all_format_classes" do  
+
+  it "should return  a list of Classes" do
+    langs = CI::Syntax::Tool::FormatFactory.all_format_classes
+    langs.each do |lang|
+      expect(lang).to be_kind_of(Class)
+    end
+  end
+
+end
+
+RSpec.describe CI::Syntax::Tool::FormatFactory, "#all_format_names" do  
+
+  it "should return a list of Strings" do
+    lang_names = CI::Syntax::Tool::FormatFactory.all_format_names
+    lang_names.each do |lang|
+      expect(lang).to be_kind_of(String)
+    end
+  end
+
+  it "should not return Base among the format names" do
+    lang_names = CI::Syntax::Tool::FormatFactory.all_format_names
+    expect(lang_names).not_to include('Base')
+  end
+
+  it "should include the expected format names" do
+    lang_names = CI::Syntax::Tool::FormatFactory.all_format_names
+    [
+      'Progress',
+    ].each do |lang|
+      expect(lang_names).to include(lang)
+    end
+  end
+  
+end
+
+RSpec.describe CI::Syntax::Tool::FormatFactory, "#create" do
+  it "should be able to create one of each format with a single arg" do
+    CI::Syntax::Tool::FormatFactory.all_format_names.each do |fmt_name|      
+      lang_obj = CI::Syntax::Tool::FormatFactory.create(fmt_name, 'test/tmp/dest-unit-0')
+      expect(lang_obj).to be_kind_of CI::Syntax::Tool::Format::Base
+    end
+  end
+end

data/test/unit/language_factory_spec.rb

@@ -0,0 +1,46 @@
+require_relative './spec_helper'
+
+RSpec.describe CI::Syntax::Tool::LanguageFactory, "#all_language_classes" do  
+
+  it "should return  a list of Classes" do
+    langs = CI::Syntax::Tool::LanguageFactory.all_language_classes
+    langs.each do |lang|
+      expect(lang).to be_kind_of(Class)
+    end
+  end
+
+end
+
+RSpec.describe CI::Syntax::Tool::LanguageFactory, "#all_language_names" do  
+
+  it "should return a list of Strings" do
+    lang_names = CI::Syntax::Tool::LanguageFactory.all_language_names
+    lang_names.each do |lang|
+      expect(lang).to be_kind_of(String)
+    end
+  end
+
+  it "should not return Base among the language names" do
+    lang_names = CI::Syntax::Tool::LanguageFactory.all_language_names
+    expect(lang_names).not_to include('Base')
+  end
+
+  it "should include the expected language names" do
+    lang_names = CI::Syntax::Tool::LanguageFactory.all_language_names
+    [
+      'YAML',
+    ].each do |lang|
+      expect(lang_names).to include(lang)
+    end
+  end
+  
+end
+
+RSpec.describe CI::Syntax::Tool::LanguageFactory, "#create" do
+  it "should be able to create one of each language with no args" do
+    CI::Syntax::Tool::LanguageFactory.all_language_names.each do |lang_name|      
+      lang_obj = CI::Syntax::Tool::LanguageFactory.create(lang_name)
+      expect(lang_obj).to be_kind_of CI::Syntax::Tool::Language::Base
+    end
+  end
+end

data/test/unit/result_spec.rb

@@ -0,0 +1,18 @@
+require_relative './spec_helper'
+
+RSpec.describe CI::Syntax::Tool::Issue, "#constructor" do  
+
+  it "should be an error-level issue by default" do
+    issue = CI::Syntax::Tool::Issue.new
+    expect(issue.level).to be :error
+  end
+
+end
+
+RSpec.describe CI::Syntax::Tool::Result::FileResult, "#issue counting" do
+  it "should have zero issues by default" do
+    fr = CI::Syntax::Tool::Result::FileResult.new('fake.yaml')
+    expect(fr.warning_count).to eq 0
+    expect(fr.error_count).to eq 0
+  end
+end

data/test/unit/spec_helper.rb

@@ -0,0 +1,31 @@
+require_relative '../../lib/ci-syntax-tool'
+
+require 'rspec'
+require 'rspec/core'
+
+RSpec.configure do |config|
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+  
+  Kernel.srand config.seed
+
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: ci-syntax-tool
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Clinton Wolfe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Checks YAML, JSON, Ruby, ERB, and other syntaxes, then reports errors
+  and OKs in a nice way for your CI system.
+email:
+- clinton@omniti.com
+executables:
+- ci-syntax-tool
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- Rakefile
+- bin/ci-syntax-tool
+- ci-syntax-tool.gemspec
+- lib/ci-syntax-tool.rb
+- lib/ci-syntax-tool/checker.rb
+- lib/ci-syntax-tool/command_line.rb
+- lib/ci-syntax-tool/format/base.rb
+- lib/ci-syntax-tool/format/junit.rb
+- lib/ci-syntax-tool/format/progress.rb
+- lib/ci-syntax-tool/format_factory.rb
+- lib/ci-syntax-tool/language/base.rb
+- lib/ci-syntax-tool/language/yaml.rb
+- lib/ci-syntax-tool/language_factory.rb
+- lib/ci-syntax-tool/result.rb
+- lib/ci-syntax-tool/version.rb
+- rubocop.yml
+- test/features/.keep
+- test/features/command-line-help.feature
+- test/features/format-junit.feature
+- test/features/language-yaml.feature
+- test/features/pluggable-formatters.feature
+- test/features/pluggable-languages.feature
+- test/features/require-ruby.feature
+- test/features/step_definitions/cli_steps.rb
+- test/features/step_definitions/format_steps.rb
+- test/features/step_definitions/junit_steps.rb
+- test/features/step_definitions/language_steps.rb
+- test/features/step_definitions/require_steps.rb
+- test/features/support/feature_helper.rb
+- test/fixtures/.keep
+- test/fixtures/files/clean/README.md
+- test/fixtures/files/clean/ansiblish.yaml
+- test/fixtures/files/clean/kitchenish.yml
+- test/fixtures/files/clean/rubocopish.yaml
+- test/fixtures/files/error/bad-indentation.yaml
+- test/fixtures/files/error/missing-array-element.yaml
+- test/fixtures/files/error/unquoted-jinja-template.yaml
+- test/fixtures/files/error/very-high-yaml-version.yaml
+- test/fixtures/require/invalid.rb
+- test/fixtures/require/mock_format.rb
+- test/fixtures/require/second.rb
+- test/fixtures/require/valid.rb
+- test/tmp/.keep
+- test/unit/.keep
+- test/unit/format_factory_spec.rb
+- test/unit/language_factory_spec.rb
+- test/unit/result_spec.rb
+- test/unit/spec_helper.rb
+homepage: https://github.com/clintoncwolfe/ci-syntax-tool
+licenses:
+- BSD (3-clause)
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A Rubygem implementing a suite of source code syntax checkers, with well-behaved
+  output fo use with CI engines.
+test_files:
+- test/features/.keep
+- test/features/command-line-help.feature
+- test/features/format-junit.feature
+- test/features/language-yaml.feature
+- test/features/pluggable-formatters.feature
+- test/features/pluggable-languages.feature
+- test/features/require-ruby.feature
+- test/features/step_definitions/cli_steps.rb
+- test/features/step_definitions/format_steps.rb
+- test/features/step_definitions/junit_steps.rb
+- test/features/step_definitions/language_steps.rb
+- test/features/step_definitions/require_steps.rb
+- test/features/support/feature_helper.rb
+- test/fixtures/.keep
+- test/fixtures/files/clean/README.md
+- test/fixtures/files/clean/ansiblish.yaml
+- test/fixtures/files/clean/kitchenish.yml
+- test/fixtures/files/clean/rubocopish.yaml
+- test/fixtures/files/error/bad-indentation.yaml
+- test/fixtures/files/error/missing-array-element.yaml
+- test/fixtures/files/error/unquoted-jinja-template.yaml
+- test/fixtures/files/error/very-high-yaml-version.yaml
+- test/fixtures/require/invalid.rb
+- test/fixtures/require/mock_format.rb
+- test/fixtures/require/second.rb
+- test/fixtures/require/valid.rb
+- test/tmp/.keep
+- test/unit/.keep
+- test/unit/format_factory_spec.rb
+- test/unit/language_factory_spec.rb
+- test/unit/result_spec.rb
+- test/unit/spec_helper.rb
+has_rdoc: