xcknife 0.6.3 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a16ad712fe21666c9ec13b16c1cc3007120bc9eb
-  data.tar.gz: fc3109c894275ca6c8e5fed344fd35a3a11d0457
+SHA256:
+  metadata.gz: d5e951e4ae5d93f82ed7773becf567d9ce8dc3a10295b3c9b7774617e1a10d48
+  data.tar.gz: 5f9cfc34b089ec42bf675280fd3fbf0da524220c79a55e0297ada05d0e3403d6
 SHA512:
-  metadata.gz: f364876c260015cc6b0729035c5835b295e1772b27671b50448064659841ab21e2384476b4e5860387e0f397db41d80f4fe48730b6e36879776295e18d89056d
-  data.tar.gz: 456da664e95295f2ae4a20982b245e7ade3a616047cf89dd654e0de0d5d053f2d1a11da6b9bc88b8f1099fd917111f7ed963a112b9c3c2cde6c50056a406a00d
+  metadata.gz: a57b87ee14efa242124ad9e14c2d7bc86937315a8dc9e9206c80480285c4744495ad4376f02ad835f7c23e52e79ebbbc7f7cbcab9ba95a3b12d894aaed0daca9
+  data.tar.gz: 07afb2bc56b4792c355a89001cce7d45261358375457cff69f717b73ce3dbfb0c69ac91fee0b01714d1a8761869bbf1475c0044064aa74ae8e20023ef0fc8481

data/.gitignore

@@ -2,9 +2,10 @@
 pkg
 .idea/
 *.gem
-Gemfile.lock
 xcuserdata/
 testdumperbuild
 contents.xcworkspacedata
 TestDumper/TestDumper.dylib
 *.tmp
+.bin/
+.bundle/

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.6.1

data/.travis.yml

@@ -1,9 +1,14 @@
-language: ruby
+language: objective-c
 sudo: false
-before_install: gem install bundler
-bundler_args: --without development
+matrix:
+  include:
+    - os: osx
+      osx_image: xcode10.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/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    xcknife (0.11.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (11.1.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  rake (~> 11.1.1)
+  rspec (~> 3.4.0)
+  xcknife!
+
+BUNDLED WITH
+   1.17.3

data/OWNERS.yml

@@ -0,0 +1,2 @@
+---
+cc: [mdx-ios]

data/README.md

@@ -9,7 +9,7 @@ It works by leveraging [xctool's](https://github.com/facebook/xctool) [json-stre
 
 XCKnife generates a list of only arguments meant to be pass to Xctool's [*-only* test arguments](https://github.com/facebook/xctool#testing), but alternatively could used to generate multiple xcschemes with the proper test partitions.
 
-More information on XCKnife, go [here](https://corner.squareup.com/2016/06/xcknife-faster-distributed-tests-for-ios.html).
+More information on XCKnife, go [here](https://developer.squareup.com/blog/xcknife-faster-distributed-tests-for-ios).
  
 ## Install
 
@@ -18,11 +18,12 @@ 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
+    -p, --partition TARGETS          Comma separated list of targets. Can be used multiple times.
     -o, --output FILENAME            Output file. Defaults to STDOUT
     -a, --abbrev                     Results are abbreviated
+    -x, --xcodebuild-output          Output is formatted for xcodebuild
     -h, --help                       Show this message
 ```
 
@@ -68,7 +69,7 @@ This will balance the tests onthe `iPhoneTestTarget` into 3 machines. The output
         }]}]}
 ```
 
-This provides a lot of data about the partitions and their imabalances (both internal to the partition sets, and amongst them).
+This provides a lot of data about the partitions and their imbalances (both internal to the partition sets, and amongst them).
 
 If you only want the *-only* arguments, run with the `-a` flag:
 
@@ -193,6 +194,14 @@ XCKnife uses only a few attributes of a json-stream file. If you are storing the
 
 `$ xcknife-min example/xcknife-exemplar-historical-data.json-stream minified.json-stream` 
 
+## Dependencies
+
+XCKnife requires the use of the `gtimeout` command, which is provided in the GNU coreutils brew package. If you don't already have them, they can be installed with the command:
+
+```
+brew install coreutils
+```
+
 ## Contributing
 
 Any contributors to the master *xcknife* repository must sign the

data/Rakefile

@@ -1,5 +1,4 @@
 require 'rspec/core/rake_task'
-require "bundler/gem_tasks"
 require 'fileutils'
 
 RSpec::Core::RakeTask.new(:spec)
@@ -11,7 +10,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
@@ -19,4 +18,5 @@ end
 desc "Release wih test_dumper"
 task :gem_release => [:build_test_dumper, :build] do
   system 'gem push pkg/xcknife-*.gem'
-end
+end
+

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.
 
@@ -8,4 +8,18 @@ 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
+    -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
+    -h, --help                       Show this message
+```

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,51 +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() {
-    NSString *testType = [NSString stringWithUTF8String: getenv("XCTEST_TYPE")];
+    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]) {
+        logDebug(@"File already exists %@. Stopping", testDumperOutputPath);
+        logEnd(true);
+    }
+
+    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"];
 
@@ -168,13 +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) {
+        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);
 }
 
 
@@ -193,8 +243,11 @@ 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);
+                logDebug(@"Unknown test level %ld for test %@", level, t.debugDescription);
 
         }
         if (level == TEST_METHOD_LEVEL) {