ci-syntax-tool 0.1.0

data/lib/ci-syntax-tool/version.rb

@@ -0,0 +1,10 @@
+module CI
+  module Syntax
+    # CI::Syntax::Tool module
+    #   Simple container for namespacing the project.  Here, just the
+    # version string.
+    module Tool
+      VERSION = '0.1.0'
+    end
+  end
+end

data/rubocop.yml

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

data/test/features/command-line-help.feature

@@ -0,0 +1,15 @@
+Feature: Command line help
+
+  In order to be able to learn about the options available for syntax checking
+  As a developer
+  I want to be able to interactively get help on the options from the command line
+
+  Scenario: Command help
+    Given I have installed the tool
+     When I run it on the command line with the help option
+     Then the simple usage text should be displayed along with a zero exit code
+
+  Scenario: Display version
+    Given I have installed the tool
+     When I run it on the command line with the version option
+     Then the current version should be displayed

data/test/features/format-junit.feature

@@ -0,0 +1,29 @@
+Feature: jUnit / SureFire format
+
+  In order to be able to use the tool with many popular CI tools
+  As a developer
+  I want to be able to have output formatted as jUnit-style XML reports
+
+  Scenario: List available core formats
+    Given I have installed the tool
+     When I run it on the command line with the list-formats option
+     Then JUnit should be included in the listed formats
+
+  Scenario: Use JUnit format on clean files
+    Given I have installed the tool
+     When I run it on the command line with the JUnit format on clean files
+     Then I should get a 0 exit code
+     And the generated files should be valid XML
+     And the JUnit files should have the correct structure
+     And the JUnit files should have 0 errors
+     And the JUnit files should have 0 warnings
+
+  Scenario: Use JUnit format on error files
+    Given I have installed the tool
+     When I run it on the command line with the JUnit format on error files
+     Then I should get a 1 exit code
+     And the generated files should be valid XML
+     And the JUnit files should have the correct structure
+     And the JUnit files should have 3 errors
+     And the JUnit files should have 0 warnings
+

data/test/features/language-yaml.feature

@@ -0,0 +1,34 @@
+Feature: Pluggable formatters
+
+  In order to be able to check YAML files for errors
+  As a developer
+  I want to be able to run the tool on yaml files
+
+  Scenario: Use YAML explicitly on clean files
+    Given I have installed the tool
+     When I run it on the command line specifying the YAML language and clean files
+     Then I should get a 0 exit code
+     And the output should show only files for YAML
+     And the output should have 0 warnings
+     And the output should have 0 errors
+
+
+  Scenario: Run all lamnguages on clean files
+    Given I have installed the tool
+     When I run it on the command line specifying all languages and clean files
+     Then I should get a 0 exit code
+     And the output should include files for YAML
+     And the output should have 0 warnings
+     And the output should have 0 errors
+
+
+  Scenario: Use YAML explicitly on error files
+    Given I have installed the tool
+     When I run it on the command line specifying the YAML language and error files
+     Then I should get a 1 exit code
+     And the output should show only files for YAML
+     And the output should have 0 warnings
+     And the output should have 3 errors
+
+
+

data/test/features/pluggable-formatters.feature

@@ -0,0 +1,42 @@
+Feature: Pluggable formatters
+
+  In order to be able to use the tool with whatever CI engine I need
+  As a developer
+  I want to be able to output the results of language checks in various formats
+
+  Scenario: List available core formats
+    Given I have installed the tool
+     When I run it on the command line with the list-formats option
+     Then I should get a list of the core formats along with a zero exit code
+
+  Scenario: Reject an invalid format
+    Given I have installed the tool
+     When I run it on the command line with the format option and the argument foo
+     Then I should get an error message and the exit code 4
+
+  Scenario: Reject multiple formats without destination
+    Given I have installed the tool
+     When I run it on the command line with two format options and 0 destinations
+     Then I should get an error message and the exit code 4
+
+  Scenario: Reject multiple formats with ambiguous destination count
+    Given I have installed the tool
+     When I run it on the command line with two format options and 1 destinations
+     Then I should get an error message and the exit code 4
+
+  Scenario: Use multiple formatters with correct number of destinations
+    Given I have installed the tool
+     When I run it on the command line with two format options and 2 destinations
+     Then I should get a 0 exit code
+
+  Scenario: Create destination files automatically
+    Given I have installed the tool
+     When I run it on the command line with a destination in the current directory
+     Then the file should be created
+
+  Scenario: Create destination directories automatically
+    Given I have installed the tool
+     When I run it on the command line with a destination in a directory that does not exist
+     Then the file should be created
+
+

