sdk

command module
v0.0.0-...-d7d38ad Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 17, 2019 License: MIT Imports: 1 Imported by: 0

README

Flywheel SDK

An SDK for interaction with a remote Flywheel instance in Golang!

GoDoc Report Card Build status

Building

git clone https://github.com/flywheel-io/sdk workspace/src/flywheel.io/sdk
ln -s workspace/src/flywheel.io/sdk sdk

./sdk/make.sh

Testing

The simplest way to run the test suite is to install the CircleCI runner and use it from the SDK folder:

circleci build

If you want to test manually, you can configure the test suite with these environment variables:

  • SdkTestKey: Set this to an API key. Defaults to localhost:8443:change-me.
  • SdkTestMongo: Set this to a mongo connection string. If not set, database tests are skipped.
  • SdkTestDebug: Setting this to any value will cause each test to print an HTTP/1.1 representation of each request. Best used to debug a single failing test.

To run the integration test suite against a running API:

export SdkTestKey="localhost:8443:some-api-key"

./sdk/make.sh test

Or, to run a single test:

./sdk/make.sh test -run TestSuite/TestGetConfig

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL