Fuzzball Service

Fuzzball enables programmatic management of high performance compute resources.

Quick Start

Ensure that you have one of the two most recent minor versions of Go installed as per the installation instructions.

Configure your Go environment to pull private Go modules, by forcing go get to use git+ssh instead of https. This lets the Go compiler pull private dependencies using your machine's ssh keys.

git config --global url."ssh://[email protected]/sylabs".insteadOf "https://github.com/sylabs"

Starting with v1.13, the go command defaults to downloading modules from the public Go module mirror, and validating downloaded modules against the public Go checksum database. Since private Sylabs projects are not availble in the public mirror nor the public checksum database, we must tell Go about this. One way to do this is to set GOPRIVATE in the Go environment:

go env -w GOPRIVATE=github.com/sylabs

Install go-bindata to help generate the GraphQL schema later:

go get -u github.com/go-bindata/go-bindata/...

In order for Go to execute this binary the path in go env GOPATH needs to be included in your PATH.

To run the server, you'll need MongoDB, NATS, and Redis endpoints to point it to. If you don't have these already, you can start them with Docker easy enough:

docker run -d -p 27017:27017 mongo
docker run -d -p 4222:4222 nats
docker run -d -p 6379:6379 redis

Finally, start the server:

$ go generate ./... && go run ./cmd/server/
INFO[0000] starting                                      name="Fuzzball Server" org=Sylabs
INFO[0000] connecting to database
INFO[0000] database ready                                took=7.375268ms
INFO[0000] connecting to messaging system
INFO[0000] messaging system ready                        took=5.21203ms
INFO[0000] listening                                     addr="[::]:8080"

Testing

Unit Tests

Unit tests can be run like so:

go test ./...

Integration Tests

To run integration tests, you'll need MongoDB, NATS, and Redis endpoints to point it to. If you don't have these already, you can start them with Docker easy enough:

docker run -d -p 27017:27017 mongo
docker run -d -p 4222:4222 nats
docker run -d -p 6379:6379 redis

Integration tests can then be run like so:

go test -tags=integration ./...