Building, Testing, and Contributing
In the past, ddev would be checked out in the $GOPATH, but as of go 1.11, this is no longer appropriate. You should check out your fork outside the $GOPATH.
Build/test/check static analysis with:
The binaries are built into .gotmp/bin; although normal command-line
go build or
go install will work (and everything works fine with IDEs like Goland or vscode) the official build technique is via
make which uses a completely consistent golang-build-container so that the build is identical no matter what machine or OS it might be built on.
Normal test invocation is just
make test. Run a single test with an invocation like
go test -v -run TestDevAddSites ./pkg/... or
make testpkg TESTARGS="-run TestDevAddSites".
To see which ddev commands the tests are executing, set the environment variable DRUD_DEBUG=true.
Use GOTEST_SHORT=true to run just one CMS in each test.
Docker container development
The docker containers that ddev uses are included in the containers/ directory:
- containers/ddev-webserver: Provides the web servers (the "web" container).
- containers/ddev-dbserver: Provides the "db" container.
- containers/ddev-bgsync: Fast web directory syncing
- containers/phpmyadmin: Provides the phpmyadmin (dba) container
- containers/ddev-router: The router image
When changes are made to a container, they have to be temporarily pushed to a tag that is preferably the same as the branch name of the PR, and the tag updated in pkg/version/version.go. Just ask if you need a container pushed to support a PR.