Add --wait to ios launch (danielpaulus#205)

adds new --wait switch to keep the command running and display application logs when an app is launched with ios launch [bundleID]

Author: danielpaulus

ios/dtx_codec/connection.go

@@ -1,13 +1,13 @@
 package dtx
 
 import (
+	"github.com/danielpaulus/go-ios/ios"
 	"io"
+	"math"
 	"strings"
 	"sync"
 	"time"
-	"math"
 
-	ios "github.com/danielpaulus/go-ios/ios"
 	"github.com/danielpaulus/go-ios/ios/nskeyedarchiver"
 	log "github.com/sirupsen/logrus"
 )
@@ -73,9 +73,13 @@ func (g GlobalDispatcher) Dispatch(msg Message) {
 		}
 		//TODO: use the dispatchFunctions map
 		if "outputReceived:fromProcess:atTime:" == msg.Payload[0] {
-			msg, err := nskeyedarchiver.Unarchive(msg.Auxiliary.GetArguments()[0].([]byte))
+			logmsg, err := nskeyedarchiver.Unarchive(msg.Auxiliary.GetArguments()[0].([]byte))
 			if err == nil {
-				log.Info(msg[0])
+				log.WithFields(log.Fields{
+					"msg":  logmsg[0],
+					"pid":  msg.Auxiliary.GetArguments()[1],
+					"time": msg.Auxiliary.GetArguments()[2],
+				}).Info("outputReceived:fromProcess:atTime:")
 			}
 			return
 		}

ios/instruments/processcontrol.go

@@ -2,7 +2,6 @@ package instruments
 
 import (
 	"fmt"
-
 	"github.com/danielpaulus/go-ios/ios"
 	dtx "github.com/danielpaulus/go-ios/ios/dtx_codec"
 	log "github.com/sirupsen/logrus"
@@ -16,13 +15,20 @@ type ProcessControl struct {
 //LaunchApp launches the app with the given bundleID on the given device.LaunchApp
 //Use LaunchAppWithArgs for passing arguments and envVars. It returns the PID of the created app process.
 func (p *ProcessControl) LaunchApp(bundleID string) (uint64, error) {
-	options := map[string]interface{}{}
-	options["StartSuspendedKey"] = uint64(0)
-	return p.StartProcess(bundleID, map[string]interface{}{}, []interface{}{}, options)
+	opts := map[string]interface{}{
+		"StartSuspendedKey": uint64(0),
+	}
+	// Xcode sends all these, no idea if we need them for sth. later.
+	//"CA_ASSERT_MAIN_THREAD_TRANSACTIONS": "0", "CA_DEBUG_TRANSACTIONS": "0", "LLVM_PROFILE_FILE": "/dev/null", "METAL_DEBUG_ERROR_MODE": "0", "METAL_DEVICE_WRAPPER_TYPE": "1",
+	//"OS_ACTIVITY_DT_MODE": "YES", "SQLITE_ENABLE_THREAD_ASSERTIONS": "1", "__XPC_LLVM_PROFILE_FILE": "/dev/null"
+	// NSUnbufferedIO seems to make the app send its logs via instruments using the outputReceived:fromProcess:atTime: selector
+	// We'll supply per default to get logs
+	env := map[string]interface{}{"NSUnbufferedIO": "YES"}
+	return p.StartProcess(bundleID, env, []interface{}{}, opts)
 }
 
-func (p *ProcessControl) Close() {
-	p.conn.Close()
+func (p *ProcessControl) Close() error {
+	return p.conn.Close()
 }
 
 func NewProcessControl(device ios.DeviceEntry) (*ProcessControl, error) {

main.go

@@ -93,7 +93,7 @@ Usage:
   ios install --path=<ipaOrAppFolder> [options]
   ios uninstall <bundleID> [options]
   ios apps [--system] [--all] [--list] [options]
-  ios launch <bundleID> [options]
+  ios launch <bundleID> [--wait] [options]
   ios kill (<bundleID> | --pid=<processID> | --process=<processName>) [options]
   ios runtest <bundleID> [options]
   ios runwda [--bundleid=<bundleid>] [--testrunnerbundleid=<testbundleid>] [--xctestconfig=<xctestconfig>] [--arg=<a>]... [--env=<e>]... [options]
@@ -177,7 +177,7 @@ The commands work as following:
    ios install --path=<ipaOrAppFolder> [options]                      Specify a .app folder or an installable ipa file that will be installed.  
    ios pcap [options] [--pid=<processID>] [--process=<processName>]   Starts a pcap dump of network traffic, use --pid or --process to filter specific processes.
    ios apps [--system] [--all] [--list]                               Retrieves a list of installed applications. --system prints out preinstalled system apps. --all prints all apps, including system, user, and hidden apps. --list only prints bundle ID, bundle name and version number.
-   ios launch <bundleID>                                              Launch app with the bundleID on the device. Get your bundle ID from the apps command.
+   ios launch <bundleID> [--wait]                                     Launch app with the bundleID on the device. Get your bundle ID from the apps command. --wait keeps the connection open if you want logs.
    ios kill (<bundleID> | --pid=<processID> | --process=<processName>) [options] Kill app with the specified bundleID, process id, or process name on the device.
    ios runtest <bundleID>                                             Run a XCUITest. 
    ios runwda [--bundleid=<bundleid>] [--testrunnerbundleid=<testbundleid>] [--xctestconfig=<xctestconfig>] [--arg=<a>]... [--env=<e>]...[options]  runs WebDriverAgents
@@ -515,6 +515,7 @@ The commands work as following:
 
 	b, _ = arguments.Bool("launch")
 	if b {
+		wait, _ := arguments.Bool("--wait")
 		bundleID, _ := arguments.String("<bundleID>")
 		if bundleID == "" {
 			log.Fatal("please provide a bundleID")
@@ -524,8 +525,13 @@ The commands work as following:
 
 		pid, err := pControl.LaunchApp(bundleID)
 		exitIfError("launch app command failed", err)
-
 		log.WithFields(log.Fields{"pid": pid}).Info("Process launched")
+		if wait {
+			c := make(chan os.Signal, 1)
+			signal.Notify(c, syscall.SIGINT, syscall.SIGTERM)
+			<-c
+			log.WithFields(log.Fields{"pid": pid}).Info("stop listening to logs")
+		}
 	}
 
 	b, _ = arguments.Bool("kill")