Skip to content

Commit aec1be4

Browse files
fangming-ning-spfangming-ning-sp
committed
PLTCONN-2935: More tests & mock out terminal for unit tests
1 parent e3033f9 commit aec1be4

15 files changed

+179
-39
lines changed

‎Makefile

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ clean:
55
.PHONY: mocks
66
mocks:
77
# Ref: https://github.com/golang/mock
8-
mockgen -source=client/client.go -destination=mocks/client.go -package=mocks
8+
mockgen -source=internal/client/client.go -destination=internal/mocks/client.go -package=mocks
9+
mockgen -source=internal/terminal/terminal.go -destination=internal/mocks/terminal.go -package=mocks
910

1011
.PHONY: test
1112
test:

‎cmd/configure/configure.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import (
77
"github.com/spf13/cobra"
88
)
99

10-
func NewConfigureCmd() *cobra.Command {
10+
func NewConfigureCmd(term terminal.Terminal) *cobra.Command {
1111
var ClientID string
1212
var ClientSecret string
1313
var err error
@@ -20,7 +20,7 @@ func NewConfigureCmd() *cobra.Command {
2020
RunE: func(cmd *cobra.Command, args []string) error {
2121

2222
if ClientID == "" {
23-
ClientID, err = terminal.PromptPassword("Personal Access Token Client ID:")
23+
ClientID, err = term.PromptPassword("Personal Access Token Client ID:")
2424
if err != nil {
2525
return err
2626
}
@@ -29,7 +29,7 @@ func NewConfigureCmd() *cobra.Command {
2929
config.SetPatClientID(ClientID)
3030

3131
if ClientSecret == "" {
32-
ClientSecret, err = terminal.PromptPassword("Personal Access Token Client Secret:")
32+
ClientSecret, err = term.PromptPassword("Personal Access Token Client Secret:")
3333
if err != nil {
3434
return err
3535
}

‎cmd/connector/conn.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import (
99

1010
"github.com/sailpoint-oss/sailpoint-cli/internal/client"
1111
"github.com/sailpoint-oss/sailpoint-cli/internal/config"
12+
"github.com/sailpoint-oss/sailpoint-cli/internal/terminal"
1213
"github.com/spf13/cobra"
1314
"github.com/spf13/pflag"
1415
"gopkg.in/yaml.v2"
@@ -18,7 +19,7 @@ const (
1819
connectorsEndpoint = "/beta/platform-connectors"
1920
)
2021

21-
func NewConnCmd() *cobra.Command {
22+
func NewConnCmd(term terminal.Terminal) *cobra.Command {
2223
conn := &cobra.Command{
2324
Use: "connectors",
2425
Short: "manage connectors",
@@ -45,7 +46,7 @@ func NewConnCmd() *cobra.Command {
4546
newConnCreateCmd(Client),
4647
newConnCreateVersionCmd(Client),
4748
newConnVersionsCmd(Client),
48-
newConnInvokeCmd(Client),
49+
newConnInvokeCmd(Client, term),
4950
newConnValidateCmd(Client),
5051
newConnTagCmd(Client),
5152
newConnValidateSourcesCmd(Client),

‎cmd/connector/conn_invoke.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import (
99

1010
connclient "github.com/sailpoint-oss/sailpoint-cli/cmd/connector/client"
1111
"github.com/sailpoint-oss/sailpoint-cli/internal/client"
12+
"github.com/sailpoint-oss/sailpoint-cli/internal/terminal"
1213
"github.com/spf13/cobra"
1314
)
1415

@@ -23,7 +24,7 @@ const (
2324
stdTestConnection = "std:test-connection"
2425
)
2526

26-
func newConnInvokeCmd(client client.Client) *cobra.Command {
27+
func newConnInvokeCmd(client client.Client, term terminal.Terminal) *cobra.Command {
2728
cmd := &cobra.Command{
2829
Use: "invoke",
2930
Short: "Invoke Command on a connector",
@@ -42,7 +43,7 @@ func newConnInvokeCmd(client client.Client) *cobra.Command {
4243

4344
cmd.AddCommand(
4445
newConnInvokeTestConnectionCmd(client),
45-
newConnInvokeChangePasswordCmd(client),
46+
newConnInvokeChangePasswordCmd(client, term),
4647
newConnInvokeAccountCreateCmd(client),
4748
newConnInvokeAccountDiscoverSchemaCmd(client),
4849
newConnInvokeAccountListCmd(client),

‎cmd/connector/conn_invoke_change-password.go ‎cmd/connector/conn_invoke_change_password.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
)
1111

1212
// newConnInvokeChangePasswordCmd defines a command to perform change password operation
13-
func newConnInvokeChangePasswordCmd(spClient client.Client) *cobra.Command {
13+
func newConnInvokeChangePasswordCmd(spClient client.Client, term terminal.Terminal) *cobra.Command {
1414
cmd := &cobra.Command{
1515
Use: "change-password",
1616
Short: "Invoke a change-password command",
@@ -24,7 +24,7 @@ func newConnInvokeChangePasswordCmd(spClient client.Client) *cobra.Command {
2424
return err
2525
}
2626

27-
password, err := terminal.PromptPassword("Enter Password:")
27+
password, err := term.PromptPassword("Enter Password:")
2828
if err != nil {
2929
return err
3030
}

‎cmd/connector/conn_invoke_change_password_test.go

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
// Copyright (c) 2023, SailPoint Technologies, Inc. All rights reserved.
2+
package connector
3+
4+
import (
5+
"bytes"
6+
"io"
7+
"net/http"
8+
"testing"
9+
10+
"github.com/golang/mock/gomock"
11+
"github.com/sailpoint-oss/sailpoint-cli/internal/mocks"
12+
)
13+
14+
func TestChangePasswordWithoutInput(t *testing.T) {
15+
ctrl := gomock.NewController(t)
16+
defer ctrl.Finish()
17+
18+
client := mocks.NewMockClient(ctrl)
19+
term := mocks.NewMockTerm(ctrl)
20+
21+
cmd := newConnInvokeChangePasswordCmd(client, term)
22+
addRequiredFlagsFromParentCmd(cmd)
23+
24+
b := new(bytes.Buffer)
25+
cmd.SetOut(b)
26+
cmd.SetArgs([]string{"-c", "test-connector", "--config-json", "{}"})
27+
28+
err := cmd.Execute()
29+
if err == nil {
30+
t.Errorf("failed to detect error: reading account without identity")
31+
}
32+
}
33+
34+
func TestChangePasswordWithIdentityAndPassword(t *testing.T) {
35+
ctrl := gomock.NewController(t)
36+
defer ctrl.Finish()
37+
38+
i := `{"connectorRef":"test-connector","tag":"latest","type":"std:change-password","config":{},` +
39+
`"input":{"identity":"john.doe","key":{"simple":{"id":"john.doe"}},"password":"password"}}`
40+
41+
client := mocks.NewMockClient(ctrl)
42+
client.EXPECT().
43+
Post(gomock.Any(), gomock.Any(), "application/json", bytes.NewReader([]byte(i))).
44+
Return(&http.Response{StatusCode: http.StatusOK, Body: io.NopCloser(bytes.NewReader([]byte("{}")))}, nil)
45+
46+
term := mocks.NewMockTerm(ctrl)
47+
term.EXPECT().
48+
PromptPassword(gomock.Any()).
49+
Return("password", nil)
50+
51+
cmd := newConnInvokeChangePasswordCmd(client, term)
52+
addRequiredFlagsFromParentCmd(cmd)
53+
54+
b := new(bytes.Buffer)
55+
cmd.SetOut(b)
56+
cmd.SetArgs([]string{"john.doe", "-c", "test-connector", "--config-json", "{}"})
57+
58+
err := cmd.Execute()
59+
if err != nil {
60+
t.Errorf("command failed with err: %s", err)
61+
}
62+
}
63+
64+
func TestChangePasswordWithIdentityAndPasswordAndUniqueId(t *testing.T) {
65+
ctrl := gomock.NewController(t)
66+
defer ctrl.Finish()
67+
68+
i := `{"connectorRef":"test-connector","tag":"latest","type":"std:change-password","config":{},` +
69+
`"input":{"identity":"john.doe","key":{"compound":{"lookupId":"john.doe","uniqueId":"12345"}},"password":"password"}}`
70+
71+
client := mocks.NewMockClient(ctrl)
72+
client.EXPECT().
73+
Post(gomock.Any(), gomock.Any(), "application/json", bytes.NewReader([]byte(i))).
74+
Return(&http.Response{StatusCode: http.StatusOK, Body: io.NopCloser(bytes.NewReader([]byte("{}")))}, nil)
75+
76+
term := mocks.NewMockTerm(ctrl)
77+
term.EXPECT().
78+
PromptPassword(gomock.Any()).
79+
Return("password", nil)
80+
81+
cmd := newConnInvokeChangePasswordCmd(client, term)
82+
addRequiredFlagsFromParentCmd(cmd)
83+
84+
b := new(bytes.Buffer)
85+
cmd.SetOut(b)
86+
cmd.SetArgs([]string{"john.doe", "12345", "-c", "test-connector", "--config-json", "{}"})
87+
88+
err := cmd.Execute()
89+
if err != nil {
90+
t.Errorf("command failed with err: %s", err)
91+
}
92+
}

‎cmd/connector/conn_invoke_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ func TestNewConnInvokeCmd_noArgs(t *testing.T) {
2424
ctrl := gomock.NewController(t)
2525
defer ctrl.Finish()
2626

27-
cmd := newConnInvokeCmd(mocks.NewMockClient(ctrl))
27+
cmd := newConnInvokeCmd(mocks.NewMockClient(ctrl), mocks.NewMockTerm(ctrl))
2828
if len(cmd.Commands()) != numConnInvokeSubcommands {
2929
t.Fatalf("expected: %d, actual: %d", len(cmd.Commands()), numConnInvokeSubcommands)
3030
}

‎cmd/root/root.go

+6-3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import (
1313
"github.com/sailpoint-oss/sailpoint-cli/cmd/spconfig"
1414
"github.com/sailpoint-oss/sailpoint-cli/cmd/transform"
1515
"github.com/sailpoint-oss/sailpoint-cli/cmd/va"
16+
"github.com/sailpoint-oss/sailpoint-cli/internal/terminal"
1617
"github.com/spf13/cobra"
1718
)
1819

@@ -34,13 +35,15 @@ func NewRootCmd() *cobra.Command {
3435
},
3536
}
3637

38+
t := &terminal.Term{}
39+
3740
root.AddCommand(
3841
set.NewSetCommand(),
3942
environment.NewEnvironmentCommand(),
40-
configure.NewConfigureCmd(),
41-
connector.NewConnCmd(),
43+
configure.NewConfigureCmd(t),
44+
connector.NewConnCmd(t),
4245
transform.NewTransformCmd(),
43-
va.NewVACmd(),
46+
va.NewVACmd(t),
4447
search.NewSearchCmd(),
4548
spconfig.NewSPConfigCmd(),
4649
report.NewReportCommand(),

‎cmd/va/collect.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
"github.com/spf13/cobra"
1212
)
1313

14-
func newCollectCmd() *cobra.Command {
14+
func newCollectCmd(term terminal.Terminal) *cobra.Command {
1515
var output string
1616
var logs bool
1717
var config bool
@@ -37,7 +37,7 @@ func newCollectCmd() *cobra.Command {
3737
}
3838

3939
for credential := 0; credential < len(args); credential++ {
40-
password, _ := terminal.PromptPassword(fmt.Sprintf("Enter Password for %v:", args[credential]))
40+
password, _ := term.PromptPassword(fmt.Sprintf("Enter Password for %v:", args[credential]))
4141
credentials = append(credentials, password)
4242
}
4343

‎cmd/va/troubleshoot.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
"github.com/spf13/cobra"
1414
)
1515

16-
func NewTroubleshootCmd() *cobra.Command {
16+
func NewTroubleshootCmd(term terminal.Terminal) *cobra.Command {
1717
var output string
1818
cmd := &cobra.Command{
1919
Use: "troubleshoot",
@@ -29,7 +29,7 @@ func NewTroubleshootCmd() *cobra.Command {
2929

3030
var credentials []string
3131
for credential := 0; credential < len(args); credential++ {
32-
password, _ := terminal.PromptPassword(fmt.Sprintf("Enter Password for %v:", args[credential]))
32+
password, _ := term.PromptPassword(fmt.Sprintf("Enter Password for %v:", args[credential]))
3333
credentials = append(credentials, password)
3434
}
3535

‎cmd/va/update.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import (
99
"github.com/spf13/cobra"
1010
)
1111

12-
func newUpdateCmd() *cobra.Command {
12+
func newUpdateCmd(term terminal.Terminal) *cobra.Command {
1313
cmd := &cobra.Command{
1414
Use: "update",
1515
Short: "Perform Update Operations on a SailPoint Virtual Appliance",
@@ -19,7 +19,7 @@ func newUpdateCmd() *cobra.Command {
1919
RunE: func(cmd *cobra.Command, args []string) error {
2020
var credentials []string
2121
for credential := 0; credential < len(args); credential++ {
22-
password, _ := terminal.PromptPassword(fmt.Sprintf("Enter Password for %v:", args[credential]))
22+
password, _ := term.PromptPassword(fmt.Sprintf("Enter Password for %v:", args[credential]))
2323
credentials = append(credentials, password)
2424
}
2525
for i := 0; i < len(args); i++ {

‎cmd/va/va.go

+4-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ package va
44
import (
55
"fmt"
66

7+
"github.com/sailpoint-oss/sailpoint-cli/internal/terminal"
78
"github.com/spf13/cobra"
89
)
910

10-
func NewVACmd() *cobra.Command {
11+
func NewVACmd(term terminal.Terminal) *cobra.Command {
1112
cmd := &cobra.Command{
1213
Use: "va",
1314
Short: "Interact with SailPoint Virtual Appliances",
@@ -19,9 +20,9 @@ func NewVACmd() *cobra.Command {
1920
}
2021

2122
cmd.AddCommand(
22-
newCollectCmd(),
23+
newCollectCmd(term),
2324
// newTroubleshootCmd(),
24-
newUpdateCmd(),
25+
newUpdateCmd(term),
2526
newParseCmd(),
2627
)
2728

‎internal/mocks/client.go

+1-15
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎internal/mocks/terminal.go

+49
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)