xcpretty 0.0.6 → 0.0.7

data/features/steps/junit_steps.rb

@@ -1,21 +1,33 @@
+Given(/^I have tests in my suite from 2 classes$/) do
+  add_run_input SAMPLE_OCUNIT_TEST
+  add_run_input SAMPLE_KIWI_TEST
+end
+
 Then(/^I should see a failed test node in my report$/) do
-  junit_report.root.elements.to_a.detect do |node|
+  junit_report_root.elements.to_a.detect do |node|
     element = node.elements.to_a.first
     element && element.name == "failure"
   end.should_not be_nil
 end
 
 Then(/^I should see a passing test node in my report$/) do
-  junit_report.root.elements.to_a.detect do |node|
+  junit_report_root.elements.to_a.detect do |node|
     node.attributes["time"] != nil
   end.should_not be_nil
 end
 
 Then(/^I should see a test suite node$/) do
-  junit_report.root.should_not be_nil
+  junit_report_root.elements.to_a.first.should_not be_nil
 end
 
 Then(/^I should see (\d+) tests in my report$/) do |test_count|
-  junit_report.root.attributes["tests"].should == test_count
-  junit_report.root.elements.to_a.count.should == test_count.to_i
-end
+  junit_report_root.attributes["tests"].should == test_count
+  junit_report_root.elements.to_a.count.should == test_count.to_i
+end
+
+Then(/^I should see (\d+) test suites$/) do |count|
+  suites = junit_report.root.elements.to_a
+  suites.size.should == count.to_i
+  suites.select {|s| s.name == 'testsuite' }.size.should == count.to_i
+end
+

data/features/steps/xcpretty_steps.rb

@@ -0,0 +1,7 @@
+Given(/^the build has failed$/) do
+  add_run_input "/Users/musalj/code/OSS/ObjectiveSugar/Example/ObjectiveSugarTests/NSArrayCategoriesTests.m:53:13: error: use of undeclared identifier 'something'"
+end
+
+Then(/^the exit status code should be (\d)$/) do |numbah|
+  $?.exitstatus.should == numbah.to_i
+end

data/features/support/env.rb

@@ -1,12 +1,13 @@
 $:.unshift File.expand_path('../../..', __FILE__)
 
-require "tempfile"
-require "spec/fixtures/constants"
-require "spec/support/matchers/colors"
-require "lib/xcpretty/ansi"
-require "rexml/document"
-require "lib/xcpretty/printer"
-require "lib/xcpretty/reporters/junit"
+require 'tempfile'
+require 'spec/fixtures/constants'
+require 'spec/support/matchers/colors'
+require 'lib/xcpretty/ansi'
+require 'lib/xcpretty/syntax'
+require 'rexml/document'
+require 'lib/xcpretty/formatters/formatter'
+require 'lib/xcpretty/reporters/junit'
 
 include XCPretty::ANSI
 
@@ -17,10 +18,8 @@ TEST_PATH_MATCHER = %r{[\w/\-\s]+:\d+}
 PASSING_TEST_NAME_MATCHER = %r{\w+\s\(\d+\.\d+\sseconds\)}
 FAILING_TEST_NAME_MATCHER = %r{\w+, expected:}
 
-def run_xcpretty flags
-  add_run_input SAMPLE_OCUNIT_SUITE_COMPLETION
-  add_run_input SAMPLE_EXECUTED_TESTS
-  input_file = Tempfile.new("xcpretty_input")
+def run_xcpretty(flags)
+  input_file = Tempfile.new('xcpretty_input')
   File.open(input_file.path, 'w') do |file|
     file.print run_input
   end
@@ -28,24 +27,28 @@ def run_xcpretty flags
   input_file.unlink
 end
 
-def add_run_input text
+def add_run_input(text)
   run_input << "\n#{text}"
 end
 
 def run_input
-  @input ||= ""
+  @input ||= ''
 end
 
 def run_output
-  @output ||= ""
+  @output ||= ''
 end
 
 def junit_report
   REXML::Document.new(File.open(XCPretty::JUnit::FILEPATH, 'r').read)
 end
 