data/test/features/pluggable-languages.feature

@@ -0,0 +1,15 @@
+Feature: Pluggable languages
+
+  In order to be able to use the tool on whatever language I need
+  As a developer
+  I want to be able to extend the tool by adding support for new languages
+
+  Scenario: List available core languages
+    Given I have installed the tool
+     When I run it on the command line with the list-languages option
+     Then I should get a list of the core languages along with a zero exit code
+
+  Scenario: Reject an invalid language
+    Given I have installed the tool
+     When I run it on the command line with the lang option and the argument foo
+     Then I should get an error message and the exit code 3

data/test/features/require-ruby.feature

@@ -0,0 +1,38 @@
+Feature: Load extra Ruby files
+
+  In order to be able to use the tool with custom plugins
+  As a developer
+  I want to be able to load additional ruby files
+
+  Scenario: Load a valid ruby file
+    Given I have installed the tool
+     When I run it on the command line with the require option and a valid ruby file
+     Then the valid ruby file should have been loaded
+     And I should get a 0 exit code
+
+  Scenario: Reject a missing file with a nice message
+    Given I have installed the tool
+     When I run it on the command line with the require option and a missing ruby file
+     Then I should get an error message about the missing require file
+     And I should get a 5 exit code
+
+  Scenario: Reject an invalid file with a nice message
+    Given I have installed the tool
+     When I run it on the command line with the require option and a invalid ruby file
+     Then I should get an error message about the invalid require file
+     And I should get a 5 exit code
+
+Scenario: Reject an invalid file with a stacktrace when debug flag is present
+    Given I have installed the tool
+     When I run it on the command line with the require option and the debug option and a invalid ruby file
+     Then I should get a stack trace about the invalid require file
+     And I should get a 5 exit code
+
+  Scenario: Accept multiple requires
+    Given I have installed the tool
+     When I run it on the command line with two requires
+     Then the first ruby file should have been loaded
+     And the second ruby file should have been loaded      
+     And I should get a 0 exit code
+
+

data/test/features/step_definitions/cli_steps.rb

@@ -0,0 +1,46 @@
+Given(/^I have installed the tool$/) do
+end
+
+# TODO: Add code to target fixture directory by default
+When(/^I run it on the command line with the ([^ ]+) option(?: and the argument )?([^ ]+)?$/) do |option, arg|
+  options = []
+  if option.match(/\-\w$/)
+    options << option
+  else
+    options << "--#{option}"
+  end
+  if arg
+    options << arg
+  end
+  @run_result = run_check(options)
+end
+
+Then(/^the simple usage text should be displayed along with a non\-zero exit code$/) do
+  refute_empty(@run_result[:stderr], 'Expected to see an error message on STDERR')
+  refute_equal(@run_result[:exit_status], 0)
+  assert_usage_message
+end
+
+Then(/^the simple usage text should be displayed along with a zero exit code$/) do
+  assert_empty(@run_result[:stderr])
+  assert_equal(@run_result[:exit_status], 0)
+  assert_usage_message
+end
+
+Then(/^the current version should be displayed$/) do
+  assert_match(/^ci-syntax-tool/, @run_result[:stdout], 'Version string should include tool name')
+  assert_match(Regexp.new(Regexp.escape(CI::Syntax::Tool::VERSION)), @run_result[:stdout], 'Version string should include the version')
+  assert_equal(@run_result[:stdout].split("\n").length, 1, 'Version output should be exactly one line long')
+  assert_empty(@run_result[:stderr])
+  assert_equal(@run_result[:exit_status], 0)
+end
+
+Then(/^I should get an error message and the exit code (\d+)$/) do |expected_exit_status|
+  refute_empty(@run_result[:stderr], 'Expected to see an error message on STDERR')
+  assert_equal(expected_exit_status.to_i, @run_result[:exit_status])
+end
+
+Then(/^I should get a (\d+) exit code$/) do |expected_exit_status|
+  assert_equal(expected_exit_status.to_i, @run_result[:exit_status].to_i)
+end
+

