Merge pull request #860 from SoftLayer/issues851

Fixed user detail not showing JSON output

Author: allmightyspiff

README.md

@@ -157,7 +157,8 @@ Check testhelpers/fake_softlayer_session.go for all the fields that get recorded
 
 
 
-### Fake Managers
+### Test Fakes
+
 
 CLI calls to manager functions need an entry in `plugin\testhelpers\fake_manager.go` 
 Managers have a fake/test interface that is autogenerate with a program called [couterfieter](https://github.com/maxbrunsfeld/counterfeiter)
@@ -177,24 +178,37 @@ each manager and defined interface should have this line in it to be automatical
 
 If you want to use the real manager but fixture API data, just initialize the manager like this in the CLI test
 
-(filenames here is optional of course)
+This example is from `plugin\commands\account\invoice-detail_test.go`
 ```go
-BeforeEach(func() {
-
-    filenames := []string{"getDatacenters_1",}
-    fakeSLSession = testhelpers.NewFakeSoftlayerSession(filenames)
-    OrderManager = managers.NewOrderManager(fakeSLSession)
-    fakeUI = terminal.NewFakeUI()
-    cmd = order.NewPlaceCommand(fakeUI, OrderManager, nil)
-    cliCommand = cli.Command{
-        Name:        metadata.OrderPlaceMetaData().Name,
-        Description: metadata.OrderPlaceMetaData().Description,
-        Usage:       metadata.OrderPlaceMetaData().Usage,
-        Flags:       metadata.OrderPlaceMetaData().Flags,
-        Action:      cmd.Run,
-    }
-})
+var _ = Describe("<COMMAND> Tests", func() {
+    var (
+        fakeUI          *terminal.FakeUI
+        cliCommand      *account.InvoiceDetailCommand
+        fakeSession     *session.Session
+        slCommand       *metadata.SoftlayerCommand
+        fakeHandler     *testhelpers.FakeTransportHandler
+    )
+    BeforeEach(func() {
+        // Fake UI to capture output of comamnds
+        fakeUI = terminal.NewFakeUI()
+        // Fake session to handle loading data from testfixtures
+        fakeSession = testhelpers.NewFakeSoftlayerSession(nil)
+        // Fake handler to control error generation
+        fakeHandler = testhelpers.GetSessionHandler(fakeSession)
+        // Real parent command, with fake UI and Fake Session being passed in
+        slCommand = metadata.NewSoftlayerCommand(fakeUI, fakeSession)
+        // Real actual command
+        cliCommand = account.NewInvoiceDetailCommand(slCommand)
+        // Need to set output flag since its set manually in the parent command normally.
+        cliCommand.Command.PersistentFlags().Var(cliCommand.OutputFlag, "output", "--output=JSON for json output.")
+    })
+    AfterEach(func() {
+        // Clear API call logs and any errors that might have been set after every test
+        fakeHandler.ClearApiCallLogs()
+        fakeHandler.ClearErrors()
+    })
 ```
+`plugin\commands\user\details_test.go` is also a good example test file for CLI commands.
 
 ### `[no tests to run]`
 New commands needs a `command_test.go` file in the CLI directory.
@@ -224,8 +238,7 @@ fakeHandler = testhelpers.GetSessionHandler(fakeSession)
 
 // Then in a BeforeEach for the specific test...
 BeforeEach(func() {
-    fakeHandler.AddApiError("SoftLayer_User_Customer", "getObject",
-                            500, "Internal Server Error")
+    fakeHandler.AddApiError("SoftLayer_User_Customer", "getObject", 500, "Internal Server Error")
 })
 ```
 

plugin/commands/user/details.go

@@ -52,13 +52,25 @@ func NewDetailsCommand(sl *metadata.SoftlayerCommand) (cmd *DetailsCommand) {
 	return thisCmd
 }
 
+type UserInformation struct {
+	User           datatypes.User_Customer
+	Hardware       []datatypes.Hardware
+	Virtual        []datatypes.Virtual_Guest
+	Events         []datatypes.Event_Log
+	Permissions    []datatypes.User_Customer_CustomerPermission_Permission
+	Logins         []datatypes.User_Customer_Access_Authentication
+	DedicatedHosts []datatypes.Virtual_DedicatedHost
+}
+
 func (cmd *DetailsCommand) Run(args []string) error {
 	userId := args[0]
 	id, err := strconv.Atoi(userId)
 	if err != nil {
 		return errors.NewInvalidUsageError(T("User ID should be a number."))
 	}
 
+	outputFormat := cmd.GetOutputFlag()
+	userInfo := UserInformation{}
 	keys := cmd.Keys
 	permissions := cmd.Permissions
 	hardware := cmd.Hardware
@@ -68,11 +80,14 @@ func (cmd *DetailsCommand) Run(args []string) error {
 
 	object_mask := "userStatus[name],parent[id,username],apiAuthenticationKeys[authenticationKey]"
 	user, err := cmd.UserManager.GetUser(id, object_mask)
+	userInfo.User = user
 	if err != nil {
 		return errors.NewAPIError(T("Failed to show user detail.\n"), err.Error(), 2)
 	}
 
-	baseUserPrint(user, keys, cmd.UI)
+	if outputFormat != "JSON" {
+		baseUserPrint(user, keys, cmd.UI)
+	}
 
 	if permissions {
 		perms, err := cmd.UserManager.GetUserPermissions(id)
@@ -84,7 +99,10 @@ func (cmd *DetailsCommand) Run(args []string) error {
 			table.Add(utils.FormatStringPointer(perm.KeyName), utils.FormatStringPointer(perm.Name))
 		}
 		table.Add("", "")
-		table.Print()
+		if outputFormat != "JSON" {
+			table.Print()
+		}
+		userInfo.Permissions = perms
 	}
 
 	if hardware {
@@ -105,7 +123,6 @@ func (cmd *DetailsCommand) Run(args []string) error {
 			table.Add(hostId, hostFqdn, hostCpu, hostMem, hostDisk, hostCreated)
 		}
 		table.Add("", "")
-		table.Print()
 
 		tableAccess := cmd.UI.Table([]string{T("ID"), T("Hostname"), T("Primary Public IP"), T("Primary Private IP"), T("Created")})
 		for _, host := range access.Hardware {
@@ -117,7 +134,12 @@ func (cmd *DetailsCommand) Run(args []string) error {
 			tableAccess.Add(hostId, hostFqdn, hostPrimary, hostPrivate, hostCreated)
 		}
 		tableAccess.Add("", "")
-		tableAccess.Print()
+		if outputFormat != "JSON" {
+			table.Print()
+			tableAccess.Print()
+		}
+		userInfo.Hardware = access.Hardware
+		userInfo.DedicatedHosts = access.DedicatedHosts
 	}
 
 	if virtual {
@@ -137,7 +159,10 @@ func (cmd *DetailsCommand) Run(args []string) error {
 			tableAccess.Add(hostId, hostFqdn, hostPrimary, hostPrivate, hostCreated)
 		}
 		tableAccess.Add("", "")
-		tableAccess.Print()
+		if outputFormat != "JSON" {
+			tableAccess.Print()
+		}
+		userInfo.Virtual = access.VirtualGuests
 	}
 
 	if logins {
@@ -156,7 +181,11 @@ func (cmd *DetailsCommand) Run(args []string) error {
 			table.Add(loginData, loginIp, loginSucc)
 		}
 		table.Add("", "")
-		table.Print()
+		if outputFormat != "JSON" {
+			table.Print()
+		}
+		userInfo.Logins = loginLog
+
 	}
 
 	if events {
@@ -176,9 +205,16 @@ func (cmd *DetailsCommand) Run(args []string) error {
 			table.Add(eventData, eventName, eventIp, eventLabel, eventUsername)
 		}
 		table.Add("", "")
-		table.Print()
+		if outputFormat != "JSON" {
+			table.Print()
+		}
+		userInfo.Events = events
 	}
 
+	if outputFormat == "JSON" {
+		err := utils.PrintPrettyJSON(cmd.UI, userInfo)
+		return err
+	}
 	return nil
 
 }