trainer 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d3f3f7766506007d3f80b42de82fe1c92582ffe
+  data.tar.gz: c04661b81b99b5fe24e056609fce852280f63935
+SHA512:
+  metadata.gz: 2fa78e21f1ff0585fd779781f5d3ffc76998637c326be9beb496f10311a5a8c7a35d51703db2efe57a4a0c13a9a9c3c0df5856662c1fb7c3730b6d1a227ad96a
+  data.tar.gz: c8765f4ebbe0de90fc45a07b484e6d45b39a82414aa9a60f49242f57f86dcec4667090d1ddc37bedd77f8c4faeb747ca0e709b3941bdadf2a5087a74bc716bc6

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Felix Krause
+
+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,78 @@
+# trainer
+
+This is an alternative approach to generate JUnit files for your CI (e.g. Jenkins) without parsing the `xcodebuild` output, but using the Xcode `plist` files instead.
+
+The new Xcode beta has a known issue around not properly closing `stdout` ([Radar](https://openradar.appspot.com/27447948)), so you [can't use xcpretty](https://github.com/supermarin/xcpretty/issues/227).
+
+`trainer` is a more robust approach on parsing test results based on the `plist` files that get generated by `xcodebuild`.
+
+## Use with [fastlane](https://fastlane.tools)
+
+Update to the latest [fastlane](https://fastlane.tools) and run
+
+```bash
+fastlane add_plugin trainer
+```
+
+Now add the following to your `Fastfile`
+
+```ruby
+lane :test do
+  scan(workspace: "MyApp.xcworkspace")
+  trainer
+end
+```
+
+For more information, check out the [fastlane plugin docs](fastlane-plugin-trainer#readme).
+
+## Without [fastlane](https://fastlane.tools)
+
+### Installation
+
+Add this to your `Gemfile` 
+```
+gem trainer
+```
+and run
+```
+bundle install
+```
+
+Alternatively you can install the gem system-wide using `sudo gem install trainer`.
+
+### Usage
+
+If you use `fastlane`, check out the official [fastlane plugin](fastlane-plugin-trainer#readme) on how to use `trainer` in `fastlane`.
+
+#### Run tests
+
+```
+cd [project]
+scan --derived_data_path "output"
+```
+
+#### Convert the plist files to junit
+
+```
+trainer
+```
+
+You can also pass a custom directory containing the plist files
+
+```
+trainer --path ./something
+```
+
+For more information run
+
+```
+trainer --help
+````
+
+### Thanks
+
+After the [lobbying of @steipete](https://twitter.com/steipete/status/753662170848690176) and the comment
+
+> How does Xcode Server parse the results?
+
+I started investigating alternative approaches on how to parse test results.

data/bin/trainer

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$:.push File.expand_path("../../lib", __FILE__)
+
+require 'trainer'
+require 'trainer/commands_generator'
+Trainer::CommandsGenerator.start

data/lib/assets/junit.xml.erb

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<% number_of_tests = 0 %>
+<% number_of_failures = 0 %>
+<% @results.each { |a| number_of_tests += a[:number_of_tests] } %>
+<% @results.each { |a| number_of_failures += a[:number_of_failures] } %>
+
+<testsuites tests="<%= number_of_tests %>" failures="<%= number_of_failures %>">
+  <% @results.each do |testsuite| %>
+    <testsuite name=<%= testsuite[:target_name].encode(:xml => :attr) %> tests="<%= testsuite[:number_of_tests] %>" failures="<%= testsuite[:number_of_failures] %>">
+      <% testsuite[:tests].each do |test| %>
+        <testcase classname=<%= test[:test_group].encode(:xml => :attr) %> name=<%= test[:name].encode(:xml => :attr) %>>
+          <% (test[:failures] || []).each do |failure| %>
+            <failure message=<%= failure[:failure_message].encode(:xml => :attr) %>>
+            </failure>
+          <% end %>
+        </testcase>
+      <% end %>
+    </testsuite>
+  <% end %>
+</testsuites>

data/lib/trainer/commands_generator.rb

@@ -0,0 +1,43 @@
+require 'commander'
+
+HighLine.track_eof = false
+
+module Trainer
+  class CommandsGenerator
+    include Commander::Methods
+
+    def self.start
+      self.new.run
+    end
+
+    def run
+      program :version, Trainer::VERSION
+      program :description, Trainer::DESCRIPTION
+      program :help, 'Author', 'Felix Krause <trainer@krausefx.com>'
+      program :help, 'Website', 'https://fastlane.tools'
+      program :help, 'GitHub', 'https://github.com/KrauseFx/trainer'
+      program :help_formatter, :compact
+
+      global_option('--verbose', 'Shows a more verbose output') { $verbose = true }
+
+      always_trace!
+
+      FastlaneCore::CommanderGenerator.new.generate(Trainer::Options.available_options)
+
+      command :run do |c|
+        c.syntax = 'trainer'
+        c.description = Trainer::DESCRIPTION
+
+        c.action do |args, options|
+          options = FastlaneCore::Configuration.create(Trainer::Options.available_options, options.__hash__)
+          FastlaneCore::PrintTable.print_values(config: options, title: "Summary for trainer #{Trainer::VERSION}") if $verbose
+          Trainer::TestParser.auto_convert(options[:path])
+        end
+      end
+
+      default_command :run
+
+      run!
+    end
+  end
+end

data/lib/trainer/junit_generator.rb

@@ -0,0 +1,29 @@
+module Trainer
+  class JunitGenerator
+    attr_accessor :results
+
+    def initialize(results)
+      self.results = results
+    end
+
+    def generate
+      # JUnit file documentation: http://llg.cubic.org/docs/junit/
+      # And http://nelsonwells.net/2012/09/how-jenkins-ci-parses-and-displays-junit-output/
+      # And http://windyroad.com.au/dl/Open%20Source/JUnit.xsd
+
+      lib_path = FastlaneCore::Helper.gem_path("trainer")
+      xml_path = File.join(lib_path, "lib/assets/junit.xml.erb")
+      xml = ERB.new(File.read(xml_path), nil, '<>').result(binding) # http://www.rrn.dk/rubys-erb-templating-system
+
+      xml = xml.gsub('system_', 'system-').delete("\e") # Jenkins can not parse 'ESC' symbol
+
+      # We have to manuall clear empty lines
+      # They may contain white spaces
+      clean_xml = []
+      xml.each_line do |row|
+        clean_xml << row.delete("\n") if row.strip.to_s.length > 0
+      end
+      return clean_xml.join("\n")
+    end
+  end
+end

data/lib/trainer/options.rb

@@ -0,0 +1,17 @@
+module Trainer
+  class Options
+    def self.available_options
+      @options ||= [
+        FastlaneCore::ConfigItem.new(key: :path,
+                                     short_option: "-p",
+                                     env_name: "trainer_PATH",
+                                     default_value: ".",
+                                     description: "Path to the directory that should be converted",
+                                     verify_block: proc do |value|
+                                       v = File.expand_path(value.to_s)
+                                       UI.user_error!("Path '#{v}' is not a directory or can't be found") unless File.directory?(v)
+                                     end)
+      ]
+    end
+  end
+end

data/lib/trainer/test_parser.rb

@@ -0,0 +1,113 @@
+module Trainer
+  class TestParser
+    attr_accessor :data
+
+    attr_accessor :file_content
+
+    attr_accessor :raw_json
+
+    def self.auto_convert(containing_dir)
+      files = Dir["#{containing_dir}/**/Logs/Test/*TestSummaries.plist"]
+      files += Dir["#{containing_dir}/Test/*TestSummaries.plist"]
+      files += Dir["#{containing_dir}/*TestSummaries.plist"]
+
+      UI.user_error!("No test result files found in directory '#{containing_dir}'") if files.empty?
+
+      return files.collect do |path|
+        to_path = path.gsub(".plist", ".junit")
+        File.write(to_path, Trainer::TestParser.new(path).to_junit)
+        puts "Successfully generated '#{to_path}'"
+        to_path
+      end
+    end
+
+    def initialize(path)
+      path = File.expand_path(path)
+      UI.user_error!("File not found at path '#{path}'") unless File.exist?(path)
+
+      self.file_content = File.read(path)
+      self.raw_json = Plist.parse_xml(self.file_content)
+      return if self.raw_json["FormatVersion"].to_s.length == 0 # maybe that's a useless plist file
+
+      ensure_file_valid!
+      parse_content
+    end
+
+    # Returns the JUnit report as String
+    def to_junit
+      JunitGenerator.new(self.data).generate
+    end
+
+    private
+
+    def ensure_file_valid!
+      format_version = self.raw_json["FormatVersion"]
+      UI.user_error!("Format version '#{format_version}' is not supported") unless format_version == "1.2"
+    end
+
+    # Convert the Hashes and Arrays in something more useful
+    def parse_content
+      def unfold_tests(data)
+        # `data` looks like this
+        # => [{"Subtests"=>
+        #  [{"Subtests"=>
+        #     [{"Subtests"=>
+        #        [{"TestIdentifier"=>"Unit/testExample()",
+        #          "TestName"=>"testExample()",
+        #          "TestObjectClass"=>"IDESchemeActionTestSummary",
+        #          "TestStatus"=>"Success",
+        #          "TestSummaryGUID"=>"4A24BFED-03E6-4FBE-BC5E-2D80023C06B4"},
+        #         {"FailureSummaries"=>
+        #           [{"FileName"=>"/Users/krausefx/Developer/themoji/Unit/Unit.swift",
+        #             "LineNumber"=>34,
+        #             "Message"=>"XCTAssertTrue failed - ",
+        #             "PerformanceFailure"=>false}],
+        #          "TestIdentifier"=>"Unit/testExample2()",
+
+        tests = []
+        data.each do |current_hash|
+          if current_hash["Subtests"]
+            tests += unfold_tests(current_hash["Subtests"])
+          end
+          if current_hash["TestStatus"]
+            tests << current_hash
+          end
+        end
+        return tests
+      end
+
+      self.data = self.raw_json["TestableSummaries"].collect do |testable_summary|
+        summary_row = {
+          project_path: testable_summary["ProjectPath"],
+          target_name: testable_summary["TargetName"],
+          test_name: testable_summary["TestName"],
+          tests: unfold_tests(testable_summary["Tests"]).collect do |current_test|
+            current_row = {
+              identifier: current_test["TestIdentifier"],
+              test_group: current_test["TestIdentifier"].split("/")[0..-2].join("."),
+              name: current_test["TestName"],
+              object_class: current_test["TestObjectClass"],
+              status: current_test["TestStatus"],
+              guid: current_test["TestSummaryGUID"]
+            }
+            if current_test["FailureSummaries"]
+              current_row[:failures] = current_test["FailureSummaries"].collect do |current_failure|
+                {
+                  file_name: current_failure['FileName'],
+                  line_number: current_failure['LineNumber'],
+                  message: current_failure['Message'],
+                  performance_failure: current_failure['PerformanceFailure'],
+                  failure_message: "#{current_failure['Message']}#{current_failure['FileName']}:#{current_failure['LineNumber']}"
+                }
+              end
+            end
+            current_row
+          end
+        }
+        summary_row[:number_of_tests] = summary_row[:tests].count
+        summary_row[:number_of_failures] = summary_row[:tests].find_all { |a| (a[:failures] || []).count > 0 }.count
+        summary_row
+      end
+    end
+  end
+end

data/lib/trainer/version.rb

@@ -0,0 +1,4 @@
+module Trainer
+  VERSION = "0.1.1"
+  DESCRIPTION = "Convert xcodebuild plist files to JUnit reports"
+end

data/lib/trainer.rb

@@ -0,0 +1,10 @@
+require 'fastlane_core'
+
+require 'trainer/version'
+require 'trainer/options'
+require 'trainer/test_parser'
+require 'trainer/junit_generator'
+
+module Trainer
+  UI = FastlaneCore::UI
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: trainer
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Felix Krause
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fastlane_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.38.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.38.0
+description: Convert xcodebuild plist files to JUnit reports
+email:
+- fastlane@krausefx.com
+executables:
+- trainer
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/trainer
+- lib/assets/junit.xml.erb
+- lib/trainer.rb
+- lib/trainer/commands_generator.rb
+- lib/trainer/junit_generator.rb
+- lib/trainer/options.rb
+- lib/trainer/test_parser.rb
+- lib/trainer/version.rb
+homepage: https://fastlane.tools
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Convert xcodebuild plist files to JUnit reports
+test_files: []