Merge pull request #20 from passbolt/feature-json-output

Json Output Support
This commit is contained in:
Samuel Lorch 2022-12-30 16:29:25 +01:00 committed by GitHub
commit 9a2944c6fb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
20 changed files with 471 additions and 157 deletions

View file

@ -92,6 +92,11 @@ You can setup MFA also using the configuration sub command, only TOTP is support
# Server Verification # Server Verification
To enable Server Verification you need to run `passbolt verify` once, after that the server will always be verified if the same config is used To enable Server Verification you need to run `passbolt verify` once, after that the server will always be verified if the same config is used
# Scripting
For Scripting we have a -j or --json flag to convert the Output for the create, get and list commands to JSON for easier Parsing in Scripts.
Note: The JSON Output does not cover Error Messages, you can detect Errors by checking if the Exitcode is not 0
# Documentation # Documentation
Usage for all Subcommands is [here](https://github.com/passbolt/go-passbolt-cli/wiki/go-passbolt-cli). Usage for all Subcommands is [here](https://github.com/passbolt/go-passbolt-cli/wiki/go-passbolt-cli).
And is also available via `man passbolt` And is also available via `man passbolt`

View file

@ -18,6 +18,7 @@ var createCmd = &cobra.Command{
func init() { func init() {
rootCmd.AddCommand(createCmd) rootCmd.AddCommand(createCmd)
createCmd.PersistentFlags().BoolP("json", "j", false, "Output JSON")
createCmd.AddCommand(resource.ResourceCreateCmd) createCmd.AddCommand(resource.ResourceCreateCmd)
createCmd.AddCommand(folder.FolderCreateCmd) createCmd.AddCommand(folder.FolderCreateCmd)
createCmd.AddCommand(group.GroupCreateCmd) createCmd.AddCommand(group.GroupCreateCmd)

View file

@ -18,6 +18,7 @@ var getCmd = &cobra.Command{
func init() { func init() {
rootCmd.AddCommand(getCmd) rootCmd.AddCommand(getCmd)
getCmd.PersistentFlags().BoolP("json", "j", false, "Output JSON")
getCmd.AddCommand(resource.ResourceGetCmd) getCmd.AddCommand(resource.ResourceGetCmd)
getCmd.AddCommand(folder.FolderGetCmd) getCmd.AddCommand(folder.FolderGetCmd)
getCmd.AddCommand(group.GroupGetCmd) getCmd.AddCommand(group.GroupGetCmd)

View file

@ -18,6 +18,7 @@ var listCmd = &cobra.Command{
func init() { func init() {
rootCmd.AddCommand(listCmd) rootCmd.AddCommand(listCmd)
listCmd.PersistentFlags().BoolP("json", "j", false, "Output JSON")
listCmd.AddCommand(resource.ResourceListCmd) listCmd.AddCommand(resource.ResourceListCmd)
listCmd.AddCommand(folder.FolderListCmd) listCmd.AddCommand(folder.FolderListCmd)
listCmd.AddCommand(group.GroupListCmd) listCmd.AddCommand(group.GroupListCmd)

View file

@ -2,6 +2,7 @@ package folder
import ( import (
"context" "context"
"encoding/json"
"fmt" "fmt"
"github.com/passbolt/go-passbolt-cli/util" "github.com/passbolt/go-passbolt-cli/util"
@ -33,6 +34,10 @@ func FolderCreate(cmd *cobra.Command, args []string) error {
if err != nil { if err != nil {
return err return err
} }
jsonOutput, err := cmd.Flags().GetBool("json")
if err != nil {
return err
}
ctx := util.GetContext() ctx := util.GetContext()
@ -53,6 +58,18 @@ func FolderCreate(cmd *cobra.Command, args []string) error {
return fmt.Errorf("Creating Folder: %w", err) return fmt.Errorf("Creating Folder: %w", err)
} }
fmt.Printf("FolderID: %v\n", id) if jsonOutput {
jsonId, err := json.MarshalIndent(
map[string]string{"id": id},
"",
" ",
)
if err != nil {
return fmt.Errorf("Marshalling Json: %w", err)
}
fmt.Println(string(jsonId))
} else {
fmt.Printf("FolderID: %v\n", id)
}
return nil return nil
} }

View file

@ -2,11 +2,11 @@ package folder
import ( import (
"context" "context"
"encoding/json"
"fmt" "fmt"
"github.com/alessio/shellescape" "github.com/alessio/shellescape"
"github.com/passbolt/go-passbolt-cli/util" "github.com/passbolt/go-passbolt-cli/util"
"github.com/passbolt/go-passbolt/helper"
"github.com/spf13/cobra" "github.com/spf13/cobra"
) )
@ -29,6 +29,10 @@ func FolderGet(cmd *cobra.Command, args []string) error {
if err != nil { if err != nil {
return err return err
} }
jsonOutput, err := cmd.Flags().GetBool("json")
if err != nil {
return err
}
ctx := util.GetContext() ctx := util.GetContext()
@ -39,15 +43,22 @@ func FolderGet(cmd *cobra.Command, args []string) error {
defer client.Logout(context.TODO()) defer client.Logout(context.TODO())
cmd.SilenceUsage = true cmd.SilenceUsage = true
folderParentID, name, err := helper.GetFolder( folder, err := client.GetFolder(ctx, id, nil)
ctx,
client,
id,
)
if err != nil { if err != nil {
return fmt.Errorf("Getting Folder: %w", err) return fmt.Errorf("Getting Folder: %w", err)
} }
fmt.Printf("FolderParentID: %v\n", folderParentID) if jsonOutput {
fmt.Printf("Name: %v\n", shellescape.StripUnsafe(name)) jsonGroup, err := json.MarshalIndent(FolderJsonOutput{
FolderParentID: &folder.FolderParentID,
Name: &folder.Name,
}, "", " ")
if err != nil {
return err
}
fmt.Println(string(jsonGroup))
} else {
fmt.Printf("FolderParentID: %v\n", folder.FolderParentID)
fmt.Printf("Name: %v\n", shellescape.StripUnsafe(folder.Name))
}
return nil return nil
} }

11
folder/json.go Normal file
View file

@ -0,0 +1,11 @@
package folder
import "time"
type FolderJsonOutput struct {
ID *string `json:"id,omitempty"`
FolderParentID *string `json:"folder_parent_id,omitempty"`
Name *string `json:"name,omitempty"`
CreatedTimestamp *time.Time `json:"created_timestamp,omitempty"`
ModifiedTimestamp *time.Time `json:"modified_timestamp,omitempty"`
}

View file

@ -2,6 +2,7 @@ package folder
import ( import (
"context" "context"
"encoding/json"
"fmt" "fmt"
"strings" "strings"
"time" "time"
@ -46,6 +47,10 @@ func FolderList(cmd *cobra.Command, args []string) error {
if len(columns) == 0 { if len(columns) == 0 {
return fmt.Errorf("You need to Specify atleast one column to return") return fmt.Errorf("You need to Specify atleast one column to return")
} }
jsonOutput, err := cmd.Flags().GetBool("json")
if err != nil {
return err
}
ctx := util.GetContext() ctx := util.GetContext()
cmd.SilenceUsage = true cmd.SilenceUsage = true
@ -64,30 +69,48 @@ func FolderList(cmd *cobra.Command, args []string) error {
return fmt.Errorf("Listing Folder: %w", err) return fmt.Errorf("Listing Folder: %w", err)
} }
data := pterm.TableData{columns} if jsonOutput {
outputFolders := []FolderJsonOutput{}
for _, folder := range folders { for i := range folders {
entry := make([]string, len(columns)) outputFolders = append(outputFolders, FolderJsonOutput{
for i := range columns { ID: &folders[i].ID,
switch strings.ToLower(columns[i]) { FolderParentID: &folders[i].FolderParentID,
case "id": Name: &folders[i].Name,
entry[i] = folder.ID CreatedTimestamp: &folders[i].Created.Time,
case "folderparentid": ModifiedTimestamp: &folders[i].Modified.Time,
entry[i] = folder.FolderParentID })
case "name":
entry[i] = shellescape.StripUnsafe(folder.Name)
case "createdtimestamp":
entry[i] = folder.Created.Format(time.RFC3339)
case "modifiedtimestamp":
entry[i] = folder.Modified.Format(time.RFC3339)
default:
cmd.SilenceUsage = false
return fmt.Errorf("Unknown Column: %v", columns[i])
}
} }
data = append(data, entry) jsonFolders, err := json.MarshalIndent(outputFolders, "", " ")
} if err != nil {
return err
}
fmt.Println(string(jsonFolders))
} else {
data := pterm.TableData{columns}
pterm.DefaultTable.WithHasHeader().WithData(data).Render() for _, folder := range folders {
entry := make([]string, len(columns))
for i := range columns {
switch strings.ToLower(columns[i]) {
case "id":
entry[i] = folder.ID
case "folderparentid":
entry[i] = folder.FolderParentID
case "name":
entry[i] = shellescape.StripUnsafe(folder.Name)
case "createdtimestamp":
entry[i] = folder.Created.Format(time.RFC3339)
case "modifiedtimestamp":
entry[i] = folder.Modified.Format(time.RFC3339)
default:
cmd.SilenceUsage = false
return fmt.Errorf("Unknown Column: %v", columns[i])
}
}
data = append(data, entry)
}
pterm.DefaultTable.WithHasHeader().WithData(data).Render()
}
return nil return nil
} }

View file

@ -2,6 +2,7 @@ package group
import ( import (
"context" "context"
"encoding/json"
"fmt" "fmt"
"github.com/passbolt/go-passbolt-cli/util" "github.com/passbolt/go-passbolt-cli/util"
@ -40,6 +41,10 @@ func GroupCreate(cmd *cobra.Command, args []string) error {
if err != nil { if err != nil {
return err return err
} }
jsonOutput, err := cmd.Flags().GetBool("json")
if err != nil {
return err
}
ops := []helper.GroupMembershipOperation{} ops := []helper.GroupMembershipOperation{}
for _, user := range users { for _, user := range users {
@ -74,6 +79,18 @@ func GroupCreate(cmd *cobra.Command, args []string) error {
return fmt.Errorf("Creating Group: %w", err) return fmt.Errorf("Creating Group: %w", err)
} }
fmt.Printf("GroupID: %v\n", id) if jsonOutput {
jsonId, err := json.MarshalIndent(
map[string]string{"id": id},
"",
" ",
)
if err != nil {
return fmt.Errorf("Marshalling Json: %w", err)
}
fmt.Println(string(jsonId))
} else {
fmt.Printf("GroupID: %v\n", id)
}
return nil return nil
} }

View file

@ -2,6 +2,7 @@ package group
import ( import (
"context" "context"
"encoding/json"
"fmt" "fmt"
"strings" "strings"
@ -37,6 +38,10 @@ func GroupGet(cmd *cobra.Command, args []string) error {
if err != nil { if err != nil {
return err return err
} }
jsonOutput, err := cmd.Flags().GetBool("json")
if err != nil {
return err
}
ctx := util.GetContext() ctx := util.GetContext()
@ -55,34 +60,58 @@ func GroupGet(cmd *cobra.Command, args []string) error {
if err != nil { if err != nil {
return fmt.Errorf("Getting Group: %w", err) return fmt.Errorf("Getting Group: %w", err)
} }
fmt.Printf("Name: %v\n", name)
// Print Memberships
if len(columns) != 0 {
data := pterm.TableData{columns}
for _, membership := range memberships { if jsonOutput {
entry := make([]string, len(columns)) groupUserMemberships := []GroupUserMembershipJsonOutput{}
for i := range columns { for i := range memberships {
switch strings.ToLower(columns[i]) { groupUserMemberships = append(groupUserMemberships, GroupUserMembershipJsonOutput{
case "userid": ID: &memberships[i].UserID,
entry[i] = membership.UserID Username: &memberships[i].Username,
case "isgroupmanager": FirstName: &memberships[i].UserFirstName,
entry[i] = fmt.Sprint(membership.IsGroupManager) LastName: &memberships[i].UserLastName,
case "username": IsGroupManager: &memberships[i].IsGroupManager,
entry[i] = shellescape.StripUnsafe(membership.Username) })
case "userfirstname":
entry[i] = shellescape.StripUnsafe(membership.UserFirstName)
case "userlastname":
entry[i] = shellescape.StripUnsafe(membership.UserLastName)
default:
cmd.SilenceUsage = false
return fmt.Errorf("Unknown Column: %v", columns[i])
}
}
data = append(data, entry)
} }
pterm.DefaultTable.WithHasHeader().WithData(data).Render() jsonGroup, err := json.MarshalIndent(GroupJsonOutput{
Name: &name,
Users: groupUserMemberships,
}, "", " ")
if err != nil {
return err
}
fmt.Println(string(jsonGroup))
} else {
fmt.Printf("Name: %v\n", name)
// Print Memberships
if len(columns) != 0 {
data := pterm.TableData{columns}
for _, membership := range memberships {
entry := make([]string, len(columns))
for i := range columns {
switch strings.ToLower(columns[i]) {
case "userid":
entry[i] = membership.UserID
case "isgroupmanager":
entry[i] = fmt.Sprint(membership.IsGroupManager)
case "username":
entry[i] = shellescape.StripUnsafe(membership.Username)
case "userfirstname":
entry[i] = shellescape.StripUnsafe(membership.UserFirstName)
case "userlastname":
entry[i] = shellescape.StripUnsafe(membership.UserLastName)
default:
cmd.SilenceUsage = false
return fmt.Errorf("Unknown Column: %v", columns[i])
}
}
data = append(data, entry)
}
pterm.DefaultTable.WithHasHeader().WithData(data).Render()
}
} }
return nil return nil
} }

19
group/json.go Normal file
View file

@ -0,0 +1,19 @@
package group
import "time"
type GroupJsonOutput struct {
ID *string `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
Users []GroupUserMembershipJsonOutput `json:"users,omitempty"`
CreatedTimestamp *time.Time `json:"created_timestamp,omitempty"`
ModifiedTimestamp *time.Time `json:"modified_timestamp,omitempty"`
}
type GroupUserMembershipJsonOutput struct {
ID *string `json:"id,omitempty"`
Username *string `json:"username,omitempty"`
FirstName *string `json:"first_name,omitempty"`
LastName *string `json:"last_name,omitempty"`
IsGroupManager *bool `json:"is_group_manager,omitempty"`
}

View file

@ -2,6 +2,7 @@ package group
import ( import (
"context" "context"
"encoding/json"
"fmt" "fmt"
"strings" "strings"
"time" "time"
@ -46,6 +47,10 @@ func GroupList(cmd *cobra.Command, args []string) error {
if len(columns) == 0 { if len(columns) == 0 {
return fmt.Errorf("You need to specify atleast one column to return") return fmt.Errorf("You need to specify atleast one column to return")
} }
jsonOutput, err := cmd.Flags().GetBool("json")
if err != nil {
return err
}
ctx := util.GetContext() ctx := util.GetContext()
@ -64,28 +69,45 @@ func GroupList(cmd *cobra.Command, args []string) error {
return fmt.Errorf("Listing Group: %w", err) return fmt.Errorf("Listing Group: %w", err)
} }
data := pterm.TableData{columns} if jsonOutput {
outputGroups := []GroupJsonOutput{}
for _, group := range groups { for i := range groups {
entry := make([]string, len(columns)) outputGroups = append(outputGroups, GroupJsonOutput{
for i := range columns { ID: &groups[i].ID,
switch strings.ToLower(columns[i]) { Name: &groups[i].Name,
case "id": CreatedTimestamp: &groups[i].Created.Time,
entry[i] = group.ID ModifiedTimestamp: &groups[i].Modified.Time,
case "name": })
entry[i] = shellescape.StripUnsafe(group.Name)
case "createdtimestamp":
entry[i] = group.Created.Format(time.RFC3339)
case "modifiedtimestamp":
entry[i] = group.Modified.Format(time.RFC3339)
default:
cmd.SilenceUsage = false
return fmt.Errorf("Unknown Column: %v", columns[i])
}
} }
data = append(data, entry) jsonGroups, err := json.MarshalIndent(outputGroups, "", " ")
} if err != nil {
return err
}
fmt.Println(string(jsonGroups))
} else {
data := pterm.TableData{columns}
pterm.DefaultTable.WithHasHeader().WithData(data).Render() for _, group := range groups {
entry := make([]string, len(columns))
for i := range columns {
switch strings.ToLower(columns[i]) {
case "id":
entry[i] = group.ID
case "name":
entry[i] = shellescape.StripUnsafe(group.Name)
case "createdtimestamp":
entry[i] = group.Created.Format(time.RFC3339)
case "modifiedtimestamp":
entry[i] = group.Modified.Format(time.RFC3339)
default:
cmd.SilenceUsage = false
return fmt.Errorf("Unknown Column: %v", columns[i])
}
}
data = append(data, entry)
}
pterm.DefaultTable.WithHasHeader().WithData(data).Render()
}
return nil return nil
} }

View file

@ -2,6 +2,7 @@ package resource
import ( import (
"context" "context"
"encoding/json"
"fmt" "fmt"
"github.com/passbolt/go-passbolt-cli/util" "github.com/passbolt/go-passbolt-cli/util"
@ -54,6 +55,10 @@ func ResourceCreate(cmd *cobra.Command, args []string) error {
if err != nil { if err != nil {
return err return err
} }
jsonOutput, err := cmd.Flags().GetBool("json")
if err != nil {
return err
}
ctx := util.GetContext() ctx := util.GetContext()
@ -78,6 +83,18 @@ func ResourceCreate(cmd *cobra.Command, args []string) error {
return fmt.Errorf("Creating Resource: %w", err) return fmt.Errorf("Creating Resource: %w", err)
} }
fmt.Printf("ResourceID: %v\n", id) if jsonOutput {
jsonId, err := json.MarshalIndent(
map[string]string{"id": id},
"",
" ",
)
if err != nil {
return fmt.Errorf("Marshalling Json: %w", err)
}
fmt.Println(string(jsonId))
} else {
fmt.Printf("ResourceID: %v\n", id)
}
return nil return nil
} }

View file

@ -2,6 +2,7 @@ package resource
import ( import (
"context" "context"
"encoding/json"
"fmt" "fmt"
"github.com/alessio/shellescape" "github.com/alessio/shellescape"
@ -29,6 +30,10 @@ func ResourceGet(cmd *cobra.Command, args []string) error {
if err != nil { if err != nil {
return err return err
} }
jsonOutput, err := cmd.Flags().GetBool("json")
if err != nil {
return err
}
ctx := util.GetContext() ctx := util.GetContext()
@ -47,11 +52,27 @@ func ResourceGet(cmd *cobra.Command, args []string) error {
if err != nil { if err != nil {
return fmt.Errorf("Getting Resource: %w", err) return fmt.Errorf("Getting Resource: %w", err)
} }
fmt.Printf("FolderParentID: %v\n", folderParentID)
fmt.Printf("Name: %v\n", shellescape.StripUnsafe(name)) if jsonOutput {
fmt.Printf("Username: %v\n", shellescape.StripUnsafe(username)) jsonResource, err := json.MarshalIndent(ResourceJsonOutput{
fmt.Printf("URI: %v\n", shellescape.StripUnsafe(uri)) FolderParentID: &folderParentID,
fmt.Printf("Password: %v\n", shellescape.StripUnsafe(password)) Name: &name,
fmt.Printf("Description: %v\n", shellescape.StripUnsafe(description)) Username: &username,
URI: &uri,
Password: &password,
Description: &description,
}, "", " ")
if err != nil {
return err
}
fmt.Println(string(jsonResource))
} else {
fmt.Printf("FolderParentID: %v\n", folderParentID)
fmt.Printf("Name: %v\n", shellescape.StripUnsafe(name))
fmt.Printf("Username: %v\n", shellescape.StripUnsafe(username))
fmt.Printf("URI: %v\n", shellescape.StripUnsafe(uri))
fmt.Printf("Password: %v\n", shellescape.StripUnsafe(password))
fmt.Printf("Description: %v\n", shellescape.StripUnsafe(description))
}
return nil return nil
} }

15
resource/json.go Normal file
View file

@ -0,0 +1,15 @@
package resource
import "time"
type ResourceJsonOutput struct {
ID *string `json:"id,omitempty"`
FolderParentID *string `json:"folder_parent_id,omitempty"`
Name *string `json:"name,omitempty"`
Username *string `json:"username,omitempty"`
URI *string `json:"uri,omitempty"`
Password *string `json:"password,omitempty"`
Description *string `json:"description,omitempty"`
CreatedTimestamp *time.Time `json:"created_timestamp,omitempty"`
ModifiedTimestamp *time.Time `json:"modified_timestamp,omitempty"`
}

View file

@ -2,6 +2,7 @@ package resource
import ( import (
"context" "context"
"encoding/json"
"fmt" "fmt"
"strings" "strings"
"time" "time"
@ -58,6 +59,10 @@ func ResourceList(cmd *cobra.Command, args []string) error {
if len(columns) == 0 { if len(columns) == 0 {
return fmt.Errorf("You need to specify atleast one column to return") return fmt.Errorf("You need to specify atleast one column to return")
} }
jsonOutput, err := cmd.Flags().GetBool("json")
if err != nil {
return err
}
ctx := util.GetContext() ctx := util.GetContext()
@ -78,46 +83,72 @@ func ResourceList(cmd *cobra.Command, args []string) error {
return fmt.Errorf("Listing Resource: %w", err) return fmt.Errorf("Listing Resource: %w", err)
} }
data := pterm.TableData{columns} if jsonOutput {
outputResources := []ResourceJsonOutput{}
for _, resource := range resources { for i := range resources {
entry := make([]string, len(columns)) _, _, _, _, pass, desc, err := helper.GetResource(ctx, client, resources[i].ID)
for i := range columns { if err != nil {
switch strings.ToLower(columns[i]) { return fmt.Errorf("Get Resource %w", err)
case "id":
entry[i] = resource.ID
case "folderparentid":
entry[i] = resource.FolderParentID
case "name":
entry[i] = shellescape.StripUnsafe(resource.Name)
case "username":
entry[i] = shellescape.StripUnsafe(resource.Username)
case "uri":
entry[i] = shellescape.StripUnsafe(resource.URI)
case "password":
_, _, _, _, pass, _, err := helper.GetResource(ctx, client, resource.ID)
if err != nil {
return fmt.Errorf("Get Resource %w", err)
}
entry[i] = shellescape.StripUnsafe(pass)
case "description":
_, _, _, _, _, desc, err := helper.GetResource(ctx, client, resource.ID)
if err != nil {
return fmt.Errorf("Get Resource %w", err)
}
entry[i] = shellescape.StripUnsafe(desc)
case "createdtimestamp":
entry[i] = resource.Created.Format(time.RFC3339)
case "modifiedtimestamp":
entry[i] = resource.Modified.Format(time.RFC3339)
default:
cmd.SilenceUsage = false
return fmt.Errorf("Unknown Column: %v", columns[i])
} }
outputResources = append(outputResources, ResourceJsonOutput{
ID: &resources[i].ID,
FolderParentID: &resources[i].FolderParentID,
Name: &resources[i].Name,
Username: &resources[i].Username,
URI: &resources[i].URI,
Password: &pass,
Description: &desc,
CreatedTimestamp: &resources[i].Created.Time,
ModifiedTimestamp: &resources[i].Modified.Time,
})
} }
data = append(data, entry) jsonResources, err := json.MarshalIndent(outputResources, "", " ")
} if err != nil {
return err
}
fmt.Println(string(jsonResources))
} else {
data := pterm.TableData{columns}
pterm.DefaultTable.WithHasHeader().WithData(data).Render() for _, resource := range resources {
entry := make([]string, len(columns))
for i := range columns {
switch strings.ToLower(columns[i]) {
case "id":
entry[i] = resource.ID
case "folderparentid":
entry[i] = resource.FolderParentID
case "name":
entry[i] = shellescape.StripUnsafe(resource.Name)
case "username":
entry[i] = shellescape.StripUnsafe(resource.Username)
case "uri":
entry[i] = shellescape.StripUnsafe(resource.URI)
case "password":
_, _, _, _, pass, _, err := helper.GetResource(ctx, client, resource.ID)
if err != nil {
return fmt.Errorf("Get Resource %w", err)
}
entry[i] = shellescape.StripUnsafe(pass)
case "description":
_, _, _, _, _, desc, err := helper.GetResource(ctx, client, resource.ID)
if err != nil {
return fmt.Errorf("Get Resource %w", err)
}
entry[i] = shellescape.StripUnsafe(desc)
case "createdtimestamp":
entry[i] = resource.Created.Format(time.RFC3339)
case "modifiedtimestamp":
entry[i] = resource.Modified.Format(time.RFC3339)
default:
cmd.SilenceUsage = false
return fmt.Errorf("Unknown Column: %v", columns[i])
}
}
data = append(data, entry)
}
pterm.DefaultTable.WithHasHeader().WithData(data).Render()
}
return nil return nil
} }

View file

@ -2,6 +2,7 @@ package user
import ( import (
"context" "context"
"encoding/json"
"fmt" "fmt"
"github.com/passbolt/go-passbolt-cli/util" "github.com/passbolt/go-passbolt-cli/util"
@ -45,6 +46,11 @@ func UserCreate(cmd *cobra.Command, args []string) error {
if err != nil { if err != nil {
return err return err
} }
jsonOutput, err := cmd.Flags().GetBool("json")
if err != nil {
return err
}
ctx := util.GetContext() ctx := util.GetContext()
client, err := util.GetClient(ctx) client, err := util.GetClient(ctx)
@ -66,6 +72,18 @@ func UserCreate(cmd *cobra.Command, args []string) error {
return fmt.Errorf("Creating User: %w", err) return fmt.Errorf("Creating User: %w", err)
} }
fmt.Printf("UserID: %v\n", id) if jsonOutput {
jsonId, err := json.MarshalIndent(
map[string]string{"id": id},
"",
" ",
)
if err != nil {
return fmt.Errorf("Marshalling Json: %w", err)
}
fmt.Println(string(jsonId))
} else {
fmt.Printf("UserID: %v\n", id)
}
return nil return nil
} }

View file

@ -2,6 +2,7 @@ package user
import ( import (
"context" "context"
"encoding/json"
"fmt" "fmt"
"github.com/alessio/shellescape" "github.com/alessio/shellescape"
@ -29,6 +30,10 @@ func UserGet(cmd *cobra.Command, args []string) error {
if err != nil { if err != nil {
return err return err
} }
jsonOutput, err := cmd.Flags().GetBool("json")
if err != nil {
return err
}
ctx := util.GetContext() ctx := util.GetContext()
@ -47,10 +52,22 @@ func UserGet(cmd *cobra.Command, args []string) error {
if err != nil { if err != nil {
return fmt.Errorf("Getting User: %w", err) return fmt.Errorf("Getting User: %w", err)
} }
fmt.Printf("Username: %v\n", shellescape.StripUnsafe(username)) if jsonOutput {
fmt.Printf("FirstName: %v\n", shellescape.StripUnsafe(firstname)) jsonUser, err := json.MarshalIndent(UserJsonOutput{
fmt.Printf("LastName: %v\n", shellescape.StripUnsafe(lastname)) Username: &username,
fmt.Printf("Role: %v\n", shellescape.StripUnsafe(role)) FirstName: &firstname,
LastName: &lastname,
Role: &role,
}, "", " ")
if err != nil {
return err
}
fmt.Println(string(jsonUser))
} else {
fmt.Printf("Username: %v\n", shellescape.StripUnsafe(username))
fmt.Printf("FirstName: %v\n", shellescape.StripUnsafe(firstname))
fmt.Printf("LastName: %v\n", shellescape.StripUnsafe(lastname))
fmt.Printf("Role: %v\n", shellescape.StripUnsafe(role))
}
return nil return nil
} }

13
user/json.go Normal file
View file

@ -0,0 +1,13 @@
package user
import "time"
type UserJsonOutput struct {
ID *string `json:"id,omitempty"`
Username *string `json:"username,omitempty"`
FirstName *string `json:"first_name,omitempty"`
LastName *string `json:"last_name,omitempty"`
Role *string `json:"role,omitempty"`
CreatedTimestamp *time.Time `json:"created_timestamp,omitempty"`
ModifiedTimestamp *time.Time `json:"modified_timestamp,omitempty"`
}

View file

@ -2,6 +2,7 @@ package user
import ( import (
"context" "context"
"encoding/json"
"fmt" "fmt"
"strings" "strings"
"time" "time"
@ -57,6 +58,10 @@ func UserList(cmd *cobra.Command, args []string) error {
if len(columns) == 0 { if len(columns) == 0 {
return fmt.Errorf("You need to specify atleast one column to return") return fmt.Errorf("You need to specify atleast one column to return")
} }
jsonOutput, err := cmd.Flags().GetBool("json")
if err != nil {
return err
}
ctx := util.GetContext() ctx := util.GetContext()
@ -77,34 +82,54 @@ func UserList(cmd *cobra.Command, args []string) error {
return fmt.Errorf("Listing User: %w", err) return fmt.Errorf("Listing User: %w", err)
} }
data := pterm.TableData{columns} if jsonOutput {
outputUsers := []UserJsonOutput{}
for _, user := range users { for i := range users {
entry := make([]string, len(columns)) outputUsers = append(outputUsers, UserJsonOutput{
for i := range columns { ID: &users[i].ID,
switch strings.ToLower(columns[i]) { Username: &users[i].Username,
case "id": FirstName: &users[i].Profile.FirstName,
entry[i] = user.ID LastName: &users[i].Profile.LastName,
case "username": Role: &users[i].Role.Name,
entry[i] = shellescape.StripUnsafe(user.Username) CreatedTimestamp: &users[i].Created.Time,
case "firstname": ModifiedTimestamp: &users[i].Modified.Time,
entry[i] = shellescape.StripUnsafe(user.Profile.FirstName) })
case "lastname":
entry[i] = shellescape.StripUnsafe(user.Profile.LastName)
case "role":
entry[i] = shellescape.StripUnsafe(user.Role.Name)
case "createdtimestamp":
entry[i] = user.Created.Format(time.RFC3339)
case "modifiedtimestamp":
entry[i] = user.Modified.Format(time.RFC3339)
default:
cmd.SilenceUsage = false
return fmt.Errorf("Unknown Column: %v", columns[i])
}
} }
data = append(data, entry) jsonUsers, err := json.MarshalIndent(outputUsers, "", " ")
} if err != nil {
return err
}
fmt.Println(string(jsonUsers))
} else {
data := pterm.TableData{columns}
pterm.DefaultTable.WithHasHeader().WithData(data).Render() for _, user := range users {
entry := make([]string, len(columns))
for i := range columns {
switch strings.ToLower(columns[i]) {
case "id":
entry[i] = user.ID
case "username":
entry[i] = shellescape.StripUnsafe(user.Username)
case "firstname":
entry[i] = shellescape.StripUnsafe(user.Profile.FirstName)
case "lastname":
entry[i] = shellescape.StripUnsafe(user.Profile.LastName)
case "role":
entry[i] = shellescape.StripUnsafe(user.Role.Name)
case "createdtimestamp":
entry[i] = user.Created.Format(time.RFC3339)
case "modifiedtimestamp":
entry[i] = user.Modified.Format(time.RFC3339)
default:
cmd.SilenceUsage = false
return fmt.Errorf("Unknown Column: %v", columns[i])
}
}
data = append(data, entry)
}
pterm.DefaultTable.WithHasHeader().WithData(data).Render()
}
return nil return nil
} }