trainer 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea5f5a25b2bf4b4dc97a8eb2852329b2e6f162ac
-  data.tar.gz: 145951b040f3ba7f303bed5daabf90f76ae21d68
+  metadata.gz: c9bd919dd0dc94df63dac316b75515bd599fa555
+  data.tar.gz: c7899ff83d99d07ed2c4a9afc10a1c1656dab42e
 SHA512:
-  metadata.gz: 7c648fe59e528643f422ba0a87340608a2b1a6c2b97b2b514a2df2036d447384a396ee70f8e98f3bdfb3eb3b923377e22e835b4ec6b6c339a4548d9cf6cecd65
-  data.tar.gz: 3ec4dc20b8a9f0274b3a8a1c064b0dddb7477031593e021f394ab5eac29760db9aeb53d3dd007d5a70ffc079df354c6d06a9f215a914ffab304adf8f731ccfc5
+  metadata.gz: cfcc1720af088d7285b8d8f53e323fb451148f814cd0df1c4acff9bf4ab0d5f84a757ad8c9902796f3c21e5e6e20875a958d4f0d96bf0b603e95e3a3bc8bb9c9
+  data.tar.gz: e00913b6fa064c578feb850816736498983970cddb406ff24c3a44e524fec737280d89e82c625f743e0635d2931ed38cdab7955c2c094f76d870ba8a897183e3

data/README.md

@@ -1,10 +1,27 @@
 # trainer
 
