xcpretty-junit-formatter 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67fa7b7ce83a60b25f80d299e90378d32758da9a80109c2ac7fa348afdcf5a63
+  data.tar.gz: 36ed73df1b55d942f2bf76aca3ec90e4fad733720a3c1d0a31754b7ac256e233
+SHA512:
+  metadata.gz: 8922c15610f765bd5cb5ecb0430fbd06b3136b0cc4e46cfe10031e6c7deac90fc9ca2fc008ba59f81d6030772db074d689c34e2c8ee3afd20e98b44a0a6eb5cb
+  data.tar.gz: 52c01e03f61f888ebbeac90d0ca92d9ec6bf6d93425a8164910b6da3a59731ec8767cbee7477d6048f746d1cea98459e50f056eea90b71bbe4a488bb0571b35c

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Marcelo Fabri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# XCPretty JUnit Formatter
+
+[![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](LICENSE.txt)
+[![Gem](https://img.shields.io/gem/v/xcpretty-json-formatter.svg?style=flat)](http://rubygems.org/gems/xcpretty-json-formatter)
+[![Build Status](https://travis-ci.org/marcelofabri/xcpretty-json-formatter.svg?branch=master)](https://travis-ci.org/marcelofabri/xcpretty-json-formatter)
+
+Custom formatter for [xcpretty](https://github.com/supermarin/xcpretty) that saves on a XML (JUnit) file all the errors, warnings and test failures, so you can process them easily later.
+
+## Installation
+
+This formatter is distributed via RubyGems, and depends on a version of `xcpretty` >= 0.0.7 (when custom formatters were introduced). Run:
+
+    gem install xcpretty-junit-formatter
+
+## Usage
+
+Specify `xcpretty-junit-formatter` as a custom formatter to `xcpretty`:
+
+```bash
+#!/bin/bash
+
+xcodebuild | xcpretty -f `xcpretty-junit-formatter`
+```
+
+By default, `xcpretty-junit-formatter` writes the result in `build/reports/errors.xml`, but you can change that with an environment variable:
+
+```bash
+#!/bin/bash
+
+xcodebuild | XCPRETTY_JUNIT_FILE_OUTPUT=result.xml xcpretty -f `xcpretty-junit-formatter`
+```
+
+## Output format
+
+You can check some example JUnit xml files in the [fixtures folder](spec/fixtures).
+
+## Thanks
+
+* [Marin Usalj](http://github.com/supermarin) and [Delisa Mason](http://github.com/kattrali) for creating [xcpretty](https://github.com/supermarin/xcpretty).
+* [Delisa Mason](http://github.com/kattrali) for creating [xcpretty-travis-formatter](https://github.com/kattrali/xcpretty-travis-formatter), which I used as a guide.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/faken/xcpretty-junit-formatter.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/bin/xcpretty-junit-formatter

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+print File.expand_path('../../lib/junit_formatter.rb', __FILE__)

data/lib/junit_formatter.rb

@@ -0,0 +1,186 @@
+require 'fileutils'
+require 'xmlsimple'
+require 'cgi'
+
+class JUNITFormatter < XCPretty::Simple
+  FILE_PATH = 'build/reports/errors.xml'.freeze
+
+  def initialize(use_unicode, colorize)
+    super
+    @warnings = []
+    @ld_warnings = []
+    @compile_warnings = []
+    @errors = []
+    @compile_errors = []
+    @file_missing_errors = []
+    @undefined_symbols_errors = []
+    @duplicate_symbols_errors = []
+    @failures = {}
+    @tests_summary_messages = []
+  end
+
+  def format_ld_warning(message)
+    @ld_warnings << message
+    write_to_file_if_needed
+    super
+  end
+
+  def format_warning(message)
+    @warnings << message
+    write_to_file_if_needed
+    super
+  end
+
+  def format_compile_warning(file_name, file_path, reason, line, cursor)
+    @compile_warnings << {
+      message: reason, 
+      type: "WARNING", 
+      "content" => "\nFile: #{file_name}\n"\
+                   "Path: #{file_path}\n"\
+                   "Line: #{line}\n"\
+                   "Reason: #{reason}\n"\
+                   "Cursor: #{cursor}\n"
+    }
+    write_to_file_if_needed
+    super
+  end
+
+  def format_error(message)
+    @errors << message
+    write_to_file_if_needed
+    super
+  end
+
+  def format_compile_error(file_name, file_path, reason, line, cursor)
+    @compile_errors << {
+      message: reason, 
+      type: "ERROR", 
+      "content" => "\nFile: #{file_name}\n"\
+                   "Path: #{file_path}\n"\
+                   "Line: #{line}\n"\
+                   "Reason: #{reason}\n"\
+                   "Cursor: #{cursor}\n"
+    }
+    write_to_file_if_needed
+    super
+  end
+
+  def format_file_missing_error(reason, file_path)
+    @file_missing_errors << {
+      message: reason, 
+      type: "ERROR", 
+      "content" => "\nFile: #{file_path}\n"\
+                   "Reason: #{reason}\n"
+    }
+    write_to_file_if_needed
+    super
+  end
+
+  def format_undefined_symbols(message, symbol, reference)
+    @undefined_symbols_errors = {
+      message: message,
+      type: "ERROR", 
+      "content" => "Reference: #{reference}"\
+      "Symbol: #{symbol}"
+    }
+    write_to_file_if_needed
+    super
+  end
+
+  def format_duplicate_symbols(message, file_paths)
+    @duplicate_symbols_errors = {
+      message: message,
+      type: "ERROR", 
+      "content" => "\nMessage: #{message}\n"\
+      "Paths: #{file_paths}\n"
+    }
+    write_to_file_if_needed
+    super
+  end
+
+  def format_test_summary(message, failures_per_suite)
+    @failures = failures_per_suite.map { |key, value|
+      {
+        name: key,
+        failure: value.map { |failure| 
+          {
+            message: CGI.escapeHTML(failure[:reason]), 
+            type: "ERROR", 
+            "content" => "\nFile: #{failure[:file_path]}\n"\
+                         "Reason: #{failure[:reason]}\n"\
+                         "Test Case: #{failure[:test_case]}\n"
+          }
+        }
+      } 
+    }
+
+    @tests_summary_messages << message
+
+    puts "😂: #{@failures}"
+    puts "😂: #{@tests_summary_messages}"
+
+    write_to_file_if_needed
+    super
+  end
+
+  def finish
+    write_to_file
+    super
+  end
+
+  def combined_compile_errors 
+    [ @errors, @compile_errors, @file_missing_errors, 
+      @undefined_symbols_errors, @duplicate_symbols_errors ].flatten.compact.delete_if &:empty?
+    end
+
+    def combined_compile_warnings 
+      [@warnings, @ld_warnings, @compile_warnings].flatten.compact.delete_if &:empty?
+    end
+
+    def combined_test_failures
+      [@failures].flatten.compact.delete_if &:empty?
+    end
+
+    def junit_output
+      {
+        testsuites: {
+          name: "xcode_build", 
+          testsuite: [
+            {
+              name: "compile", 
+              testcase: [
+                {
+                  name: "failures", 
+                  failure: combined_compile_warnings
+                }, 
+                {
+                  name: "errors", 
+                  error: combined_compile_errors
+                }
+              ]
+            }, 
+            {
+              name: "test", 
+              testcase: combined_test_failures
+            }
+          ]
+        }
+      }
+    end
+
+    def write_to_file_if_needed
+      write_to_file unless XCPretty::Formatter.method_defined? :finish
+    end
+
+    def write_to_file
+      file_name = ENV['XCPRETTY_JUNIT_FILE_OUTPUT'] || FILE_PATH
+      dirname = File.dirname(file_name)
+      FileUtils.mkdir_p dirname
+
+      File.open(file_name, 'w') do |io|
+        io.write(XmlSimple.xml_out(junit_output, {keeproot: true, noescape: true}))
+      end
+    end
+  end
+
+  JUNITFormatter

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: xcpretty-junit-formatter
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Sascha Held
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xcpretty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+description: Custom formatter for xcpretty that saves on a JUNIT file that contains
+  all the errors, warnings and test failures, so you can process them easily later.
+email:
+- saschaheld@me.com
+executables:
+- xcpretty-junit-formatter
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/xcpretty-junit-formatter
+- lib/junit_formatter.rb
+homepage: https://github.com/faken/xcpretty-junit-formatter
+licenses:
+- MIT
+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.7.6
+signing_key: 
+specification_version: 4
+summary: xcpretty custom formatter for JUNIT output
+test_files: []