tidwall cfc65a13f6 Refactor repository and build scripts
This commit includes updates that affects the build, testing, and
deployment of Tile38.

- The root level build.sh has been broken up into multiple scripts
  and placed in the "scripts" directory.

- The vendor directory has been updated to follow the Go modules
  rules, thus `make` should work on isolated environments. Also
  some vendored packages may have been updated to a later
  version, if needed.

- The Makefile has been updated to allow for making single
  binaries such as `make tile38-server`. There is some scaffolding
  during the build process, so from now on all binaries should be
  made using make. For example, to run a development version of
  the tile38-cli binary, do this:
     make tile38-cli && ./tile38-cli
  not this:
     go run cmd/tile38-cli/main.go

- Travis.CI docker push script has been updated to address a
  change to Docker's JSON repo meta output, which in turn fixes
  a bug where new Tile38 versions were not being properly pushed
  to Docker
2019-11-18 10:33:15 -07:00

1.2 KiB

Prequisites

  1. Go: https://golang.org/dl/
  2. Golint go get -u -v github.com/golang/lint/golint

Contributing

The workflow is pretty standard:

  1. Fork github.com/streadway/amqp
  2. Add the pre-commit hook: ln -s ../../pre-commit .git/hooks/pre-commit
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Run integration tests (see below)
  5. Implement tests
  6. Implement fixs
  7. Commit your changes (git commit -am 'Add some feature')
  8. Push to a branch (git push -u origin my-new-feature)
  9. Submit a pull request

Running Tests

The test suite assumes that:

Integration Tests

After starting a local RabbitMQ, run integration tests with the following:

env AMQP_URL=amqp://guest:guest@127.0.0.1:5672/ go test -v -cpu 2 -tags integration -race

All integration tests should use the integrationConnection(...) test helpers defined in integration_test.go to setup the integration environment and logging.