ref(client): move control plane stuff to backend

Matthew Fisher · Matthew Fisher · commit e9ba86f5a56a · 2014-09-19T15:12:30.000-07:00
In preparation for writing tests for `deisctl`, I have abstracted the
concept of the `deisctl` client and the underlying backend clients which
deisctl talks to. In our case, we only have one, which is the fleet
backend. However, in order to properly test `deisctl`, we need to
create a new backend which we can use locally. This is a first pass
at refactoring the client in order to better flesh out these
requirements.

Note that `deisctl config` and `deisctl update` call docopt again,
therefore eliminating the need for additional parameters. This is bad,
as we cannot tell `deisctl config` to use the client's corresponding
backend. This will be addressed in another PR.

I've also removed the commands `list-units` and `list-unit-files` as
they were redundantly calling `list-units`, were undocumented, and
were not used.
diff --git a/backend/backend.go b/backend/backend.go
@@ -1,7 +1,7 @@
-package client
+package backend
 
-// Client interface used to interact with the cluster control plane
-type Client interface {
+// Backend interface is used to interact with the cluster control plane
+type Backend interface {
 	Create([]string) error
 	Destroy([]string) error
 	Start([]string) error
diff --git a/backend/fleet/create.go b/backend/fleet/create.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import (
 	"fmt"
diff --git a/backend/fleet/destroy.go b/backend/fleet/destroy.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import (
 	"fmt"
diff --git a/backend/fleet/fleet.go b/backend/fleet/fleet.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import "github.com/coreos/fleet/client"
 
diff --git a/backend/fleet/fleet_test.go b/backend/fleet/fleet_test.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import "testing"
 
diff --git a/backend/fleet/journal.go b/backend/fleet/journal.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import (
 	"fmt"
diff --git a/backend/fleet/list_unit_files.go b/backend/fleet/list_unit_files.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import (
 	"fmt"
diff --git a/backend/fleet/list_units.go b/backend/fleet/list_units.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import (
 	"fmt"
diff --git a/backend/fleet/registry.go b/backend/fleet/registry.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import (
 	"fmt"
diff --git a/backend/fleet/registry_test.go b/backend/fleet/registry_test.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import (
 	"strings"
diff --git a/backend/fleet/scale.go b/backend/fleet/scale.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import (
 	"errors"
diff --git a/backend/fleet/ssh.go b/backend/fleet/ssh.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import (
 	"fmt"
diff --git a/backend/fleet/start.go b/backend/fleet/start.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import (
 	"strings"
diff --git a/backend/fleet/state.go b/backend/fleet/state.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import (
 	"errors"
diff --git a/backend/fleet/status.go b/backend/fleet/status.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import (
 	"fmt"
diff --git a/backend/fleet/stop.go b/backend/fleet/stop.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import (
 	"github.com/coreos/fleet/job"
diff --git a/backend/fleet/unit.go b/backend/fleet/unit.go
@@ -1,16 +1,16 @@
-package client
+package fleet
 
 import (
 	"fmt"
 	"io/ioutil"
 	"os"
-	"os/user"
 	"path"
 	"regexp"
 	"strconv"
 	"strings"
 
 	"github.com/coreos/fleet/unit"
+	"github.com/deis/deisctl/utils"
 )
 
 // path hierarchy for finding systemd service templates
@@ -121,7 +121,7 @@ func readTemplate(component string) (out []byte, err error) {
 		if p == "" {
 			continue
 		}
-		p, _ := ExpandUser(p)
+		p, _ := utils.ExpandUser(p)
 		filename := path.Join(p, templateName)
 		if _, err := os.Stat(filename); err == nil {
 			templateFile = filename
@@ -138,12 +138,3 @@ func readTemplate(component string) (out []byte, err error) {
 	}
 	return
 }
-
-// ExpandUser replaces "~" in a string with the current user's home directory.
-func ExpandUser(path string) (string, error) {
-	user, err := user.Current()
-	if err != nil {
-		return path, err
-	}
-	return strings.Replace(path, "~/", user.HomeDir+"/", 1), nil
-}
diff --git a/backend/fleet/unit_test.go b/backend/fleet/unit_test.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import "testing"
 
diff --git a/backend/fleet/utils.go b/backend/fleet/utils.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import (
 	"fmt"
diff --git a/backend/fleet/utils_test.go b/backend/fleet/utils_test.go
@@ -1,4 +1,4 @@
-package client
+package fleet
 
 import "testing"
 
diff --git a/client/client.go b/client/client.go
@@ -0,0 +1,96 @@
+package client
+
+import (
+	"errors"
+
+	"github.com/deis/deisctl/backend"
+	"github.com/deis/deisctl/backend/fleet"
+	"github.com/deis/deisctl/cmd"
+)
+
+type DeisCtlClient interface {
+	Config() error
+	Install(targets []string) error
+	Journal(targets []string) error
+	List() error
+	RefreshUnits() error
+	Restart(targets []string) error
+	Scale(targets []string) error
+	Start(targets []string) error
+	Status(targets []string) error
+	Stop(targets []string) error
+	Uninstall(targets []string) error
+	Update() error
+}
+
+type Client struct {
+	Backend backend.Backend
+}
+
+func NewClient(requestedBackend string) (*Client, error) {
+	var backend backend.Backend
+
+	if requestedBackend == "" {
+		requestedBackend = "fleet"
+	}
+
+	switch requestedBackend {
+	case "fleet":
+		b, err := fleet.NewClient()
+		if err != nil {
+			return nil, err
+		}
+		backend = b
+	default:
+		return nil, errors.New("invalid backend")
+	}
+	return &Client{Backend: backend}, nil
+}
+
+func (c *Client) Config() error {
+	return cmd.Config()
+}
+
+func (c *Client) Install(targets []string) error {
+	return cmd.Install(c.Backend, targets)
+}
+
+func (c *Client) Journal(targets []string) error {
+	return cmd.Journal(c.Backend, targets)
+}
+
+func (c *Client) List() error {
+	return cmd.ListUnits(c.Backend)
+}
+
+func (c *Client) RefreshUnits() error {
+	return cmd.RefreshUnits()
+}
+
+func (c *Client) Restart(targets []string) error {
+	return cmd.Restart(c.Backend, targets)
+}
+
+func (c *Client) Scale(targets []string) error {
+	return cmd.Scale(c.Backend, targets)
+}
+
+func (c *Client) Start(targets []string) error {
+	return cmd.Start(c.Backend, targets)
+}
+
+func (c *Client) Status(targets []string) error {
+	return cmd.Status(c.Backend, targets)
+}
+
+func (c *Client) Stop(targets []string) error {
+	return cmd.Stop(c.Backend, targets)
+}
+
+func (c *Client) Uninstall(targets []string) error {
+	return cmd.Uninstall(c.Backend, targets)
+}
+
+func (c *Client) Update() error {
+	return cmd.Update()
+}
diff --git a/cmd/cmd.go b/cmd/cmd.go
diff --git a/config/etcd.go b/config/etcd.go
diff --git a/deisctl.go b/deisctl.go
diff --git a/update/client.go b/update/client.go
diff --git a/utils/utils.go b/utils/utils.go

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package client`
	`1`	`+package fleet`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"fmt"`