+def junit_report_root
+  junit_report.root.elements.to_a.first
+end
+
 Before do
- self.colorize = true
+  self.colorize = true
 end
 
 After do

data/features/test_format.feature

@@ -12,6 +12,7 @@ Feature: Showing RSpec-style test output
 
     Scenario: Showing some tests failed with color
         Given I have a failing test in my suite
+        And the test suite has finished
         When I pipe to xcpretty with "--test --color"
         Then I should see a red failed test icon
         And I should see the path of a failed test

data/features/xcpretty.feature

@@ -0,0 +1,12 @@
+Feature: Status codes
+
+    Scenario: Xcode tests have failed
+        Given I have a failing test in my suite
+        When I pipe to xcpretty
+        Then the exit status code should be 1
+
+    Scenario: Xcode build has failed
+        Given the build has failed
+        When I pipe to xcpretty
+        Then the exit status code should be 1
+

data/lib/xcpretty.rb

@@ -1,9 +1,31 @@
 require "xcpretty/version"
 require "xcpretty/printer"
-require "xcpretty/printers/simple"
-require "xcpretty/printers/rspec"
+require "xcpretty/syntax"
+require "xcpretty/formatters/formatter"
+require "xcpretty/formatters/simple"
+require "xcpretty/formatters/rspec"
 require "xcpretty/reporters/junit"
 
 module XCPretty
-  # Your code goes here...
+  class ExitStatus
+
+    include XCPretty::Matchers
+
+    POSSIBLE_FAILURES = [
+      FAILING_TEST_MATCHER,
+      /\serror:\s/
+    ]
+
+    def self.code
+      $exit_status || 0
+    end
+
+    def self.handle(text)
+      POSSIBLE_FAILURES.detect do |failure|
+        $exit_status = 1 if text =~ failure
+      end
+    end
+
+  end
 end
+

data/lib/xcpretty/ansi.rb

@@ -1,5 +1,6 @@
 module XCPretty
   module ANSI
