xcpretty 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6174a374d362e6eef62f59962119eb7b6aaf384e
-  data.tar.gz: 14df3e40231cf38544095c3385b327375eaa4759
+  metadata.gz: c9e545d9dce2b78bc9b2e752084c12eea449548c
+  data.tar.gz: 66f8241eb6083b21bad323f67b523487beb8ddd2
 SHA512:
-  metadata.gz: 9216ed7953d333dc50fee64448f7c768c0e5779a8e37c8a574d8760ebe39465c17d0639dd95218d5b8c5ccccc3c02d1417122b73547fb451e0ffe29fbd0d72ff
-  data.tar.gz: f2bcf82f2de77686c8fac0b01cc26a14c39938ba619fbfcae0634dab5607eb8d7db2dc8979044740ef48f990fb7df7ce180d28d829e23b2e117dc1c67b62b56c
+  metadata.gz: bcbddd17addbb98fdf571bec535dfe1a1bdaf82e25c2d735988c8b2b012be022251365f129d9de7ba6a97ae2edc4f601acf802778af0940dfe4ed2961489bf2c
+  data.tar.gz: 8449afa6fea052c28f75667785072ca269c2c1a04e87feada85f90ff5e5f53f19d49780345a5b89003e28a1d40ac3fdd669bb56f1e9823a0b85133e8c8fd6672

data/README.md