data/test/features/step_definitions/format_steps.rb

@@ -0,0 +1,63 @@
+require 'fileutils'
+
+When(/^I run it on the command line with two format options and (\d) destination(?:s)$/) do |dest_count|
+  options = [
+    '--require', Dir.pwd + '/' + 'test/fixtures/require/mock_format.rb', 
+    '--format', 'MockFormat',
+    '--format', 'MockFormat',
+  ]
+  (0..(dest_count.to_i-1)).to_a.each do |i|
+    options << '--output'
+    options << 'test/tmp/dest-' + i.to_s
+  end
+  options << 'test/fixtures/files/clean'
+  @run_result = run_check(options)
+end
+
+When(/^I run it on the command line with a destination in (the current directory|a directory that does not exist)$/) do |mode|
+  path = 'output-create-test-1'
+  options = [
+    '--output'
+  ]
+  if mode == 'the current directory'
+    FileUtils.rm_f path
+    options << path
+  else
+    dir = 'test/tmp/output-create-dir'
+    FileUtils.rm_f dir
+    options << dir + '/' + path
+  end
+  options << 'test/fixtures/files/clean'
+  @expected_output_paths = [ path ]
+  @run_result = run_check(options)
+end
+
+When(/^I run it on the command line with the ([^ ]+) format on ([^ ]+) files$/) do |fmt_name, fixture|
+  path = "test/tmp/#{fmt_name}.out"
+  FileUtils.rm_f path
+  options = [
+    '--format', fmt_name,
+    '--output', path,
+    '--lang', 'YAML',
+    "test/fixtures/files/#{fixture}",
+  ]
+  @expected_output_paths = [ path ]
+  @run_result = run_check(options)
+end
+
+Then(/^I should get a list of the core formats along with a zero exit code$/) do
+  assert_equal(0, @run_result[:exit_status])
+  assert_format_list
+end
+
+Then(/^([^ ]+) should be included in the listed formats$/) do |fmt_name|
+  actual = @run_result[:stdout].split("\n")
+  assert_includes(actual, fmt_name)
+end
+
+Then(/^the file(?:s)? should be created$/) do
+  @expected_output_paths.each do |path|
+    assert(File.exist?(path), "#{path} should exist")
+  end
+end
+

data/test/features/step_definitions/junit_steps.rb

@@ -0,0 +1,57 @@
+require 'nokogiri'
+
+Then(/^the generated files should be valid XML$/) do
+  @expected_output_paths.each do |path|
+    begin
+      doc = File.open(path) { |f| Nokogiri::XML(f) }
+      pass
+    rescue
+      flunk
+    end
+  end
+end
+
+Then(/^the JUnit files should have the correct structure$/) do
+  @expected_output_paths.each do |path|
+
+    # puts "POINT A:" + path
+    
+    doc = File.open(path) { |f| Nokogiri::XML(f) }
+
+    # puts "POINT B:" + doc.to_s
+    assert_equal(1, doc.xpath('/testsuites').length, "It should have one root testsuites element")
+
+    # It should have nonzero testsuite elements with a name attribute reflecting the language
+    match = doc.xpath('/testsuites/testsuite')
+    assert(match.length > 0, "It should have nonzero testsuite elements")
+    langs = CI::Syntax::Tool::LanguageFactory.all_language_names
+    match.each do |node|
+      assert_includes(langs, node.at_xpath('@name').to_s)
+    end
+    
+    # It should have nonzero testcase elements, one per file, with name = sanitized filename
+    match = doc.xpath('/testsuites/testsuite/testcase')
+    assert(match.length > 0, "It should have nonzero testcase elements")
+    match.each do |node|
+      file = node.at_xpath('@name').to_s
+      refute_empty(file, "testcase should have a name attribute")
+    end
+        
+    # It may have failure elements which must have a type=warning or error
+    match = doc.xpath('/testsuites/testsuite/testcase/failure')
+    match.each do |node|
+      type = node.at_xpath('@type').to_s
+      assert_includes(['warning', 'error'], type, "Each failure type should be either a warning or an error")
+    end
+  end
+
+end
+
+Then(/^the JUnit files should have (\d+) (error|warning)s$/) do |count, level|
+  actual_count = 0
+  @expected_output_paths.each do |path|
+    doc = File.open(path) { |f| Nokogiri::XML(f) }
+    actual_count += doc.xpath("//failure[@type=\"#{level}\"]").length
+  end
+  assert_equal(count.to_i, actual_count)
+end

