Skip to content

Latest commit

 

History

History
163 lines (107 loc) · 4.23 KB

README.md

File metadata and controls

163 lines (107 loc) · 4.23 KB
Raw

Roster

A demo project for understanding Go kit

Installation

  1. Install PostgreSQL
  2. Create a database called "roster"
$ createdb roster
  1. Install Go, following instructions at https://golang.org/doc/install or, for Mac, you can just use homebrew:
$ brew install go
$ brew install protobuf
$ # Add the below line to your appropriate "rc" file for your shell: (bashrc, zshrc, .fishrc, etc)
$ export GOPATH=$HOME/go; export PATH=$PATH:$GOPATH/bin

Note: Older installation guides indicate setting more environment variables than necessary. The page at https://github.com/golang/go/wiki/SettingGOPATH contains current information on Go's environment variables.

  1. Follow instructions at https://grpc.io/docs/quickstart/go.html to install gRPC and Protocol Buffers 3. Note that, for the Protocol Buffers step, if you use homebrew on a Mac you can use:
$ brew install protobuf
  1. Get the code
$ go get -u github.com/hoop33/roster
$ cd $GOPATH/src/github.com/hoop33/roster
$ make deps
$ dep ensure -update
$ make
  1. Ensure postgress is working correctly.
$ psql #logs in as super user
\connect roster
psql=# CREATE USER <db user> WITH SUPERUSER PASSWORD <'password'>;
psql=#\q
  1. Run the app, which will create the players table
$ ROSTER_USER=<db user> ROSTER_PASSWORD=<db password> ./roster

(Optional) Seed the Database

  1. Follow instructions to install https://github.com/hoop33/jags
  2. $ jags | sed 's/,,/,N\/A,/g' | sed 's/,R,/,0,/g' > players.csv
  3. Run the following SQL:
COPY players(name,number,position,height,weight,age,experience,college) 
FROM '<path to file>/players.csv' DELIMITER ',' CSV HEADER;

Troubleshooting

If you see an error around grpc libraries, e.g., :

package google.golang.org/grpc/grpclb/grpc_lb_v1/messages: cannot find package "google.golang.org/grpc/grpclb/grpc_lb_v1/messages" in any of:
	/usr/local/Cellar/go/1.10.3/libexec/src/google.golang.org/grpc/grpclb/grpc_lb_v1/messages (from $GOROOT)
	/Users/<user>/go/src/google.golang.org/grpc/grpclb/grpc_lb_v1/messages (from $GOPATH)

You may have a mismatch between the grpc libraries in your vendored files and the ones that protoc is picking up. To get them in sync, try getting the latest for both:

$ go get -u google.golang.org/grpc
$ cd $GOPATH/src/github.com/hoop33/roster
$ dep ensure -update google.golang.org/grpc

See a discussion at grpc/grpc-go#581

Walkthrough

For each step, check out the tag, build the app, and run:

$ git checkout <tag>
$ make && ./roster

Step 1: A Simple Service (step_1)

Nothing Go kit-related here; just a simple Go command-line service around a database table.

Step 2: Add a Logger (step_2)

We use Go kit's built in logger here, but we could have used logrus or any other logger.

Step 3: Add Endpoints (step_3)

This is where things get a little interesting, Go kit-wise. An endpoint is a Go kit function that takes a request and returns a response, callable from a Go kit transport.

Step 4: Add an HTTP Transport (step_4)

And now we have a ReST service around our database table, powered by Go kit.

Step 5: Add a Protocol Buffer Definition (step_5)

Nothing new integrated into our application in this step. We define our protocol buffers.

Step 6: Add a gRPC Transport (step_6)

Now we can access our data over gRPC.

Building

The make file has various targets. To quickly build, run:

$ make quick

To run all the linters and tests, run:

$ make

To run a test coverage report, run:

$ make coverage

Presentation

The accompanying presentation can be found at presentation/microservices_with_gokit.md and is designed to be viewed with Deckset.

Acknowledgments

Apologies for any I've missed.

License

Copyright © 2018 Rob Warner

Licensed under the MIT License