xcknife 0.6.6 → 0.13.0

data/TestDumper/README.md

@@ -1,6 +1,6 @@
 # TestDumper - EXPERIMENTAL
 
-Utility that replaces xctool for enumerating tests. It requires the `build-for-testing` feature Xcode8 introduced on xcodebuild. In particular, it leverages the xctestrun file (see `man xcodebuild.xctestrun`).
+Utility that replaces xctool for enumerating tests. It requires the `build-for-testing` feature Xcode 8 introduced on xcodebuild. In particular, it leverages the xctestrun file (see `man xcodebuild.xctestrun`).
 
 ## Building.
 
@@ -17,6 +17,7 @@ $ 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
+    -x, --simctl-timeout SECONDS    Max allowed time in seconds for simctl commands
     -t OUTPUT_FOLDER,                Sets temporary Output folder
         --temporary-output
     -s, --scheme XCSCHEME_FILE       Reads environments variables from the xcscheme file

data/TestDumper/TestDumper.xcodeproj/project.pbxproj

@@ -181,7 +181,7 @@
 			isa = PBXProject;
 			attributes = {
 				LastSwiftUpdateCheck = 0700;
-				LastUpgradeCheck = 0700;
+				LastUpgradeCheck = 1010;
 				ORGANIZATIONNAME = "Square, Inc";
 				TargetAttributes = {
 					F60C68B91B8D038300CC8521 = {
@@ -198,7 +198,7 @@
 					};
 				};
 			};
-			buildConfigurationList = F60C68B41B8D038300CC8521 /* Build configuration list for PBXProject "toolc" */;
+			buildConfigurationList = F60C68B41B8D038300CC8521 /* Build configuration list for PBXProject "TestDumper" */;
 			compatibilityVersion = "Xcode 3.2";
 			developmentRegion = English;
 			hasScannedForEncodings = 0;
@@ -288,13 +288,23 @@
 				CLANG_CXX_LIBRARY = "libc++";
 				CLANG_ENABLE_MODULES = YES;
 				CLANG_ENABLE_OBJC_ARC = YES;
+				CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES;
 				CLANG_WARN_BOOL_CONVERSION = YES;
+				CLANG_WARN_COMMA = YES;
 				CLANG_WARN_CONSTANT_CONVERSION = YES;
+				CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES;
 				CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
 				CLANG_WARN_EMPTY_BODY = YES;
 				CLANG_WARN_ENUM_CONVERSION = YES;
+				CLANG_WARN_INFINITE_RECURSION = YES;
 				CLANG_WARN_INT_CONVERSION = YES;
+				CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES;
+				CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
+				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
 				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
+				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
+				CLANG_WARN_STRICT_PROTOTYPES = YES;
+				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
@@ -337,13 +347,23 @@
 				CLANG_CXX_LIBRARY = "libc++";
 				CLANG_ENABLE_MODULES = YES;
 				CLANG_ENABLE_OBJC_ARC = YES;
+				CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES;
 				CLANG_WARN_BOOL_CONVERSION = YES;
+				CLANG_WARN_COMMA = YES;
 				CLANG_WARN_CONSTANT_CONVERSION = YES;
+				CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES;
 				CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
 				CLANG_WARN_EMPTY_BODY = YES;
 				CLANG_WARN_ENUM_CONVERSION = YES;
+				CLANG_WARN_INFINITE_RECURSION = YES;
 				CLANG_WARN_INT_CONVERSION = YES;
+				CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES;
+				CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
+				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
 				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