data/test/features/step_definitions/language_steps.rb

@@ -0,0 +1,39 @@
+When(/^I run it on the command line specifying(?: the)? ([^ ]+) language(?:s)? and ([^ ]+) files$/) do |lang_name, fixture_group|
+  options = [
+    '--require', Dir.pwd + '/' + 'test/fixtures/require/mock_format.rb', 
+    '--format', 'MockFormat',
+  ]
+  unless lang_name == 'all'
+    options << '--lang'
+    options << lang_name
+  end
+  options << 'test/fixtures/files/' + fixture_group
+
+  @run_result = run_check(options)
+end
+
+Then(/^I should get a list of the core languages along with a zero exit code$/) do
+  assert_equal(0, @run_result[:exit_status].to_i)
+  assert_language_list
+end
+
+Then(/^the output should have (\d+) (error|warning)s$/) do |count, level|
+  actual = @run_result[:overall_result].send((level +'_count').to_sym)
+  assert_equal(count.to_i, actual)
+end
+
+Then(/^the output should show only files for ([^ ]+)$/) do |lang_name|
+  touched = @run_result[:overall_result].file_paths
+  matched = files_matching_language(touched, lang_name)
+  extra = touched - matched
+  assert_empty(extra, "The touched files should ONLY include files for #{lang_name}")
+  refute_empty(matched, "The touched files should include files for #{lang_name}")
+end
+
+
+Then(/^the output should include files for ([^ ]+)$/) do | lang_name|
+  touched = @run_result[:overall_result].file_paths
+  matched = files_matching_language(touched, lang_name)
+  refute_empty(matched, "The touched files should include files for #{lang_name}")
+end
+

data/test/features/step_definitions/require_steps.rb

@@ -0,0 +1,38 @@
+When(/^I run it on the command line with the require option (and the debug option )?and a (valid|invalid|missing) ruby file$/) do |need_debug, require_file|
+  options = [
+    '--require', Dir.pwd + '/' + 'test/fixtures/require/' + require_file + '.rb',
+  ]
+  if need_debug then
+    options << '--debug'
+  end
+  options << 'test/fixtures/files/clean'
+  @run_result = run_check(options)
+end
+
+When(/^I run it on the command line with two requires$/) do
+  options = [
+    '--require', Dir.pwd + '/' + 'test/fixtures/require/valid.rb',
+    '--require', Dir.pwd + '/' + 'test/fixtures/require/second.rb',
+  ]
+  options << 'test/fixtures/files/clean'
+  @run_result = run_check(options)
+end
+
+Then(/^I should get an error message about the (missing|invalid) require file$/) do |which_require|
+  assert_match(Regexp.new("Could not load .+ because it appears to be #{which_require}."), @run_result[:stderr])
+  assert_equal(1, @run_result[:stderr].split("\n").length, 'Stderr should be a single line, not a nasty stacktrace')
+  assert_empty(@run_result[:stdout], 'Stdout should be silent')
+end
+
+Then(/^I should get a stack trace about the invalid require file$/) do
+  assert_match(Regexp.new("Could not load .+ because it appears to be invalid."), @run_result[:stderr])
+  assert_match(Regexp.new('(Error|Exception)'),@run_result[:stderr], 'Stderr should include a stack trace')
+  assert_empty(@run_result[:stdout], 'Stdout should be silent')
+end
+
+Then(/^the (valid|first|second) ruby file should have been loaded$/) do |which_require|
+  klass_name = which_require == 'first' ? 'valid' : which_require
+  klass_name.capitalize!
+  klass_name = 'CI::Syntax::Tool::Test::' + klass_name + 'Require'
+  assert_class_loaded(klass_name)
+end