chore: fix spelling (#148)

5 files changed
tree: 0e7a344aa1af050c5fe4eec2cea95a925d083b99
  1. .gitignore
  2. .travis.yml
  3. CHANGELOG.md
  4. CONTRIBUTING.md
  5. LICENSE.txt
  6. Makefile
  7. NOTICE.txt
  8. README.md
  9. example/
  10. go.mod
  11. go.sum
  12. tools/
  13. whisk/
  14. wski18n/
README.md

Openwhisk Client Go

License Build Status

This project openwhisk-client-go is a Go client library to access the Openwhisk API.


Building the project

Prerequisites

The Openwhisk Go Client library requires you to Download and install GoLang onto your local machine.

Note Go version 1.15 or higher is recommended

Make sure you select the package that fits your local environment, and set the GOPATH environment variable.

Download the source code from GitHub

As the code is managed using GitHub, it is easiest to retrieve the code using the git clone command.

If you just want to build the code and do not intend to be a Contributor, you can clone the latest code from the Apache repository:

git clone git@github.com:apache/openwhisk-client-go

You can also specify a release (tag), if you do not want the latest code, by using the --branch <tag> flag. For example, you can clone the source code for the tagged 1.1.0 release

git clone --branch 1.1.0 git@github.com:apache/openwhisk-client-go

You can also pull the code from a fork of the repository. If you intend to become a Contributor to the project, read the section Contributing to the project below on how to setup a fork.

Building using go build

Change into the cloned project directory and use the following command to build all packages:

$ go build -v ./...

or simply build just the whisk commands:

$ go build -v ./whisk

Note: There is no main function in this project as the ./whisk packages are treated together as a client library.

Testing using go test

Open a terminal, change into the project directory and use the following command to run the unit tests:

$ go test -v ./... -tags=unit

You should see all the unit tests passed; if not, please log an issue for us.


Configuration

This Go client library is used to access the OpenWhisk API, so please make sure you have an OpenWhisk service running somewhere available for you to run this library.

We use a configuration file called wskprop to specify all the parameters necessary for this Go client library to access the OpenWhisk services. Make sure you create or edit the file ~/.wskprops, and add the mandatory parameters APIHOST, APIVERSION, NAMESPACE and AUTH.

  • The parameter APIHOST is the OpenWhisk API hostname.

    • If you are using a local quick start standalone, OpenWhisk services APIHOST will look like http://localhost:3233
    • If you are using IBM cloud functions as your provider, APIHOST will look like <region>.functions.cloud.ibm.com where region can be us-east, us-south or any additional regions
  • The parameter APIVERSION is the version of OpenWhisk API to be used to access the OpenWhisk resources.

  • The parameter NAMESPACE is the OpenWhisk namespace used to specify the OpenWhisk resources about to be accessed.

  • The parameter AUTH is the authentication key used to authenticate the incoming requests to the OpenWhisk services.

For more information regarding the REST API of OpenWhisk, please refer to OpenWhisk REST API.

Usage

import "github.com/apache/openwhisk-client-go/whisk"

Construct a new whisk client, then use various services to access different parts of the whisk api. For example to get the hello package actions:

client, _ := whisk.NewClient(http.DefaultClient, nil)
actions, resp, err := client.Actions.List("hello", nil)

Some API methods have optional parameters that can be passed. For example, to list the first 10 actions of the hello package:

client, _ := whisk.NewClient(http.DefaultClient, nil)

options := &whisk.ActionListOptions{
  Limit: 10,
  Skip: 0,
}

actions, resp, err := client.Actions.List("hello", options)

By default, this Go client library is automatically configured by the configuration file wskprop. The parameters of APIHOST, APIVERSION, NAMESPACE and AUTH will be used to access the OpenWhisk services.

In addition, it can also be configured by passing in a *whisk.Config object as the second argument to whisk.New( ... ). For example:

config := &whisk.Config{
  Host: "<APIHOST>",
  Version: "<APIVERSION>",
  Namespace: "<NAMESPACE>",
  AuthToken: "<AUTH>",
}
client, err := whisk.Newclient(http.DefaultClient, config)

Example

You need to have an OpenWhisk service accessible, to run the following example.

package main

import (
  "os"
  "fmt"
  "net/http"

  "github.com/apache/openwhisk-client-go/whisk"
)

func main() {
  client, err := whisk.NewClient(http.DefaultClient, nil)
  if err != nil {
    fmt.Println(err)
    os.Exit(-1)
  }

  options := &whisk.ActionListOptions{
    Limit: 10,
    Skip: 0,
  }

  actions, resp, err := client.Actions.List("", options)
  if err != nil {
    fmt.Println(err)
    os.Exit(-1)
  }

  fmt.Println("Returned with status: ", resp.Status)
  fmt.Printf("Returned actions: \n%+v", actions)

}

Then run it with the go tool:

$ cd example
$ go run example_list_actions.go

If the openWhisk service is available and your configuration is correct, you should receive the status and the actions with the above example.


Contributing to the project

Git repository setup

  1. Fork the Apache repository

    If you intend to contribute code, you will want to fork the apache/openwhisk-client-go repository into your github account and use that as the source for your clone.

  2. Clone the repository from your fork:

    git clone git@github.com:${GITHUB_ACCOUNT_USERNAME}/openwhisk-client-go.git
    
  3. Add the Apache repository as a remote with the upstream alias:

    git remote add upstream git@github.com:apache/openwhisk-client-go
    

    You can now use git push to push local commit changes to your origin repository and submit pull requests to the upstream project repository.

  4. Optionally, prevent accidental pushes to upstream using this command:

    git remote set-url --push upstream no_push
    

Be sure to Sync your fork before starting any contributions to keep it up-to-date with the upstream repository.

Adding new dependencies

Please use go get to add new dependencies to the go.mod file:

go get -u github.com/project/libname@v1.2.0

Please avoid using commit hashes for referencing non-OpenWhisk libraries.

Updating dependency versions

Although you might be tempted to edit the go.mod file directly, please use the recommended method of using the go get command:

go get -u github.com/project/libname  # Using "latest" version
go get -u github.com/project/libname@v1.1.0 # Using tagged version
go get -u github.com/project/libname@aee5cab1c  # Using a commit hash

Updating Go version

Although you could edit the version directly in the go.mod file, it is better to use the go edit command:

go mod edit -go=1.15