Merge pull request #740 from Ace-Tang/client_backend

refactor: abstract common api client
AliyunContainerService · Feb 23, 2018 · b41c5f0 · b41c5f0
2 parents c31211f + 9f3c119
commit b41c5f0
Show file tree

Hide file tree

Showing 7 changed files with 77 additions and 28 deletions.
diff --git a/cli/cli.go b/cli/cli.go
@@ -30,7 +30,7 @@ type Option struct {
 type Cli struct {
 	Option
 	rootCmd   *cobra.Command
-	APIClient *client.APIClient
+	APIClient client.CommonAPIClient
 	padding   int
 }
 
@@ -70,7 +70,7 @@ func (c *Cli) NewAPIClient() {
 }
 
 // Client returns API client torwards daemon.
-func (c *Cli) Client() *client.APIClient {
+func (c *Cli) Client() client.CommonAPIClient {
 	return c.APIClient
 }
 

diff --git a/client/client.go b/client/client.go
@@ -29,7 +29,7 @@ type APIClient struct {
 }
 
 // NewAPIClient initializes a new API client for the given host
-func NewAPIClient(host string, tls utils.TLSConfig) (*APIClient, error) {
+func NewAPIClient(host string, tls utils.TLSConfig) (CommonAPIClient, error) {
 	if host == "" {
 		host = defaultHost
 	}

diff --git a/client/container.go b/client/container.go
@@ -9,21 +9,6 @@ import (
 	"github.com/alibaba/pouch/apis/types"
 )
 
-// ContainerAPIClient defines methods of Container client.
-type ContainerAPIClient interface {
-	ContainerCreate(ctx context.Context, config types.ContainerConfig, hostConfig *types.HostConfig, networkConfig *types.NetworkingConfig, containerName string) (*types.ContainerCreateResp, error)
-	ContainerStart(ctx context.Context, name, detachKeys string) error
-	ContainerStop(ctx context.Context, name, timeout string) error
-	ContainerRemove(ctx context.Context, name string, force bool) error
-	ContainerList(ctx context.Context, all bool) ([]*types.Container, error)
-	ContainerAttach(ctx context.Context, name string, stdin bool) (net.Conn, *bufio.Reader, error)
-	ContainerCreateExec(ctx context.Context, name string, config *types.ExecCreateConfig) (*types.ExecCreateResp, error)
-	ContainerStartExec(ctx context.Context, execid string, config *types.ExecStartConfig) (net.Conn, *bufio.Reader, error)
-	ContainerGet(ctx context.Context, name string) (*types.ContainerJSON, error)
-	ContainerRename(ctx context.Context, id string, name string) error
-	ContainerPause(ctx context.Context, name string) error
-}
-
 // ContainerCreate creates a new container based in the given configuration.
 func (client *APIClient) ContainerCreate(ctx context.Context, config types.ContainerConfig, hostConfig *types.HostConfig, networkingConfig *types.NetworkingConfig, containerName string) (*types.ContainerCreateResp, error) {
 	createConfig := types.ContainerCreateConfig{

diff --git a/client/image.go b/client/image.go
@@ -8,14 +8,6 @@ import (
 	"github.com/alibaba/pouch/apis/types"
 )
 
-// ImageAPIClient defines methods of Image client.
-type ImageAPIClient interface {
-	ImageList(ctx context.Context) ([]types.ImageInfo, error)
-	ImageInspect(ctx context.Context, name string) (types.ImageInfo, error)
-	ImagePull(ctx context.Context, name, tag string) (io.ReadCloser, error)
-	ImageRemove(ctx context.Context, name string, force bool) error
-}
-
 // ImageInspect requests daemon to inspect an image.
 func (client *APIClient) ImageInspect(ctx context.Context, name string) (types.ImageInfo, error) {
 	image := types.ImageInfo{}

diff --git a/client/interface.go b/client/interface.go
@@ -0,0 +1,66 @@
+package client
+
+import (
+	"bufio"
+	"context"
+	"io"
+	"net"
+
+	"github.com/alibaba/pouch/apis/types"
+)
+
+// CommonAPIClient defines common methods of api client
+type CommonAPIClient interface {
+	ContainerAPIClient
+	ImageAPIClient
+	VolumeAPIClient
+	SystemAPIClient
+	NetworkAPIClient
+}
+
+// ContainerAPIClient defines methods of Container client.
+type ContainerAPIClient interface {
+	ContainerCreate(ctx context.Context, config types.ContainerConfig, hostConfig *types.HostConfig, networkConfig *types.NetworkingConfig, containerName string) (*types.ContainerCreateResp, error)
+	ContainerStart(ctx context.Context, name, detachKeys string) error
+	ContainerStop(ctx context.Context, name, timeout string) error
+	ContainerRemove(ctx context.Context, name string, force bool) error
+	ContainerList(ctx context.Context, all bool) ([]*types.Container, error)
+	ContainerAttach(ctx context.Context, name string, stdin bool) (net.Conn, *bufio.Reader, error)
+	ContainerCreateExec(ctx context.Context, name string, config *types.ExecCreateConfig) (*types.ExecCreateResp, error)
+	ContainerStartExec(ctx context.Context, execid string, config *types.ExecStartConfig) (net.Conn, *bufio.Reader, error)
+	ContainerGet(ctx context.Context, name string) (*types.ContainerJSON, error)
+	ContainerRename(ctx context.Context, id string, name string) error
+	ContainerPause(ctx context.Context, name string) error
+	ContainerUnpause(ctx context.Context, name string) error
+}
+
+// ImageAPIClient defines methods of Image client.
+type ImageAPIClient interface {
+	ImageList(ctx context.Context) ([]types.ImageInfo, error)
+	ImageInspect(ctx context.Context, name string) (types.ImageInfo, error)
+	ImagePull(ctx context.Context, name, tag string) (io.ReadCloser, error)
+	ImageRemove(ctx context.Context, name string, force bool) error
+}
+
+// VolumeAPIClient defines methods of Volume client.
+type VolumeAPIClient interface {
+	VolumeCreate(ctx context.Context, config *types.VolumeCreateConfig) (*types.VolumeInfo, error)
+	VolumeRemove(ctx context.Context, name string) error
+	VolumeInspect(ctx context.Context, name string) (*types.VolumeInfo, error)
+	VolumeList(ctx context.Context) (*types.VolumeListResp, error)
+}
+
+// SystemAPIClient defines methods of System client.
+type SystemAPIClient interface {
+	SystemPing(ctx context.Context) (string, error)
+	SystemVersion(ctx context.Context) (*types.SystemVersion, error)
+	SystemInfo(ctx context.Context) (*types.SystemInfo, error)
+}
+
+// NetworkAPIClient defines methods of Network client.
+type NetworkAPIClient interface {
+	NetworkCreate(ctx context.Context, req *types.NetworkCreateConfig) (*types.NetworkCreateResp, error)
+	NetworkRemove(ctx context.Context, networkID string) error
+	NetworkInspect(ctx context.Context, networkID string) (*types.NetworkInspectResp, error)
+	NetworkList(ctx context.Context) (*types.NetworkListResp, error)
+}
diff --git a/test/main_test.go b/test/main_test.go
@@ -19,11 +19,12 @@ var (
 func TestMain(m *testing.M) {
 	var err error
 
-	apiClient, err = client.NewAPIClient(environment.PouchdAddress, environment.TLSConfig)
+	commonAPIClient, err := client.NewAPIClient(environment.PouchdAddress, environment.TLSConfig)
 	if err != nil {
 		fmt.Printf("fail to initializes pouch API client: %s", err.Error())
 		os.Exit(1)
 	}
+	apiClient = commonAPIClient.(*client.APIClient)
 
 	os.Exit(m.Run())
 }

diff --git a/test/request/request.go b/test/request/request.go
@@ -115,7 +115,12 @@ func Post(endpoint string, opts ...Option) (*http.Response, error) {
 //
 // FIXME: Could we make some functions exported in alibaba/pouch/client?
 func newAPIClient(host string, tls utils.TLSConfig) (*client.APIClient, error) {
-	return client.NewAPIClient(host, tls)
+	commonAPIClient, err := client.NewAPIClient(host, tls)
+	if err != nil {
+		return nil, err
+	}
+	apiClient := commonAPIClient.(*client.APIClient)
+	return apiClient, nil
 }
 
 // newRequest creates request targeting on specific host/path by method.