eac315c6ec
The macOS/Linux output when logging out from a registry that you're not logged into is different to that of Windows. As the login test doesn't really test if the registry login works, the test now just checks that the command is properly parsed. Signed-off-by: Christopher Crone <christopher.crone@docker.com> |
||
|---|---|---|
| .dependabot | ||
| .github | ||
| azure | ||
| backend | ||
| cli | ||
| client | ||
| compose | ||
| config | ||
| containers | ||
| context | ||
| docs | ||
| errdefs | ||
| example | ||
| formatter | ||
| local | ||
| metrics | ||
| multierror | ||
| progress | ||
| protos | ||
| server | ||
| tests | ||
| .dockerignore | ||
| .gitattributes | ||
| .gitignore | ||
| .golangci.yml | ||
| CHANGELOG.md | ||
| Dockerfile | ||
| Makefile | ||
| README.md | ||
| builder.Makefile | ||
| go.mod | ||
| go.sum | ||
README.md
Docker API
Dev Setup
The recommended way is to use the main Makefile that runs everything inside a container.
If you don't have or want to use Docker for building you need to make sure you have all the needed tools installed locally:
- go 1.14
- protoc
go get github.com/golang/protobuf/protoc-gen-go@v1.4.1go get golang.org/x/tools/cmd/goimportsgo get github.com/golangci/golangci-lint/cmd/golangci-lint@v1.26.0
And then you can call the same make targets but you need to pass it the builder.Makefile (make -f builder.Makefile).
The new CLI delegates to the classic docker for default contexts ; delegation is done to com.docker.cli.
make moby-cli-linkwill create acom.docker.clilink in/usr/local/binif you don't already have it from Docker Desktop
Building the project
$ make
This will make the cli with all backends enabled. make cross on the other hand will cross-compile the cli without the
example and local backend. We use make cross to build for our release, hence the exclusion of those backends. You can
still cross-compile with all backends enabled: BUILD_TAGS=example,local make cross.
If you make changes to the .proto files, make sure to make protos to generate go code.
Tests
Unit tests
make test
If you need to update a golden file simply do go test ./... -test.update-golden.
e2e tests
make e2e-local
This requires a local Docker Engine running
AZURE_TENANT_ID="xxx" AZURE_CLIENT_ID="yyy" AZURE_CLIENT_SECRET="yyy" make e2e-aci
This requires azure service principal credentials to login to azure.
To get the values to be set in local environment variables, you can create a new service principal once you're logged in azure (with docker login azure)
az ad sp create-for-rbac --name 'MyTestServicePrincipal' --sdk-auth
Running the ACI e2e tests will override your local login, the service principal credentials use a token that cannot be refreshed automatically.
You might need to run again docker login azure to properly use the command line after running ACI e2e tests.
You can also run a single ACI test from the test suite:
TESTIFY=TestACIRunSingleContainer AZURE_TENANT_ID="xxx" AZURE_CLIENT_ID="yyy" AZURE_CLIENT_SECRET="yyy" make e2e-aci
Release
To create a new release:
- check that the CI is green on the master commit you want to release
- simply create a new tag of the form vx.y.z, following existing tags, and push the tag
Pushing the tag will automatically create a new release and make binaries (mac, win, linux) available for download.
Note: Linux binaries are not automatically copied to /docker/aci-integration-beta, if you want to make the linux binary publically available, you'll need to manually create a release in aci-integration-beta and upload the binary. For Desktop integration, you need to make a PR in /docker/pinata and update the cli release number here