From 53b13b1c76327f55be2063f6e30a2b792711d59e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 01:13:43 -0400 Subject: [PATCH 01/17] Rename PortainerClient.Authenticate() to Auth() --- client/client.go | 8 ++++---- client/client_test.go | 2 +- cmd/login.go | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/client/client.go b/client/client.go index b89c9c7..c75bfe4 100644 --- a/client/client.go +++ b/client/client.go @@ -31,8 +31,8 @@ type Config struct { // PortainerClient represents a Portainer API client type PortainerClient interface { - // Authenticate a user to get an auth token - Authenticate() (token string, err error) + // Auth a user to get an auth token + Auth() (token string, err error) // Get endpoints GetEndpoints() ([]portainer.Endpoint, error) @@ -185,7 +185,7 @@ func (n *portainerClientImp) doJSON(uri, method string, headers http.Header, req func (n *portainerClientImp) doJSONWithToken(uri, method string, headers http.Header, request interface{}, response interface{}) (err error) { // Ensure there is an auth token if n.token == "" { - n.token, err = n.Authenticate() + n.token, err = n.Auth() if err != nil { return } @@ -203,7 +203,7 @@ func (n *portainerClientImp) AfterResponse(hook func(resp *http.Response) (err e n.afterResponseHooks = append(n.afterResponseHooks, hook) } -func (n *portainerClientImp) Authenticate() (token string, err error) { +func (n *portainerClientImp) Auth() (token string, err error) { reqBody := AuthenticateUserRequest{ Username: n.user, Password: n.password, diff --git a/client/client_test.go b/client/client_test.go index b932259..88726c2 100644 --- a/client/client_test.go +++ b/client/client_test.go @@ -69,7 +69,7 @@ func TestClientAuthenticates(t *testing.T) { Password: "a", UserAgent: "GE007", }) - token, err := customClient.Authenticate() + token, err := customClient.Auth() assert.Nil(t, err) assert.Equal(t, token, "somerandomtoken") } diff --git a/cmd/login.go b/cmd/login.go index f0fad9b..a3047dc 100644 --- a/cmd/login.go +++ b/cmd/login.go @@ -22,7 +22,7 @@ var loginCmd = &cobra.Command{ logrus.WithFields(logrus.Fields{ "user": user, }).Debug("Getting auth token") - authToken, err := client.Authenticate() + authToken, err := client.Auth() common.CheckError(err) if viper.GetBool("login.print") { From 0adb18bc8ae908286d320d37af2fe01dbcd92e04 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 01:15:44 -0400 Subject: [PATCH 02/17] Rename PortainerClient.GetEndpoints() to EndpointList() --- client/client.go | 4 ++-- cmd/endpointList.go | 2 +- cmd/stackList.go | 2 +- common/utils.go | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/client/client.go b/client/client.go index c75bfe4..1027ca9 100644 --- a/client/client.go +++ b/client/client.go @@ -35,7 +35,7 @@ type PortainerClient interface { Auth() (token string, err error) // Get endpoints - GetEndpoints() ([]portainer.Endpoint, error) + EndpointList() ([]portainer.Endpoint, error) // Get endpoint groups GetEndpointGroups() ([]portainer.EndpointGroup, error) @@ -221,7 +221,7 @@ func (n *portainerClientImp) Auth() (token string, err error) { return } -func (n *portainerClientImp) GetEndpoints() (endpoints []portainer.Endpoint, err error) { +func (n *portainerClientImp) EndpointList() (endpoints []portainer.Endpoint, err error) { err = n.doJSONWithToken("endpoints", http.MethodGet, http.Header{}, nil, &endpoints) return } diff --git a/cmd/endpointList.go b/cmd/endpointList.go index df6f27f..9ae8720 100644 --- a/cmd/endpointList.go +++ b/cmd/endpointList.go @@ -30,7 +30,7 @@ var endpointListCmd = &cobra.Command{ common.CheckError(err) logrus.Debug("Getting endpoints") - endpoints, err := client.GetEndpoints() + endpoints, err := client.EndpointList() common.CheckError(err) switch viper.GetString("endpoint.list.format") { diff --git a/cmd/stackList.go b/cmd/stackList.go index d79d237..172b694 100644 --- a/cmd/stackList.go +++ b/cmd/stackList.go @@ -33,7 +33,7 @@ var stackListCmd = &cobra.Command{ portainerClient, err := common.GetClient() common.CheckError(err) - endpoints, endpointsRetrievalErr := portainerClient.GetEndpoints() + endpoints, endpointsRetrievalErr := portainerClient.EndpointList() common.CheckError(endpointsRetrievalErr) var endpointSwarmClusterID string diff --git a/common/utils.go b/common/utils.go index f9ce174..b733869 100644 --- a/common/utils.go +++ b/common/utils.go @@ -38,7 +38,7 @@ func GetDefaultEndpoint() (endpoint portainer.Endpoint, err error) { } logrus.Debug("Getting endpoints") - endpoints, err := portainerClient.GetEndpoints() + endpoints, err := portainerClient.EndpointList() if err != nil { return } @@ -85,7 +85,7 @@ func GetEndpointByName(name string) (endpoint portainer.Endpoint, err error) { return } - endpoints, err := portainerClient.GetEndpoints() + endpoints, err := portainerClient.EndpointList() if err != nil { return } From 623788b6243343e79b2c8946481bb3afa2405a11 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 01:16:40 -0400 Subject: [PATCH 03/17] Rename PortainerClient.GetEndpointGroups() to EndpointGroupList() --- client/client.go | 4 ++-- cmd/endpointGroupList.go | 2 +- common/utils.go | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/client/client.go b/client/client.go index 1027ca9..746a92f 100644 --- a/client/client.go +++ b/client/client.go @@ -38,7 +38,7 @@ type PortainerClient interface { EndpointList() ([]portainer.Endpoint, error) // Get endpoint groups - GetEndpointGroups() ([]portainer.EndpointGroup, error) + EndpointGroupList() ([]portainer.EndpointGroup, error) // Get stacks, optionally filtered by swarmId and endpointId GetStacks(swarmID string, endpointID portainer.EndpointID) ([]portainer.Stack, error) @@ -226,7 +226,7 @@ func (n *portainerClientImp) EndpointList() (endpoints []portainer.Endpoint, err return } -func (n *portainerClientImp) GetEndpointGroups() (endpointGroups []portainer.EndpointGroup, err error) { +func (n *portainerClientImp) EndpointGroupList() (endpointGroups []portainer.EndpointGroup, err error) { err = n.doJSONWithToken("endpoint_groups", http.MethodGet, http.Header{}, nil, &endpointGroups) return } diff --git a/cmd/endpointGroupList.go b/cmd/endpointGroupList.go index b3f094d..953c90e 100644 --- a/cmd/endpointGroupList.go +++ b/cmd/endpointGroupList.go @@ -30,7 +30,7 @@ var endpointGroupListCmd = &cobra.Command{ common.CheckError(err) logrus.Debug("Getting endpoint groups") - endpointGroups, err := client.GetEndpointGroups() + endpointGroups, err := client.EndpointGroupList() common.CheckError(err) switch viper.GetString("endpoint.group.list.format") { diff --git a/common/utils.go b/common/utils.go index b733869..81f272a 100644 --- a/common/utils.go +++ b/common/utils.go @@ -107,7 +107,7 @@ func GetEndpointGroupByName(name string) (endpointGroup portainer.EndpointGroup, return } - endpointGroups, err := portainerClient.GetEndpointGroups() + endpointGroups, err := portainerClient.EndpointGroupList() if err != nil { return } From 87ba553153766fc7b76aa16659f12f380e5e01f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 01:17:41 -0400 Subject: [PATCH 04/17] Rename PortainerClient.GetStacks() to StackList() --- client/client.go | 4 ++-- cmd/stackList.go | 6 +++--- common/utils.go | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/client/client.go b/client/client.go index 746a92f..03e9ed3 100644 --- a/client/client.go +++ b/client/client.go @@ -41,7 +41,7 @@ type PortainerClient interface { EndpointGroupList() ([]portainer.EndpointGroup, error) // Get stacks, optionally filtered by swarmId and endpointId - GetStacks(swarmID string, endpointID portainer.EndpointID) ([]portainer.Stack, error) + StackList(swarmID string, endpointID portainer.EndpointID) ([]portainer.Stack, error) // Create swarm stack CreateSwarmStack(stackName string, environmentVariables []portainer.Pair, stackFileContent string, swarmClusterID string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) @@ -231,7 +231,7 @@ func (n *portainerClientImp) EndpointGroupList() (endpointGroups []portainer.End return } -func (n *portainerClientImp) GetStacks(swarmID string, endpointID portainer.EndpointID) (stacks []portainer.Stack, err error) { +func (n *portainerClientImp) StackList(swarmID string, endpointID portainer.EndpointID) (stacks []portainer.Stack, err error) { filter := StackListFilter{ SwarmID: swarmID, EndpointID: endpointID, diff --git a/cmd/stackList.go b/cmd/stackList.go index 172b694..d073427 100644 --- a/cmd/stackList.go +++ b/cmd/stackList.go @@ -53,14 +53,14 @@ var stackListCmd = &cobra.Command{ logrus.WithFields(logrus.Fields{ "endpoint": endpoint.Name, }).Debug("Getting stacks") - stacks, err = portainerClient.GetStacks(endpointSwarmClusterID, endpoint.ID) + stacks, err = portainerClient.StackList(endpointSwarmClusterID, endpoint.ID) common.CheckError(err) } else if selectionErr == common.ErrStackClusterNotFound { // It's not a swarm cluster logrus.WithFields(logrus.Fields{ "endpoint": endpoint.Name, }).Debug("Getting stacks") - stacks, err = portainerClient.GetStacks("", endpoint.ID) + stacks, err = portainerClient.StackList("", endpoint.ID) common.CheckError(err) } else { // Something else happened @@ -68,7 +68,7 @@ var stackListCmd = &cobra.Command{ } } else { logrus.Debug("Getting stacks") - stacks, err = portainerClient.GetStacks("", 0) + stacks, err = portainerClient.StackList("", 0) common.CheckError(err) } diff --git a/common/utils.go b/common/utils.go index 81f272a..0c1e026 100644 --- a/common/utils.go +++ b/common/utils.go @@ -63,7 +63,7 @@ func GetStackByName(name string, swarmID string, endpointID portainer.EndpointID return } - stacks, err := portainerClient.GetStacks(swarmID, endpointID) + stacks, err := portainerClient.StackList(swarmID, endpointID) if err != nil { return } From 00b7daae733dc260d19a899d7482b0b82b0642f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 01:18:46 -0400 Subject: [PATCH 05/17] Rename PortainerClient.CreateSwarmStack() to StackCreateSwarm() --- client/client.go | 4 ++-- cmd/stackDeploy.go | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/client/client.go b/client/client.go index 03e9ed3..6f4238f 100644 --- a/client/client.go +++ b/client/client.go @@ -44,7 +44,7 @@ type PortainerClient interface { StackList(swarmID string, endpointID portainer.EndpointID) ([]portainer.Stack, error) // Create swarm stack - CreateSwarmStack(stackName string, environmentVariables []portainer.Pair, stackFileContent string, swarmClusterID string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) + StackCreateSwarm(stackName string, environmentVariables []portainer.Pair, stackFileContent string, swarmClusterID string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) // Create compose stack CreateComposeStack(stackName string, environmentVariables []portainer.Pair, stackFileContent string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) @@ -244,7 +244,7 @@ func (n *portainerClientImp) StackList(swarmID string, endpointID portainer.Endp return } -func (n *portainerClientImp) CreateSwarmStack(stackName string, environmentVariables []portainer.Pair, stackFileContent string, swarmClusterID string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) { +func (n *portainerClientImp) StackCreateSwarm(stackName string, environmentVariables []portainer.Pair, stackFileContent string, swarmClusterID string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) { reqBody := StackCreateRequest{ Name: stackName, Env: environmentVariables, diff --git a/cmd/stackDeploy.go b/cmd/stackDeploy.go index b8059cd..21dfe5f 100644 --- a/cmd/stackDeploy.go +++ b/cmd/stackDeploy.go @@ -135,7 +135,7 @@ var stackDeployCmd = &cobra.Command{ "stack": stackName, "endpoint": endpoint.Name, }).Info("Creating stack") - stack, deploymentErr := portainerClient.CreateSwarmStack(stackName, loadedEnvironmentVariables, stackFileContent, endpointSwarmClusterID, endpoint.ID) + stack, deploymentErr := portainerClient.StackCreateSwarm(stackName, loadedEnvironmentVariables, stackFileContent, endpointSwarmClusterID, endpoint.ID) common.CheckError(deploymentErr) logrus.WithFields(logrus.Fields{ "stack": stack.Name, From ea63f26ee0f4cfc29aab3cea31e771d87c360520 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 01:19:41 -0400 Subject: [PATCH 06/17] Rename PortainerClient.UpdateStack() to StackUpdate() --- client/client.go | 8 ++++---- cmd/stackDeploy.go | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/client/client.go b/client/client.go index 6f4238f..d09129b 100644 --- a/client/client.go +++ b/client/client.go @@ -47,10 +47,10 @@ type PortainerClient interface { StackCreateSwarm(stackName string, environmentVariables []portainer.Pair, stackFileContent string, swarmClusterID string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) // Create compose stack - CreateComposeStack(stackName string, environmentVariables []portainer.Pair, stackFileContent string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) + StackCreateCompose(stackName string, environmentVariables []portainer.Pair, stackFileContent string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) // Update stack - UpdateStack(stack portainer.Stack, environmentVariables []portainer.Pair, stackFileContent string, prune bool, endpointID portainer.EndpointID) error + StackUpdate(stack portainer.Stack, environmentVariables []portainer.Pair, stackFileContent string, prune bool, endpointID portainer.EndpointID) error // Delete stack DeleteStack(stackID portainer.StackID) error @@ -256,7 +256,7 @@ func (n *portainerClientImp) StackCreateSwarm(stackName string, environmentVaria return } -func (n *portainerClientImp) CreateComposeStack(stackName string, environmentVariables []portainer.Pair, stackFileContent string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) { +func (n *portainerClientImp) StackCreateCompose(stackName string, environmentVariables []portainer.Pair, stackFileContent string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) { reqBody := StackCreateRequest{ Name: stackName, Env: environmentVariables, @@ -267,7 +267,7 @@ func (n *portainerClientImp) CreateComposeStack(stackName string, environmentVar return } -func (n *portainerClientImp) UpdateStack(stack portainer.Stack, environmentVariables []portainer.Pair, stackFileContent string, prune bool, endpointID portainer.EndpointID) (err error) { +func (n *portainerClientImp) StackUpdate(stack portainer.Stack, environmentVariables []portainer.Pair, stackFileContent string, prune bool, endpointID portainer.EndpointID) (err error) { reqBody := StackUpdateRequest{ Env: environmentVariables, StackFileContent: stackFileContent, diff --git a/cmd/stackDeploy.go b/cmd/stackDeploy.go index 21dfe5f..44376c6 100644 --- a/cmd/stackDeploy.go +++ b/cmd/stackDeploy.go @@ -115,7 +115,7 @@ var stackDeployCmd = &cobra.Command{ logrus.WithFields(logrus.Fields{ "stack": retrievedStack.Name, }).Info("Updating stack") - err := portainerClient.UpdateStack(retrievedStack, newEnvironmentVariables, stackFileContent, viper.GetBool("stack.deploy.prune"), endpoint.ID) + err := portainerClient.StackUpdate(retrievedStack, newEnvironmentVariables, stackFileContent, viper.GetBool("stack.deploy.prune"), endpoint.ID) common.CheckError(err) } else if stackRetrievalErr == common.ErrStackNotFound { // We are deploying a new stack @@ -148,7 +148,7 @@ var stackDeployCmd = &cobra.Command{ "stack": stackName, "endpoint": endpoint.Name, }).Info("Creating stack") - stack, deploymentErr := portainerClient.CreateComposeStack(stackName, loadedEnvironmentVariables, stackFileContent, endpoint.ID) + stack, deploymentErr := portainerClient.StackCreateCompose(stackName, loadedEnvironmentVariables, stackFileContent, endpoint.ID) common.CheckError(deploymentErr) logrus.WithFields(logrus.Fields{ "stack": stack.Name, From 0b946ac0ec8b633f360986eefffec41651a1ff30 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 01:21:14 -0400 Subject: [PATCH 07/17] Rename PortainerClient.DeleteStack() to StackDelete() --- client/client.go | 4 ++-- cmd/stackRemove.go | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/client/client.go b/client/client.go index d09129b..86620a1 100644 --- a/client/client.go +++ b/client/client.go @@ -53,7 +53,7 @@ type PortainerClient interface { StackUpdate(stack portainer.Stack, environmentVariables []portainer.Pair, stackFileContent string, prune bool, endpointID portainer.EndpointID) error // Delete stack - DeleteStack(stackID portainer.StackID) error + StackDelete(stackID portainer.StackID) error // Get stack file content GetStackFileContent(stackID portainer.StackID) (content string, err error) @@ -278,7 +278,7 @@ func (n *portainerClientImp) StackUpdate(stack portainer.Stack, environmentVaria return } -func (n *portainerClientImp) DeleteStack(stackID portainer.StackID) (err error) { +func (n *portainerClientImp) StackDelete(stackID portainer.StackID) (err error) { err = n.doJSONWithToken(fmt.Sprintf("stacks/%d", stackID), http.MethodDelete, http.Header{}, nil, nil) return } diff --git a/cmd/stackRemove.go b/cmd/stackRemove.go index 0e147d5..72d9f63 100644 --- a/cmd/stackRemove.go +++ b/cmd/stackRemove.go @@ -77,7 +77,7 @@ var stackRemoveCmd = &cobra.Command{ "stack": stackName, "endpoint": endpoint.Name, }).Info("Removing stack") - err := portainerClient.DeleteStack(stackID) + err := portainerClient.StackDelete(stackID) common.CheckError(err) logrus.WithFields(logrus.Fields{ "stack": stack.Name, From 636757e28906f98db0ea0cf95a1ce4e0a5483e2f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 01:24:53 -0400 Subject: [PATCH 08/17] Rename PortainerClient.GetStackFileContent() to StackFileInspect() --- client/client.go | 4 ++-- cmd/stackDeploy.go | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/client/client.go b/client/client.go index 86620a1..a91f2e5 100644 --- a/client/client.go +++ b/client/client.go @@ -56,7 +56,7 @@ type PortainerClient interface { StackDelete(stackID portainer.StackID) error // Get stack file content - GetStackFileContent(stackID portainer.StackID) (content string, err error) + StackFileInspect(stackID portainer.StackID) (content string, err error) // Get endpoint Docker info GetEndpointDockerInfo(endpointID portainer.EndpointID) (info map[string]interface{}, err error) @@ -283,7 +283,7 @@ func (n *portainerClientImp) StackDelete(stackID portainer.StackID) (err error) return } -func (n *portainerClientImp) GetStackFileContent(stackID portainer.StackID) (content string, err error) { +func (n *portainerClientImp) StackFileInspect(stackID portainer.StackID) (content string, err error) { var respBody StackFileInspectResponse err = n.doJSONWithToken(fmt.Sprintf("stacks/%v/file", stackID), http.MethodGet, http.Header{}, nil, &respBody) diff --git a/cmd/stackDeploy.go b/cmd/stackDeploy.go index 44376c6..0f5dc18 100644 --- a/cmd/stackDeploy.go +++ b/cmd/stackDeploy.go @@ -87,7 +87,7 @@ var stackDeployCmd = &cobra.Command{ logrus.WithFields(logrus.Fields{ "stack": retrievedStack.Name, }).Debug("Getting stack file content") - stackFileContent, stackFileContentRetrievalErr = portainerClient.GetStackFileContent(retrievedStack.ID) + stackFileContent, stackFileContentRetrievalErr = portainerClient.StackFileInspect(retrievedStack.ID) common.CheckError(stackFileContentRetrievalErr) } From aa606782afa55b5808388a1cd61749e5411f0ef1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 01:25:54 -0400 Subject: [PATCH 09/17] Rename PortainerClient.GetEndpointDockerInfo() to EndpointDockerInfo() --- client/client.go | 4 ++-- common/utils.go | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/client/client.go b/client/client.go index a91f2e5..45b5cc2 100644 --- a/client/client.go +++ b/client/client.go @@ -59,7 +59,7 @@ type PortainerClient interface { StackFileInspect(stackID portainer.StackID) (content string, err error) // Get endpoint Docker info - GetEndpointDockerInfo(endpointID portainer.EndpointID) (info map[string]interface{}, err error) + EndpointDockerInfo(endpointID portainer.EndpointID) (info map[string]interface{}, err error) // Get Portainer status info GetStatus() (portainer.Status, error) @@ -296,7 +296,7 @@ func (n *portainerClientImp) StackFileInspect(stackID portainer.StackID) (conten return } -func (n *portainerClientImp) GetEndpointDockerInfo(endpointID portainer.EndpointID) (info map[string]interface{}, err error) { +func (n *portainerClientImp) EndpointDockerInfo(endpointID portainer.EndpointID) (info map[string]interface{}, err error) { err = n.doJSONWithToken(fmt.Sprintf("endpoints/%v/docker/info", endpointID), http.MethodGet, http.Header{}, nil, &info) return } diff --git a/common/utils.go b/common/utils.go index 0c1e026..28a1d09 100644 --- a/common/utils.go +++ b/common/utils.go @@ -151,7 +151,7 @@ func GetEndpointSwarmClusterID(endpointID portainer.EndpointID) (endpointSwarmCl return } - result, err := portainerClient.GetEndpointDockerInfo(endpointID) + result, err := portainerClient.EndpointDockerInfo(endpointID) if err != nil { return } From f38481b0083a985153e9edab4cc0f39ce0975308 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 01:29:21 -0400 Subject: [PATCH 10/17] Rename PortainerClient.GetStatus() to Status() --- client/client.go | 4 ++-- cmd/status.go | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/client/client.go b/client/client.go index 45b5cc2..0566d4c 100644 --- a/client/client.go +++ b/client/client.go @@ -62,7 +62,7 @@ type PortainerClient interface { EndpointDockerInfo(endpointID portainer.EndpointID) (info map[string]interface{}, err error) // Get Portainer status info - GetStatus() (portainer.Status, error) + Status() (portainer.Status, error) // Run a function before sending a request to Portainer BeforeRequest(hook func(req *http.Request) (err error)) @@ -301,7 +301,7 @@ func (n *portainerClientImp) EndpointDockerInfo(endpointID portainer.EndpointID) return } -func (n *portainerClientImp) GetStatus() (status portainer.Status, err error) { +func (n *portainerClientImp) Status() (status portainer.Status, err error) { err = n.doJSONWithToken("status", http.MethodGet, http.Header{}, nil, &status) return } diff --git a/cmd/status.go b/cmd/status.go index 7602a8c..abe67dc 100644 --- a/cmd/status.go +++ b/cmd/status.go @@ -26,7 +26,7 @@ var statusCmd = &cobra.Command{ client, err := common.GetClient() common.CheckError(err) - respBody, err := client.GetStatus() + respBody, err := client.Status() common.CheckError(err) switch viper.GetString("status.format") { From 26a3efdd3a333a8f092a8d7779622ff76195613f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 01:40:15 -0400 Subject: [PATCH 11/17] Add options object for PortainerClient.StackList() --- client/client.go | 16 ++++++++-------- cmd/stackList.go | 15 ++++++++++++--- common/utils.go | 9 ++++++++- 3 files changed, 28 insertions(+), 12 deletions(-) diff --git a/client/client.go b/client/client.go index 0566d4c..c16a8ff 100644 --- a/client/client.go +++ b/client/client.go @@ -19,6 +19,11 @@ type StackListFilter struct { EndpointID portainer.EndpointID `json:"EndpointId,omitempty"` } +// StackListOptions represents options passed to PortainerClient.StackList() +type StackListOptions struct { + Filter StackListFilter +} + // Config represents a Portainer client configuration type Config struct { URL *url.URL @@ -41,7 +46,7 @@ type PortainerClient interface { EndpointGroupList() ([]portainer.EndpointGroup, error) // Get stacks, optionally filtered by swarmId and endpointId - StackList(swarmID string, endpointID portainer.EndpointID) ([]portainer.Stack, error) + StackList(options StackListOptions) ([]portainer.Stack, error) // Create swarm stack StackCreateSwarm(stackName string, environmentVariables []portainer.Pair, stackFileContent string, swarmClusterID string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) @@ -231,13 +236,8 @@ func (n *portainerClientImp) EndpointGroupList() (endpointGroups []portainer.End return } -func (n *portainerClientImp) StackList(swarmID string, endpointID portainer.EndpointID) (stacks []portainer.Stack, err error) { - filter := StackListFilter{ - SwarmID: swarmID, - EndpointID: endpointID, - } - - filterJSONBytes, _ := json.Marshal(filter) +func (n *portainerClientImp) StackList(options StackListOptions) (stacks []portainer.Stack, err error) { + filterJSONBytes, _ := json.Marshal(options.Filter) filterJSONString := string(filterJSONBytes) err = n.doJSONWithToken(fmt.Sprintf("stacks?filters=%s", filterJSONString), http.MethodGet, http.Header{}, nil, &stacks) diff --git a/cmd/stackList.go b/cmd/stackList.go index d073427..88cdfa8 100644 --- a/cmd/stackList.go +++ b/cmd/stackList.go @@ -53,14 +53,23 @@ var stackListCmd = &cobra.Command{ logrus.WithFields(logrus.Fields{ "endpoint": endpoint.Name, }).Debug("Getting stacks") - stacks, err = portainerClient.StackList(endpointSwarmClusterID, endpoint.ID) + stacks, err = portainerClient.StackList(client.StackListOptions{ + Filter: client.StackListFilter{ + SwarmID: endpointSwarmClusterID, + EndpointID: endpoint.ID, + }, + }) common.CheckError(err) } else if selectionErr == common.ErrStackClusterNotFound { // It's not a swarm cluster logrus.WithFields(logrus.Fields{ "endpoint": endpoint.Name, }).Debug("Getting stacks") - stacks, err = portainerClient.StackList("", endpoint.ID) + stacks, err = portainerClient.StackList(client.StackListOptions{ + Filter: client.StackListFilter{ + EndpointID: endpoint.ID, + }, + }) common.CheckError(err) } else { // Something else happened @@ -68,7 +77,7 @@ var stackListCmd = &cobra.Command{ } } else { logrus.Debug("Getting stacks") - stacks, err = portainerClient.StackList("", 0) + stacks, err = portainerClient.StackList(client.StackListOptions{}) common.CheckError(err) } diff --git a/common/utils.go b/common/utils.go index 28a1d09..1b34702 100644 --- a/common/utils.go +++ b/common/utils.go @@ -4,6 +4,8 @@ import ( "fmt" "reflect" + "github.com/greenled/portainer-stack-utils/client" + portainer "github.com/portainer/portainer/api" "github.com/sirupsen/logrus" ) @@ -63,7 +65,12 @@ func GetStackByName(name string, swarmID string, endpointID portainer.EndpointID return } - stacks, err := portainerClient.StackList(swarmID, endpointID) + stacks, err := portainerClient.StackList(client.StackListOptions{ + Filter: client.StackListFilter{ + SwarmID: swarmID, + EndpointID: endpointID, + }, + }) if err != nil { return } From 768410ce20a7470f1cca6ce30a511aa90650fe89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 01:46:28 -0400 Subject: [PATCH 12/17] Add options object for PortainerClient.StackCreateSwarm() --- client/client.go | 23 ++++++++++++++++------- cmd/stackDeploy.go | 10 +++++++++- 2 files changed, 25 insertions(+), 8 deletions(-) diff --git a/client/client.go b/client/client.go index c16a8ff..fdf975a 100644 --- a/client/client.go +++ b/client/client.go @@ -24,6 +24,15 @@ type StackListOptions struct { Filter StackListFilter } +// StackCreateSwarmOptions represents options passed to PortainerClient.StackCreateSwarm() +type StackCreateSwarmOptions struct { + StackName string + EnvironmentVariables []portainer.Pair + StackFileContent string + SwarmClusterID string + EndpointID portainer.EndpointID +} + // Config represents a Portainer client configuration type Config struct { URL *url.URL @@ -49,7 +58,7 @@ type PortainerClient interface { StackList(options StackListOptions) ([]portainer.Stack, error) // Create swarm stack - StackCreateSwarm(stackName string, environmentVariables []portainer.Pair, stackFileContent string, swarmClusterID string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) + StackCreateSwarm(options StackCreateSwarmOptions) (stack portainer.Stack, err error) // Create compose stack StackCreateCompose(stackName string, environmentVariables []portainer.Pair, stackFileContent string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) @@ -244,15 +253,15 @@ func (n *portainerClientImp) StackList(options StackListOptions) (stacks []porta return } -func (n *portainerClientImp) StackCreateSwarm(stackName string, environmentVariables []portainer.Pair, stackFileContent string, swarmClusterID string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) { +func (n *portainerClientImp) StackCreateSwarm(options StackCreateSwarmOptions) (stack portainer.Stack, err error) { reqBody := StackCreateRequest{ - Name: stackName, - Env: environmentVariables, - SwarmID: swarmClusterID, - StackFileContent: stackFileContent, + Name: options.StackName, + Env: options.EnvironmentVariables, + SwarmID: options.SwarmClusterID, + StackFileContent: options.StackFileContent, } - err = n.doJSONWithToken(fmt.Sprintf("stacks?type=%v&method=%s&endpointId=%v", 1, "string", endpointID), http.MethodPost, http.Header{}, &reqBody, &stack) + err = n.doJSONWithToken(fmt.Sprintf("stacks?type=%v&method=%s&endpointId=%v", 1, "string", options.EndpointID), http.MethodPost, http.Header{}, &reqBody, &stack) return } diff --git a/cmd/stackDeploy.go b/cmd/stackDeploy.go index 0f5dc18..4b0b0c5 100644 --- a/cmd/stackDeploy.go +++ b/cmd/stackDeploy.go @@ -3,6 +3,8 @@ package cmd import ( "io/ioutil" + "github.com/greenled/portainer-stack-utils/client" + portainer "github.com/portainer/portainer/api" "github.com/sirupsen/logrus" @@ -135,7 +137,13 @@ var stackDeployCmd = &cobra.Command{ "stack": stackName, "endpoint": endpoint.Name, }).Info("Creating stack") - stack, deploymentErr := portainerClient.StackCreateSwarm(stackName, loadedEnvironmentVariables, stackFileContent, endpointSwarmClusterID, endpoint.ID) + stack, deploymentErr := portainerClient.StackCreateSwarm(client.StackCreateSwarmOptions{ + StackName: stackName, + EnvironmentVariables: loadedEnvironmentVariables, + StackFileContent: stackFileContent, + SwarmClusterID: endpointSwarmClusterID, + EndpointID: endpoint.ID, + }) common.CheckError(deploymentErr) logrus.WithFields(logrus.Fields{ "stack": stack.Name, From 17b941d10824b7bc492e934b25770a4eedb73aa5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 01:48:59 -0400 Subject: [PATCH 13/17] Add options object for PortainerClient.StackCreateCompose() --- client/client.go | 20 ++++++++++++++------ cmd/stackDeploy.go | 7 ++++++- 2 files changed, 20 insertions(+), 7 deletions(-) diff --git a/client/client.go b/client/client.go index fdf975a..7cb1b22 100644 --- a/client/client.go +++ b/client/client.go @@ -33,6 +33,14 @@ type StackCreateSwarmOptions struct { EndpointID portainer.EndpointID } +// StackCreateComposeOptions represents options passed to PortainerClient.StackCreateCompose() +type StackCreateComposeOptions struct { + StackName string + EnvironmentVariables []portainer.Pair + StackFileContent string + EndpointID portainer.EndpointID +} + // Config represents a Portainer client configuration type Config struct { URL *url.URL @@ -61,7 +69,7 @@ type PortainerClient interface { StackCreateSwarm(options StackCreateSwarmOptions) (stack portainer.Stack, err error) // Create compose stack - StackCreateCompose(stackName string, environmentVariables []portainer.Pair, stackFileContent string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) + StackCreateCompose(options StackCreateComposeOptions) (stack portainer.Stack, err error) // Update stack StackUpdate(stack portainer.Stack, environmentVariables []portainer.Pair, stackFileContent string, prune bool, endpointID portainer.EndpointID) error @@ -265,14 +273,14 @@ func (n *portainerClientImp) StackCreateSwarm(options StackCreateSwarmOptions) ( return } -func (n *portainerClientImp) StackCreateCompose(stackName string, environmentVariables []portainer.Pair, stackFileContent string, endpointID portainer.EndpointID) (stack portainer.Stack, err error) { +func (n *portainerClientImp) StackCreateCompose(options StackCreateComposeOptions) (stack portainer.Stack, err error) { reqBody := StackCreateRequest{ - Name: stackName, - Env: environmentVariables, - StackFileContent: stackFileContent, + Name: options.StackName, + Env: options.EnvironmentVariables, + StackFileContent: options.StackFileContent, } - err = n.doJSONWithToken(fmt.Sprintf("stacks?type=%v&method=%s&endpointId=%v", 2, "string", endpointID), http.MethodPost, http.Header{}, &reqBody, &stack) + err = n.doJSONWithToken(fmt.Sprintf("stacks?type=%v&method=%s&endpointId=%v", 2, "string", options.EndpointID), http.MethodPost, http.Header{}, &reqBody, &stack) return } diff --git a/cmd/stackDeploy.go b/cmd/stackDeploy.go index 4b0b0c5..2d5a293 100644 --- a/cmd/stackDeploy.go +++ b/cmd/stackDeploy.go @@ -156,7 +156,12 @@ var stackDeployCmd = &cobra.Command{ "stack": stackName, "endpoint": endpoint.Name, }).Info("Creating stack") - stack, deploymentErr := portainerClient.StackCreateCompose(stackName, loadedEnvironmentVariables, stackFileContent, endpoint.ID) + stack, deploymentErr := portainerClient.StackCreateCompose(client.StackCreateComposeOptions{ + StackName: stackName, + EnvironmentVariables: loadedEnvironmentVariables, + StackFileContent: stackFileContent, + EndpointID: endpoint.ID, + }) common.CheckError(deploymentErr) logrus.WithFields(logrus.Fields{ "stack": stack.Name, From d17b9eb9f546dce936908fab1926a8d54cf96748 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 01:52:41 -0400 Subject: [PATCH 14/17] Add options object for PortainerClient.StackUpdate() --- client/client.go | 21 +++++++++++++++------ cmd/stackDeploy.go | 8 +++++++- 2 files changed, 22 insertions(+), 7 deletions(-) diff --git a/client/client.go b/client/client.go index 7cb1b22..e80be22 100644 --- a/client/client.go +++ b/client/client.go @@ -41,6 +41,15 @@ type StackCreateComposeOptions struct { EndpointID portainer.EndpointID } +// StackUpdateOptions represents options passed to PortainerClient.StackUpdate() +type StackUpdateOptions struct { + Stack portainer.Stack + EnvironmentVariables []portainer.Pair + StackFileContent string + Prune bool + EndpointID portainer.EndpointID +} + // Config represents a Portainer client configuration type Config struct { URL *url.URL @@ -72,7 +81,7 @@ type PortainerClient interface { StackCreateCompose(options StackCreateComposeOptions) (stack portainer.Stack, err error) // Update stack - StackUpdate(stack portainer.Stack, environmentVariables []portainer.Pair, stackFileContent string, prune bool, endpointID portainer.EndpointID) error + StackUpdate(options StackUpdateOptions) error // Delete stack StackDelete(stackID portainer.StackID) error @@ -284,14 +293,14 @@ func (n *portainerClientImp) StackCreateCompose(options StackCreateComposeOption return } -func (n *portainerClientImp) StackUpdate(stack portainer.Stack, environmentVariables []portainer.Pair, stackFileContent string, prune bool, endpointID portainer.EndpointID) (err error) { +func (n *portainerClientImp) StackUpdate(options StackUpdateOptions) (err error) { reqBody := StackUpdateRequest{ - Env: environmentVariables, - StackFileContent: stackFileContent, - Prune: prune, + Env: options.EnvironmentVariables, + StackFileContent: options.StackFileContent, + Prune: options.Prune, } - err = n.doJSONWithToken(fmt.Sprintf("stacks/%v?endpointId=%v", stack.ID, endpointID), http.MethodPut, http.Header{}, &reqBody, nil) + err = n.doJSONWithToken(fmt.Sprintf("stacks/%v?endpointId=%v", options.Stack.ID, options.EndpointID), http.MethodPut, http.Header{}, &reqBody, nil) return } diff --git a/cmd/stackDeploy.go b/cmd/stackDeploy.go index 2d5a293..dfdde9e 100644 --- a/cmd/stackDeploy.go +++ b/cmd/stackDeploy.go @@ -117,7 +117,13 @@ var stackDeployCmd = &cobra.Command{ logrus.WithFields(logrus.Fields{ "stack": retrievedStack.Name, }).Info("Updating stack") - err := portainerClient.StackUpdate(retrievedStack, newEnvironmentVariables, stackFileContent, viper.GetBool("stack.deploy.prune"), endpoint.ID) + err := portainerClient.StackUpdate(client.StackUpdateOptions{ + Stack: retrievedStack, + EnvironmentVariables: newEnvironmentVariables, + StackFileContent: stackFileContent, + Prune: viper.GetBool("stack.deploy.prune"), + EndpointID: endpoint.ID, + }) common.CheckError(err) } else if stackRetrievalErr == common.ErrStackNotFound { // We are deploying a new stack From f745392e413b00bb4aa1354d1a36936c6a441152 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 01:59:40 -0400 Subject: [PATCH 15/17] Rename client/portainerTypes.go to types.go --- client/{portainerTypes.go => types.go} | 0 client/{portainerTypes_test.go => types_test.go} | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename client/{portainerTypes.go => types.go} (100%) rename client/{portainerTypes_test.go => types_test.go} (100%) diff --git a/client/portainerTypes.go b/client/types.go similarity index 100% rename from client/portainerTypes.go rename to client/types.go diff --git a/client/portainerTypes_test.go b/client/types_test.go similarity index 100% rename from client/portainerTypes_test.go rename to client/types_test.go From 5d95af3681d54e9dbb36b6b19ce8c6db9b155594 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 02:29:58 -0400 Subject: [PATCH 16/17] Split Portainer client source file into several function-related ones --- client/auth.go | 32 +++++ client/auth_test.go | 48 +++++++ client/client.go | 159 ----------------------- client/client_test.go | 86 ------------ client/endpointGroup_list.go | 12 ++ client/endpoint_docker_info.go | 13 ++ client/endpoint_list.go | 12 ++ client/errors.go | 16 +++ client/{types_test.go => errors_test.go} | 39 ------ client/stackFile_inspect.go | 26 ++++ client/stack_create.go | 56 ++++++++ client/stack_delete.go | 13 ++ client/stack_list.go | 28 ++++ client/stack_update.go | 35 +++++ client/status.go | 12 ++ client/types.go | 63 --------- client/utils.go | 44 +++++++ client/utils_test.go | 97 ++++++++++++++ 18 files changed, 444 insertions(+), 347 deletions(-) create mode 100644 client/auth.go create mode 100644 client/auth_test.go create mode 100644 client/endpointGroup_list.go create mode 100644 client/endpoint_docker_info.go create mode 100644 client/endpoint_list.go create mode 100644 client/errors.go rename client/{types_test.go => errors_test.go} (59%) create mode 100644 client/stackFile_inspect.go create mode 100644 client/stack_create.go create mode 100644 client/stack_delete.go create mode 100644 client/stack_list.go create mode 100644 client/stack_update.go create mode 100644 client/status.go delete mode 100644 client/types.go create mode 100644 client/utils.go create mode 100644 client/utils_test.go diff --git a/client/auth.go b/client/auth.go new file mode 100644 index 0000000..dbf4d93 --- /dev/null +++ b/client/auth.go @@ -0,0 +1,32 @@ +package client + +import "net/http" + +// AuthenticateUserRequest represents the body of a request to POST /auth +type AuthenticateUserRequest struct { + Username string + Password string +} + +// AuthenticateUserResponse represents the body of a response for a request to POST /auth +type AuthenticateUserResponse struct { + Jwt string +} + +func (n *portainerClientImp) Auth() (token string, err error) { + reqBody := AuthenticateUserRequest{ + Username: n.user, + Password: n.password, + } + + respBody := AuthenticateUserResponse{} + + err = n.doJSON("auth", http.MethodPost, http.Header{}, &reqBody, &respBody) + if err != nil { + return + } + + token = respBody.Jwt + + return +} diff --git a/client/auth_test.go b/client/auth_test.go new file mode 100644 index 0000000..f837d5d --- /dev/null +++ b/client/auth_test.go @@ -0,0 +1,48 @@ +package client + +import ( + "net/http" + "net/http/httptest" + "net/url" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestClientAuthenticates(t *testing.T) { + ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { + var body map[string]interface{} + err := readRequestBodyAsJSON(req, &body) + + assert.Equal(t, req.Method, http.MethodPost) + assert.Equal(t, req.RequestURI, "/api/auth") + assert.NotNil(t, req.Header["Content-Type"]) + assert.NotNil(t, req.Header["Content-Type"][0]) + assert.Equal(t, req.Header["Content-Type"][0], "application/json") + assert.NotNil(t, req.Header["User-Agent"]) + assert.NotNil(t, req.Header["User-Agent"][0]) + assert.Equal(t, req.Header["User-Agent"][0], "GE007") + assert.Nil(t, err) + assert.NotNil(t, body["Username"]) + assert.Equal(t, body["Username"], "admin") + assert.NotNil(t, body["Password"]) + assert.Equal(t, body["Password"], "a") + + writeResponseBodyAsJSON(w, map[string]interface{}{ + "jwt": "somerandomtoken", + }) + })) + defer ts.Close() + + apiURL, _ := url.Parse(ts.URL + "/api/") + + customClient := NewClient(ts.Client(), Config{ + URL: apiURL, + User: "admin", + Password: "a", + UserAgent: "GE007", + }) + token, err := customClient.Auth() + assert.Nil(t, err) + assert.Equal(t, token, "somerandomtoken") +} diff --git a/client/client.go b/client/client.go index e80be22..6f3bf88 100644 --- a/client/client.go +++ b/client/client.go @@ -3,53 +3,13 @@ package client import ( "bytes" "encoding/json" - "errors" - "fmt" "io" - "io/ioutil" "net/http" "net/url" portainer "github.com/portainer/portainer/api" ) -// StackListFilter represents a filter for a stack list -type StackListFilter struct { - SwarmID string `json:"SwarmId,omitempty"` - EndpointID portainer.EndpointID `json:"EndpointId,omitempty"` -} - -// StackListOptions represents options passed to PortainerClient.StackList() -type StackListOptions struct { - Filter StackListFilter -} - -// StackCreateSwarmOptions represents options passed to PortainerClient.StackCreateSwarm() -type StackCreateSwarmOptions struct { - StackName string - EnvironmentVariables []portainer.Pair - StackFileContent string - SwarmClusterID string - EndpointID portainer.EndpointID -} - -// StackCreateComposeOptions represents options passed to PortainerClient.StackCreateCompose() -type StackCreateComposeOptions struct { - StackName string - EnvironmentVariables []portainer.Pair - StackFileContent string - EndpointID portainer.EndpointID -} - -// StackUpdateOptions represents options passed to PortainerClient.StackUpdate() -type StackUpdateOptions struct { - Stack portainer.Stack - EnvironmentVariables []portainer.Pair - StackFileContent string - Prune bool - EndpointID portainer.EndpointID -} - // Config represents a Portainer client configuration type Config struct { URL *url.URL @@ -113,27 +73,6 @@ type portainerClientImp struct { afterResponseHooks []func(resp *http.Response) (err error) } -// Check if an http.Response object has errors -func checkResponseForErrors(resp *http.Response) error { - if 300 <= resp.StatusCode { - // Guess it's a GenericError - respBody := GenericError{} - err := json.NewDecoder(resp.Body).Decode(&respBody) - if err != nil { - // It's not a GenericError - bodyBytes, err := ioutil.ReadAll(resp.Body) - defer resp.Body.Close() - if err != nil { - return err - } - resp.Body = ioutil.NopCloser(bytes.NewReader(bodyBytes)) - return errors.New(string(bodyBytes)) - } - return &respBody - } - return nil -} - // Do an http request func (n *portainerClientImp) do(uri, method string, requestBody io.Reader, headers http.Header) (resp *http.Response, err error) { requestURL, err := n.url.Parse(uri) @@ -234,104 +173,6 @@ func (n *portainerClientImp) AfterResponse(hook func(resp *http.Response) (err e n.afterResponseHooks = append(n.afterResponseHooks, hook) } -func (n *portainerClientImp) Auth() (token string, err error) { - reqBody := AuthenticateUserRequest{ - Username: n.user, - Password: n.password, - } - - respBody := AuthenticateUserResponse{} - - err = n.doJSON("auth", http.MethodPost, http.Header{}, &reqBody, &respBody) - if err != nil { - return - } - - token = respBody.Jwt - - return -} - -func (n *portainerClientImp) EndpointList() (endpoints []portainer.Endpoint, err error) { - err = n.doJSONWithToken("endpoints", http.MethodGet, http.Header{}, nil, &endpoints) - return -} - -func (n *portainerClientImp) EndpointGroupList() (endpointGroups []portainer.EndpointGroup, err error) { - err = n.doJSONWithToken("endpoint_groups", http.MethodGet, http.Header{}, nil, &endpointGroups) - return -} - -func (n *portainerClientImp) StackList(options StackListOptions) (stacks []portainer.Stack, err error) { - filterJSONBytes, _ := json.Marshal(options.Filter) - filterJSONString := string(filterJSONBytes) - - err = n.doJSONWithToken(fmt.Sprintf("stacks?filters=%s", filterJSONString), http.MethodGet, http.Header{}, nil, &stacks) - return -} - -func (n *portainerClientImp) StackCreateSwarm(options StackCreateSwarmOptions) (stack portainer.Stack, err error) { - reqBody := StackCreateRequest{ - Name: options.StackName, - Env: options.EnvironmentVariables, - SwarmID: options.SwarmClusterID, - StackFileContent: options.StackFileContent, - } - - err = n.doJSONWithToken(fmt.Sprintf("stacks?type=%v&method=%s&endpointId=%v", 1, "string", options.EndpointID), http.MethodPost, http.Header{}, &reqBody, &stack) - return -} - -func (n *portainerClientImp) StackCreateCompose(options StackCreateComposeOptions) (stack portainer.Stack, err error) { - reqBody := StackCreateRequest{ - Name: options.StackName, - Env: options.EnvironmentVariables, - StackFileContent: options.StackFileContent, - } - - err = n.doJSONWithToken(fmt.Sprintf("stacks?type=%v&method=%s&endpointId=%v", 2, "string", options.EndpointID), http.MethodPost, http.Header{}, &reqBody, &stack) - return -} - -func (n *portainerClientImp) StackUpdate(options StackUpdateOptions) (err error) { - reqBody := StackUpdateRequest{ - Env: options.EnvironmentVariables, - StackFileContent: options.StackFileContent, - Prune: options.Prune, - } - - err = n.doJSONWithToken(fmt.Sprintf("stacks/%v?endpointId=%v", options.Stack.ID, options.EndpointID), http.MethodPut, http.Header{}, &reqBody, nil) - return -} - -func (n *portainerClientImp) StackDelete(stackID portainer.StackID) (err error) { - err = n.doJSONWithToken(fmt.Sprintf("stacks/%d", stackID), http.MethodDelete, http.Header{}, nil, nil) - return -} - -func (n *portainerClientImp) StackFileInspect(stackID portainer.StackID) (content string, err error) { - var respBody StackFileInspectResponse - - err = n.doJSONWithToken(fmt.Sprintf("stacks/%v/file", stackID), http.MethodGet, http.Header{}, nil, &respBody) - if err != nil { - return - } - - content = respBody.StackFileContent - - return -} - -func (n *portainerClientImp) EndpointDockerInfo(endpointID portainer.EndpointID) (info map[string]interface{}, err error) { - err = n.doJSONWithToken(fmt.Sprintf("endpoints/%v/docker/info", endpointID), http.MethodGet, http.Header{}, nil, &info) - return -} - -func (n *portainerClientImp) Status() (status portainer.Status, err error) { - err = n.doJSONWithToken("status", http.MethodGet, http.Header{}, nil, &status) - return -} - // NewClient creates a new Portainer API client func NewClient(httpClient *http.Client, config Config) PortainerClient { return &portainerClientImp{ diff --git a/client/client_test.go b/client/client_test.go index 88726c2..275f3df 100644 --- a/client/client_test.go +++ b/client/client_test.go @@ -1,7 +1,6 @@ package client import ( - "bytes" "encoding/json" "fmt" "io" @@ -36,44 +35,6 @@ func TestNewClient(t *testing.T) { assert.NotNil(t, validClient) } -func TestClientAuthenticates(t *testing.T) { - ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { - var body map[string]interface{} - err := readRequestBodyAsJSON(req, &body) - - assert.Equal(t, req.Method, http.MethodPost) - assert.Equal(t, req.RequestURI, "/api/auth") - assert.NotNil(t, req.Header["Content-Type"]) - assert.NotNil(t, req.Header["Content-Type"][0]) - assert.Equal(t, req.Header["Content-Type"][0], "application/json") - assert.NotNil(t, req.Header["User-Agent"]) - assert.NotNil(t, req.Header["User-Agent"][0]) - assert.Equal(t, req.Header["User-Agent"][0], "GE007") - assert.Nil(t, err) - assert.NotNil(t, body["Username"]) - assert.Equal(t, body["Username"], "admin") - assert.NotNil(t, body["Password"]) - assert.Equal(t, body["Password"], "a") - - writeResponseBodyAsJSON(w, map[string]interface{}{ - "jwt": "somerandomtoken", - }) - })) - defer ts.Close() - - apiURL, _ := url.Parse(ts.URL + "/api/") - - customClient := NewClient(ts.Client(), Config{ - URL: apiURL, - User: "admin", - Password: "a", - UserAgent: "GE007", - }) - token, err := customClient.Auth() - assert.Nil(t, err) - assert.Equal(t, token, "somerandomtoken") -} - func Test_portainerClientImp_do(t *testing.T) { type fields struct { user string @@ -184,50 +145,3 @@ func Test_portainerClientImp_do(t *testing.T) { }) } } - -func Test_checkResponseForErrors(t *testing.T) { - type args struct { - resp *http.Response - } - tests := []struct { - name string - args args - wantErr bool - }{ - { - name: "generic error", - args: args{ - resp: func() (resp *http.Response) { - resp = &http.Response{ - StatusCode: http.StatusNotFound, - } - bodyBytes, _ := json.Marshal(map[string]interface{}{ - "Err": "Error", - "Details": "Not found", - }) - resp.Body = ioutil.NopCloser(bytes.NewReader(bodyBytes)) - return - }(), - }, - wantErr: true, - }, - { - name: "non generic error", - args: args{ - resp: func() (resp *http.Response) { - resp = &http.Response{ - StatusCode: http.StatusNotFound, - Body: ioutil.NopCloser(bytes.NewReader([]byte("Err"))), - } - return - }(), - }, - wantErr: true, - }, - } - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - assert.Equal(t, tt.wantErr, checkResponseForErrors(tt.args.resp) != nil) - }) - } -} diff --git a/client/endpointGroup_list.go b/client/endpointGroup_list.go new file mode 100644 index 0000000..89de541 --- /dev/null +++ b/client/endpointGroup_list.go @@ -0,0 +1,12 @@ +package client + +import ( + "net/http" + + portainer "github.com/portainer/portainer/api" +) + +func (n *portainerClientImp) EndpointGroupList() (endpointGroups []portainer.EndpointGroup, err error) { + err = n.doJSONWithToken("endpoint_groups", http.MethodGet, http.Header{}, nil, &endpointGroups) + return +} diff --git a/client/endpoint_docker_info.go b/client/endpoint_docker_info.go new file mode 100644 index 0000000..83fb90e --- /dev/null +++ b/client/endpoint_docker_info.go @@ -0,0 +1,13 @@ +package client + +import ( + "fmt" + "net/http" + + portainer "github.com/portainer/portainer/api" +) + +func (n *portainerClientImp) EndpointDockerInfo(endpointID portainer.EndpointID) (info map[string]interface{}, err error) { + err = n.doJSONWithToken(fmt.Sprintf("endpoints/%v/docker/info", endpointID), http.MethodGet, http.Header{}, nil, &info) + return +} diff --git a/client/endpoint_list.go b/client/endpoint_list.go new file mode 100644 index 0000000..2aac0e9 --- /dev/null +++ b/client/endpoint_list.go @@ -0,0 +1,12 @@ +package client + +import ( + "net/http" + + portainer "github.com/portainer/portainer/api" +) + +func (n *portainerClientImp) EndpointList() (endpoints []portainer.Endpoint, err error) { + err = n.doJSONWithToken("endpoints", http.MethodGet, http.Header{}, nil, &endpoints) + return +} diff --git a/client/errors.go b/client/errors.go new file mode 100644 index 0000000..6a77642 --- /dev/null +++ b/client/errors.go @@ -0,0 +1,16 @@ +package client + +import "fmt" + +// GenericError represents the body of a generic error returned by the Portainer API +type GenericError struct { + Err string + Details string +} + +func (e *GenericError) Error() string { + if e.Details != "" { + return fmt.Sprintf("%s: %s", e.Err, e.Details) + } + return fmt.Sprintf("%s", e.Err) +} diff --git a/client/types_test.go b/client/errors_test.go similarity index 59% rename from client/types_test.go rename to client/errors_test.go index eb7050e..a0ebaef 100644 --- a/client/types_test.go +++ b/client/errors_test.go @@ -3,48 +3,9 @@ package client import ( "testing" - portainer "github.com/portainer/portainer/api" "github.com/stretchr/testify/assert" ) -func TestGetTranslatedStackType(t *testing.T) { - type args struct { - t portainer.StackType - } - tests := []struct { - name string - args args - want string - }{ - { - name: "swarm stack type", - args: args{ - t: portainer.DockerSwarmStack, - }, - want: "swarm", - }, - { - name: "compose stack type", - args: args{ - t: portainer.DockerComposeStack, - }, - want: "compose", - }, - { - name: "unknown stack type", - args: args{ - t: 100, - }, - want: "", - }, - } - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - assert.Equal(t, tt.want, GetTranslatedStackType(tt.args.t)) - }) - } -} - func TestGenericError_Error(t *testing.T) { type fields struct { Err string diff --git a/client/stackFile_inspect.go b/client/stackFile_inspect.go new file mode 100644 index 0000000..7ef6720 --- /dev/null +++ b/client/stackFile_inspect.go @@ -0,0 +1,26 @@ +package client + +import ( + "fmt" + "net/http" + + portainer "github.com/portainer/portainer/api" +) + +// StackFileInspectResponse represents the body of a response for a request to GET /stack/{id}/file +type StackFileInspectResponse struct { + StackFileContent string +} + +func (n *portainerClientImp) StackFileInspect(stackID portainer.StackID) (content string, err error) { + var respBody StackFileInspectResponse + + err = n.doJSONWithToken(fmt.Sprintf("stacks/%v/file", stackID), http.MethodGet, http.Header{}, nil, &respBody) + if err != nil { + return + } + + content = respBody.StackFileContent + + return +} diff --git a/client/stack_create.go b/client/stack_create.go new file mode 100644 index 0000000..d93011c --- /dev/null +++ b/client/stack_create.go @@ -0,0 +1,56 @@ +package client + +import ( + "fmt" + "net/http" + + portainer "github.com/portainer/portainer/api" +) + +// StackCreateComposeOptions represents options passed to PortainerClient.StackCreateCompose() +type StackCreateComposeOptions struct { + StackName string + EnvironmentVariables []portainer.Pair + StackFileContent string + EndpointID portainer.EndpointID +} + +// StackCreateRequest represents the body of a request to POST /stacks +type StackCreateRequest struct { + Name string + SwarmID string + StackFileContent string + Env []portainer.Pair `json:",omitempty"` +} + +// StackCreateSwarmOptions represents options passed to PortainerClient.StackCreateSwarm() +type StackCreateSwarmOptions struct { + StackName string + EnvironmentVariables []portainer.Pair + StackFileContent string + SwarmClusterID string + EndpointID portainer.EndpointID +} + +func (n *portainerClientImp) StackCreateCompose(options StackCreateComposeOptions) (stack portainer.Stack, err error) { + reqBody := StackCreateRequest{ + Name: options.StackName, + Env: options.EnvironmentVariables, + StackFileContent: options.StackFileContent, + } + + err = n.doJSONWithToken(fmt.Sprintf("stacks?type=%v&method=%s&endpointId=%v", 2, "string", options.EndpointID), http.MethodPost, http.Header{}, &reqBody, &stack) + return +} + +func (n *portainerClientImp) StackCreateSwarm(options StackCreateSwarmOptions) (stack portainer.Stack, err error) { + reqBody := StackCreateRequest{ + Name: options.StackName, + Env: options.EnvironmentVariables, + SwarmID: options.SwarmClusterID, + StackFileContent: options.StackFileContent, + } + + err = n.doJSONWithToken(fmt.Sprintf("stacks?type=%v&method=%s&endpointId=%v", 1, "string", options.EndpointID), http.MethodPost, http.Header{}, &reqBody, &stack) + return +} diff --git a/client/stack_delete.go b/client/stack_delete.go new file mode 100644 index 0000000..f67fc20 --- /dev/null +++ b/client/stack_delete.go @@ -0,0 +1,13 @@ +package client + +import ( + "fmt" + "net/http" + + portainer "github.com/portainer/portainer/api" +) + +func (n *portainerClientImp) StackDelete(stackID portainer.StackID) (err error) { + err = n.doJSONWithToken(fmt.Sprintf("stacks/%d", stackID), http.MethodDelete, http.Header{}, nil, nil) + return +} diff --git a/client/stack_list.go b/client/stack_list.go new file mode 100644 index 0000000..7b74c6d --- /dev/null +++ b/client/stack_list.go @@ -0,0 +1,28 @@ +package client + +import ( + "encoding/json" + "fmt" + "net/http" + + portainer "github.com/portainer/portainer/api" +) + +// StackListFilter represents a filter for a stack list +type StackListFilter struct { + SwarmID string `json:"SwarmId,omitempty"` + EndpointID portainer.EndpointID `json:"EndpointId,omitempty"` +} + +// StackListOptions represents options passed to PortainerClient.StackList() +type StackListOptions struct { + Filter StackListFilter +} + +func (n *portainerClientImp) StackList(options StackListOptions) (stacks []portainer.Stack, err error) { + filterJSONBytes, _ := json.Marshal(options.Filter) + filterJSONString := string(filterJSONBytes) + + err = n.doJSONWithToken(fmt.Sprintf("stacks?filters=%s", filterJSONString), http.MethodGet, http.Header{}, nil, &stacks) + return +} diff --git a/client/stack_update.go b/client/stack_update.go new file mode 100644 index 0000000..45ea6b8 --- /dev/null +++ b/client/stack_update.go @@ -0,0 +1,35 @@ +package client + +import ( + "fmt" + "net/http" + + portainer "github.com/portainer/portainer/api" +) + +// StackUpdateOptions represents options passed to PortainerClient.StackUpdate() +type StackUpdateOptions struct { + Stack portainer.Stack + EnvironmentVariables []portainer.Pair + StackFileContent string + Prune bool + EndpointID portainer.EndpointID +} + +// StackUpdateRequest represents the body of a request to PUT /stacks/{id} +type StackUpdateRequest struct { + StackFileContent string + Env []portainer.Pair `json:",omitempty"` + Prune bool +} + +func (n *portainerClientImp) StackUpdate(options StackUpdateOptions) (err error) { + reqBody := StackUpdateRequest{ + Env: options.EnvironmentVariables, + StackFileContent: options.StackFileContent, + Prune: options.Prune, + } + + err = n.doJSONWithToken(fmt.Sprintf("stacks/%v?endpointId=%v", options.Stack.ID, options.EndpointID), http.MethodPut, http.Header{}, &reqBody, nil) + return +} diff --git a/client/status.go b/client/status.go new file mode 100644 index 0000000..62744bd --- /dev/null +++ b/client/status.go @@ -0,0 +1,12 @@ +package client + +import ( + "net/http" + + portainer "github.com/portainer/portainer/api" +) + +func (n *portainerClientImp) Status() (status portainer.Status, err error) { + err = n.doJSONWithToken("status", http.MethodGet, http.Header{}, nil, &status) + return +} diff --git a/client/types.go b/client/types.go deleted file mode 100644 index 48d9d9a..0000000 --- a/client/types.go +++ /dev/null @@ -1,63 +0,0 @@ -package client - -import ( - "fmt" - - portainer "github.com/portainer/portainer/api" -) - -// GetTranslatedStackType returns a stack's Type field (int) translated to it's human readable form (string) -func GetTranslatedStackType(t portainer.StackType) string { - switch t { - case portainer.DockerSwarmStack: - return "swarm" - case portainer.DockerComposeStack: - return "compose" - default: - return "" - } -} - -// StackCreateRequest represents the body of a request to POST /stacks -type StackCreateRequest struct { - Name string - SwarmID string - StackFileContent string - Env []portainer.Pair `json:",omitempty"` -} - -// StackUpdateRequest represents the body of a request to PUT /stacks/{id} -type StackUpdateRequest struct { - StackFileContent string - Env []portainer.Pair `json:",omitempty"` - Prune bool -} - -// StackFileInspectResponse represents the body of a response for a request to GET /stack/{id}/file -type StackFileInspectResponse struct { - StackFileContent string -} - -// GenericError represents the body of a generic error returned by the Portainer API -type GenericError struct { - Err string - Details string -} - -func (e *GenericError) Error() string { - if e.Details != "" { - return fmt.Sprintf("%s: %s", e.Err, e.Details) - } - return fmt.Sprintf("%s", e.Err) -} - -// AuthenticateUserRequest represents the body of a request to POST /auth -type AuthenticateUserRequest struct { - Username string - Password string -} - -// AuthenticateUserResponse represents the body of a response for a request to POST /auth -type AuthenticateUserResponse struct { - Jwt string -} diff --git a/client/utils.go b/client/utils.go new file mode 100644 index 0000000..173b31f --- /dev/null +++ b/client/utils.go @@ -0,0 +1,44 @@ +package client + +import ( + "bytes" + "encoding/json" + "errors" + "io/ioutil" + "net/http" + + portainer "github.com/portainer/portainer/api" +) + +// GetTranslatedStackType returns a stack's Type field (int) translated to it's human readable form (string) +func GetTranslatedStackType(t portainer.StackType) string { + switch t { + case portainer.DockerSwarmStack: + return "swarm" + case portainer.DockerComposeStack: + return "compose" + default: + return "" + } +} + +// Check if an http.Response object has errors +func checkResponseForErrors(resp *http.Response) error { + if 300 <= resp.StatusCode { + // Guess it's a GenericError + respBody := GenericError{} + err := json.NewDecoder(resp.Body).Decode(&respBody) + if err != nil { + // It's not a GenericError + bodyBytes, err := ioutil.ReadAll(resp.Body) + defer resp.Body.Close() + if err != nil { + return err + } + resp.Body = ioutil.NopCloser(bytes.NewReader(bodyBytes)) + return errors.New(string(bodyBytes)) + } + return &respBody + } + return nil +} diff --git a/client/utils_test.go b/client/utils_test.go new file mode 100644 index 0000000..a4f225e --- /dev/null +++ b/client/utils_test.go @@ -0,0 +1,97 @@ +package client + +import ( + "bytes" + "encoding/json" + "io/ioutil" + "net/http" + "testing" + + portainer "github.com/portainer/portainer/api" + "github.com/stretchr/testify/assert" +) + +func TestGetTranslatedStackType(t *testing.T) { + type args struct { + t portainer.StackType + } + tests := []struct { + name string + args args + want string + }{ + { + name: "swarm stack type", + args: args{ + t: portainer.DockerSwarmStack, + }, + want: "swarm", + }, + { + name: "compose stack type", + args: args{ + t: portainer.DockerComposeStack, + }, + want: "compose", + }, + { + name: "unknown stack type", + args: args{ + t: 100, + }, + want: "", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + assert.Equal(t, tt.want, GetTranslatedStackType(tt.args.t)) + }) + } +} + +func Test_checkResponseForErrors(t *testing.T) { + type args struct { + resp *http.Response + } + tests := []struct { + name string + args args + wantErr bool + }{ + { + name: "generic error", + args: args{ + resp: func() (resp *http.Response) { + resp = &http.Response{ + StatusCode: http.StatusNotFound, + } + bodyBytes, _ := json.Marshal(map[string]interface{}{ + "Err": "Error", + "Details": "Not found", + }) + resp.Body = ioutil.NopCloser(bytes.NewReader(bodyBytes)) + return + }(), + }, + wantErr: true, + }, + { + name: "non generic error", + args: args{ + resp: func() (resp *http.Response) { + resp = &http.Response{ + StatusCode: http.StatusNotFound, + Body: ioutil.NopCloser(bytes.NewReader([]byte("Err"))), + } + return + }(), + }, + wantErr: true, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + assert.Equal(t, tt.wantErr, checkResponseForErrors(tt.args.resp) != nil) + }) + } +} From 22dc5e5d753e42dda3b0cd85b0e2190e1ac676ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Aug 2019 02:34:01 -0400 Subject: [PATCH 17/17] Rename PortainerClient.Auth() to AuthenticateUser() --- client/auth.go | 2 +- client/auth_test.go | 2 +- client/client.go | 6 +++--- cmd/login.go | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/client/auth.go b/client/auth.go index dbf4d93..71921cf 100644 --- a/client/auth.go +++ b/client/auth.go @@ -13,7 +13,7 @@ type AuthenticateUserResponse struct { Jwt string } -func (n *portainerClientImp) Auth() (token string, err error) { +func (n *portainerClientImp) AuthenticateUser() (token string, err error) { reqBody := AuthenticateUserRequest{ Username: n.user, Password: n.password, diff --git a/client/auth_test.go b/client/auth_test.go index f837d5d..5769575 100644 --- a/client/auth_test.go +++ b/client/auth_test.go @@ -42,7 +42,7 @@ func TestClientAuthenticates(t *testing.T) { Password: "a", UserAgent: "GE007", }) - token, err := customClient.Auth() + token, err := customClient.AuthenticateUser() assert.Nil(t, err) assert.Equal(t, token, "somerandomtoken") } diff --git a/client/client.go b/client/client.go index 6f3bf88..57c8904 100644 --- a/client/client.go +++ b/client/client.go @@ -22,8 +22,8 @@ type Config struct { // PortainerClient represents a Portainer API client type PortainerClient interface { - // Auth a user to get an auth token - Auth() (token string, err error) + // AuthenticateUser a user to get an auth token + AuthenticateUser() (token string, err error) // Get endpoints EndpointList() ([]portainer.Endpoint, error) @@ -155,7 +155,7 @@ func (n *portainerClientImp) doJSON(uri, method string, headers http.Header, req func (n *portainerClientImp) doJSONWithToken(uri, method string, headers http.Header, request interface{}, response interface{}) (err error) { // Ensure there is an auth token if n.token == "" { - n.token, err = n.Auth() + n.token, err = n.AuthenticateUser() if err != nil { return } diff --git a/cmd/login.go b/cmd/login.go index a3047dc..49f3191 100644 --- a/cmd/login.go +++ b/cmd/login.go @@ -22,7 +22,7 @@ var loginCmd = &cobra.Command{ logrus.WithFields(logrus.Fields{ "user": user, }).Debug("Getting auth token") - authToken, err := client.Auth() + authToken, err := client.AuthenticateUser() common.CheckError(err) if viper.GetBool("login.print") {