Xcodebuild Destination

From http://www.mokacoding.com/blog/xcodebuild-destination-options/
When using xcodebuild there are cases in which you want to use the -destination option to configure which device or Simulator will be used by the tool, for example when doing xcodebuild test.
If you are like me your brain cannot retain the syntax and options for -destination, so here's a cheatsheet.

Destination Specifier

The argument for -destination is called destination specifier, and its syntax is a list of comma separated key=value pairs.
The specifier platform key can be used to target one of the supported platforms. Each platform comes with its set of keys.
The supported platforms are:
  • OS X, your Mac
  • iOS, a connected iOS device
  • iOS Simulator
  • watchOS
  • watchOS Simulator
  • tvOS
  • tvOS Simulator

OS X

The Mac OS X platform accepts an arch keyword, which can be either x86_64 or i386. x86_64 is the default.
xcodebuild \
  -workspace MyMacApp.xcworkspace \
  -scheme MyMacApp \
  -destination 'platform=OS X,arch=x86_64' \
  clean test

iOS

The iOS platform should be used when you want to run tests on a connected device. It supports two keys, id and name. Either one of the two must be provided, but not both.1
Use name to target a device using it's name, id to use its UUID.
xcodebuild \
  -workspace MyApp.xcworkspace \
  -scheme MyApp \
  -destination "platform=iOS,name=Gio's iPhone" \
  DEVELOPMENT_TEAM <dev_team_id> \
  clean test

xcodebuild \
  -workspace MyApp.xcworkspace \
  -scheme MyApp \
  -destination 'platform=iOS,id=YOUR_PHONE_UUID' \
  clean test1

iOS Simulator

iOS Simulator is the platform I use more often. It supports the same id and name mutually exclusive keys as iOS, plus an OS key. OS expects a target version number, like 9.1, or latest, which is the default.
xcodebuild \
  -workspace MyApp.xcworkspace \
  -scheme MyApp \
  -destination 'platform=iOS Simulator,name=iPhone 6,OS=9.1' \
  clean test2

tvOS and tvOS Simulator

The tvOS and tvOS Simulator platforms expect the same parameters as their iOS counter parts.

watchOS and watchOS Simulator

watchOS and watchOS Simulator have a slightly different behaviour. Since a watchOS app is always build and deployed nested inside of an iOS app to use such a destination you will need to specify a scheme which is configured to run a WatchKit app, and specify the platform destination that is paired with the watchOS device you want to use.
xcodebuild \
  -workspace MyApp.xcworkspace \
  -scheme MyWatchKitApp
  -destination 'platform=iOS Simulator,name=iPhone 6,OS=9.1' \
  build

Unable to find destination

When in doubt with the destination parameter a good trick is to write some nonsense in as the destination specifier. xcodebuild will fail and then list all the available destinations for the given scheme:
xcodebuild: error: Unable to find a destination matching the provided destination specifier:
        { platform:jibberish }

    The requested device could not be found because no available devices matched the request.

    Available destinations for the "MyApp" scheme:
        { platform:iOS Simulator, id:5BBA1401-0C74-47A7-8709-9F6C1D9C9CBB, OS:9.1, name:iPhone 6s }
        { platform:iOS Simulator, id:28FF0903-97D6-459B-8F34-D9436AEA3B87, OS:9.1, name:iPhone 6s Plus }

Generic Platform

There are some xcodebuild actions, like build, that may be performed without an actual device. To target a platform generically prefix the destination specifier with generic/.
-destination generic/platform=iOS

Multiple Destinations

You can specify multiple -destination options to make xcodebuild perform the action on multiple destinations.1

Timeout

The -destination-timeout option specifies the amount of time in seconds to wait before considering the specified destination unavailable. The default timeout is 30 seconds.

Default Destination

If -destination is omitted, xcodebuild defaults to a destination compatible with the selected scheme. But, do you really trust Xcode to do the right thing for you? 😕

List All Available Destinations

To list all the known destination you can use instruments -s devices. The output is a list in the format name (OS) [UUID].
Giovanni’s Retina MacBook Pro [37B86DB5-FB69-56F7-A023-ECC6B90C3486]
Apple TV 1080p (9.0) [BCFBA897-9E8D-43BA-9EE0-A93B39615ECA]
Apple Watch - 38mm (2.0) [9366B46E-EB1D-4CF3-B7EE-6E1BCEE0F89E]
...
iPhone 6s (9.1) [5BBA1401-0C74-47A7-8709-9F6C1D9C9CBB]
iPhone 6s (9.1) + Apple Watch - 38mm (2.0) [303CB525-E04F-463D-B0E5-22E19278E88C]
...

CMD used in WebDriverAgent


xcodebuild build-for-testing test-without-building -project WebDriverAgent.xcodeproj -scheme WebDriverAgentRunner -destination id=a5203d20775e876e87e926e7ddb11bc19eb250e7 -configuration Debug IPHONEOS_DEPLOYMENT_TARGET=10.3 CODE_SIGN_IDENTITY="iPhone Developer" DEVELOPMENT_TEAM=<id>

or using the -xcconfig way with the file containing the last 3 parameters

xcodebuild build-for-testing test-without-building -project WebDriverAgent.xcodeproj -scheme WebDriverAgentRunner -destination id=a5203d20775e876e87e926e7ddb11bc19eb250e7 -configuration Debug -xcconfig /tmp/appium-temp.xcconfig
You can find more information about the -destination option and xcodebuild itself by reading the tool's manpage: man xcodebuild.

Comments

Post a Comment

Popular posts from this blog

Python: pickle and copyreg

multiprocessing must pickle things to sling them among processes, and bound methods are not picklable. The workaround (whether you consider it "easy" or not;-) is to add the infrastructure to your program to allow such methods to be pickled, registering it with the  copy_reg standard library method. Following is from the python doc The  copyreg  module offers a way to define functions used while pickling specific objects. The  pickle  and  copy  modules use those functions when pickling/copying those objects. The module provides configuration information about object constructors which are not classes. Such constructors may be factory functions or class instances. copyreg . constructor ( object ) Declares  object  to be a valid constructor. If  object  is not callable (and hence not valid as a constructor), raises  TypeError . copyreg . pickle ( type ,  function ,  constructor=None ) Declares that  ...
Read more

Swift: Codable

Image
From  https://hackernoon.com/everything-about-codable-in-swift-4-97d0e18a2999 As we are all aware, to support encoding and decoding of instances in iOS, a class must adopt the  NSCoding  protocol and implement its methods: init(coder:) — Returns an object initialized from data in a given unarchiver. encode(with:) — Encodes the receiver using a given archiver. Example: Code Snippet — 1 init(coder:)  and  encode(with:)  must contain the code for each property that needs to be encoded or decoded. 😲 Well, it seems that you have to write so much of redundant code 😖 only with the property name changes.  Copy Paste..Copy Paste..!!!😕😴 But why should I do that? 🙇‍♀️ If the property names are same as the key names and I don’t have any specific requirements, why don’t  NSCoding  handle everything at its own end? 🤷‍♀️ Why do I have to write so much code? Noooooo..!!! 😼 OMG..!!! Another problem 🤦‍♀️. It doesn’t even ...
Read more

Java - Writing your own JUnit Rule

 Repost from  https://medium.com/@vanniktech/writing-your-own-junit-rule-3df41997b10c A JUnit Rule can be used to do some work around the execution of a test. One example would be to set up something before a test is running and then after it ran tearing something down. This is actually quite simple to do with JUnit itself. public class YourTest { @Before public void setUp() { // Do something before exampleTest starts. } @Test public void exampleTest() { // Your normal test. } @After public void tearDown() { // Do something after exampleTest finished. } } Now imagine you want to connect to a database during  setUp  and then close the connection in  tearDown . If you want to use that database in multiple files you don’t want to copy paste that code in every file. TestRule Let’s look at a quick example of a custom TestRule. public final class DatabaseRule implements TestRule { public Database database; @Override public Statement apply(f...
Read more