Skip to content
master
Switch branches/tags
Code
This branch is 14 commits ahead, 30 commits behind EconomistDigitalSolutions:master.
Contribute
Fetch upstream

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

GOBERRY - Economist vanilla microservice template.

SETUP

  1. Clone this repository into your GOPATH.
  2. Run godep restore to get the minimal dependencies.
  3. Drop the .git folder.
  4. Design your RAML API interface.
  5. Run raml-gen which will generate HTTP handlers for your service.
  6. Copy the generated handlers_gen.go file to handlers.go.
  7. Run git init.
  8. Run go install to build the binary, run it in the app root.
  9. The ramlapi package will wire up your endpoints to the handlers.
  10. Now build out your service.

12-FACTOR GOODNESS

We are aiming to make our microservices 12 factor

  • Create a .env file for environment variables and drop into the project root. The godotenv package will then parse this file and set environment variables for everything contained in this file.

MAKEFILE

The Makefile provides the following:

  • gomkbuild: build the application binary.
  • gomkinstall: install the application binary.
  • buildstamp: build the appication binary, and when the binary is run with the --version flag, log build date and build commit hash (default stdout).
    • installstamp: install the appication binary, and when the binary is run with the --version flag, log build date and build commit hash (default stdout).
  • gomkxbuild: build all cross-platform binaries, using gox.
  • gomkclean: clean the project directory.
  • vet: run go tool vet on each source file.
  • lint: run golint on each source file.
  • fmt: run go fmt on the entire project.
  • test: run go test for all packages in the project.
  • race: run go test with race detection in all packages in the project.
  • cover: run tests with coverage report in all pkgs in the project.
  • printvars: print all variables defined in the Makefile.

BUILD INFORMATION

To build the service and drop build date information, build as follows:

go build -ldflags "-X main.buildstamp `date -u '+%Y-%m-%d_%I:%M:%S%p'` -X main.githash `git rev-parse HEAD`"

Then run --version=yes

ASSET BUNDLING

We use gobundle to bundle assets (for now, just api.raml) with the binary. To bundle an updated RAML file:

  • Make sure BUNDLE_ASSETS=1 is included in your .env file.

Run go get github.com/alecthomas/gobundle/gobundle

Run gobundle --compress --uncompress_on_init --package=main --target=bundle.go "api.raml"

By default this is off in goberry so you can adapt your RAML file as necessary when you create a new service and then bundle it up.

TESTS

Run make test for boring old black and white test output.

Run pride to get nicely colorized test output.

SERVICE DISCOVERY

The goconsul.json file is present to hook up to a package being built to plug into consul

METRICS

This codebase provides low level metrics using the built-in expvar package. Simply navigate to /debug/vars to see basic memory allocation and stack use information.

About

No description, website, or topics provided.

Resources

License

Packages

No packages published