xcknife 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a16ad712fe21666c9ec13b16c1cc3007120bc9eb
-  data.tar.gz: fc3109c894275ca6c8e5fed344fd35a3a11d0457
+  metadata.gz: 1e7dcc40d67413a5b35f7eba1289d75724965a63
+  data.tar.gz: 7ea917dd613f5fcdd8e6a41471538c01bf9df4d2
 SHA512:
-  metadata.gz: f364876c260015cc6b0729035c5835b295e1772b27671b50448064659841ab21e2384476b4e5860387e0f397db41d80f4fe48730b6e36879776295e18d89056d
-  data.tar.gz: 456da664e95295f2ae4a20982b245e7ade3a616047cf89dd654e0de0d5d053f2d1a11da6b9bc88b8f1099fd917111f7ed963a112b9c3c2cde6c50056a406a00d
+  metadata.gz: b786211a86a81b9483a8721de939de4bcb7eba683698e334d6f299e706153ee607a3b8de6621599465cecbf236b42805618f2e71812a664c9c9cf8abd20c8ae3
+  data.tar.gz: 1295e3a8a1e7040d0acadf14d42e2c36838f9fdde95c8d57c83b4bcaa4986165b689239a27cdecbdb512233110b3d54c40d1175c649f7c8b7c267642495c47bf

data/.travis.yml

@@ -1,9 +1,18 @@
-language: ruby
+language: objective-c
 sudo: false
-before_install: gem install bundler
-bundler_args: --without development
+matrix:
+  include:
+    - os: osx
+      osx_image: xcode8
+    - os: osx
+      osx_image: xcode8.1
+    - os: osx
+      osx_image: xcode8.2
 
-rvm:
-  - 2.2.3
-  - 2.3.0
-  - 2.3.1
+before_script:
+  - export LANG=en_US.UTF-8
+install: bundle
+script:
+  - csrutil status
+  - git submodule update --init --recursive
+  - bundle exec rake build_test_dumper spec

data/README.md

@@ -18,7 +18,7 @@ More information on XCKnife, go [here](https://corner.squareup.com/2016/06/xckni
 ## Using as command line tool
  
 ```
-$ xcknife -h
+$ xcknife --help
 Usage: xcknife [options] worker-count historical-timings-json-stream-file [current-tests-json-stream-file]
     -p, --partition TARGETS          Comma separated list of targets. Can be used multiple times
     -o, --output FILENAME            Output file. Defaults to STDOUT

data/Rakefile

@@ -11,7 +11,7 @@ task :build_test_dumper do
   target_dir = File.join(File.dirname(__FILE__), "TestDumper")
   Dir.chdir(target_dir) do
     system "./build.sh"
-    FileUtils.copy_file("./testdumperbuild/Build/Products/Release-iphonesimulator/TestDumper.framework/TestDumper", "./TestDumper.dylib")
+    FileUtils.copy_file("./testdumperbuild/Build/Products/Debug-iphonesimulator/TestDumper.framework/TestDumper", "./TestDumper.dylib")
     puts "TestDumper.dylib was created successfully"
   end
 end

data/TestDumper/README.md

@@ -8,4 +8,17 @@ Run
 
 ```
 $ ./build.sh
-````
+````
+
+## Using as command line tool
+
+```
+$ xcknife-test-dumper --help
+Usage: xcknife-test-dumper [options] derived_data_folder output_file [device_id]
+    -d, --debug                      Debug mode enabled
+    -r, --retry-count COUNT          Max retry count for simulator output
+    -t OUTPUT_FOLDER,                Sets temporary Output folder
+        --temporary-output
+    -s, --scheme XCSCHEME_FILE       Reads environments variables from the xcscheme file
+    -h, --help                       Show this message
+```

data/TestDumper/TestDumper/Initialize.m

@@ -120,9 +120,16 @@ const int TEST_TARGET_LEVEL = 0;
 const int TEST_CLASS_LEVEL = 1;
 const int TEST_METHOD_LEVEL = 2;
 
-
 __attribute__((constructor))
 void initialize() {
+    NSLog(@"Starting TestDumper");
+    NSString *testDumperOutputPath = NSProcessInfo.processInfo.environment[@"TestDumperOutputPath"];
+    NSFileManager *fileManager = [NSFileManager defaultManager];
+
+    if ([fileManager fileExistsAtPath:testDumperOutputPath]) {
+        NSLog(@"File already exists %@. Stopping", testDumperOutputPath);
+        exit(0);
+    }
     NSString *testType = [NSString stringWithUTF8String: getenv("XCTEST_TYPE")];
 
     if ([testType isEqualToString: @"APPTEST"]) {
@@ -169,6 +176,10 @@ void enumerateTests() {
     }
 
     NSLog(@"Opened %@ with fd %p", testDumperOutputPath, outFile);
+    if (outFile == NULL) {
+        NSLog(@"File already exists %@. Stopping", testDumperOutputPath);
+        exit(0);
+    }
 
     PrintDumpStart(outFile, testType);
     [[XCTestSuite defaultTestSuite] printTestsWithLevel:0 withTarget: testTarget withParent: nil outputFile:outFile];
@@ -193,6 +204,9 @@ void enumerateTests() {
             case TEST_METHOD_LEVEL:
                 PrintTestClass(outputFile, parent);
                 break;
+            case TEST_CLASS_LEVEL:
+                // nothing to do here
+                break;
             default:
                 NSLog(@"Uknown level %ld", level);
 

data/TestDumper/build.sh

@@ -1,6 +1,7 @@
 #!/bin/bash
+rm -rf TestDumper.dylib testdumperbuild
 xcodebuild -project TestDumper.xcodeproj \
-    -configuration Release \
+    -configuration Debug \
     -derivedDataPath testdumperbuild \
     -scheme TestDumper \
-    -sdk iphonesimulator build
+    -sdk iphonesimulator build ONLY_ACTIVE_ARCH=NO

data/lib/xcknife.rb

@@ -4,7 +4,8 @@ require 'xcknife/xctool_cmd_helper'
 require 'xcknife/runner'
 require 'xcknife/test_dumper'
 require 'xcknife/exceptions'
+require 'xcknife/xcscheme_analyzer'
 
 module XCKnife
-  VERSION = '0.6.3'
+  VERSION = '0.6.4'
 end

data/lib/xcknife/test_dumper.rb

@@ -4,6 +4,7 @@ require 'fileutils'
 require 'tmpdir'
 require 'ostruct'
 require 'set'
+require 'logger'
 
 module XCKnife
   class TestDumper
@@ -11,32 +12,120 @@ module XCKnife
       new(ARGV).run
     end
 
+    attr_reader :logger
+
     def initialize(args)
-      @derived_data_folder, @output_file, @device_id = args
+      @debug = false
+      @max_retry_count = 150
+      @temporary_output_folder = nil
+      @xcscheme_file = nil
+      @parser = build_parser
+      parse_arguments(args)
       @device_id ||= "booted"
+      @logger = Logger.new($stdout)
+      @logger.level = @debug ? Logger::DEBUG : Logger::FATAL
+      @parser = nil
     end
 
     def run
-      if @derived_data_folder.nil? or @output_file.nil?
-        return puts "Usage: xcknife-test-dumper [derived_data_folder] [output_file] [<device_id>]"
-      end
-      helper = TestDumperHelper.new(@device_id)
+      helper = TestDumperHelper.new(@device_id, @max_retry_count, @debug, @logger)
+      extra_environment_variables = parse_scheme_file
+      logger.info { "Environment variables from xcscheme: #{extra_environment_variables.pretty_inspect}" }
       output_fd = File.open(@output_file, "w")
-      Dir.mktmpdir("xctestdumper_") do |outfolder|
-        helper.call(@derived_data_folder, outfolder).each do |test_specification|
-          concat_to_file(test_specification, output_fd)
+      if @temporary_output_folder.nil?
+        Dir.mktmpdir("xctestdumper_") do |outfolder|
+          list_tests(extra_environment_variables, helper, outfolder, output_fd)
+        end
+      else
+        unless File.directory?(@temporary_output_folder)
+          puts "Error no such directory: #{@temporary_output_folder}"
+          exit 1
+        end
+
+        if Dir.entries(@temporary_output_folder).any? { |f| File.file?(File.join(@temporary_output_folder,f)) }
+          puts "Warning: #{@temporary_output_folder} is not empty! Files can be overwritten."
         end
+        list_tests(extra_environment_variables, helper, File.absolute_path(@temporary_output_folder), output_fd)
       end
       output_fd.close
       puts "Done listing test methods"
     end
 
     private
+    def list_tests(extra_environment_variables, helper, outfolder, output_fd)
+      helper.call(@derived_data_folder, outfolder, extra_environment_variables).each do |test_specification|
+        concat_to_file(test_specification, output_fd)
+      end
+    end
+
+
+    def parse_scheme_file
+      return {} unless @xcscheme_file
+      unless File.exists?(@xcscheme_file)
+        puts "Error: no such xcscheme file: #{@xcscheme_file}"
+        exit 1
+      end
+      XCKnife::XcschemeAnalyzer.extract_environment_variables(IO.read(@xcscheme_file))
+    end
+
+    def parse_arguments(args)
+      positional_arguments = parse_options(args)
+      if positional_arguments.size < required_arguments.size
+        warn_and_exit("You must specify *all* required arguments: #{required_arguments.join(", ")}")
+      end
+      @derived_data_folder, @output_file, @device_id = positional_arguments
+    end
+
+    def parse_options(args)
+      begin
+        return @parser.parse(args)
+      rescue OptionParser::ParseError => error
+        warn_and_exit(error)
+      end
+    end
+
+    def build_parser
+      OptionParser.new do |opts|
+        opts.banner += " #{arguments_banner}"
+        opts.on("-d", "--debug", "Debug mode enabled") { |v| @debug = v }
+        opts.on("-r", "--retry-count COUNT", "Max retry count for simulator output", Integer) { |v| @max_retry_count = v }
+        opts.on("-t", "--temporary-output OUTPUT_FOLDER", "Sets temporary Output folder") { |v| @temporary_output_folder = v }
+        opts.on("-s", "--scheme XCSCHEME_FILE", "Reads environments variables from the xcscheme file") { |v| @xcscheme_file = v }
+
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+      end
+    end
+
+    def required_arguments
+      %w[derived_data_folder output_file]
+    end
+
+    def optional_arguments
+      %w[device_id]
+    end
+
+    def arguments_banner
+      optional_args = optional_arguments.map { |a| "[#{a}]" }
+      (required_arguments + optional_args).join(" ")
+    end
+
+    def warn_and_exit(msg)
+      warn "#{msg.to_s.capitalize} \n\n#{@parser}"
+      exit 1
+    end
+
     def concat_to_file(test_specification, output_fd)
       file = test_specification.json_stream_file
       IO.readlines(file).each do |line|
         event = OpenStruct.new(JSON.load(line))
-        output_fd.write(line) unless should_test_event_be_ignored?(test_specification, event)
+        if should_test_event_be_ignored?(test_specification, event)
+          logger.info "Skipped test dumper line #{line}"
+        else
+          output_fd.write(line)
+        end
         output_fd.flush
       end
       output_fd.flush
@@ -52,7 +141,9 @@ module XCKnife
   class TestDumperHelper
     TestSpecification = Struct.new :json_stream_file, :skip_test_identifiers
 
-    def initialize(device_id)
+    attr_reader :logger
+
+    def initialize(device_id, max_retry_count, debug, logger)
       @xcode_path = `xcode-select -p`.strip
       @simctl_path = `xcrun -f simctl`.strip
       @platforms_path = "#{@xcode_path}/Platforms/"
@@ -60,9 +151,12 @@ module XCKnife
       @sdk_path = "#{@platform_path}/Developer/SDKs/iPhoneSimulator.sdk"
       @testroot = nil
       @device_id = device_id
+      @max_retry_count = max_retry_count
+      @logger = logger
+      @debug = debug
     end
 
-    def call(derived_data_folder, list_folder)
+    def call(derived_data_folder, list_folder, extra_environment_variables = {})
       @testroot = "#{derived_data_folder}/Build/Products/"
       xctestrun_file = Dir["#{@testroot}/*.xctestrun"].first
       if xctestrun_file.nil?
@@ -72,14 +166,14 @@ module XCKnife
       xctestrun_as_json = `plutil -convert json -o - "#{xctestrun_file}"`
       FileUtils.mkdir_p(list_folder)
       JSON.load(xctestrun_as_json).map do |test_bundle_name, test_bundle|
-        test_specification = list_tests_wiht_simctl(list_folder, test_bundle, test_bundle_name)
+        test_specification = list_tests_wiht_simctl(list_folder, test_bundle, test_bundle_name, extra_environment_variables)
         wait_test_dumper_completion(test_specification.json_stream_file)
         test_specification
       end
     end
 
     private
-    def list_tests_wiht_simctl(list_folder, test_bundle, test_bundle_name)
+    def list_tests_wiht_simctl(list_folder, test_bundle, test_bundle_name, extra_environment_variables)
       env_variables = test_bundle["EnvironmentVariables"]
       testing_env_variables = test_bundle["TestingEnvironmentVariables"]
       outpath = "#{list_folder}/#{test_bundle_name}"
@@ -110,7 +204,10 @@ module XCKnife
         "DYLD_FALLBACK_FRAMEWORK_PATH" => "#{@platform_path}/Developer/Library/Frameworks",
         "DYLD_INSERT_LIBRARIES" => test_dumper_path,
       )
+      env.merge!(simctl_child_attrs(extra_environment_variables))
       inject_vars(env, test_host)
+      FileUtils.remove(outpath) if File.exists?(outpath)
+      logger.info { "Temporary TestDumper file for #{test_bundle_name} is #{outpath}" }
       if is_logic_test
         run_logic_test(env, test_host, test_bundle_path)
       else
@@ -159,18 +256,14 @@ module XCKnife
       retries_count = 0
       until has_test_dumper_terminated?(file)  do
         retries_count += 1
-        assert_has_not_timed_out(retries_count, file)
+        if retries_count == @max_retry_count
+          puts "Timeout error on: #{file}"
+          exit 1
+        end
         sleep 0.1
       end
     end
 
-    def assert_has_not_timed_out(retries_count, file)
-      if retries_count == 100
-        puts "Timeout error on: #{file}"
-        exit 1
-      end
-    end
-
     def has_test_dumper_terminated?(file)
       return false unless File.exists?(file)
       last_line = `tail -n 1 "#{file}"`
@@ -182,12 +275,18 @@ module XCKnife
     end
 
     def run_logic_test(env, test_host, test_bundle_path)
-      call_simctl env, "spawn #{@device_id} '#{test_host}' -XCTest All '#{test_bundle_path}' 2> /dev/null"
+      call_simctl env, "spawn #{@device_id} '#{test_host}' -XCTest All '#{test_bundle_path}'#{redirect_output}"
+    end
+
+    def redirect_output
+      return '' unless @debug
+      ' 2> /dev/null'
     end
 
     def call_simctl(env, string_args)
       cmd = "#{simctl} #{string_args}"
       puts "Running:\n$ #{cmd}"
+      logger.info { "Environment variables:\n #{env.pretty_print_inspect}" }
       unless system(env, cmd)
         puts "Simctl errored with the following env:\n #{env.pretty_print_inspect}"
       end

data/lib/xcknife/xcscheme_analyzer.rb

@@ -0,0 +1,29 @@
+require 'rexml/document'
+
+module XCKnife
+  module XcschemeAnalyzer
+    extend self
+
+    def extract_environment_variables(xscheme_data)
+      ret = {}
+      xml_root = REXML::Document.new(xscheme_data).root
+
+
+      action = xml_root.elements["//TestAction"]
+      return ret if action.nil?
+      if action.attributes['shouldUseLaunchSchemeArgsEnv'] == "YES"
+        action = xml_root.elements["//LaunchAction"]
+      end
+      return ret if action.nil?
+      env_elements = action.elements[".//EnvironmentVariables"]
+      return ret if env_elements.nil?
+      env_elements.elements.each do |e|
+        attrs = e.attributes
+        if attrs["isEnabled"] == "YES"
+          ret[attrs["key"]] = attrs["value"]
+        end
+      end
+      ret
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcknife
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Daniel Ribeiro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,6 +69,7 @@ files:
 - lib/xcknife/runner.rb
 - lib/xcknife/stream_parser.rb
 - lib/xcknife/test_dumper.rb
+- lib/xcknife/xcscheme_analyzer.rb
 - lib/xcknife/xctool_cmd_helper.rb
 - xcknife.gemspec
 homepage: https://github.com/square/xcknife