README
¶
wr
experimental reimplementation of wr using TDD
Developers
To develop this code base, you should use TDD. To aid this, the test suite is written using GoConvey.
To install goconvey:
cd ~/somewhere_else
git checkout https://github.com/smartystreets/goconvey.git
go build
mv goconvey $GOPATH/bin/
To use goconvey:
cd ~/your_clone_of_this_repository
goconvey &
This will pop up a browser window which will aid in the red-green-refactor cycle.
To run the tests on the command line:
go test ./... or make test or make race
To run the benchmarks:
go test -run Bench -bench=. ./... or make bench
Before committing any code, you should make sure you haven't introduced any
linting errors. First install the linters:
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.39.0
Then:
make lint
Directories
¶
| Path | Synopsis |
|---|---|
|
package backoff is used to implement waiting for increasing periods of time between attempts at doing something.
|
package backoff is used to implement waiting for increasing periods of time between attempts at doing something. |
|
mock
package mock contains a mock implementation of backoff.Sleeper
|
package mock contains a mock implementation of backoff.Sleeper |
|
time
package time contains a real time-based implementation of backoff.Sleeper.
|
package time contains a real time-based implementation of backoff.Sleeper. |
|
package clog is used to do contextual logging with a global logger.
|
package clog is used to do contextual logging with a global logger. |
|
package fs is for interacting with file systems.
|
package fs is for interacting with file systems. |
|
local
package local contains a local implementation of VolumeUsageCalculator.
|
package local contains a local implementation of VolumeUsageCalculator. |
|
mock
package mock contains a mock implementation of VolumeUsageCalculator.
|
package mock contains a mock implementation of VolumeUsageCalculator. |
|
network
|
|
|
retry is used to keep trying something until it works.
|
retry is used to keep trying something until it works. |
Click to show internal directories.
Click to hide internal directories.