xcpretty 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cd373202b87a02b86dcb442fc772f3b8a2aeec7
-  data.tar.gz: 8e5c493eaedb98e1814aec0a3e7e93315a5ece76
+  metadata.gz: 50b91a1ee68864cc0c7f42210ff068b9f0ac4fbd
+  data.tar.gz: 183872807da2eafa43b7e938d3d00c99d9a7575d
 SHA512:
-  metadata.gz: 030ef974bc44f69886e39c4579e712183fa0aa44e7910577479779d945af76d1ac3606996b1d29fbe591dc21f362f37154c81f9953e443b7bfc8d6b2e79dc73c
-  data.tar.gz: ea349222ec2cc5c1b661168be29aeb2977973399088930b820c7a83d7daa333009c94d5437718f2116f4a09636a8c3ba41a398dbe02f0ce79c93d59107919886
+  metadata.gz: 9a81e3342d8eae995237e34a33849e35d894da2cd8853a4e87f63f7f7e40417062f2a5ef4b3dccce30425a445769a39b6e92bbfae5e13feb199dac555f59a979
+  data.tar.gz: 8aa6375079a878afe70a2532f40b441ff70836eea40afaca914f9c7620cb7bc9067b924052b01b9c0cf955e9a0e5e662f50feae5423d8f1d5a65aaf54de9f18e

data/CHANGELOG.md

@@ -4,7 +4,7 @@
 
 ###### Bug Fixes
 
-* --no-utf was set uncorrectly. now it works
+* `--no-utf` was set incorrectly. now it works as expected.
 
 
 ## 0.0.4
@@ -20,7 +20,7 @@
 
 * Added example of running tests continuously
 
-* Support for not using Unicode (--no-utf)
+* Support for not using Unicode (`--no-utf`)
 
 ###### Bug Fixes
 

data/CONTRIBUTING.md

