BUILDING.md

Ice for Swift Build Instructions

This file describes how to build Ice for Swift from source and how to test the resulting build.

• Swift Build Requirements
  • Operating Systems
  • Slice to Swift Compiler
  • Swift Version
  • Carthage
• Building Ice for Swift
• Running the Swift Test Suite
  • macOS
  • iOS

Swift Build Requirements

Operating Systems

Ice for Swift builds and runs on macOS and is supported on the platforms listed on the supported platforms page.

Slice to Swift Compiler

You need the Slice to Swift compiler to build Ice for Swift and also to use Ice for Swift. The Slice to Swift compiler (slice2swift) is a command-line tool written in C++. You can build the Slice to Swift compiler from source, or alternatively you can install an Ice binary distribution that includes this compiler.

Swift Version

Ice for Swift requires Swift 5 or later.

Carthage

Carthage must be installed to build Ice for Swift. You can install Carthage using Homebrew:

brew install carthage

Building Ice for Swift

First download and build the PromiseKit framework by running:

carthage bootstrap --use-xcframeworks

from the root directory of your ice repository.

Then open ice.xcodeproj with Xcode and build the Ice macOS or Ice iOS targets.

The test programs for macOS and iOS can be built using TestDriver macOS and TestDriver iOS respectively.

Building the TestDriver iOS application to deploy to an iOS device requires signing the application with a developer certificate. You need to update the Xcode projects to use your Apple development certificates by setting DEVELOPMENT_TEAM environment variable to the Id of your development team and regenerate the projects with rake.

export DEVELOPMENT_TEAM=U4TBVKNQ7F
rake

Running the Swift Test Suite

Python is required to run the test suite.

macOS

After a successful build, you can run the tests as follows:

python3 allTests.py --config Debug

If everything worked out, you should see lots of ok messages. In case of a failure, the tests abort with failed.

iOS

Start the TestDriver iOS application on your iOS device or simulator, from Xcode.

Then on your mac, run:

python3 allTests.py --config Debug --platform iphoneos

or

python3 allTests.py --config Debug --platform iphonesimulator

depending on your target.