Skip to content

NO-JIRA: Display whoami information as JSON or YAML #1324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

NO-JIRA: Display whoami information as JSON or YAML #1324

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
790d0f4
Added the ability to change the output to YAML or JSON
Jan 19, 2023
25e26e6
Merge branch 'openshift:master' into whoami-show-groups
christianh814 Mar 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 36 additions & 5 deletions pkg/cli/whoami/whoami.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package whoami

import (
"context"
"encoding/json"
"fmt"

"github.com/spf13/cobra"
Expand All @@ -17,6 +18,7 @@ import (

userv1 "github.com/openshift/api/user/v1"
userv1typedclient "github.com/openshift/client-go/user/clientset/versioned/typed/user/v1"
"sigs.k8s.io/yaml"
)

const (
Expand Down Expand Up @@ -47,6 +49,8 @@ type WhoAmIOptions struct {
ShowContext bool
ShowServer bool
ShowConsoleUrl bool
ShowGroups bool
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unused and not related to this PR?

Output string

genericclioptions.IOStreams
}
Expand Down Expand Up @@ -76,6 +80,7 @@ func NewCmdWhoAmI(f kcmdutil.Factory, streams genericclioptions.IOStreams) *cobr
cmd.Flags().BoolVarP(&o.ShowContext, "show-context", "c", o.ShowContext, "Print the current user context name")
cmd.Flags().BoolVar(&o.ShowServer, "show-server", o.ShowServer, "If true, print the current server's REST API URL")
cmd.Flags().BoolVar(&o.ShowConsoleUrl, "show-console", o.ShowConsoleUrl, "If true, print the current server's web console URL")
cmd.Flags().StringVarP(&o.Output, "output", "o", o.Output, "One of 'yaml' or 'json'.")

return cmd
}
Expand Down Expand Up @@ -136,6 +141,12 @@ func (o *WhoAmIOptions) getWebConsoleUrl() (string, error) {
}

func (o *WhoAmIOptions) Run() error {
var err error
o.UserInterface, err = userv1typedclient.NewForConfig(o.ClientConfig)
if err != nil {
return err
}

switch {
case o.ShowToken:
fmt.Fprintf(o.Out, "%s\n", o.ClientConfig.BearerToken)
Expand All @@ -153,14 +164,34 @@ func (o *WhoAmIOptions) Run() error {
}
fmt.Fprintf(o.Out, "%s\n", consoleUrl)
return nil
}
case o.Output == "yaml":
u, err := o.UserInterface.Users().Get(context.TODO(), "~", metav1.GetOptions{})
Copy link
Member

@ardaguclu ardaguclu May 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SelfSubjectReview needs to take precedence over UserInterface (logic

oc/pkg/cli/whoami/whoami.go

Lines 88 to 107 in 093ad87

res, err := o.AuthV1Client.SelfSubjectReviews().Create(context.TODO(), &v1.SelfSubjectReview{}, metav1.CreateOptions{})
if err == nil {
me := &userv1.User{
ObjectMeta: metav1.ObjectMeta{
Name: res.Status.UserInfo.Username,
},
Groups: res.Status.UserInfo.Groups,
}
fmt.Fprintf(o.Out, "%s\n", me.Name)
return me, nil
} else {
klog.V(2).Infof("selfsubjectreview request error %v, falling back to user object", err)
}
me, err := o.UserInterface.Users().Get(context.TODO(), "~", metav1.GetOptions{})
if err == nil {
fmt.Fprintf(o.Out, "%s\n", me.Name)
}
return me, err
). Actually, there is no need to duplicate the effort. Why can't we print what we get in WhoAmI function.

u.SetGroupVersionKind(userv1.GroupVersion.WithKind("User"))
if err != nil {
return err
}

var err error
o.UserInterface, err = userv1typedclient.NewForConfig(o.ClientConfig)
if err != nil {
return err
y, err := yaml.Marshal(u)
if err != nil {
return err
}
fmt.Fprintf(o.Out, "%s\n", string(y))
return nil
case o.Output == "json":
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can use built-in printing flags to print yaml and json files. Example, https://github.com/kubernetes/kubectl/blob/5ff92a69e3ecb06912d5f468186d458bf610244e/pkg/cmd/auth/whoami.go#L64

u, err := o.UserInterface.Users().Get(context.TODO(), "~", metav1.GetOptions{})
u.SetGroupVersionKind(userv1.GroupVersion.WithKind("User"))
if err != nil {
return err
}
j, err := json.MarshalIndent(u, "", " ")
if err != nil {
return err
}
fmt.Fprintf(o.Out, "%s\n", string(j))
return nil
}

_, err = o.WhoAmI()

return err
}