Merge pull request #700 from rumpl/feat-remove-experimental

Remove experimental because it's not used

Author: rumpl

BUILDING.md

@@ -66,16 +66,6 @@ make test-e2e                   # run the end-to-end tests
 Vendoring of external imports uses the [`dep`](https://github.com/golang/dep) tool.
 Please refer to its documentation if you need to update a dependency.
 
-### Experimental
-
-Just add the `EXPERIMENTAL=on` flag before invoking a build target:
-```console
-$ make EXPERIMENTAL=on bin/docker-app
-$ ./bin/docker-app version
-...
-Experimental: on
-```
-
 ## Build using Docker
 
 If you don't have Go installed but Docker is present, you can also use

Dockerfile

@@ -2,17 +2,17 @@ FROM dockercore/golang-cross:1.12.9@sha256:3ea9dcef4dd2c46d80445c0b22d6177817f4c
 ENV     DISABLE_WARN_OUTSIDE_CONTAINER=1
 
 RUN apt-get install -y -q --no-install-recommends \
-    coreutils \
-    util-linux \
-    uuid-runtime
+  coreutils \
+  util-linux \
+  uuid-runtime
 
 WORKDIR /go/src/github.com/docker/cli
 
 RUN git clone https://github.com/docker/cli . && git checkout a1b83ffd2cbeefc0752e5aa7a543d49c1ddfd2cb
 
 ARG GOPROXY
 RUN make binary-osx binary-windows binary && \
- cp build/docker-linux-amd64 /usr/bin/docker
+  cp build/docker-linux-amd64 /usr/bin/docker
 
 WORKDIR /go/src/github.com/docker/app/
 
@@ -21,35 +21,33 @@ FROM build AS dev
 ENV PATH=${PATH}:/go/src/github.com/docker/app/bin/
 ARG DEP_VERSION=v0.5.4
 RUN curl -o /usr/bin/dep -L https://github.com/golang/dep/releases/download/${DEP_VERSION}/dep-linux-amd64 && \
-    chmod +x /usr/bin/dep
+  chmod +x /usr/bin/dep
 ARG GOTESTSUM_VERSION=v0.3.4
 ARG GOPROXY
 RUN mkdir $GOPATH/src/gotest.tools && \
-    git clone -q https://github.com/gotestyourself/gotestsum $GOPATH/src/gotest.tools/gotestsum && \
-    cd $GOPATH/src/gotest.tools/gotestsum && \
-    git -C $GOPATH/src/gotest.tools/gotestsum checkout -q $GOTESTSUM_VERSION && \
-    GO111MODULE=on GOOS=linux   go build -o /usr/local/bin/gotestsum-linux       gotest.tools/gotestsum && \
-    GO111MODULE=on GOOS=darwin  go build -o /usr/local/bin/gotestsum-darwin      gotest.tools/gotestsum && \
-    GO111MODULE=on GOOS=windows go build -o /usr/local/bin/gotestsum-windows.exe gotest.tools/gotestsum && \
-    ln -s gotestsum-linux /usr/local/bin/gotestsum
+  git clone -q https://github.com/gotestyourself/gotestsum $GOPATH/src/gotest.tools/gotestsum && \
+  cd $GOPATH/src/gotest.tools/gotestsum && \
+  git -C $GOPATH/src/gotest.tools/gotestsum checkout -q $GOTESTSUM_VERSION && \
+  GO111MODULE=on GOOS=linux   go build -o /usr/local/bin/gotestsum-linux       gotest.tools/gotestsum && \
+  GO111MODULE=on GOOS=darwin  go build -o /usr/local/bin/gotestsum-darwin      gotest.tools/gotestsum && \
+  GO111MODULE=on GOOS=windows go build -o /usr/local/bin/gotestsum-windows.exe gotest.tools/gotestsum && \
+  ln -s gotestsum-linux /usr/local/bin/gotestsum
 # Source for cmd/test2json is part of the Go distribution and is
 # therefore available in the base image.
 RUN GOOS=linux   go build -o /usr/local/bin/test2json-linux       cmd/test2json && \
-    GOOS=darwin  go build -o /usr/local/bin/test2json-darwin      cmd/test2json && \
-    GOOS=windows go build -o /usr/local/bin/test2json-windows.exe cmd/test2json
+  GOOS=darwin  go build -o /usr/local/bin/test2json-darwin      cmd/test2json && \
+  GOOS=windows go build -o /usr/local/bin/test2json-windows.exe cmd/test2json
 RUN go get -d gopkg.in/mjibson/esc.v0 && \
-    cd /go/src/github.com/mjibson/esc && \
-    go build -v -o /usr/bin/esc . && \
-    rm -rf /go/src/* /go/pkg/* /go/bin/*
+  cd /go/src/github.com/mjibson/esc && \
+  go build -v -o /usr/bin/esc . && \
+  rm -rf /go/src/* /go/pkg/* /go/bin/*
 COPY . .
 
 FROM dev AS cross
-ARG EXPERIMENTAL="off"
 ARG TAG="unknown"
-RUN make EXPERIMENTAL=${EXPERIMENTAL} TAG=${TAG} cross
+RUN make TAG=${TAG} cross
 
 FROM cross AS e2e-cross
-ARG EXPERIMENTAL="off"
 ARG TAG="unknown"
 # Run e2e tests
-RUN make EXPERIMENTAL=${EXPERIMENTAL} TAG=${TAG} e2e-cross
+RUN make TAG=${TAG} e2e-cross

Dockerfile.invocation-image

@@ -3,18 +3,17 @@ ARG ALPINE_VERSION=3.10.1
 FROM golang:1.13.0 AS build
 
 RUN apt-get update -qq && apt-get install -y -q --no-install-recommends \
-    coreutils \
-    util-linux \
-    uuid-runtime
+  coreutils \
+  util-linux \
+  uuid-runtime
 
 WORKDIR /go/src/github.com/docker/app/
 
 COPY . .
-ARG EXPERIMENTAL="off"
 ARG TAG="unknown"
-RUN make EXPERIMENTAL=${EXPERIMENTAL} BUILD_TAG=${BUILD_TAG} TAG=${TAG} bin/cnab-run
+RUN make BUILD_TAG=${BUILD_TAG} TAG=${TAG} bin/cnab-run
 
- # local cnab invocation image
+# local cnab invocation image
 FROM alpine:${ALPINE_VERSION} as invocation
 RUN apk add --no-cache ca-certificates && adduser -S cnab
 USER cnab

Jenkinsfile

@@ -76,12 +76,10 @@ pipeline {
                             ansiColor('xterm') {
                                 sh 'make -f docker.Makefile save-invocation-image'
                                 sh 'make -f docker.Makefile INVOCATION_IMAGE_TAG=$TAG-coverage OUTPUT=coverage-invocation-image.tar save-invocation-image-tag'
-                                sh 'make -f docker.Makefile INVOCATION_IMAGE_TAG=$TAG-coverage-experimental OUTPUT=coverage-experimental-invocation-image.tar save-invocation-image-tag'
                             }
                             dir('_build') {
                                 stash name: 'invocation-image', includes: 'invocation-image.tar'
                                 stash name: 'coverage-invocation-image', includes: 'coverage-invocation-image.tar'
-                                stash name: 'coverage-experimental-invocation-image', includes: 'coverage-experimental-invocation-image.tar'
                             }
                         }
                     }
@@ -90,7 +88,6 @@ pipeline {
                             dir('src/github.com/docker/app') {
                                 sh 'docker rmi docker/cnab-app-base:$TAG'
                                 sh 'docker rmi docker/cnab-app-base:$TAG-coverage'
-                                sh 'docker rmi docker/cnab-app-base:$TAG-coverage-experimental'
                             }
                             deleteDir()
                         }
@@ -130,34 +127,6 @@ pipeline {
                         }
                     }
                 }
-                stage("Coverage (experimental)") {
-                    agent { label 'ubuntu-1804 && x86_64 && overlay2' }
-                    steps {
-                        dir('src/github.com/docker/app') {
-                            checkout scm
-                            dir('_build') {
-                                unstash "coverage-experimental-invocation-image"
-                                sh 'docker load -i coverage-experimental-invocation-image.tar'
-                            }
-                            ansiColor('xterm') {
-                                sh 'make EXPERIMENTAL=on TEST_RESULTS_PREFIX="experimental-" -f docker.Makefile TAG=$TAG-coverage-experimental coverage-run || true'
-                                sh 'make EXPERIMENTAL=on TEST_RESULTS_PREFIX="experimental-" -f docker.Makefile TAG=$TAG-coverage-experimental coverage-results'
-                            }
-                        }
-                    }
-                    post {
-                        always {
-                            dir('src/github.com/docker/app/_build/test-results') {
-                                sh '[ ! -e experimental-unit-coverage.xml ] || sed -i -E -e \'s,"github.com/docker/app","unit/experimental",g; s,"github.com/docker/app/([^"]*)","unit/experimental/\\1",g\' experimental-unit-coverage.xml'
-                                sh '[ ! -e experimental-e2e-coverage.xml ] || sed -i -E -e \'s,"github.com/docker/app/e2e","e2e/experimental",g\' experimental-e2e-coverage.xml'
-                                archiveArtifacts '*.xml'
-                                junit '*.xml'
-                            }
-                            sh 'docker rmi docker/cnab-app-base:$TAG-coverage-experimental'
-                            deleteDir()
-                        }
-                    }
-                }
                 stage("Test Linux") {
                     agent { label 'ubuntu-1804 && x86_64 && overlay2' }
                     environment {

Makefile

@@ -8,15 +8,9 @@ ifeq ($(BUILDTIME),)
   $(warning unable to set BUILDTIME. Set the value manually)
 endif
 
-BUILDTAGS=""
-ifeq ($(EXPERIMENTAL),on)
-  BUILDTAGS="experimental"
-endif
-
 LDFLAGS := "-s -w \
   -X $(PKG_NAME)/internal.GitCommit=$(COMMIT) \
   -X $(PKG_NAME)/internal.Version=$(TAG)      \
-  -X $(PKG_NAME)/internal.Experimental=$(EXPERIMENTAL) \
   -X $(PKG_NAME)/internal.BuildTime=$(BUILDTIME)"
 
 EXEC_EXT :=

README.md

@@ -382,11 +382,3 @@ Commands:
 
 Run 'docker app COMMAND --help' for more information on a command.
 ```
-
-## Experimental
-
-Some commands are flagged as experimental and will remain in this state until
-they mature. These commands are only accessible using an experimental binary.
-Feel free to test these commands and give us some feedback!
-
-See [BUILDING.md/Experimental](BUILDING.md#experimental).

docker.Makefile

@@ -14,7 +14,7 @@ E2E_CROSS_CTNR_NAME := $(BIN_NAME)-e2e-cross-$(TAG)
 COV_CTNR_NAME := $(BIN_NAME)-cov-$(TAG)
 SCHEMAS_CTNR_NAME := $(BIN_NAME)-schemas-$(TAG)
 
-BUILD_ARGS=--build-arg EXPERIMENTAL=$(EXPERIMENTAL) --build-arg TAG=$(TAG) --build-arg COMMIT=$(COMMIT) --build-arg ALPINE_VERSION=$(ALPINE_VERSION) --build-arg GOPROXY=$(GOPROXY)
+BUILD_ARGS=--build-arg TAG=$(TAG) --build-arg COMMIT=$(COMMIT) --build-arg ALPINE_VERSION=$(ALPINE_VERSION) --build-arg GOPROXY=$(GOPROXY)
 
 PKG_PATH := /go/src/$(PKG_NAME)
 
@@ -37,7 +37,7 @@ shell: build_dev_image ## run a shell in the docker build image
 	docker run -ti --rm $(DEV_IMAGE_NAME) bash
 
 cross: create_bin ## cross-compile binaries (linux, darwin, windows)
-	docker build $(BUILD_ARGS) --target=cross -t $(CROSS_IMAGE_NAME)  .
+	docker build $(BUILD_ARGS) --target=cross -t $(CROSS_IMAGE_NAME) .
 	docker create --name $(CROSS_CTNR_NAME) $(CROSS_IMAGE_NAME) noop
 	docker cp $(CROSS_CTNR_NAME):$(PKG_PATH)/bin/$(BIN_NAME)-linux bin/$(BIN_NAME)-linux
 	docker cp $(CROSS_CTNR_NAME):$(PKG_PATH)/bin/$(BIN_NAME)-darwin bin/$(BIN_NAME)-darwin
@@ -48,7 +48,7 @@ cross: create_bin ## cross-compile binaries (linux, darwin, windows)
 	@$(call chmod,+x,bin/$(BIN_NAME)-windows.exe)
 
 cli-cross: create_bin
-	docker build $(BUILD_ARGS) --target=build -t $(CLI_IMAGE_NAME)  .
+	docker build $(BUILD_ARGS) --target=build -t $(CLI_IMAGE_NAME) .
 	docker create --name $(CLI_CNTR_NAME) $(CLI_IMAGE_NAME) noop
 	docker cp $(CLI_CNTR_NAME):/go/src/github.com/docker/cli/build/docker-linux-amd64 bin/docker-linux
 	docker cp $(CLI_CNTR_NAME):/go/src/github.com/docker/cli/build/docker-darwin-amd64 bin/docker-darwin
@@ -90,15 +90,15 @@ test: test-unit test-e2e ## run all tests
 
 test-unit: build_dev_image ## run unit tests
 	@$(call mkdir,_build/test-results)
-	docker run --rm -v $(CURDIR)/_build/test-results:/test-results $(DEV_IMAGE_NAME) make EXPERIMENTAL=$(EXPERIMENTAL) TEST_RESULTS_PREFIX=$(TEST_RESULTS_PREFIX) test-unit
+	docker run --rm -v $(CURDIR)/_build/test-results:/test-results $(DEV_IMAGE_NAME) make TEST_RESULTS_PREFIX=$(TEST_RESULTS_PREFIX) test-unit
 
 test-e2e: build_dev_image invocation-image ## run end-to-end tests
-	docker run -v /var/run:/var/run:ro --rm --network="host" $(DEV_IMAGE_NAME) make EXPERIMENTAL=$(EXPERIMENTAL) TEST_RESULTS_PREFIX=$(TEST_RESULTS_PREFIX) bin/$(BIN_NAME) test-e2e
+	docker run -v /var/run:/var/run:ro --rm --network="host" $(DEV_IMAGE_NAME) make TEST_RESULTS_PREFIX=$(TEST_RESULTS_PREFIX) bin/$(BIN_NAME) test-e2e
 
 COV_LABEL := com.docker.app.cov-run=$(TAG)
 coverage-run: build_dev_image ## run tests with coverage
 	@$(call mkdir,_build)
-	docker run -v /var/run:/var/run:ro --name $(COV_CTNR_NAME) --network="host" -t $(DEV_IMAGE_NAME) make COMMIT=${COMMIT} TAG=${TAG} EXPERIMENTAL=$(EXPERIMENTAL) TEST_RESULTS_PREFIX=$(TEST_RESULTS_PREFIX) coverage
+	docker run -v /var/run:/var/run:ro --name $(COV_CTNR_NAME) --network="host" -t $(DEV_IMAGE_NAME) make COMMIT=${COMMIT} TAG=${TAG} TEST_RESULTS_PREFIX=$(TEST_RESULTS_PREFIX) coverage
 coverage-results:
 	docker cp $(COV_CTNR_NAME):$(PKG_PATH)/_build/cov/ ./_build/ci-cov
 	docker cp $(COV_CTNR_NAME):$(PKG_PATH)/_build/test-results/ ./_build/test-results

e2e/main_test.go

@@ -1,12 +1,10 @@
 package e2e
 
 import (
-	"bytes"
 	"encoding/json"
 	"flag"
 	"io/ioutil"
 	"os"
-	"os/exec"
 	"path/filepath"
 	"runtime"
 	"testing"
@@ -19,10 +17,9 @@ import (
 )
 
 var (
-	e2ePath         = flag.String("e2e-path", ".", "Set path to the e2e directory")
-	dockerCliPath   = os.Getenv("DOCKERCLI_BINARY")
-	hasExperimental = false
-	dockerCli       dockerCliCommand
+	e2ePath       = flag.String("e2e-path", ".", "Set path to the e2e directory")
+	dockerCliPath = os.Getenv("DOCKERCLI_BINARY")
+	dockerCli     dockerCliCommand
 )
 
 type dockerCliCommand struct {
@@ -119,13 +116,6 @@ func TestMain(m *testing.M) {
 	createDockerAppSymLink(dockerApp, cliPluginDir)
 
 	dockerCli = dockerCliCommand{path: dockerCliPath, cliPluginDir: cliPluginDir}
-
-	cmd := exec.Command(dockerApp, "app", "--version")
-	output, err := cmd.CombinedOutput()
-	if err != nil {
-		panic(err)
-	}
-	hasExperimental = bytes.Contains(output, []byte("Experimental: on"))
 	os.Exit(m.Run())
 }
 

e2e/plugin_test.go

@@ -23,9 +23,6 @@ func TestInvokePluginFromCLI(t *testing.T) {
 	usage := icmd.RunCmd(cmd).Assert(t, icmd.Success).Combined()
 
 	goldenFile := "plugin-usage.golden"
-	if hasExperimental {
-		goldenFile = "plugin-usage-experimental.golden"
-	}
 	golden.Assert(t, usage, goldenFile)
 
 	// docker info should print app version and short description