+[![Twitter: @KrauseFx](https://img.shields.io/badge/contact-@KrauseFx-blue.svg?style=flat)](https://twitter.com/KrauseFx)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/KrauseFx/trainer/blob/master/LICENSE)
+[![Gem](https://img.shields.io/gem/v/trainer.svg?style=flat)](http://rubygems.org/gems/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).
+Some Xcode versions 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 and faster approach to generate JUnit reports for your CI system. 
+
+> By using `trainer`, the Twitter iOS code base now generates JUnit reports 10 times faster.
 
-`trainer` is a more robust approach on parsing test results based on the `plist` files that get generated by `xcodebuild`.
+ | [xcpretty](https://github.com/supermarin/xcpretty) |  trainer
+--------------------------|------------------------------|------------------------------
+Prettify the `xcodebuild` output | :white_check_mark: | :no_entry_sign:
+Generate JUnit reports | :white_check_mark: | :white_check_mark:
+Generate HTML reports | :white_check_mark: | :no_entry_sign:
+Works when the `xcodebuild` output format changed | :no_entry_sign: | :white_check_mark:
+Show test execution duration | :white_check_mark: | :no_entry_sign:
+Speed | :car: | :rocket:
+
+[xcpretty](https://github.com/supermarin/xcpretty) is a great piece of software that is used across all [fastlane tools](https://fastlane.tools). `trainer` was built to have the minimum code to generate JUnit reports for your CI system.
 
 ## Use with [fastlane](https://fastlane.tools)
 
@@ -18,15 +35,25 @@ Now add the following to your `Fastfile`
 
 ```ruby
 lane :test do
-  scan(workspace: "MyApp.xcworkspace",
-       output_types: "",
-       derived_data_path: "/tmp/fastlane_trainer/#{Time.now.to_i}")
-  trainer
+    begin
+      scan(workspace: "Themoji.xcworkspace", scheme: "ThemojiUITests", output_types: "")
+    rescue => ex
+      failure = ex
+    end
+
+    trainer(output_directory: "/tmp/fastlane_trainer/#{Time.now.to_i}")
+    raise failure if failure
 end
 ```
 
 This will generate the JUnit file in the temporary location `/tmp/fastlane_trainer/[time]`. You can specify any path you want, just make sure to have it clean for every run so that your CI system knows which one to pick.
 
+If you use circle, use the following to automatically publish the JUnit reports
+
+```ruby
+trainer(output_directory: (ENV["CIRCLE_TEST_REPORTS"] || "/tmp"))
+```
+
 For more information, check out the [fastlane plugin docs](fastlane-plugin-trainer#readme).
 
 ## Without [fastlane](https://fastlane.tools)
@@ -52,7 +79,7 @@ If you use `fastlane`, check out the official [fastlane plugin](fastlane-plugin-
 
 ```
 cd [project]
-scan --derived_data_path "output"
+scan --derived_data_path "output_dir"
 ```
 
 #### Convert the plist files to junit
@@ -77,7 +104,7 @@ trainer --help
 
 To make it easier for you and your contributors to see the test failures, you should start using [danger](http://danger.systems) with the [danger-junit](https://github.com/orta/danger-junit) plugin
 
-![](https://raw.githubusercontent.com/orta/danger-junit/master/img/example.png)
+![](assets/danger-output.png)
 
 ### Thanks
 
@@ -86,3 +113,5 @@ After the [lobbying of @steipete](https://twitter.com/steipete/status/7536621708
 > How does Xcode Server parse the results?
 
 I started investigating alternative approaches on how to parse test results.
+
+For more information about the plist files that are being used, check out [Michele's blog post](http://michele.io/test-logs-in-xcode).

data/lib/trainer/options.rb

@@ -9,7 +9,11 @@ module Trainer
                                      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)
+                                       if v.end_with?(".plist")
+                                         UI.user_error!("Can't find file at path #{v}") unless File.exist?(v)
+                                       else
+                                         UI.user_error!("Path '#{v}' is not a directory or can't be found") unless File.directory?(v)
+                                       end
                                      end),
         FastlaneCore::ConfigItem.new(key: :extension,
                                      short_option: "-e",
@@ -24,7 +28,7 @@ module Trainer
                                      env_name: "TRAINER_OUTPUT_DIRECTORY",
                                      default_value: nil,
                                      optional: true,
-                                     description: "Directoy in which the xml files should be written to. Same directory as source by default"),
+                                     description: "Directoy in which the xml files should be written to. Same directory as source by default")
       ]
     end
   end

data/lib/trainer/test_parser.rb

@@ -6,15 +6,24 @@ module Trainer
 
     attr_accessor :raw_json
 
+    # Returns a hash with the path being the key, and the value
+    # defining if the tests were successful
     def self.auto_convert(config)
+      FastlaneCore::PrintTable.print_values(config: config,
+                                             title: "Summary for trainer #{Trainer::VERSION}")
+
       containing_dir = config[:path]
       files = Dir["#{containing_dir}/**/Logs/Test/*TestSummaries.plist"]
       files += Dir["#{containing_dir}/Test/*TestSummaries.plist"]
       files += Dir["#{containing_dir}/*TestSummaries.plist"]
+      files += Dir[containing_dir] if containing_dir.end_with?(".plist") # if it's the exact path to a plist file
 
-      UI.user_error!("No test result files found in directory '#{containing_dir}'") if files.empty?
+      if files.empty?
+        UI.user_error!("No test result files found in directory '#{containing_dir}', make sure the file name ends with 'TestSummaries.plist'")
+      end
 
-      return files.collect do |path|
+      return_hash = {}
+      files.each do |path|
         if config[:output_directory]
           FileUtils.mkdir_p(config[:output_directory])
           filename = File.basename(path).gsub(".plist", config[:extension])
@@ -23,10 +32,13 @@ module Trainer
           to_path = path.gsub(".plist", config[:extension])
         end
 
-        File.write(to_path, Trainer::TestParser.new(path).to_junit)
+        tp = Trainer::TestParser.new(path)
+        File.write(to_path, tp.to_junit)
         puts "Successfully generated '#{to_path}'"
-        to_path
+
+        return_hash[to_path] = tp.tests_successful?
       end
+      return_hash
     end
 
     def initialize(path)
@@ -46,11 +58,17 @@ module Trainer
       JunitGenerator.new(self.data).generate
     end
 
+    # @return [Bool] were all tests successful? Is false if at least one test failed
+    def tests_successful?
+      self.data.collect { |a| a[:number_of_failures] }.all? { |a| a == 0 }
+    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"
+      supported_versions = ["1.1", "1.2"]
+      UI.user_error!("Format version '#{format_version}' is not supported, must be #{supported_versions.join(', ')}") unless supported_versions.include?(format_version)
     end
 
     # Convert the Hashes and Arrays in something more useful

data/lib/trainer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trainer
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-02 00:00:00.000000000 Z
+date: 2016-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastlane_core
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.48.1
+        version: 0.50.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.48.1
+        version: 0.50.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -158,9 +158,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Convert xcodebuild plist files to JUnit reports
 test_files: []
-has_rdoc: