commit	18373749e60a4f1df54df778a3bc906650436d5c	[log] [tgz]
author	David Grove <dgrove-oss@users.noreply.github.com>	Sat Mar 13 10:20:41 2021 -0500
committer	GitHub <noreply@github.com>	Sat Mar 13 10:20:41 2021 -0500
tree	140bc78b13fe1b20832af3b08afb024b426dbbcf
parent	cce5402cf15423127d1fd5e332a5f11675c1b1d5 [diff]

tree: 140bc78b13fe1b20832af3b08afb024b426dbbcf

README.md

Apache OpenWhisk runtimes for swift

Changelogs

Quick Swift Action

Simple swift action hello.swift

The traditional support for the dictionary still works:

import Foundation

func main(args: [String:Any]) -> [String:Any] {
    if let name = args["name"] as? String {
        return [ "greeting" : "Hello \(name)!" ]
    } else {
        return [ "greeting" : "Hello stranger!" ]
    }
}

Swift 5.x support

Some examples of using Codable In and Out

Codable style function signature

Create file helloCodableAsync.swift


import Foundation

// Domain model/entity
struct Employee: Codable {
  let id: Int?
  let name: String?
}
// codable main function
func main(input: Employee, respondWith: (Employee?, Error?) -> Void) -> Void {
    // For simplicity, just passing same Employee instance forward
    respondWith(input, nil)
}

wsk action update helloCodableAsync helloCodableAsync.swift swift:5.1

ok: updated action helloCodableAsync

wsk action invoke helloCodableAsync -r -p id 73 -p name Andrea

{
    "id": 73,
    "name": "Andrea"
}

Codable Error Handling

Create file helloCodableAsync.swift


import Foundation

struct Employee: Codable {
    let id: Int?
    let name: String?
}
enum VendingMachineError: Error {
    case invalidSelection
    case insufficientFunds(coinsNeeded: Int)
    case outOfStock
}
func main(input: Employee, respondWith: (Employee?, Error?) -> Void) -> Void {
    // Return real error
    do {
        throw VendingMachineError.insufficientFunds(coinsNeeded: 5)
    } catch {
        respondWith(nil, error)
    }
}

wsk action update helloCodableError helloCodableError.swift swift:5.1

ok: updated action helloCodableError

wsk action invoke helloCodableError -b -p id 51 -p name Carlos

{
"name": "helloCodableError",
"response": {
  "result": {
    "error": "insufficientFunds(5)"
  },
"status": "application error",
"success": false
}

Packaging an action as a Swift executable using Swift 5.x

When you create an OpenWhisk Swift action with a Swift source file, it has to be compiled into a binary before the action is run. Once done, subsequent calls to the action are much faster until the container holding your action is purged. This delay is known as the cold-start delay.

To avoid the cold-start delay, you can compile your Swift file into a binary and then upload to OpenWhisk in a zip file. As you need the OpenWhisk scaffolding, the easiest way to create the binary is to build it within the same environment as it will be run in.

Compiling Swift 5.x

Compiling Swift 5.x single file

Use the docker container and pass the single source file as stdin. Pass the name of the method to the flag -compile

docker run -i openwhisk/action-swift-v5.1 -compile main <main.swift >../action.zip

Compiling Swift 5.1 multiple files with dependencies

Use the docker container and pass a zip archive containing a Package.swift and source files a main source file in the location Sources/main.swift.

zip - -r * | docker run -i openwhisk/action-swift-v5.1 -compile main >../action.zip

For more build examples see here

Swift 4.x support

Some examples of using Codable In and Out

Codable style function signature

Create file helloCodableAsync.swift

// Domain model/entity
struct Employee: Codable {
  let id: Int?
  let name: String?
}
// codable main function
func main(input: Employee, respondWith: (Employee?, Error?) -> Void) -> Void {
    // For simplicity, just passing same Employee instance forward
    respondWith(input, nil)
}

wsk action update helloCodableAsync helloCodableAsync.swift swift:4.2

ok: updated action helloCodableAsync

wsk action invoke helloCodableAsync -r -p id 42 -p name Carlos

{
    "id": 42,
    "name": "Carlos"
}

Codable Error Handling

Create file helloCodableAsync.swift

struct Employee: Codable {
    let id: Int?
    let name: String?
}
enum VendingMachineError: Error {
    case invalidSelection
    case insufficientFunds(coinsNeeded: Int)
    case outOfStock
}
func main(input: Employee, respondWith: (Employee?, Error?) -> Void) -> Void {
    // Return real error
    do{
        throw VendingMachineError.insufficientFunds(coinsNeeded: 5)
    } catch {
        respondWith(nil, error)
    }
}

wsk action update helloCodableError helloCodableError.swift swift:4.2

ok: updated action helloCodableError

wsk action invoke helloCodableError -b -p id 42 -p name Carlos

{
"name": "helloCodableError",
"response": {
  "result": {
    "error": "insufficientFunds(5)"
  },
"status": "application error",
"success": false
}

Packaging an action as a Swift executable using Swift 4.x

Compiling Swift 4.2

Compiling Swift 4.2 single file

Use the docker container and pass the single source file as stdin. Pass the name of the method to the flag -compile

docker run -i openwhisk/action-swift-v4.2 -compile main <main.swift >../action.zip

Compiling Swift 4.2 multiple files with dependencies

Use the docker container and pass a zip archive containing a Package.swift and source files a main source file in the location Sources/main.swift.

zip - -r * | docker run -i openwhisk/action-swift-v4.2 -compile main >../action.zip

For more build examples see here

Compiling Swift 4.1

These are the steps:

Run an interactive Swift action container.
```
docker run --rm -it -v "$(pwd):/owexec" openwhisk/action-swift-v4.2 bash
```
This puts you in a bash shell within the Docker container.

Copy the source code and prepare to build it.

cp /owexec/hello.swift /swift4Action/spm-build/Sources/Action/main.swift

cat /swift4Action/epilogue.swift >> /swift4Action/spm-build/Sources/Action/main.swift

echo '_run_main(mainFunction:main)' >> /swift4Action/spm-build/Sources/Action/main.swift

Copy any additional source files to /swift4Action/spm-build/Sources/Action/

Create the Package.swift file to add dependencies.

// swift-tools-version:4.0
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
    name: "Action",
    products: [
      .executable(
        name: "Action",
        targets:  ["Action"]
      )
    ],
    dependencies: [
      .package(url: "https://github.com/IBM-Swift/SwiftyRequest.git", .upToNextMajor(from: "1.0.0"))
    ],
    targets: [
      .target(
        name: "Action",
        dependencies: ["SwiftyRequest"],
        path: "."
      )
    ]

As you can see this example adds SwiftyRequest dependencies.

Notice that now with swift:4.2 is no longer required to include CCurl, Kitura-net and SwiftyJSON in your own Package.swift. You are free now to use no dependencies, or add the combination that you want with the versions you want.

Copy Package.swift to spm-build directory

cp /owexec/Package.swift /swift4Action/spm-build/Package.swift

Change to the spm-build directory.
```
cd /swift4Action/spm-build
```
Compile your Swift Action.
```
swift build -c release
```

Create the zip archive.

zip /owexec/hello.zip .build/release/Action

Exit the Docker container.
```
exit
```
This has created hello.zip in the same directory as hello.swift.

Upload it to OpenWhisk with the action name helloSwifty:

wsk action update helloSwiftly hello.zip openwhisk/action-swift-v4.2

To check how much faster it is, run

wsk action invoke helloSwiftly --blocking

Building the Swift4 Image

./gradlew core:swift40Action:distDocker

This will produce the image whisk/action-swift-v4.2

Build and Push image

docker login
./gradlew core:swift40Action:distDocker -PdockerImagePrefix=$prefix-user -PdockerRegistry=docker.io

Codable Support with Swift 4.x

Some examples of using Codable In and Out

Codable style function signature

Create file helloCodableAsync.swift

// Domain model/entity
struct Employee: Codable {
  let id: Int
  let name: String
}
// codable main function
func main(input: Employee, respondWith: (Employee?, Error?) -> Void) -> Void {
    // For simplicity, just passing same Employee instance forward
    respondWith(input, nil)
}

wsk action update helloCodableAsync helloCodableAsync.swift swift:4.2

ok: updated action helloCodableAsync

wsk action invoke helloCodableAsync -r -p id 42 -p name Carlos

{
    "id": 42,
    "name": "Carlos"
}

Codable Error Handling

Create file helloCodableAsync.swift

struct Employee: Codable {
    let id: Int
    let name: String
}
enum VendingMachineError: Error {
    case invalidSelection
    case insufficientFunds(coinsNeeded: Int)
    case outOfStock
}
func main(input: Employee, respondWith: (Employee?, Error?) -> Void) -> Void {
    // Return real error
    do{
        throw VendingMachineError.insufficientFunds(coinsNeeded: 5)
    } catch {
        respondWith(nil, error)
    }
}

wsk action update helloCodableError helloCodableError.swift swift:4.2

ok: updated action helloCodableError

wsk action invoke helloCodableError -b -p id 42 -p name Carlos

{
  "name": "helloCodableError",
  "response": {
    "result": {
      "error": "insufficientFunds(5)"
    },
    "status": "application error",
    "success": false
  }
}

Using Swift 4.2

To use as a docker action

wsk action update myAction myAction.swift --docker openwhisk/action-swift-v4.2:1.0.7

This works on any deployment of Apache OpenWhisk

To use on deployment that contains the runtime as a kind

To use as a kind action

wsk action update myAction myAction.swift --kind swift:4.2

Local development

./gradlew core:swift41Action:distDocker

This will produce the image whisk/action-swift-v4.2

Build and Push image

docker login
./gradlew core:swift41Action:distDocker -PdockerImagePrefix=$prefix-user -PdockerRegistry=docker.io

Deploy OpenWhisk using ansible environment that contains the kind swift:4.2 Assuming you have OpenWhisk already deploy locally and OPENWHISK_HOME pointing to root directory of OpenWhisk core repository.

Set ROOTDIR to the root directory of this repository.

Redeploy OpenWhisk

cd $OPENWHISK_HOME/ansible
ANSIBLE_CMD="ansible-playbook -i ${ROOTDIR}/ansible/environments/local"
$ANSIBLE_CMD setup.yml
$ANSIBLE_CMD couchdb.yml
$ANSIBLE_CMD initdb.yml
$ANSIBLE_CMD wipe.yml
$ANSIBLE_CMD openwhisk.yml

Or you can use wskdev and create a soft link to the target ansible environment, for example:

ln -s ${ROOTDIR}/ansible/environments/local ${OPENWHISK_HOME}/ansible/environments/local-swift
wskdev fresh -t local-swift

Testing

Install dependencies from the root directory on $OPENWHISK_HOME repository

./gradlew :common:scala:install :core:controller:install :core:invoker:install :tests:install

Using gradle to run all tests

./gradlew :tests:test

Using gradle to run some tests

./gradlew :tests:test --tests *ActionContainerTests*

Using IntelliJ:

Import project as gradle project.
Make sure the working directory is root of the project/repo

Using container image to test

To use as docker action push to your own Docker Hub account

docker tag whisk/action-swift-v4.2 $user_prefix/action-swift-v4.2
docker push $user_prefix/action-swift-v4.2

Then create the action using your image from Docker Hub

wsk action update myAction myAction.swift --docker $user_prefix/action-swift-v4.2

The $user_prefix is usually your Docker Hub user id.