+				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
+				CLANG_WARN_STRICT_PROTOTYPES = YES;
+				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
@@ -373,12 +393,13 @@
 		F60C68D11B8D038300CC8521 /* Debug */ = {
 			isa = XCBuildConfiguration;
 			buildSettings = {
+				ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;
 				CLANG_ENABLE_MODULES = YES;
+				CODE_SIGN_IDENTITY = "";
 				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
 				DYLIB_CURRENT_VERSION = 1;
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
-				EMBEDDED_CONTENT_CONTAINS_SWIFT = YES;
 				FRAMEWORK_SEARCH_PATHS = (
 					"$(inherited)",
 					"$(SDKROOT)/../../Library/Frameworks/",
@@ -399,12 +420,13 @@
 		F60C68D21B8D038300CC8521 /* Release */ = {
 			isa = XCBuildConfiguration;
 			buildSettings = {
+				ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;
 				CLANG_ENABLE_MODULES = YES;
+				CODE_SIGN_IDENTITY = "";
 				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
 				DYLIB_CURRENT_VERSION = 1;
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
-				EMBEDDED_CONTENT_CONTAINS_SWIFT = YES;
 				FRAMEWORK_SEARCH_PATHS = (
 					"$(inherited)",
 					"$(SDKROOT)/../../Library/Frameworks/",
@@ -483,7 +505,7 @@
 /* End XCBuildConfiguration section */
 
 /* Begin XCConfigurationList section */
-		F60C68B41B8D038300CC8521 /* Build configuration list for PBXProject "toolc" */ = {
+		F60C68B41B8D038300CC8521 /* Build configuration list for PBXProject "TestDumper" */ = {
 			isa = XCConfigurationList;
 			buildConfigurations = (
 				F60C68CE1B8D038300CC8521 /* Debug */,

data/TestDumper/TestDumper.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDEDidComputeMac32BitWarning</key>
+	<true/>
+</dict>
+</plist>

data/TestDumper/TestDumper.xcodeproj/xcshareddata/xcschemes/TestDumper.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0800"
+   LastUpgradeVersion = "1010"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

data/TestDumper/TestDumper/Initialize.m

@@ -7,13 +7,9 @@
 //
 
 @import Dispatch;
+@import Foundation;
 @import XCTest;
 
-
-
-
-@class NSSet, NSString, NSURL, NSUUID;
-
 @interface XCTestConfiguration : NSObject <NSSecureCoding>
 {
     NSURL *_testBundleURL;
@@ -71,6 +67,46 @@
 
 #include <dlfcn.h>
 
+// Logging
+FILE *logFile;
+
+void initializeLogFile(const char *logFilePath)
+{
+    logFile = fopen(logFilePath, "w");
+}
+
+void logDebug(NSString *, ...) NS_FORMAT_FUNCTION(1, 2);
+void logDebug(NSString *msg, ...)
+{
+    assert(logFile);
+    va_list varargs;
+    va_start(varargs, msg);
+    msg = [[NSString alloc] initWithFormat:msg arguments:varargs];
+    va_end(varargs);
+    fprintf(logFile, "%s\n", msg.UTF8String);
+    
+    NSLog(@"%@", msg);
+}
+
+void logInit()
+{
+    logDebug(@"Starting TestDumper...");
+    logDebug(@"Environment Variables:");
+    logDebug(@"%@", NSProcessInfo.processInfo.environment.description);
+    logDebug(@"Command Line Arguments:");
+    logDebug(@"%@", NSProcessInfo.processInfo.arguments.description);
+    
+    logDebug(@"--------------------------------");
+}
+
+OS_NORETURN
+void logEnd(Boolean success)
+{
+    int exitCode = success ? EXIT_SUCCESS : EXIT_FAILURE;
+    logDebug(@"EndingTestDumper...\nExiting with status %d", exitCode);
+    fclose(logFile);
+    exit(exitCode);
+}
 
 // Used for a structured log, just like Xctool's.
 // Example: https://github.com/square/xcknife/blob/master/example/xcknife-exemplar.json-stream
@@ -81,10 +117,10 @@ static void PrintJSON(FILE *outFile, id JSONObject)
 
     if (error) {
         fprintf(outFile, "{ \"message\" : \"Error while serializing to JSON. Check out simulator logs for details\" }");
-        NSLog(@"ERROR: Error generating JSON for object: %s: %s\n",
+        logDebug(@"ERROR: Error generating JSON for object: %s: %s\n",
                 [[JSONObject description] UTF8String],
                 [[error localizedFailureReason] UTF8String]);
-        exit(1);
+        logEnd(false);
     }
 
     fwrite([data bytes], 1, [data length], outFile);
@@ -114,58 +150,60 @@ static void PrintTestClass(FILE *outFile, NSString *testClass) {
                          @"totalDuration" : @"0"});
 }
 
-void enumerateTests();
+void enumerateTests(NSString *);
 
 const int TEST_TARGET_LEVEL = 0;
 const int TEST_CLASS_LEVEL = 1;
 const int TEST_METHOD_LEVEL = 2;
+FILE *noteFile;
 
 __attribute__((constructor))
 void initialize() {
     NSLog(@"Starting TestDumper");
+    const char *logFilePath = [[[NSProcessInfo processInfo] arguments][3] UTF8String];
+    initializeLogFile(logFilePath);
+    logInit();
+    NSString *testBundlePath = [[NSProcessInfo processInfo] arguments][4];
     NSString *testDumperOutputPath = NSProcessInfo.processInfo.environment[@"TestDumperOutputPath"];
     NSFileManager *fileManager = [NSFileManager defaultManager];
 
     if ([fileManager fileExistsAtPath:testDumperOutputPath]) {
-        NSLog(@"File already exists %@. Stopping", testDumperOutputPath);
-        exit(0);
+        logDebug(@"File already exists %@. Stopping", testDumperOutputPath);
+        logEnd(true);
     }
-    NSString *testType = [NSString stringWithUTF8String: getenv("XCTEST_TYPE")];
 
+    NSString *testType = [NSString stringWithUTF8String: getenv("XCTEST_TYPE")];
     if ([testType isEqualToString: @"APPTEST"]) {
         [[NSNotificationCenter defaultCenter] addObserverForName:UIApplicationDidFinishLaunchingNotification object:nil queue:nil usingBlock:^(NSNotification * _Nonnull note) {
-            enumerateTests();
+            enumerateTests(testBundlePath);
         }];
     } else {
-        enumerateTests();
+        enumerateTests(testBundlePath);
     }
 }
 
-
-void enumerateTests() {
-    XCTestConfiguration *config = [[XCTestConfiguration alloc] init];
-    NSString *testType = [NSString stringWithUTF8String: getenv("XCTEST_TYPE")];
-    NSString *testTarget = [NSString stringWithUTF8String: getenv("XCTEST_TARGET")];
-
-    if ([testType isEqualToString: @"APPTEST"]) {
-        config.testBundleURL = [NSURL fileURLWithPath:NSProcessInfo.processInfo.environment[@"XCInjectBundle"]];
-        config.targetApplicationPath = NSProcessInfo.processInfo.environment[@"XCInjectBundleInto"];
-
-        NSString *configPath = [NSTemporaryDirectory() stringByAppendingPathComponent:[NSString stringWithFormat:@"%ul.xctestconfiguration", arc4random()]];
-
-        NSLog(@"Writing config to %@", configPath);
-
-        NSData *data = [NSKeyedArchiver archivedDataWithRootObject:config];
-
-        [data writeToFile:configPath atomically:true];
-
-        setenv("XCTestConfigurationFilePath", configPath.UTF8String, YES);
-
-        dlopen(getenv("IDE_INJECTION_PATH"), RTLD_GLOBAL);
+void enumerateTests(NSString *testBundlePath) {
+    logDebug(@"Listing all test bundles");
+    for (NSBundle *bundle in NSBundle.allBundles) {
+        logDebug(@"Found a test bundle named: %@", bundle.bundlePath);
     }
-    NSString *testBundle = [[[NSProcessInfo processInfo] arguments] lastObject];
-    [[NSBundle bundleWithPath:testBundle] load];
-
+    logDebug(@"Finished listing all test bundles");
+    
+    NSBundle* testBundleObj = [NSBundle bundleWithPath:testBundlePath];
+    [testBundleObj load];
+    logDebug(@"test bundle loaded");
+    
+    logDebug(@"Listing all test bundles");
+    for (NSBundle *bundle in NSBundle.allBundles) {
+        logDebug(@"Found a test bundle named: %@", bundle.bundlePath);
+    }
+    logDebug(@"Finished listing all test bundles");
+    
+    NSString *testType = [NSString stringWithUTF8String: getenv("XCTEST_TYPE")];
+    NSString *testTarget = [[[testBundlePath componentsSeparatedByString:@"/"] lastObject] componentsSeparatedByString:@"."][0];
+    
+    logDebug(@"The test target is: %@ of type %@", testTarget, testType);
+    
     FILE *outFile;
     NSString *testDumperOutputPath = NSProcessInfo.processInfo.environment[@"TestDumperOutputPath"];
 
@@ -175,17 +213,18 @@ void enumerateTests() {
         outFile = fopen(testDumperOutputPath.UTF8String, "w+");
     }
 
-    NSLog(@"Opened %@ with fd %p", testDumperOutputPath, outFile);
+    logDebug(@"Opened %@ with fd %p", testDumperOutputPath, outFile);
     if (outFile == NULL) {
-        NSLog(@"File already exists %@. Stopping", testDumperOutputPath);
-        exit(0);
+        logDebug(@"File already exists at %@. Stopping", testDumperOutputPath);
+        logEnd(true);
     }
-
+    
     PrintDumpStart(outFile, testType);
-    [[XCTestSuite defaultTestSuite] printTestsWithLevel:0 withTarget: testTarget withParent: nil outputFile:outFile];
+    XCTestSuite* testSuite = [XCTestSuite defaultTestSuite];
+    [testSuite printTestsWithLevel:0 withTarget: testTarget withParent: nil outputFile:outFile];
     PrintDumpEnd(outFile, testType);
     fclose(outFile);
-    exit(0);
+    logEnd(true);
 }
 
 
@@ -208,7 +247,7 @@ void enumerateTests() {
                 // nothing to do here
                 break;
             default:
-                NSLog(@"Uknown level %ld", level);
+                logDebug(@"Unknown test level %ld for test %@", level, t.debugDescription);
 
         }
         if (level == TEST_METHOD_LEVEL) {

data/bin/xcknife

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'xcknife'
 
 XCKnife::Runner.invoke

data/bin/xcknife-min

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# encoding: utf-8
+# frozen_string_literal: true
 
 # Script for cleaning up historical events, so that we only store the ones we need
 require 'set'
@@ -7,25 +7,22 @@ require 'json' unless defined?(::JSON)
 
 INTERESTING_EVENTS = %w[begin-ocunit end-test].to_set
 def cleanup(input_file_name, output_file_name)
-  if input_file_name.nil? or output_file_name.nil?
-    return puts "Usage: xcknife-min [input] [output]"
-  end
+  return puts 'Usage: xcknife-min [input] [output]' if input_file_name.nil? || output_file_name.nil?
+
   lines = IO.readlines(input_file_name)
   lines_written = 0
   total = lines.size
-  File.open(output_file_name, "w") do |f|
+  File.open(output_file_name, 'w') do |f|
     lines.each do |line|
-      data = JSON.load(line)
-      if INTERESTING_EVENTS.include?(data["event"])
-        lines_written += 1
-        %w[output sdk timestamp exceptions result succeeded methodName].each do |k|
-          data.delete(k)
-        end
-        if data["test"]
-          data["test"] = "1"
-        end
-        f.puts(data.to_json)
+      data = JSON.parse(line)
+      next unless INTERESTING_EVENTS.include?(data['event'])
+
+      lines_written += 1
+      %w[output sdk timestamp exceptions result succeeded methodName].each do |k|
+        data.delete(k)
       end
+      data['test'] = '1' if data['test']
+      f.puts(data.to_json)
     end
   end
   lines_removed = total - lines_written

data/bin/xcknife-test-dumper

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'xcknife'
 
 XCKnife::TestDumper.invoke

data/example/run_example.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 require_relative '../lib/xcknife'
 require 'pp'
 
 # Gem usage of xcknife. Functionaly equivalent to
 # $ xcknife -p CommonTestTarget -p CommonTestTarget,iPadTestTarget 6 example/xcknife-exemplar-historical-data.json-stream example/xcknife-exemplar.json-stream
-include XCKnife::XCToolCmdHelper
+
 TARGET_PARTITIONS = {
-  "AllTests" => ["CommonTestTarget", "iPadTestTarget"],
-  "OnlyCommon" => ["CommonTestTarget"]
-}
+  'AllTests' => %w[CommonTestTarget iPadTestTarget],
+  'OnlyCommon' => ['CommonTestTarget']
+}.freeze
 
 def run(historical_file, current_file)
   test_target_names = TARGET_PARTITIONS.keys
@@ -20,16 +22,16 @@ def run(historical_file, current_file)
   puts "imbalances = #{result.test_time_imbalances.to_h.inspect}"
   shard_number = 0
   puts "size = #{partition_sets.size}"
-  puts "sizes = #{partition_sets.map(&:size).join(", ")}"
+  puts "sizes = #{partition_sets.map(&:size).join(', ')}"
   partition_sets.each_with_index do |partition_set, i|
     target_name = test_target_names[i]
     partition_set.each do |partition|
       puts "target name for worker #{shard_number} = #{target_name}"
-      puts "only is: #{xctool_only_arguments(partition).inspect}"
-      puts "skip-only is: #{xcodebuild_skip_arguments(partition, result.test_time_for_partitions).inspect}"
+      puts "only is: #{XCKnife::XCToolCmdHelper.xctool_only_arguments(partition).inspect}"
+      puts "skip-only is: #{XCKnife::XCToolCmdHelper.xcodebuild_skip_arguments(partition, result.test_time_for_partitions).inspect}"
       shard_number += 1
     end
   end
 end
 
-run("xcknife-exemplar-historical-data.json-stream", "xcknife-exemplar.json-stream")
+run('xcknife-exemplar-historical-data.json-stream', 'xcknife-exemplar.json-stream')

data/example/xcknife-exemplar-historical-data.json-stream

@@ -1,12 +1,12 @@
-{"bundleName":"CommonTestTarget.xctest","deviceName":"iPad Air","event":"begin-ocunit","targetName":"CommonTestTarget","testType":"logic-test","sdkName":"iphonesimulator9.2"}
+{"bundleName":"CommonTestTarget.xctest","deviceName":"iPad Air","event":"begin-ocunit","targetName":"CommonTestTarget","testType":"logic-test","sdkName":"iphonesimulator13.6"}
 {"test":"1","className":"CommonTestClass","event":"end-test","totalDuration":0.1075069904327393}
 {"test":"1","className":"CommonTestClass","event":"end-test","totalDuration":0.303464949131012}
 {"test":"1","className":"CommonTestClass","event":"end-test","totalDuration":0.2003870010375977}
-{"bundleName":"iPadTestTarget.xctest","deviceName":"iPad Air","event":"begin-ocunit","targetName":"iPadTestTarget","testType":"application-test","sdkName":"iphonesimulator9.2"}
+{"bundleName":"iPadTestTarget.xctest","deviceName":"iPad Air","event":"begin-ocunit","targetName":"iPadTestTarget","testType":"application-test","sdkName":"iphonesimulator13.6"}
 {"test":"1","className":"iPadTestClassOne","event":"end-test","totalDuration":1.001249969005585}
 {"test":"1","className":"iPadTestClassThree","event":"end-test","totalDuration":0.5002140402793884}
 {"test":"1","className":"iPadTestClassTwo","event":"end-test","totalDuration":5.001157999038696}
-{"bundleName":"iPhoneTestTarget.xctest","deviceName":"iPad Air","event":"begin-ocunit","targetName":"iPhoneTestTarget","testType":"application-test","sdkName":"iphonesimulator9.2"}
+{"bundleName":"iPhoneTestTarget.xctest","deviceName":"iPad Air","event":"begin-ocunit","targetName":"iPhoneTestTarget","testType":"application-test","sdkName":"iphonesimulator13.6"}
 {"test":"1","className":"iPhoneTestClassAlpha","event":"end-test","totalDuration":0.2037490010261536}
 {"test":"1","className":"iPhoneTestClassBeta","event":"end-test","totalDuration":0.2012439966201782}
 {"test":"1","className":"iPhoneTestClassDelta","event":"end-test","totalDuration":0.1004489660263062}