xcode-result-bundle-processor 1.0.0

data/.ruby-gemset

@@ -0,0 +1 @@
+xcode-result-bundle-processor

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.3

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+os: osx
+script:
+  - bundle exec rake
+  - bundle exec rake build
+addons:
+  code_climate:
+    repo_token: ab0af39b165f1fd64c05d98119b404f3960343d9b46335de472b7692f1335fb2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xcode-result-bundle-processor.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    xcode-result-bundle-processor (1.0.0)
+      CFPropertyList (~> 2.2)
+      awesome_print (~> 1.6)
+      markaby (~> 0.8)
+      methadone (~> 1.9.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    CFPropertyList (2.3.2)
+    aruba (0.10.2)
+      childprocess (~> 0.5.6)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9.10)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
+    awesome_print (1.6.1)
+    builder (3.2.2)
+    childprocess (0.5.7)
+      ffi (~> 1.0, >= 1.0.11)
+    codeclimate-test-reporter (0.4.8)
+      simplecov (>= 0.7.1, < 1.0.0)
+    contracts (0.12.0)
+    cucumber (2.1.0)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.3.0)
+      diff-lcs (>= 1.1.3)
+      gherkin3 (~> 3.1.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.3.0)
+      gherkin3 (~> 3.1.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    ffi (1.9.10)
+    gherkin3 (3.1.2)
+    json (1.8.3)
+    markaby (0.8.0)
+      builder
+    methadone (1.9.2)
+      bundler
+    multi_json (1.11.2)
+    multi_test (0.1.2)
+    rake (10.4.2)
+    rdoc (4.2.0)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (~> 0.10)
+  bundler (~> 1.6)
+  codeclimate-test-reporter (~> 0.4)
+  rake (~> 10.4)
+  rdoc (~> 4.2)
+  rspec (~> 3.3)
+  xcode-result-bundle-processor!
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,36 @@
+# Copyfree Open Innovation License
+
+This is version 0.4 of the Copyfree Open Innovation License.
+
+## Terms and Conditions
+
+Redistributions, modified or unmodified, in whole or in part, must retain
+applicable copyright or other legal privilege notices, these conditions, and
+the following license terms and disclaimer.  Subject to these conditions, the
+holder(s) of copyright or other legal privileges, author(s) or assembler(s),
+and contributors of this work hereby grant to any person who obtains a copy of
+this work in any form:
+
+1. Permission to reproduce, modify, distribute, publish, sell, sublicense, use,
+and/or otherwise deal in the licensed material without restriction.
+
+2. A perpetual, worldwide, non-exclusive, royalty-free, irrevocable patent
+license to reproduce, modify, distribute, publish, sell, use, and/or otherwise
+deal in the licensed material without restriction, for any and all patents:
+
+    a. Held presently or in the future by each such holder of copyright or
+    other legal privilege, author or assembler, or contributor, necessarily
+    infringed by the contributions alone or by combination with the work, of
+    that privilege holder, author or assembler, or contributor.
+
+    b. Necessarily infringed by the work at the time that holder of copyright
+    or other privilege, author or assembler, or contributor made any
+    contribution to the work.
+
+NO WARRANTY OF ANY KIND IS IMPLIED BY, OR SHOULD BE INFERRED FROM, THIS LICENSE
+OR THE ACT OF DISTRIBUTION UNDER THE TERMS OF THIS LICENSE, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
+AND NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS, ASSEMBLERS, OR HOLDERS OF
+COPYRIGHT OR OTHER LEGAL PRIVILEGE BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
+LIABILITY, WHETHER IN ACTION OF CONTRACT, TORT, OR OTHERWISE ARISING FROM, OUT
+OF, OR IN CONNECTION WITH THE WORK OR THE USE OF OR OTHER DEALINGS IN THE WORK.

data/README.md

@@ -0,0 +1,72 @@
+[![Build Status](https://travis-ci.org/americanexpress/xcode-result-bundle-processor.svg?branch=master)](https://travis-ci.org/americanexpress/xcode-result-bundle-processor)
+[![Code Climate](https://codeclimate.com/github/americanexpress/xcode-result-bundle-processor/badges/gpa.svg)](https://codeclimate.com/github/americanexpress/xcode-result-bundle-processor)
+[![Test Coverage](https://codeclimate.com/github/americanexpress/xcode-result-bundle-processor/badges/coverage.svg)](https://codeclimate.com/github/americanexpress/xcode-result-bundle-processor/coverage)
+[![Issue Count](https://codeclimate.com/github/americanexpress/xcode-result-bundle-processor/badges/issue_count.svg)](https://codeclimate.com/github/americanexpress/xcode-result-bundle-processor)
+
+# XcodeResultBundleProcessor
+
+This tool converts into Xcode 7's machine-readable results bundle into a human-readable HTML report including
+detailed activity logs and screenshots for UI tests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'xcode-result-bundle-processor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xcode-result-bundle-processor
+
+## Usage
+
+First, run your UI tests using an invocation like this:
+
+    xcodebuild -workspace MyWorkspace.xcworkspace \
+        -scheme 'My UI Tests' \
+        -sdk iphonesimulator \
+        -resultBundlePath "my_results_bundle" \
+        
+This will put a bunch of mystery files into `my_results_bundle`, which you can transform into un-mystery files
+via
+
+    bundle exec xcode-result-bundle-processor --save-html-report report my_results_bundle 
+    
+The report will appear in `report/index.html`
+
+## Development
+
+If you have RVM and change to the working directory, you'll be prompted to install the needed Ruby version if you
+don't already have it. RVM will also handle creating a gemset.
+
+To update the dependencies, run
+
+    bundle
+    
+To run tests, run
+
+    bundle exec rake
+
+To build the gem, fun
+    
+    bundle exec rake build
+    
+To execute the tool, run
+
+    bundle exec xcode-result-bundle-processor
+
+## Contributing
+
+Contributing is easy and fun! Some guidelines:
+
+* If you're making a non-trivial change, consider reaching out to Manuel the Maintainer (mwudka@me.com) for an
+ architecture/implementation chat.
+* Create an issue to track your work and describe your goals
+* Branch from master and make your changes in the branch
+* Add tests for any new functionality
+* When you're happy with your changes and the builds pass, open a PR
+* If no one has addressed your PR after a day or two, prod Manuel the Maintainer (mwudka@me.com)

data/Rakefile

@@ -0,0 +1,50 @@
+def dump_load_path
+  puts $LOAD_PATH.join("\n")
+  found = nil
+  $LOAD_PATH.each do |path|
+    if File.exist?(File.join(path,"rspec"))
+      puts "Found rspec in #{path}"
+      if File.exist?(File.join(path,"rspec","core"))
+        puts "Found core"
+        if File.exist?(File.join(path,"rspec","core","rake_task"))
+          puts "Found rake_task"
+          found = path
+        else
+          puts "!! no rake_task"
+        end
+      else
+        puts "!!! no core"
+      end
+    end
+  end
+  if found.nil?
+    puts "Didn't find rspec/core/rake_task anywhere"
+  else
+    puts "Found in #{path}"
+  end
+end
+require 'bundler'
+require 'rake/clean'
+
+require 'rspec/core/rake_task'
+
+require 'cucumber'
+require 'cucumber/rake/task'
+gem 'rdoc' # we need the installed RDoc gem, not the system one
+require 'rdoc/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
+  t.fork = false
+end
+
+task :default => [:spec, :features]
+

data/bin/xcode-result-bundle-processor

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require 'xcoderesultbundleprocessor'
+
+class App
+  include Methadone::Main
+  include Methadone::CLILogging
+
+  main do |results_bundle_path|
+    change_logger(Methadone::CLILogger.new(STDERR, STDERR))
+
+    info "Preparing report for results bundle path at #{results_bundle_path}"
+
+    results_bundle = if File.directory?(results_bundle_path)
+                       XcodeResultBundleProcessor::DirectoryResultsBundle.new(results_bundle_path)
+                     else
+                       XcodeResultBundleProcessor::TarballResultsBundle.new(results_bundle_path)
+                     end
+
+    unless options['save-html-report'].nil?
+      XcodeResultBundleProcessor::TestSummaries::HTMLReport.new(results_bundle).save(options['save-html-report'])
+    end
+
+    debug XcodeResultBundleProcessor::TestSummaries::TextReport.format(results_bundle)
+    info 'Success!'
+  end
+
+  description 'Creates friendly report from Xcode results bundle'
+  arg :results_bundle_path
+  on('--save-html-report [report output dir]', 'Save a test result HTML report to given directory')
+
+  version XcodeResultBundleProcessor::VERSION
+
+  use_log_level_option :toggle_debug_on_signal => 'USR1'
+
+  go!
+end

data/lib/xcoderesultbundleprocessor.rb

@@ -0,0 +1,28 @@
+require 'rubygems/package'
+require 'cfpropertylist'
+require 'awesome_print'
+require 'methadone'
+require 'markaby'
+require 'optparse'
+require 'ostruct'
+
+require 'xcoderesultbundleprocessor/version'
+require 'xcoderesultbundleprocessor/keyword_struct'
+require 'xcoderesultbundleprocessor/indented_string_buffer'
+require 'xcoderesultbundleprocessor/slf0/tokenizer'
+require 'xcoderesultbundleprocessor/slf0/class_name_resolver'
+require 'xcoderesultbundleprocessor/slf0/deserializer'
+require 'xcoderesultbundleprocessor/slf0/model/dvtdocumentlocation'
+require 'xcoderesultbundleprocessor/slf0/model/dvttextdocumentlocation'
+require 'xcoderesultbundleprocessor/slf0/model/ideactivitylogmessage'
+require 'xcoderesultbundleprocessor/slf0/model/ideactivitylogsection'
+require 'xcoderesultbundleprocessor/slf0/model/ideactivitylogunittestsection'
+require 'xcoderesultbundleprocessor/slf0/model/ideconsoleitem'
+require 'xcoderesultbundleprocessor/activity_log_formatter'
+require 'xcoderesultbundleprocessor/log_deserializer'
+require 'xcoderesultbundleprocessor/test_summaries/test_summaries'
+require 'xcoderesultbundleprocessor/test_summaries/html_report'
+require 'xcoderesultbundleprocessor/test_summaries/text_report'
+require 'xcoderesultbundleprocessor/results_bundle'
+require 'xcoderesultbundleprocessor/element_snapshot'
+require 'xcoderesultbundleprocessor/snapshot_summary'

data/lib/xcoderesultbundleprocessor/activity_log_formatter.rb

@@ -0,0 +1,20 @@
+module XcodeResultBundleProcessor
+  module ActivityLogFormatter
+    include Methadone::CLILogging
+
+    def self.format(section)
+      debug "Formatting activity log section #{section.ai}"
+
+      return "\n" if section.nil?
+
+      buffer = IndentedStringBuffer.new
+
+      # The top-level section contains the complete log for all test runs, so grabbing that text is enough to
+      # get the full log
+      section = section.subsections.first
+
+      buffer << section.title << section.text.each_line
+      buffer.to_s
+    end
+  end
+end

data/lib/xcoderesultbundleprocessor/element_snapshot.rb

@@ -0,0 +1,81 @@
+module XcodeResultBundleProcessor
+  class ElementSnapshot < OpenStruct
+    def initialize(plist)
+      super()
+
+      @objects = plist.value.value['$objects'].value
+
+      root_object = plist.value.value['$top'].value['root']
+
+      self._deserialize_object(root_object).each do |key, value|
+        self[key] = value
+      end
+    end
+
+    def _deserialize_dictionary(cfdictionary)
+      if cfdictionary.value.key?('NS.rectval')
+        return self._deserialize_object(cfdictionary.value['NS.rectval'])
+      end
+
+      if cfdictionary.value.key?('$classname')
+        return cfdictionary.value['$classname'].value
+      end
+
+      ret = {}
+      if cfdictionary.value.key?('NS.keys') && cfdictionary.value.key?('NS.objects')
+        keys_and_values = cfdictionary.value['NS.keys'].value.zip(cfdictionary.value['NS.objects'].value)
+        keys_and_values.each do |key, value|
+          ret[self._deserialize_object(key).to_s.to_sym] = self._deserialize_object(value)
+        end
+      elsif cfdictionary.value.key?('NS.objects')
+        return cfdictionary.value['NS.objects'].value.map { |o| self._deserialize_object(o) }
+      else
+        cfdictionary.value.each do |key, value|
+          ret[key.to_sym] = self._deserialize_object(value)
+        end
+
+      end
+      ret
+    end
+
+    def _deserialize_object(object)
+      if object.is_a?(CFPropertyList::CFUid)
+        self._deserialize_object(@objects[object.value])
+      elsif object.is_a?(CFPropertyList::CFString) && object.value == '$null'
+        nil
+      elsif object.is_a?(CFPropertyList::CFDictionary)
+        self._deserialize_dictionary(object)
+      elsif object.is_a?(CFPropertyList::CFString) or object.is_a?(CFPropertyList::CFInteger) or object.is_a?(CFPropertyList::CFBoolean)
+        object.value
+      elsif object.is_a?(CFPropertyList::CFArray)
+        object.value.map { |o| self._deserialize_object(o) }
+      else
+        raise "Unsupported object type #{object.class}"
+      end
+    end
+
+    def _deserialize_uid(uid)
+      object = @objects[uid.value]
+
+      if object.is_a?(CFPropertyList::CFUid)
+        _deserialize_uid(uid)
+      elsif object.is_a?(CFPropertyList::CFString) && object.value == '$null'
+        nil
+      elsif object.is_a?(CFPropertyList::CFDictionary)
+        hash = {}
+
+        object.value.each do |key, value|
+          if value.is_a?(CFPropertyList::CFUid)
+            hash[key] = self._deserialize_uid(value)
+          else
+            hash[key] = value.value
+          end
+        end
+
+        hash
+      else
+        object.value
+      end
+    end
+  end
+end

data/lib/xcoderesultbundleprocessor/indented_string_buffer.rb

@@ -0,0 +1,33 @@
+module XcodeResultBundleProcessor
+  class IndentedStringBuffer
+    def initialize(buffer=nil, indent_level=0)
+      @buffer        = buffer || ''
+      @indent_spaces = 2
+      @indent_level  = indent_level
+    end
+
+    def <<(arg)
+      Array(arg).each do |line|
+        @buffer << ' ' * (@indent_spaces * @indent_level) << line
+        @buffer << "\n" unless line.end_with?("\n")
+        @buffer
+      end
+      self
+    end
+
+    def add_newline
+      @buffer << "\n"
+      self
+    end
+
+    def indent
+      IndentedStringBuffer.new(@buffer, @indent_level + 1)
+    end
+
+    def to_s
+      return "\n" if @buffer.empty?
+      @buffer
+    end
+
+  end
+end