Merge pull request #1155 from docker/remove_example_backend

Author: ndeloof

.github/workflows/ci.yml

@@ -65,12 +65,11 @@ jobs:
 
       - name: Test
         env:
-          BUILD_TAGS: example
         run: make -f builder.Makefile test
 
       - name: Build for local E2E
         env:
-          BUILD_TAGS: example,e2e
+          BUILD_TAGS: e2e
         run: make -f builder.Makefile cli
 
       - name: E2E Test

.github/workflows/windows-ci.yml

@@ -48,13 +48,11 @@ jobs:
           key: go-${{ hashFiles('**/go.sum') }}
 
       - name: Test
-        env:
-          BUILD_TAGS: example,local
         run: make -f builder.Makefile test
 
       - name: Build
         env:
-          BUILD_TAGS: example,local,e2e
+          BUILD_TAGS: e2e
         run: make -f builder.Makefile cli
 
       - name: E2E Test

BUILDING.md

@@ -35,22 +35,6 @@ This will create a symbolic link from the existing Docker CLI to
 You can statically cross compile the CLI for Windows, macOS, and Linux using the
 `cross` target.
 
-### Building with specific backends
-
-You can specify which backends are build using the `BUILD_TAGS` variable.
-The available backends are:
-* `aci`: For ACI support (always built)
-* `ecs`: For ECS support (always built)
-* `example`: Testing backend (off by default)
-* `local`: Beginnings of a [moby](https://github.com/moby/moby) backend
-  (off by default)
-
-If you want the ACI, ECS and example backends, then you can build as follows:
-
-```console
-make BUILD_TAGS=example cli
-```
-
 ### Updating the API code
 
 The API provided by the CLI is defined using protobuf. If you make changes to

Makefile

@@ -39,7 +39,7 @@ protos: ## Generate go code from .proto files
 cli: ## Compile the cli
 	@docker build . --target cli \
 	--platform local \
-	--build-arg BUILD_TAGS=example,e2e \
+	--build-arg BUILD_TAGS=e2e \
 	--build-arg GIT_TAG=$(GIT_TAG) \
 	--output ./bin
 
@@ -63,7 +63,6 @@ cross: ## Compile the CLI for linux, darwin and windows
 
 test: ## Run unit tests
 	@docker build . \
-	--build-arg BUILD_TAGS=example \
 	--build-arg GIT_TAG=$(GIT_TAG) \
 	--target test
 
@@ -72,7 +71,7 @@ cache-clear: ## Clear the builder cache
 
 lint: ## run linter(s)
 	@docker build . \
-	--build-arg BUILD_TAGS=example,e2e \
+	--build-arg BUILD_TAGS=e2e \
 	--build-arg GIT_TAG=$(GIT_TAG) \
 	--target lint
 

api/context/store/contextmetadata.go

@@ -61,9 +61,6 @@ type AwsContext EcsContext
 // LocalContext is the context for the local backend
 type LocalContext struct{}
 
-// ExampleContext is the context for the example backend
-type ExampleContext struct{}
-
 // MarshalJSON implements custom JSON marshalling
 func (dc ContextMetadata) MarshalJSON() ([]byte, error) {
 	s := map[string]interface{}{}

api/context/store/store.go

@@ -55,9 +55,6 @@ const (
 	// LocalContextType is the endpoint key in the context endpoints for a new
 	// local backend
 	LocalContextType = "local"
-	// ExampleContextType is the endpoint key in the context endpoints for an
-	// example backend
-	ExampleContextType = "example"
 )
 
 const (
@@ -331,8 +328,5 @@ func getters() map[string]func() interface{} {
 		LocalContextType: func() interface{} {
 			return &LocalContext{}
 		},
-		ExampleContextType: func() interface{} {
-			return &ExampleContext{}
-		},
 	}
 }

api/context/store/store_test.go

@@ -64,8 +64,8 @@ func TestGetEndpoint(t *testing.T) {
 	assert.NilError(t, err)
 	assert.Equal(t, ctx.Location, "eu")
 
-	var exampleCtx ExampleContext
-	err = s.GetEndpoint("aci", &exampleCtx)
+	var localCtx LocalContext
+	err = s.GetEndpoint("aci", &localCtx)
 	assert.Error(t, err, "wrong context type")
 }
 

cli/cmd/context/create.go

@@ -39,7 +39,7 @@ func createCommand() *cobra.Command {
 
 	longHelp := fmt.Sprintf(`Create a new context
 
-Create docker engine context: 
+Create docker engine context:
 $ docker context create CONTEXT [flags]
 
 %s
@@ -78,7 +78,6 @@ $ docker context create my-context --description "some description" --docker "ho
 
 	cmd.AddCommand(
 		createLocalCommand(),
-		createExampleCommand(),
 	)
 	for _, command := range extraCommands {
 		cmd.AddCommand(command())
@@ -111,22 +110,6 @@ func createLocalCommand() *cobra.Command {
 	return cmd
 }
 
-func createExampleCommand() *cobra.Command {
-	var opts descriptionCreateOpts
-	cmd := &cobra.Command{
-		Use:    "example CONTEXT",
-		Short:  "Create a test context returning fixed output",
-		Args:   cobra.ExactArgs(1),
-		Hidden: true,
-		RunE: func(cmd *cobra.Command, args []string) error {
-			return createDockerContext(cmd.Context(), args[0], store.ExampleContextType, opts.description, store.ExampleContext{})
-		},
-	}
-
-	addDescriptionFlag(cmd, &opts.description)
-	return cmd
-}
-
 func createDockerContext(ctx context.Context, name string, contextType string, description string, data interface{}) error {
 	s := store.ContextStore(ctx)
 	result := s.Create(

cli/main.go

@@ -51,7 +51,6 @@ import (
 	_ "github.com/docker/compose-cli/aci"
 	_ "github.com/docker/compose-cli/ecs"
 	_ "github.com/docker/compose-cli/ecs/local"
-	_ "github.com/docker/compose-cli/example"
 	_ "github.com/docker/compose-cli/local"
 )
 

docs/architecture.md

@@ -20,7 +20,6 @@ These constraints resulted in the following architecture:
 What follows is a list of useful links to help navigate the code:
 * The CLI UX code is in [`cli/`](../cli)
 * The backend interface is defined in [`backend/`](../backend)
-  * An example backend can be found in [`example/`](../example)
 * The API is defined by protobufs that can be found in [`protos/`](../protos)
 * The API server is in [`server/`](../server)
 * The context management and interface can be found in [`context/`](../api/context)