taco

taco 🌮🌮🌮

The next generation repository system for DLSS

Have questions? Check out the FAQ.

Development practices

Some agreements laid out by the development team are listed in the Development Practices document.

Go Local Development Setup

1. Install go (grab binary from here or use brew install go on Mac OSX).

2. Setup your Go workspace (where your Go code, binaries, etc. are kept together. See some helpful documentation here on the Go concept of workspaces: https://github.com/alco/gostart#1-go-tool-is-only-compatible-with-code-that-resides-in-a-workspace.):

   $ mkdir -p ~/go
   $ export GOPATH=~/go
   $ export PATH=~/go/bin:$PATH
   $ cd ~/go
   

   Your Go code repositories will reside within ~/go/src/... in the $GOPATH. Name these paths to avoid library clash, for example TACO Go code could be in ~/go/src/github.com/sul-dlss-labs/taco. This should be where your Github repository resides too.

3. In order to download the project code to ~/go/src/github.com/sul-dlss-labs/taco, from any directory in your ``$GOPATH`, run:

   $ go get github.com/sul-dlss-labs/taco
   

4. Handle Go project dependencies with the Go dep package:

   • Install Go Dep via brew install dep then brew upgrade dep (if on Mac OSX).
   • If your project's Gopkg.toml and Gopkg.lock have not yet been populated, you need to add an inferred list of your dependencies by running dep init.
   • If your project has those file populated, then make sure your dependencies are synced via running dep ensure.
   • If you need to add a new dependency, run dep ensure -add github.com/pkg/errors. This should add the dependency and put the new dependency in your Gopkg.* files.

5. Set up Localstack to Fake AWS Services Locally

6. Setup Configuration Variables

   • Configuration variables for development default to point at Localstack services. You can override the default configuration by using environment variables. See the list of the environment variables in config
   • If you want to report failures to HoneyBadger set HONEYBADGER_API_KEY=aaaaaaaa

Running the Go Code locally without a build

$ AWS_REGION=localstack AWS_ACCESS_KEY_ID=999999 AWS_SECRET_KEY=1231 go run main.go

Note: we explain the AWS keys usage below.

Building the TACO Binary

Building just the TACO Docker container

Start external services using Localstack then run:

$ docker build -t taco .
$ docker run -e AWS_REGION=localstack -e AWS_ACCESS_KEY_ID=999999 -e AWS_SECRET_KEY=1231 -p 8080:8080 taco

Building TACO Docker container along with the Localstack services

Running docker-compose up will build and run TACO in the foreground with the localstack services in the background. It will also create a directory on your local machine at /tmp/localstack/data that stores persistent data for dynamodb, kinesis, and S3. It is safe to remove that directory and rerun docker-compose up to reset for testing with new data.

$ docker-compose up

To stop and remove containers, networks, images, and volumes created by docker-compose up run:

$ docker-compose down

Build for the local OS

This will create a binary in your path that you can then run the application with.

$ go build -o tacod main.go
$ ./tacod

Running the TACO Binary

Now start the API server (passing in API keys; these can be fake and are only required for localstack):

$ AWS_REGION=localstack AWS_ACCESS_KEY_ID=999999 AWS_SECRET_KEY=1231 ./tacod

Then you can interact with it using curl:

$ curl -H "Content-Type: application/json" -d@examples/request.json http://localhost:8080/v1/resource

it will return a response like:

{"id":"fe1f66a9-5285-4b28-8240-0482c8fff6c7"}

Then you can use the returned identifier to retrieve the original:

$ curl -H "Content-Type: application/json"  http://localhost:8080/v1/resource/fe1f66a9-5285-4b28-8240-0482c8fff6c7

You can then update the resource with a PATCH request:

$ curl -X PATCH -H "Content-Type: application/json" -d@examples/update_request.json http://localhost:8080/v1/resource/fe1f66a9-5285-4b28-8240-0482c8fff6c7

Create an uploaded file by doing:

$ curl -F "[email protected];type=application/pdf" http://localhost:8080/v1/file

Testing

Testing and test driven development is outlined in the Testing Guidelines & Framework documentation.

API Code Structure

We use go-swagger to generate the API code within the generated/ directory.

We connect the specification-generated API code to our own handlers defined with handlers/. Handlers are where we add our own logic for processing requests.

Our handlers and the generated API code is connected within main.go, which is the file to start the API.

Install Go-Swagger

The API code is generated from swagger.yml using go-swagger library. As this is not used in the existing codebase anywhere currently, you'll need to install the go-swagger library before running these commands (commands for those using Mac OSX):

$ brew tap go-swagger/go-swagger
$ brew install go-swagger
$ brew upgrade go-swagger

This should give you the swagger binary command in your $GOPATH and allow you to manage versions better (TBD write this up). The version of your go-swagger binary is 0.13.0 (run swagger version to check this).

Nota Bene on go-swagger install from source

If instead of brew, you decide to install go-swagger from source (i.e. go get -u github.com/go-swagger/go-swagger/cmd/swagger), you will be running the library at its Github dev branch. You will need to change into that library (cd $GOPATH/src/github.com/go-swagger/go-swagger) and checkout from Github the latest release (git checkout tags/0.13.0). Then you will need to run go install github.com/go-swagger/go-swagger/cmd/swagger to generate the go-swagger binary in your $GOPATH/bin.

To generate the API code

There appears to be no best way to handle specification-based re-generation of the generated/ API code, so the following steps are recommended:

$ git rm -rf generated/
$ mkdir generated
$ swagger generate server -t generated --exclude-main

To generate the validator ```

go generate

This will serialize all the json in the maps/ directory into validators/maps.go

Non-generated code

Anything outside of generated/ is our own code and should not be touched by a regeneration of the API code from the Swagger specification.

SWAGGER Generated Documentation

To see the SWAGGER generated documentation, go to https://sul-dlss-labs.github.io/taco/. This is automatically generated off of the Swagger spec in this repository on the master branch.

If you want to generate this documentation locally, you can run the following:

$ swagger serve swagger.yml

This should prompt you to your web browser for the HTML generated docs.