feat(core): add Dockerfile and instructions (#789)

Author: Sh4d1

.github/workflows/unit-tests.yaml

@@ -41,3 +41,15 @@ jobs:
           fetch-depth: 1
       - name: Build binaries
         run: ./scripts/build.sh
+
+  docker-tests:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 1
+    - name: Build image in Docker
+      run: docker build -t scaleway/cli .
+    - name: Test help command in docker
+      run: docker run -i scaleway/cli help

Dockerfile

@@ -0,0 +1,27 @@
+FROM golang:1.14-alpine as builder
+
+ENV BUILD_IN_DOCKER true
+
+# ca-certificates is needed to add the certificates on the next image
+# since it's FROM scratch, it does not have any certificates
+# bash is needed to run the build script
+RUN apk update && apk add --no-cache bash git ca-certificates && update-ca-certificates
+
+WORKDIR /go/src/github.com/scaleway/scaleway-cli
+
+COPY go.mod go.mod
+COPY go.sum go.sum
+RUN go mod download
+
+COPY scripts/ scripts/
+COPY cmd/ cmd/
+COPY internal/ internal/
+COPY .git/ .git/
+
+RUN ./scripts/build.sh
+
+FROM scratch
+WORKDIR /
+COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
+COPY --from=builder /go/src/github.com/scaleway/scaleway-cli/scw .
+ENTRYPOINT ["/scw"]

README.md

@@ -112,17 +112,32 @@ Then, run the installation and remove the `.deb` file:
 ```bash
 dpkg -i /tmp/scw.deb && rm -f /tmp/scw.deb
 ```
+-->
 
+<!-- TODO:
 ## With a Docker Image
 
+### Official releases (Coming soon..)
+
 For each release, we deliver a tagged image on the [Scaleway Docker Hub](https://hub.docker.com/r/scaleway/cli/tags) so can run `scw` in a sandboxed way: _Coming soon..._
 
 ```sh
 docker run scaleway/cli version
 ```
 -->
 
-## Build Locally
+# Examples
+
+## Create an instance server
+```
+scw instance server create type=DEV1-S image=ubuntu-bionic zone=fr-par-1 tags.0="scw-cli"
+```
+
+TODO: Add more examples here.
+
+## Build it yourself
+
+### Build Locally
 
 If you have a >= Go 1.13 environment, you can install the `HEAD` version to test the latest features or to [contribute](CONTRIBUTING.md).
 Note that this development version could include bugs, use [tagged releases](https://github.com/scaleway/scaleway-cli/releases/latest) if you need stability.
@@ -133,14 +148,19 @@ go get github.com/scaleway/scaleway-cli/cmd/scw
 
 Dependencies: We only use go [Go Modules](https://github.com/golang/go/wiki/Modules) with vendoring.
 
-# Examples
+### Build with Docker
 
-## Create an instance server
+You can build the `scw` CLI with Docker. If you have Docker installed, you can run:
+```sh
+docker build -t scaleway/cli .
 ```
-scw instance server create type=DEV1-S image=ubuntu-bionic zone=fr-par-1 tags.0="scw-cli"
+
+Once build, you can then use the CLI as you would run any image:
+```sh
+docker run -i --rm scaleway/cli
 ```
 
-TODO: Add more examples here.
+See more in-depth information about running the CLI in Docker [here](./docs/docker.md)
 
 # Tutorials
 

docs/docker.md

@@ -0,0 +1,63 @@
+# Using the CLI with Docker
+
+The CLI can be used in Docker without any problem.
+
+## Basic usage
+
+In order to use it you must mount the scaleway configuration file:
+```sh
+docker run -it --rm -v $HOME/.config/scw/config.yaml:/.config/scw/config.yaml:ro scaleway/cli
+```
+
+If you want to use `scw` instead of `docker run` you can add the following in your `~/.bashrc`:
+```bash
+scw() {
+    docker run -it --rm -v $HOME/.config/scw/config.yaml:/.config/scw/config.yaml:ro scaleway/cli "$@"
+}
+export -f scw
+```
+
+Or if you use ZSH, add the following in your `~/.zshrc`:
+```zsh
+scw() {
+    docker run -it --rm -v $HOME/.config/scw/config.yaml:/.config/scw/config.yaml:ro scaleway/cli $@
+}
+```
+
+## Autocompletion
+
+You can still use autocompletion while running the CLI in Docker, you just need to modify script generated by the CLI.
+For instance, `scw autocomplete script shell=bash` will return:
+```bash
+_scw() {
+	_get_comp_words_by_ref -n = cword words
+
+	output=$(scw autocomplete complete bash -- "$COMP_LINE" "$cword" "${words[@]}")
+	COMPREPLY=($output)
+	# apply compopt option and ignore failure for older bash versions
+	[[ $COMPREPLY == *= ]] && compopt -o nospace 2> /dev/null || true
+	return
+}
+complete -F _scw scw
+```
+
+And in your `~/.bashrc` you can add:
+```bash
+scw() {
+    docker run -it --rm -v $HOME/.config/scw/config.yaml:/.config/scw/config.yaml:ro scaleway/cli "$@"
+}
+export -f scw
+
+_scw() {
+	_get_comp_words_by_ref -n = cword words
+
+	output=$(docker run -i --rm -v $HOME/.config/scw/config.yaml:/.config/scw/config.yaml:ro scaleway/cli autocomplete complete bash -- "$COMP_LINE" "$cword" "${words[@]}")
+	COMPREPLY=($output)
+	# apply compopt option and ignore failure for older bash versions
+	[[ $COMPREPLY == *= ]] && compopt -o nospace 2> /dev/null || true
+	return
+}
+complete -F _scw scw
+```
+
+The trick is to remove the `-t` when using docker inside the completion function.

scripts/build.sh

@@ -1,10 +1,5 @@
 #!/bin/bash
 
-SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
-ROOT_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
-BIN_DIR="$ROOT_DIR/bin"
-
-mkdir -p $BIN_DIR
 
 LDFLAGS=(
    -w
@@ -15,9 +10,20 @@ LDFLAGS=(
    -X main.BuildDate="$(date -u '+%Y-%m-%dT%I:%M:%S%p')"
 )
 
-VERSION=$(go run cmd/scw/main.go -o json version | jq -r .version | tr . -)
-
 export CGO_ENABLED=0
-GOOS=linux  GOARCH=amd64 go build -ldflags "${LDFLAGS[*]}" -o "$BIN_DIR/scw-$VERSION-linux-x86_64"  cmd/scw/main.go
-GOOS=darwin GOARCH=amd64 go build -ldflags "${LDFLAGS[*]}" -o "$BIN_DIR/scw-$VERSION-darwin-x86_64" cmd/scw/main.go
-GOOS=windows GOARCH=amd64 go build -ldflags "${LDFLAGS[*]}" -o "$BIN_DIR/scw-$VERSION-windows-x86_64.exe" cmd/scw/main.go
+
+if [[ "${BUILD_IN_DOCKER}" == "true" ]]; then
+    GOOS=${TARGETOS} GOARCH=${TARGETARCH} go build -ldflags "${LDFLAGS[*]}" ./cmd/scw
+else
+    SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+    ROOT_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
+    BIN_DIR="$ROOT_DIR/bin"
+
+    mkdir -p $BIN_DIR
+    
+    VERSION=$(go run cmd/scw/main.go -o json version | jq -r .version | tr . -)
+    
+    GOOS=linux  GOARCH=amd64 go build -ldflags "${LDFLAGS[*]}" -o "$BIN_DIR/scw-$VERSION-linux-x86_64"  cmd/scw/main.go
+    GOOS=darwin GOARCH=amd64 go build -ldflags "${LDFLAGS[*]}" -o "$BIN_DIR/scw-$VERSION-darwin-x86_64" cmd/scw/main.go
+    GOOS=windows GOARCH=amd64 go build -ldflags "${LDFLAGS[*]}" -o "$BIN_DIR/scw-$VERSION-windows-x86_64.exe" cmd/scw/main.go
+fi