@@ -67,7 +67,7 @@ $ xcodebuild [flags] | tee xcodebuild.log | xcpretty
 - `--report html`, `-r html`: Creates a simple HTML report at `build/reports/tests.html`.
 ![xcpretty html](http://i.imgur.com/0Rnux3v.gif)
 
-- `--report json-compilation-database`, `-r json-compilation-database`: Creates a [JSON compilation database](http://clang.llvm.org/docs/JSONCompilationDatabase.html) at `build/reports/compilation.json`. This is a format to replay single compilations independently of the build system.
+- `--report json-compilation-database`, `-r json-compilation-database`: Creates a [JSON compilation database](http://clang.llvm.org/docs/JSONCompilationDatabase.html) at `build/reports/compilation_db.json`. This is a format to replay single compilations independently of the build system.
 
 Writing a report to a custom path can be specified using `--output PATH`.
 
@@ -76,7 +76,7 @@ Writing a report to a custom path can be specified using `--output PATH`.
 `xcpretty` supports custom formatters through the use of the
 `--formatter` flag, which takes a path to a file as an argument. The
 file must contain a Ruby subclass of `XCPretty::Formatter`, and
-return that class at the end of te file. The class
+return that class at the end of the file. The class
 can override the `format_*` methods to hook into output parsing
 events.
 

data/Rakefile

@@ -23,3 +23,4 @@ task :ci do
   Rake::Task[:cucumber].invoke
   Rake::Task[:lint].invoke
 end
+

data/bin/xcpretty

@@ -39,17 +39,21 @@ OptionParser.new do |opts|
     printer_opts[:formatter] = XCPretty::TestAnything
   end
   opts.on('-f', '--formatter PATH', 'Use formatter returned from evaluating the specified Ruby file') do |path|
-    printer_opts[:formatter] = XCPretty.load_custom_formatter(path)
+    printer_opts[:formatter] = XCPretty.load_custom_class(path)
   end
-  opts.on('--[no-]color', 'Use colorized output. Defaults is auto') do |value|
+  opts.on('-c', '--[no-]color', 'Use colorized output. Default is auto') do |value|
     printer_opts[:colorize] = value
   end
   opts.on('--[no-]utf', 'Use unicode characters in output. Default is auto.') do |value|
     printer_opts[:unicode] = value
   end
-  opts.on("-r", "--report FORMAT", "Run FORMAT reporter",
+  opts.on("-r", "--report FORMAT or PATH", "Run FORMAT or PATH reporter",
           "  Choices: #{report_formats.keys.join(', ')}") do |format|
-    report_classes << report_formats[format]
+    if report_formats.key?(format)
+      report_classes << report_formats[format]
+    else
+      report_classes << XCPretty.load_custom_class(format)
+    end
     report_options << {}
   end
   opts.on('-o', '--output PATH', 'Write report output to PATH') do |path|
@@ -81,5 +85,6 @@ STDIN.each_line do |line|
   reporters.each { |r| r.handle(line) }
 end
 
+printer.finish
 reporters.each(&:finish)
 

data/features/custom_reporter.feature

@@ -0,0 +1,29 @@
+Feature: Loading an arbitrary Ruby file as a reporter
+
+    Background:
+        Given the tests have started running
+
+    Scenario: The file loaded does not contain a Ruby class
+        When I pipe to xcpretty with "-r /bin/bash"
+        Then the exit status code should be 1
+
+    Scenario: The file loaded contains a Ruby class
+        Given I have a file to compile
+        When I pipe to xcpretty with a custom reporter
+        Then the exit status code should be 0
+
+    Scenario: Showing failed tests
+        Given I have a failing test in my suite
+        When I pipe to xcpretty with a custom reporter
+        Then I should see a failed test in my custom report
+        And the custom failure counter should show 1 test
+
+    Scenario: Showing passing tests
+        Given I have a passing test in my suite
+        When I pipe to xcpretty with a custom reporter
+        Then I should see a passing test in my custom report
+
+    Scenario: Showing pending tests
+        Given I have a pending test in my suite
+        When I pipe to xcpretty with a custom reporter
+        Then I should see a pending test in my custom report

data/features/simple_format.feature

@@ -45,6 +45,11 @@ Feature: Showing build output in simple format
         When I pipe to xcpretty with "--simple --color"
         Then I should see a yellow completion icon
 
+    Scenario: Showing aggregate target
+        Given I have an aggregate target to build
+        When I pipe to xcpretty with "--simple --no-color"
+        Then I should see an aggregate target message
+
     Scenario: Showing analyze
         Given I have a file to analyze
         When I pipe to xcpretty with "--simple --no-color"

data/features/steps/custom_reporter_steps.rb

@@ -0,0 +1,16 @@
+Then(/^I should see a passing test in my custom report$/) do
+  custom_report.should include("WOW such PASS.")
+end
+
+Then(/^I should see a failed test in my custom report$/) do
+  custom_report.should include("WOW such FAIL.")
+end
+
+Then(/^I should see a pending test in my custom report$/) do
+  custom_report.should include("WOW such PENDING.")
+end
+
+Then(/^the custom failure counter should show (\d+) tests?$/) do |fail_count|
+  custom_report.should include("Much 1 FAIL.")
+end
+

data/features/steps/formatting_steps.rb

@@ -15,6 +15,10 @@ Given(/^I have a precompiled header$/) do
   add_run_input SAMPLE_PRECOMPILE
 end
 
+Given(/^I have an aggregate target to build$/) do
+  add_run_input SAMPLE_AGGREGATE_TARGET
+end
+
 Given(/^I have a file to analyze$/) do
   add_run_input SAMPLE_ANALYZE
 end
@@ -169,6 +173,10 @@ Then(/^I should see a successful precompilation message$/) do
   run_output.should start_with("▸ Precompiling")
 end
 
+Then(/^I should see an aggregate target message$/) do
+  run_output.should start_with("▸ Aggregate")
+end
+
 Then(/^I should see a successful analyze message$/) do
   run_output.should start_with("▸ Analyzing")
 end

data/features/steps/json_steps.rb

@@ -39,3 +39,4 @@ Then(/^entries with a command shouldn't have malformed "-include" directives$/)
   entries = json_db.select { |entry| entry['command'].match(/-include\s+-/) }
   entries.length.should == 0
 end
+

data/features/steps/report_steps.rb

@@ -20,3 +20,8 @@ Then(/^I should have a test report in a custom path$/) do
   step("I should have a test report at \"#{custom_report_path}\"")
 end
 
+When(/^I pipe to xcpretty with a custom reporter$/) do
+  reporter_path = File.expand_path('../../../spec/fixtures/custom_reporter.rb', __FILE__)
+  run_xcpretty("-r #{reporter_path}")
+end
+

data/features/support/env.rb

@@ -8,6 +8,7 @@ require 'lib/xcpretty/version'
 require 'lib/xcpretty/syntax'
 require 'rexml/document'
 require 'lib/xcpretty/formatters/formatter'
+require 'lib/xcpretty/reporters/reporter'
 require 'lib/xcpretty/reporters/junit'
 require 'lib/xcpretty/reporters/html'
 require 'lib/xcpretty/reporters/json_compilation_database'
@@ -79,6 +80,10 @@ def junit_report_root
   junit_report.root.elements.to_a.first
 end
 
+def custom_report
+  @custom_report ||= File.open(XCPretty::Reporter::FILEPATH, 'r').read
+end
+
 def custom_report_path
   @custom_report_path ||= begin
     @custom_report_file1 = Tempfile.new('custom_report_path')
@@ -111,7 +116,8 @@ After do
   @json = nil
   FileUtils.rm_rf(XCPretty::JUnit::FILEPATH)
   FileUtils.rm_rf(XCPretty::HTML::FILEPATH)
-  FileUtils.rm_rf(XCPretty::JSONCompilationDatabase::FILE_PATH)
+  FileUtils.rm_rf(XCPretty::JSONCompilationDatabase::FILEPATH)
+  FileUtils.rm_rf(XCPretty::Reporter::FILEPATH)
   File.delete(@screenshot_file_path) if @screenshot_file_path
 end
 

data/lib/xcpretty.rb

@@ -8,6 +8,7 @@ require 'xcpretty/formatters/simple'
 require 'xcpretty/formatters/rspec'
 require 'xcpretty/formatters/knock'
 require 'xcpretty/formatters/tap'
+require 'xcpretty/reporters/reporter'
 require 'xcpretty/reporters/junit'
 require 'xcpretty/reporters/html'
 require 'xcpretty/reporters/json_compilation_database'
@@ -21,11 +22,11 @@ module XCPretty
     klass
   end
 
-  def self.load_custom_formatter(path)
+  def self.load_custom_class(path)
     $LOAD_PATH.unshift File.dirname(path)
     class_from_path(path)
   rescue SyntaxError => e
-    exit_with_error("Expected formatter source file to return a class. #{e}")
+    exit_with_error("Expected custom source file to return a class. #{e}")
   end
 
   def self.exit_with_error(message)

data/lib/xcpretty/formatters/formatter.rb

@@ -11,6 +11,7 @@ module XCPretty
 
     def format_analyze(file_name, file_path);                  EMPTY; end
     def format_build_target(target, project, configuration);   EMPTY; end
+    def format_aggregate_target(target, project, configuration); EMPTY; end
     def format_analyze_target(target, project, configuration); EMPTY; end
     def format_check_dependencies;                             EMPTY; end
     def format_clean(project, target, configuration);          EMPTY; end
@@ -30,7 +31,7 @@ module XCPretty
     def format_passing_test(suite, test, time);                EMPTY; end
     def format_pending_test(suite, test);                      EMPTY; end
     def format_measuring_test(suite, test, time);              EMPTY; end
-    def format_failing_test(suite, test, time, file_path);     EMPTY; end
+    def format_failing_test(suite, test, reason, file_path);   EMPTY; end
     def format_process_pch(file);                              EMPTY; end
     def format_process_pch_command(file_path);                 EMPTY; end
     def format_phase_success(phase_name);                      EMPTY; end
@@ -78,6 +79,9 @@ module XCPretty
       @parser = Parser.new(self)
     end
 
+    def finish
+    end
+
     # Override if you want to catch something specific with your regex
     def pretty_format(text)
       parser.parse(text)
@@ -158,10 +162,19 @@ module XCPretty
     end
 
     def format_failure(f)
-      "  #{f[:test_case]}, #{red(f[:reason])}\n  #{cyan(f[:file_path])}\n" \
-      "  ```\n" +
-      Syntax.highlight(Snippet.from_filepath(f[:file_path])) +
-      "  ```"
+      snippet = Snippet.from_filepath(f[:file_path])
+
+      output = "  #{f[:test_case]}, #{red(f[:reason])}\n  " \
+      "#{cyan(f[:file_path])}\n  ```\n"
+
+      if @colorize
+        output += Syntax.highlight(snippet)
+      else
+        output += snippet.contents
+      end
+
+      output += "  ```"
+      output
     end
 
     def error_symbol
@@ -174,4 +187,3 @@ module XCPretty
 
   end
 end
-

data/lib/xcpretty/formatters/simple.rb

@@ -27,6 +27,10 @@ module XCPretty
       format("Building", "#{project}/#{target} [#{configuration}]")
     end
 
+    def format_aggregate_target(target, project, configuration)
+      format("Aggregate", "#{project}/#{target} [#{configuration}]")
+    end
+
     def format_analyze_target(target, project, configuration)
       format("Analyzing", "#{project}/#{target} [#{configuration}]")
     end

data/lib/xcpretty/parser.rb

@@ -7,7 +7,7 @@ module XCPretty
     # @regex Captured groups
     # $1 file_path
     # $2 file_name
-    ANALYZE_MATCHER = /^Analyze(?:Shallow)?\s(.*\/(.*\.m))*/
+    ANALYZE_MATCHER = /^Analyze(?:Shallow)?\s(.*\/(.*\.(?:m|mm|cc|cpp|c|cxx)))\s*/
 
     # @regex Captured groups
     # $1 target
@@ -15,6 +15,12 @@ module XCPretty
     # $3 configuration
     BUILD_TARGET_MATCHER = /^=== BUILD TARGET\s(.*)\sOF PROJECT\s(.*)\sWITH.*CONFIGURATION\s(.*)\s===/
 
+    # @regex Captured groups
+    # $1 target
+    # $2 project
+    # $3 configuration
+    AGGREGATE_TARGET_MATCHER = /^=== BUILD AGGREGATE TARGET\s(.*)\sOF PROJECT\s(.*)\sWITH.*CONFIGURATION\s(.*)\s===/
+
     # @regex Captured groups
     # $1 target
     # $2 project
@@ -92,7 +98,12 @@ module XCPretty
     # $2 = test_suite
     # $3 = test_case
     # $4 = reason
-    FAILING_TEST_MATCHER = /^\s*(.+:\d+):\serror:\s[\+\-]\[(.*)\s(.*)\]\s:(?:\s'.*'\s\[FAILED\],)?\s(.*)/
+    TEST_FAILURE_MATCHER = /^\s*(.+:\d+):\serror:\s[\+\-]\[(.*)\s(.*)\]\s:(?:\s'.*'\s\[FAILED\],)?\s(.*)/
+
+    # @regex Captured groups
+    # $1 = file
+    # $2 = reason
+    TEST_UI_FAILURE_MATCHER = /Assertion\sFailure:\s(.+:\d+):\s(.*)/
 
     # @regex Captured groups
     # $1 = dsym
@@ -106,7 +117,13 @@ module XCPretty
     # $1 = target
     # $2 = build_variants (normal, profile, debug)
     # $3 = architecture
-    LINKING_MATCHER = /^Ld \/.*\/(.*) (.*) (.*)$/
+    LINKING_MATCHER = /^Ld \/?.*\/(.*?) (.*) (.*)$/
+
+    # @regex Captured groups
+    # $1 = suite
+    # $2 = test_case
+    # $3 = time
+    FAILING_TEST_MATCHER = /^\s*Test Case\s'-\[(.*)\s(.*)\]'\sfailed\s\((\d*\.\d{3})\sseconds\)/
 
     # @regex Captured groups
     # $1 = suite
@@ -281,6 +298,8 @@ module XCPretty
         formatter.format_analyze($2, $1)
       when BUILD_TARGET_MATCHER
         formatter.format_build_target($1, $2, $3)
+      when AGGREGATE_TARGET_MATCHER
+        formatter.format_aggregate_target($1, $2, $3)
       when ANALYZE_TARGET_MATCHER
         formatter.format_analyze_target($1, $2, $3)
       when CLEAN_REMOVE_MATCHER
@@ -315,7 +334,7 @@ module XCPretty
         formatter.format_cpresource($1)
       when EXECUTED_MATCHER
         format_summary_if_needed(text)
-      when FAILING_TEST_MATCHER
+      when TEST_FAILURE_MATCHER
         formatter.format_failing_test($2, $3, $4, $1)
       when FATAL_ERROR_MATCHER
         formatter.format_error($1)
@@ -335,6 +354,12 @@ module XCPretty
         formatter.format_measuring_test($1, $2, $3)
       when PENDING_TEST_MATCHER
         formatter.format_pending_test($1, $2)
+      when FAILING_TEST_MATCHER
+        if @current_assertion_failure
+          formatter.format_failing_test($1, $2, @current_assertion_failure[:reason], @current_assertion_failure[:file])
+        else
+          formatter.format_failing_test($1, $2, '', '')
+        end
       when PASSING_TEST_MATCHER
         formatter.format_passing_test($1, $2, $3)
       when PODS_ERROR_MATCHER
@@ -384,9 +409,22 @@ module XCPretty
         @tests_done = false
         @formatted_summary = false
         @failures = {}
+        @assertion_failure = []
+        @current_assertion_failure = {}
       when TESTS_RUN_COMPLETION_MATCHER
         @tests_done = true
+      when TEST_UI_FAILURE_MATCHER
+        @current_assertion_failure = {
+          file: $1,
+          reason: $2
+        }
       when FAILING_TEST_MATCHER
+        if @current_assertion_failure
+          store_failure(@current_assertion_failure[:file], $1, $2, @current_assertion_failure[:reason])
+        else
+          store_failure(nil, $1, $2, '')
+        end
+      when TEST_FAILURE_MATCHER
         store_failure($1, $2, $3, $4)
       end
     end
@@ -535,4 +573,3 @@ module XCPretty
 
   end
 end
-

data/lib/xcpretty/printer.rb

@@ -11,6 +11,10 @@ module XCPretty
       @formatter = klass.new(params[:unicode], params[:colorize])
     end
 
+    def finish
+      @formatter.finish
+    end
+
     def pretty_print(text)
       formatted_text = formatter.pretty_format(text)
       unless formatted_text.empty?

data/lib/xcpretty/reporters/html.rb

@@ -1,7 +1,6 @@
 module XCPretty
-  class HTML
+  class HTML < Reporter
 
-    include XCPretty::FormatMethods
     FILEPATH = 'build/reports/tests.html'
     TEMPLATE = File.expand_path('../../../../assets/report.html.erb', __FILE__)
     SCREENSHOT_DIR = 'build/reports'
@@ -16,12 +15,8 @@ module XCPretty
     end
 
     def initialize(options)
-      load_dependencies
+      super(options)
       @test_suites = {}
-      @filepath    = options[:path] || FILEPATH
-      @parser      = Parser.new(self)
-      @test_count  = 0
-      @fail_count  = 0
       @collect_screenshots = options[:screenshots]
     end
 
@@ -39,16 +34,11 @@ module XCPretty
       add_test(suite, name: test_case, time: time)
     end
 
-    def finish
-      FileUtils.mkdir_p(File.dirname(@filepath))
-      write_report
-    end
-
     private
 
     def formatted_snippet(filepath)
       snippet = Snippet.from_filepath(filepath)
-      Syntax.highlight(snippet)
+      Syntax.highlight_html(snippet)
     end
 
 

data/lib/xcpretty/reporters/json_compilation_database.rb

@@ -1,8 +1,7 @@
 module XCPretty
-  class JSONCompilationDatabase
+  class JSONCompilationDatabase < Reporter
 
-    include XCPretty::FormatMethods
-    FILE_PATH = 'build/reports/compilation_db.json'
+    FILEPATH = 'build/reports/compilation_db.json'
 
     def load_dependencies
       unless @@loaded ||= false
@@ -14,19 +13,13 @@ module XCPretty
     end
 
     def initialize(options)
-      load_dependencies
-      @file_path = options[:path] || FILE_PATH
-      @parser = Parser.new(self)
+      super(options)
       @compilation_units = []
       @pch_path = nil
       @current_file = nil
       @current_path = nil
     end
 
-    def handle(line)
-      @parser.parse(line)
-    end
-
     def format_process_pch_command(file_path)
       @pch_path = file_path
     end
@@ -48,15 +41,8 @@ module XCPretty
                              directory: directory}
     end
 
-    def finish
-      FileUtils.mkdir_p(File.dirname(@file_path))
-      write_report
-    end
-
-    private
-
     def write_report
-      File.open(@file_path, 'w') do |f|
+      File.open(@filepath, 'w') do |f|
         f.write(@compilation_units.to_json)
       end
     end