You need either Docker and make
, or go
and glide
in order to build traefik.
- You need
go
v1.5 - You need to set
export GO15VENDOREXPERIMENT=1
environment variable - You need
go-bindata
to be able to usego generate
command (needed to build) :go get github.com/jteeuwen/go-bindata/...
. - If you clone Træfɪk into something like
~/go/src/github.com/traefik
, yourGOPATH
variable will have to be set to~/go
: exportGOPATH=~/go
.
You need to run the binary
target. This will create binaries for Linux platform in the dist
folder.
$ make binary
docker build -t "traefik-dev:no-more-godep-ever" -f build.Dockerfile .
Sending build context to Docker daemon 295.3 MB
Step 0 : FROM golang:1.5
---> 8c6473912976
Step 1 : RUN go get github.com/Masterminds/glide
[...]
docker run --rm -v "/var/run/docker.sock:/var/run/docker.sock" -it -e OS_ARCH_ARG -e OS_PLATFORM_ARG -e TESTFLAGS -v "/home/emile/dev/go/src/github.com/containous/traefik/"dist":/go/src/github.com/containous/traefik/"dist"" "traefik-dev:no-more-godep-ever" ./script/make.sh generate binary
---> Making bundle: generate (in .)
removed 'gen.go'
---> Making bundle: binary (in .)
$ ls dist/
traefik*
The idea behind glide
is the following :
- when checkout(ing) a project, run
glide install
to install (go get …
) the dependencies in theGOPATH
. - if you need another dependency, import and use it in
the source, and run
glide get github.com/Masterminds/cookoo
to save it invendor
and add it to yourglide.yaml
.
$ glide install
# generate
$ go generate
# Simple go build
$ go build
# Using gox to build multiple platform
$ gox "linux darwin" "386 amd64 arm" \
-output="dist/traefik_{{.OS}}-{{.Arch}}"
# run other commands like tests
$ go test ./...
ok _/home/vincent/src/github/vdemeester/traefik 0.004s
You can run unit tests using the test-unit
target and the
integration test using the test-integration
target.
$ make test-unit
docker build -t "traefik-dev:your-feature-branch" -f build.Dockerfile .
# […]
docker run --rm -it -e OS_ARCH_ARG -e OS_PLATFORM_ARG -e TESTFLAGS -v "/home/vincent/src/github/vdemeester/traefik/dist:/go/src/github.com/containous/traefik/dist" "traefik-dev:your-feature-branch" ./script/make.sh generate test-unit
---> Making bundle: generate (in .)
removed 'gen.go'
---> Making bundle: test-unit (in .)
+ go test -cover -coverprofile=cover.out .
ok github.com/containous/traefik 0.005s coverage: 4.1% of statements
Test success
For development purpose, you can specifiy which tests to run by using:
# Run every tests in the MyTest suite
TESTFLAGS="-check.f MyTestSuite" make test-integration
# Run the test "MyTest" in the MyTest suite
TESTFLAGS="-check.f MyTestSuite.MyTest" make test-integration
# Run every tests starting with "My", in the MyTest suite
TESTFLAGS="-check.f MyTestSuite.My" make test-integration
# Run every tests ending with "Test", in the MyTest suite
TESTFLAGS="-check.f MyTestSuite.*Test" make test-integration
More: https://labix.org/gocheck
The documentation site is built with mkdocs
First make sure you have python and pip installed
$ python --version
Python 2.7.2
$ pip --version
pip 1.5.2
Then install mkdocs with pip
$ pip install mkdocs
To test documentaion localy run mkdocs serve
in the root directory, this should start a server localy to preview your changes.
$ mkdocs serve
INFO - Building documentation...
WARNING - Config value: 'theme'. Warning: The theme 'united' will be removed in an upcoming MkDocs release. See http://www.mkdocs.org/about/release-notes/ for more details
INFO - Cleaning site directory
[I 160505 22:31:24 server:281] Serving on http://127.0.0.1:8000
[I 160505 22:31:24 handlers:59] Start watching changes
[I 160505 22:31:24 handlers:61] Start detecting changes