+    
     attr_accessor :colorize
 
     FORMATTED_MATCHER = %r{\e\[(\d+)[;]?(\d+)?m(.*)\e\[0m}

data/lib/xcpretty/formatters/formatter.rb

@@ -0,0 +1,90 @@
+require 'xcpretty/ansi'
+require 'xcpretty/parser'
+
+module XCPretty
+
+  # Making a new formatter is easy.
+  # Just make a subclass of Formatter, and override any of these methods.
+  module FormatMethods
+    EMPTY_STRING = ''
+    def format_analyze(file_name, file_path);                EMPTY_STRING; end
+    def format_build_target(target, project, configuration); EMPTY_STRING; end
+    def format_check_dependencies;                           EMPTY_STRING; end
+    def format_clean(project, target, configuration);        EMPTY_STRING; end
+    def format_clean_target(target, project, configuration); EMPTY_STRING; end
+    def format_clean_remove;                                 EMPTY_STRING; end
+    def format_compile(file_name, file_path);                EMPTY_STRING; end
+    def format_compile_error(file_name, file_path, reason, line, cursor); EMPTY_STRING; end
+    def format_compile_xib(file_name, file_path);            EMPTY_STRING; end
+    def format_copy_strings_file(file_name);                 EMPTY_STRING; end
+    def format_cpresource(file);                             EMPTY_STRING; end
+    def format_error(message);                               EMPTY_STRING; end
+    def format_generate_dsym(dsym);                          EMPTY_STRING; end
+    def format_linking(file, build_variant, arch);           EMPTY_STRING; end
+    def format_libtool(library);                             EMPTY_STRING; end
+    def format_passing_test(suite, test, time);              EMPTY_STRING; end
+    def format_failing_test(suite, test, time, file_path);   EMPTY_STRING; end
+    def format_process_pch(file);                            EMPTY_STRING; end
+    def format_phase_script_execution(script_name);          EMPTY_STRING; end
+    def format_process_info_plist(file_name, file_path);     EMPTY_STRING; end
+    def format_codesign(file);                               EMPTY_STRING; end
+    def format_preprocess(file);                             EMPTY_STRING; end
+    def format_pbxcp(file);                                  EMPTY_STRING; end
+    def format_test_run_started(name);                       EMPTY_STRING; end
+    def format_test_run_finished(name, time);                EMPTY_STRING; end
+    def format_test_suite_started(name);                     EMPTY_STRING; end
+    def format_test_summary(message, failures_per_suite);    EMPTY_STRING; end
+  end
+
+  class Formatter
+
+    include ANSI
+    include FormatMethods
+
+    attr_reader :parser
+
+    def initialize(use_unicode, colorize)
+      @use_unicode = use_unicode
+      @colorize = colorize
+      @parser = Parser.new(self)
+    end
+
+    # Override if you want to catch something specific with your regex
+    def pretty_format(text)
+      parser.parse(text)
+    end
+
+    # If you want to print inline, override #optional_newline with ''
+    def optional_newline
+      "\n"
+    end
+
+    def use_unicode?
+      !!@use_unicode
+    end
+
+    # Will be printed by default. Override with '' if you don't want summary
+    def format_test_summary(executed_message, failures_per_suite)
+      failures = format_failures(failures_per_suite)
+      final_message = failures.empty? ? green(executed_message) : red(executed_message)
+
+      text = [failures, final_message].join("\n\n\n").strip
+      "\n\n#{text}"
+    end
+
+
+    private
+
+    def format_failures(failures_per_suite)
+      failures_per_suite.map do |suite, failures|
+        formatted_failures = failures.map do |f|
+          "  #{f[:test_case]}, #{red(f[:reason])}\n  #{cyan(f[:file])}"
+        end.join("\n\n")
+
+        "\n#{suite}\n#{formatted_failures}"
+      end.join("\n")
+    end
+
+  end
+end
+

data/lib/xcpretty/formatters/rspec.rb

@@ -0,0 +1,22 @@
+module XCPretty
+
+  class RSpec < Formatter
+
+    FAIL = "F"
+    PASS = "."
+
+    def optional_newline
+      ''
+    end
+
+    def format_passing_test(suite, test_case, time)
+      green(PASS)
+    end
+
+    def format_failing_test(test_suite, test_case, reason, file)
+      red(FAIL)
+    end
+
+  end
+
+end

data/lib/xcpretty/formatters/simple.rb

@@ -0,0 +1,137 @@
+# encoding: utf-8
+require 'shellwords'
+
+module XCPretty
+
+  class Simple < Formatter
+
+    PASS = "✓"
+    FAIL = "✗"
+    ERROR = "⌦ "
+
+    ASCII_PASS = "."
+    ASCII_FAIL = "x"
+    ASCII_ERROR = "[!]"
+    COMPLETION = "▸"
+    ASCII_COMPLETION = ">"
+
+    def format_analyze(file_name, file_path)
+      format("Analyzing", file_name)
+    end
+
+    def format_build_target(target, project, configuration)
+      format("Building", "#{project}/#{target} [#{configuration}]")
+    end
+
+    def format_clean_target(target, project, configuration)
+      format("Cleaning", "#{project}/#{target} [#{configuration}]")
+    end
+
+    def format_compile(file_name, file_path)
+      format("Compiling", file_name)
+    end
+
+    def format_compile_xib(file_name, file_path)
+      format("Compiling", file_name)
+    end
+
+    def format_copy_strings_file(file)
+      format("Copying", file)
+    end
+
+    def format_cpresource(resource)
+      format("Copying", resource)
+    end
+
+    def format_error(message)
+      status_symbol(:error) + " " + red(message)
+    end
+
+    def format_compile_error(file, file_path, reason, line, cursor)
+      "\n#{file_path}: #{red(reason)}\n\n#{line}\n#{cyan(cursor)}\n\n"
+    end
+
+    def format_generate_dsym(dsym)
+      format("Generating '#{dsym}'")
+    end
+
+    def format_libtool(library)
+      format("Building library", library)
+    end
+
+    def format_linking(target, build_variants, arch)
+      format("Linking", target)
+    end
+
+    def format_failing_test(suite, test_case, reason, file)
+      format_test("#{test_case}, #{reason}", false)
+    end
+
+    def format_passing_test(suite, test_case, time)
+      format_test("#{test_case} (#{time} seconds)")
+    end
+
+    def format_phase_script_execution(script_name)
+      format("Running script", "'#{script_name}'")
+    end
+
+    def format_process_info_plist(file_name, file_path)
+      format("Processing", file_name)
+    end
+
+    def format_process_pch(file)
+      format("Precompiling", file)
+    end
+
+    def format_codesign(file)
+      format("Signing", file)
+    end
+
+    def format_preprocess(file)
+      format("Preprocessing", file)
+    end
+
+    def format_pbxcp(file)
+      format("Copying", file)
+    end
+
+    def format_test_run_started(name)
+      heading("Test Suite", name, "started")
+    end
+
+    def format_test_suite_started(name)
+      heading("", name, "")
+    end
+
+
+    private
+
+    def heading(prefix, text, description)
+      [prefix, white(text), description].join(" ").strip
+    end
+
+    def format(command, argument_text="", success=true)
+      [status_symbol(success ? :completion : :fail), white(command), argument_text].join(" ").strip
+    end
+
+    def format_test(test_case, success=true)
+      [status_symbol(success ? :pass : :fail), test_case].join(" ").strip
+    end
+
+    def status_symbol(status)
+      case status
+      when :pass
+        green(use_unicode? ? PASS : ASCII_PASS)
+      when :fail
+        red(use_unicode? ? FAIL : ASCII_FAIL)
+      when :error
+        red(use_unicode? ? ERROR : ASCII_ERROR)
+      when :completion
+        yellow(use_unicode? ? COMPLETION : ASCII_COMPLETION)
+      else
+        ""
+      end
+    end
+
+  end
+end

data/lib/xcpretty/parser.rb

@@ -0,0 +1,283 @@
+module XCPretty
+
+  module Matchers
+
+    # @regex Captured groups
+    # $1 file_path
+    # $2 file_name
+    ANALYZE_MATCHER = /^Analyze(?:Shallow)?\s(.*\/(.*\.m))*/
+
+    # @regex Captured groups
+    # $1 target
+    # $2 project
+    # $3 configuration
+    BUILD_TARGET_MATCHER = /^=== BUILD TARGET\s(.*)\sOF PROJECT\s(.*)\sWITH.*CONFIGURATION\s(.*)\s===/
+
+    # @regex Nothing returned here for now
+    CHECK_DEPENDENCIES_MATCHER = /^Check dependencies/
+
+    # @regex Nothing returned here for now
+    CLEAN_REMOVE_MATCHER = /^Clean.Remove/
+
+    # @regex Captured groups
+    # $1 target
+    # $2 project
+    # $3 configuration
+    CLEAN_TARGET_MATCHER = /^=== CLEAN TARGET\s(.*)\sOF PROJECT\s(.*)\sWITH CONFIGURATION\s(.*)\s===/
+
+    # @regex Captured groups
+    # $1 = file
+    CODESIGN_MATCHER = /^CodeSign\s((?:\\ |[^ ])*)$/
+
+    # @regex Captured groups
+    # $1 = file
+    CODESIGN_FRAMEWORK_MATCHER = /^CodeSign\s((?:\\ |[^ ])*.framework)\/Versions/
+
+    # @regex Captured groups
+    # $1 file_path
+    # $2 file_name (e.g. KWNull.m)
+    COMPILE_MATCHER = /^CompileC\s.*\s(.*\/(.*\.m))\s.*/
+
+    # @regex Captured groups
+    # $1 = file_path
+    # $2 = file_name
+    # $3 = reason
+    COMPILE_ERROR_MATCHER = /^(.+\/(.*\.[h,m,c]).*):\serror:\s(.*)$/
+
+    # @regex Captured groups
+    # $1 file_path
+    # $2 file_name (e.g. MainMenu.xib)
+    COMPILE_XIB_MATCHER = /^CompileXIB\s(.*\/(.*\.xib))/
+
+    # @regex Captured groups
+    # $1 file
+    COPY_STRINGS_MATCHER = /^CopyStringsFile.*\/(.*.strings)/
+
+    # @regex Captured groups
+    # $1 resource
+    CPRESOURCE_MATCHER = /^CpResource\s(.*)\s\//
+
+    # @regex Captured groups
+    # $1 cursor (with whitespaces and tildes)
+    CURSOR_MATCHER = /^([\s~]*\^[\s~]*)$/
+
+    # @regex Captured groups
+    #
+    EXECUTED_MATCHER = /^Executed/
+
+    # @regex Captured groups
+    # $1 = file
+    # $2 = test_suite
+    # $3 = test_case
+    # $4 = reason
+    FAILING_TEST_MATCHER = /^(.+:\d+):\serror:\s[\+\-]\[(.*)\s(.*)\]\s:(?:\s'.*'\s\[FAILED\],)?\s(.*)/
+
+    # @regex Captured groups
+    # $1 = dsym
+    GENERATE_DSYM_MATCHER = /^GenerateDSYMFile \/.*\/(.*\.dSYM)/
+
+    # @regex Captured groups
+    # $1 = library
+    LIBTOOL_MATCHER = /^Libtool.*\/(.*\.a)/
+
+    # @regex Captured groups
+    # $1 = target
+    # $2 = build_variants (normal, profile, debug)
+    # $3 = architecture
+    LINKING_MATCHER = /^Ld \/.*\/(.*) (.*) (.*)$/
+
+    # @regex Captured groups
+    # $1 = suite
+    # $2 = test_case
+    # $3 = time
+    PASSING_TEST_MATCHER = /^Test Case\s'-\[(.*)\s(.*)\]'\spassed\s\((\d*\.\d{3})\sseconds\)/
+
+    # @regex Captured groups
+    # $1 = script_name
+    PHASE_SCRIPT_EXECUTION_MATCHER = /^PhaseScriptExecution\s(.*)\s\//
+
+    # @regex Captured groups
+    PODS_ERROR_MATCHER = /^error:\s(.*)/
+
+    # @regex Captured groups
+    # $1 = file
+    PROCESS_PCH_MATCHER = /^ProcessPCH\s.*\s(.*.pch)/
+
+    # @regex Captured groups
+    # $1 = file
+    PREPROCESS_MATCHER = /^Preprocess\s(?:(?:\\ |[^ ])*)\s((?:\\ |[^ ])*)$/
+
+    # @regex Captured groups
+    # $1 = file
+    PBXCP_MATCHER = /^PBXCp\s((?:\\ |[^ ])*)/
+
+    # @regex Captured groups
+    # $1 = file
+    PROCESS_INFO_PLIST_MATCHER = /^ProcessInfoPlistFile\s.*\.plist\s(.*\/+(.*\.plist))/
+    # @regex Captured groups
+    # $1 = suite
+    # $2 = time
+    TESTS_RUN_COMPLETION_MATCHER = /Test Suite '(?:.*\/)?(.*[ox]ctest.*)' finished at (.*)/
+
+    # @regex Captured groups
+    # $1 = suite
+    # $2 = time
+    TESTS_RUN_START_MATCHER = /Test Suite '(?:.*\/)?(.*[ox]ctest.*)' started at(.*)/
+
+    # @regex Captured groups
+    # $1 test suite name
+    TEST_SUITE_START_MATCHER = /Test Suite '(.*)' started at/
+  end
+
+  class Parser
+
+    include Matchers
+    attr_reader :formatter
+
+    def initialize(formatter)
+      @formatter = formatter
+    end
+
+    def parse(text)
+      update_test_state(text)
+      update_error_state(text)
+
+      return format_error if should_format_error?
+
+      case text
+      when ANALYZE_MATCHER
+        formatter.format_analyze($2, $1)
+      when BUILD_TARGET_MATCHER
+        formatter.format_build_target($1, $2, $3)
+      when CLEAN_REMOVE_MATCHER
+        formatter.format_clean_remove
+      when CLEAN_TARGET_MATCHER
+        formatter.format_clean_target($1, $2, $3)
+      when COPY_STRINGS_MATCHER
+        formatter.format_copy_strings_file($1)
+      when CHECK_DEPENDENCIES_MATCHER
+        formatter.format_check_dependencies
+      when COMPILE_MATCHER
+        formatter.format_compile($2, $1)
+      when COMPILE_XIB_MATCHER
+        formatter.format_compile_xib($2, $1)
+      when CPRESOURCE_MATCHER
+        formatter.format_cpresource($1)
+      when EXECUTED_MATCHER
+        format_summary_if_needed(text)
+      when FAILING_TEST_MATCHER
+        formatter.format_failing_test($2, $3, $4, $1)
+      when GENERATE_DSYM_MATCHER
+        formatter.format_generate_dsym($1)
+      when LIBTOOL_MATCHER
+        formatter.format_libtool($1)
+      when LINKING_MATCHER
+        formatter.format_linking($1, $2, $3)
+      when PASSING_TEST_MATCHER
+        formatter.format_passing_test($1, $2, $3)
+      when PODS_ERROR_MATCHER
+        formatter.format_error($1)
+      when PROCESS_INFO_PLIST_MATCHER
+        formatter.format_process_info_plist(*unescaped($2, $1))
+      when PHASE_SCRIPT_EXECUTION_MATCHER
+        formatter.format_phase_script_execution(*unescaped($1))
+      when PROCESS_PCH_MATCHER
+        formatter.format_process_pch($1)
+      when CODESIGN_FRAMEWORK_MATCHER
+        formatter.format_codesign($1)
+      when CODESIGN_MATCHER
+        formatter.format_codesign($1)
+      when PREPROCESS_MATCHER
+        formatter.format_preprocess($1)
+      when PBXCP_MATCHER
+        formatter.format_pbxcp($1)
+      when TESTS_RUN_COMPLETION_MATCHER
+        formatter.format_test_run_finished($1, $2)
+      when TESTS_RUN_START_MATCHER
+        formatter.format_test_run_started($1)
+      when TEST_SUITE_START_MATCHER
+        formatter.format_test_suite_started($1)
+      else
+        ""
+      end
+    end
+
+    private
+
+    def update_test_state(text)
+      case text
+      when TESTS_RUN_START_MATCHER
+        @tests_done = false
+        @formatted_summary = false
+        @failures = {}
+      when TESTS_RUN_COMPLETION_MATCHER
+        @tests_done = true
+      when FAILING_TEST_MATCHER
+        store_failure($1, $2, $3, $4)
+      end
+    end
+
+    # @ return Hash { :file_name, :file_path, :reason, :line }
+    def update_error_state(text)
+      if text =~ COMPILE_ERROR_MATCHER
+        @formatting_error = true
+        current_error[:reason]    = $3
+        current_error[:file_path] = $1
+        current_error[:file_name] = $2
+      elsif text =~ CURSOR_MATCHER
+        @formatting_error = false
+        current_error[:cursor]    = $1.chomp
+      else
+        current_error[:line]      = text.chomp if @formatting_error
+      end
+    end
+
+    # TODO: clean up the mess around all this
+    def should_format_error?
+      current_error[:reason] && current_error[:cursor] && current_error[:line]
+    end
+
+    def current_error
+      @current_error ||= {}
+    end
+
+    def format_error
+      error = current_error.dup
+      @current_error = {}
+      formatter.format_compile_error(error[:file_name],
+                                     error[:file_path],
+                                     error[:reason],
+                                     error[:line],
+                                     error[:cursor])
+    end
+
+    def store_failure(file, test_suite, test_case, reason)
+      failures_per_suite[test_suite] ||= []
+      failures_per_suite[test_suite] << {
+        :file => file,
+        :reason => reason,
+        :test_case => test_case,
+      }
+    end
+
+    def failures_per_suite
+      @failures ||= {}
+    end
+
+    def format_summary_if_needed(executed_message)
+      return "" unless should_format_summary?
+
+      @formatted_summary = true
+      formatter.format_test_summary(executed_message, failures_per_suite)
+    end
+
+    def should_format_summary?
+      @tests_done && !@formatted_summary
+    end
+
+    def unescaped(*escaped_values)
+      escaped_values.map { |v| v.gsub('\\', '') }
+    end
+
+  end
+end