@@ -0,0 +1,60 @@
+## Pull requests
+
+XCPretty is tested with [Cucumber](http://cukes.info) and [RSpec](http://rspec.info).
+If you're planning to contribute, please do write tests.
+
+Here's an example workflow for a contribution:
+
+#### 1. Write a failing feature
+
+- These are a full-stack end to end tests
+- You can find features in `features/`. You'll need to write a `feature` and implement it's `steps`.
+- Try to reuse as many matchers as possible
+- This tests are slower because they're executing `xcpretty` command for each test
+
+Here's an example feature for adding output without UTF8:
+
+``` gherkin
+Scenario: Running tests without UTF-8 support
+    Given I have a passing test in my suite
+    And I pipe to xcpretty with "--no-utf"
+    Then I should see a non-utf prefixed output
+```
+
+And the steps:
+
+- `Given I have a passing test in my suite`
+
+``` ruby
+Given(/^I have a passing test in my suite$/) do
+  add_run_input SAMPLE_OCUNIT_TEST
+end
+```
+
+- `And I pipe to xcpretty with "--no-utf"`
+
+``` ruby
+When(/^I pipe to xcpretty with "(.*?)"$/) do |flags|
+  run_xcpretty(flags)
+end
+```
+
+- `Then I should see a non-utf prefixed output`
+
+``` ruby
+Then(/^I should see a non-utf prefixed output$/) do
+  run_output.should start_with(".")
+end
+```
+
+
+#### 2. Write a failing BDD test
+
+- These are unit tests, and they're very fast (below 200ms for the entire suite)
+- You should be running them continuously with `kicker`, or your awesome Vim binding
+
+
+#### 3. Implement your awesome contribution
+
+- This should fix unit tests one-by-one, and finally your `feature` will be passing
+

data/README.md

@@ -17,15 +17,19 @@ It's even a bit faster than `xcodebuild` only, since it saves your terminal some
 
 ## Formats
 
-- --color, -c (you can add it to any format)
-- --simple, -s (default)
+- `--color`, `-c` (you can add it to any format)
+- `--simple`, `-s` (default)
 ![xcpretty --simple](http://i.imgur.com/LdmozBS.gif)
 
-- --test, -t (RSpec style)
+- `--test`, `-t` (RSpec style)
 ![xcpretty alpha](http://i.imgur.com/VeTQQub.gif)
 
 - tun / tap (not yet implemented. possible solution for most CI servers)
 
+## Reporters
+
+- `--report junit`, `-r junit`: Creates a JUnit-style XML report at `build/reports/junit.xml`, compatible with Jenkins CI.
+
 ## Have you just cloned xctool?
 
 Unlike [xctool](https://github.com/facebook/xctool), `xcpretty` isn't a build tool.

data/bin/xcpretty

@@ -7,7 +7,12 @@ if RUBY_VERSION < '1.8.7'
   abort "error: XCPretty requires Ruby 1.8.7 or higher."
 end
 
+report_formats = {
+  "junit" => XCPretty::JUnit
+}
+
 OptionParser.new do |opts|
+  @report_formats = []
   opts.banner = "Usage: xcodebuild [options] | xcpretty"
   opts.on('-t', '--test', 'Use RSpec style output') do
     @klass = XCPretty::Printer::RSpec
@@ -21,6 +26,10 @@ OptionParser.new do |opts|
   opts.on('--no-utf', 'Disable unicode characters in output') do
     @no_utf = true
   end
+  opts.on("-r", "--report FORMAT", "Run FORMAT reporter",
+                "  Choices: #{report_formats.keys.join(', ')}") do |format|
+    @report_formats << report_formats[format]
+  end
   opts.on_tail('-h', '--help', 'Show this message') { puts opts; exit }
   opts.on_tail("-v", "--version", "Show version") { puts XCPretty::VERSION; exit }
   opts.parse!
@@ -30,6 +39,11 @@ printer = (@klass || XCPretty::Printer::Simple).new
 printer.colorize = @colorize
 printer.use_unicode = !@no_utf
 
+reporters = @report_formats.compact.map(&:new)
+
 ARGF.each_line do |line|
   printer.pretty_print(line)
+  reporters.each {|r| r.handle(line) }
 end
+
+reporters.each(&:finish)

data/features/junit_report.feature

@@ -0,0 +1,24 @@
+Feature: Creating a JUnit test report
+
+    Background:
+        Given the tests have started running
+
+    Scenario: Showing a test suite
+        When I pipe to xcpretty with "--report junit"
+        Then I should see a test suite node
+
+    Scenario: Showing failed tests
+        Given I have a failing test in my suite
+        When I pipe to xcpretty with "--report junit"
+        Then I should see a failed test node in my report
+
+    Scenario: Showing passing tests
+        Given I have a passing test in my suite
+        When I pipe to xcpretty with "--report junit"
+        Then I should see a passing test node in my report
+
+    Scenario: Counting tests
+        Given I have a passing test in my suite
+        And I have a failing test in my suite
+        When I pipe to xcpretty with "--report junit"
+        Then I should see 2 tests in my report

data/features/steps/junit_steps.rb

@@ -0,0 +1,21 @@
+Then(/^I should see a failed test node in my report$/) do
+  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|
+    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
+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

data/features/support/env.rb

@@ -4,6 +4,9 @@ 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"
 
 include XCPretty::ANSI
 
@@ -37,6 +40,10 @@ def run_output
   @output ||= ""
 end
 
+def junit_report
+  REXML::Document.new(File.open(XCPretty::JUnit::FILEPATH, 'r').read)
+end
+
 Before do
  self.colorize = true
 end
@@ -44,4 +51,5 @@ end
 After do
   @input  = ""
   @output = ""
+  FileUtils.rm_rf(XCPretty::JUnit::FILEPATH)
 end

data/lib/xcpretty/printer.rb

@@ -16,9 +16,10 @@ module XCPretty
       TESTS_RUN_COMPLETION_MATCHER = /Test Suite '(?:.*\/)?(.*[ox]ctest.*)' finished at(.*)/
 
       # @regex Captured groups
-      # $1 = test_case
-      # $2 = time
-      PASSING_TEST_MATCHER = /Test Case\s'-\[.*\s(.*)\]'\spassed\s\((\d*\.\d{3})\sseconds\)/
+      # $1 = class
+      # $2 = test_case
+      # $3 = time
+      PASSING_TEST_MATCHER = /Test Case\s'-\[(.*)\s(.*)\]'\spassed\s\((\d*\.\d{3})\sseconds\)/
 
       # @regex Captured groups
       # $1 = file

data/lib/xcpretty/printers/simple.rb

@@ -44,7 +44,7 @@ module XCPretty
         when /^Ld/
           print_linking(text)
         when PASSING_TEST_MATCHER
-          print_passing_test($1, $2)
+          print_passing_test($2, $3)
         when FAILING_TEST_MATCHER
           print_failing_test($3, $4)
         when TESTS_RUN_START_MATCHER

data/lib/xcpretty/reporters/junit.rb

@@ -0,0 +1,79 @@
+
+module XCPretty
+  class JUnit
+    include Printer::Matchers
+
+    FILEPATH = 'build/reports/junit.xml'
+
+    def load_dependencies
+      unless @@loaded ||= false
+        require 'fileutils'
+        require 'rexml/document'
+        require 'rexml/formatters/pretty'
+        @@loaded = true
+      end
+    end
+
+    def initialize
+      load_dependencies
+      @document = REXML::Document.new
+    end
+
+    def handle(line)
+      case line
+      when TESTS_RUN_START_MATCHER
+        create_test_suite($1)
+      when TESTS_RUN_COMPLETION_MATCHER
+        finish_test_suite
+      when PASSING_TEST_MATCHER
+        create_passing_test_case($1, $2, $3)
+      when FAILING_TEST_MATCHER
+        create_failing_test_case($1, $2, $3, $4)
+      end
+    end
+
+    def finish
+      FileUtils.mkdir_p(File.dirname(FILEPATH))
+      formatter = REXML::Formatters::Pretty.new(2)
+      formatter.compact = true
+      formatter.write(@document, File.open(FILEPATH,'w+'))
+    end
+
+    def create_test_suite(name)
+      @test_count = 0
+      @fail_count = 0
+      suite = @document.add_element('testsuite')
+      suite.attributes['name'] = $1
+    end
+
+    def finish_test_suite
+      current_suite.attributes['tests'] = @test_count
+      current_suite.attributes['failures'] = @fail_count
+      @test_count = 0
+      @fail_count = 0
+    end
+
+    def current_suite
+      @document.elements.to_a.last
+    end
+
+    def create_failing_test_case(file, classname, name, reason)
+      test_node = current_suite.add_element('testcase')
+      test_node.attributes['classname'] = classname
+      test_node.attributes['name']      = name
+      fail_node = test_node.add_element('failure')
+      fail_node.attributes['message'] = reason
+      fail_node.text = file
+      @test_count+=1
+      @fail_count+=1
+    end
+
+    def create_passing_test_case(classname, name, time)
+      test_node = current_suite.add_element('testcase')
+      test_node.attributes['classname'] = classname
+      test_node.attributes['name']      = name
+      test_node.attributes['time']      = time
+      @test_count+=1
+    end
+  end
+end

data/lib/xcpretty/version.rb

@@ -1,3 +1,3 @@
 module XCPretty
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/xcpretty.rb

@@ -2,6 +2,7 @@ require "xcpretty/version"
 require "xcpretty/printer"
 require "xcpretty/printers/simple"
 require "xcpretty/printers/rspec"
+require "xcpretty/reporters/junit"
 
 module XCPretty
   # Your code goes here...

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xcpretty
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Marin Usalj
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
+date: 2013-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,13 +82,16 @@ files:
 - .kick
 - .travis.yml
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/xcpretty
+- features/junit_report.feature
 - features/simple_format.feature
 - features/steps/formatting_steps.rb
+- features/steps/junit_steps.rb
 - features/support/env.rb
 - features/test_format.feature
 - lib/xcpretty.rb
@@ -96,6 +99,7 @@ files:
 - lib/xcpretty/printer.rb
 - lib/xcpretty/printers/rspec.rb
 - lib/xcpretty/printers/simple.rb
+- lib/xcpretty/reporters/junit.rb
 - lib/xcpretty/version.rb
 - spec/fixtures/constants.rb
 - spec/fixtures/raw_kiwi_compilation_fail.txt
@@ -134,8 +138,10 @@ signing_key:
 specification_version: 4
 summary: xcodebuild formatter done right
 test_files:
+- features/junit_report.feature
 - features/simple_format.feature
 - features/steps/formatting_steps.rb
+- features/steps/junit_steps.rb
 - features/support/env.rb
 - features/test_format.feature
 - spec/fixtures/constants.rb
@@ -149,4 +155,3 @@ test_files:
 - spec/xcpretty/printers/printer_spec.rb
 - spec/xcpretty/printers/rspec_spec.rb
 - spec/xcpretty/printers/simple_spec.rb
-has_rdoc: