Skip to content

[public api] Add gpctl api workspace ownertoken command #9983

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

Merged
merged 1 commit into from
May 13, 2022
Merged

[public api] Add gpctl api workspace ownertoken command #9983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 15 additions & 2 deletions dev/gpctl/cmd/api/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ func NewCommand() *cobra.Command {
}

func newConn(connOpts *connectionOptions) (*grpc.ClientConn, error) {
log.Log.Infof("Estabilishing gRPC connection against %s", connOpts.address)
log.Log.Infof("Establishing gRPC connection against %s", connOpts.address)

opts := []grpc.DialOption{
// attach token to requests to auth
Expand All @@ -61,13 +61,26 @@ func newConn(connOpts *connectionOptions) (*grpc.ClientConn, error) {
return conn, nil
}

func validateAndConnect(connOpts *connectionOptions) (*grpc.ClientConn, error) {
if err := connOpts.validate(); err != nil {
return nil, fmt.Errorf("invalid connection options: %w", err)
}

conn, err := newConn(connOpts)
if err != nil {
return nil, fmt.Errorf("failed to establish gRPC connection: %w", err)
}

return conn, nil
}

type connectionOptions struct {
address string
insecure bool
token string
}

func (o *connectionOptions) Validate() error {
func (o *connectionOptions) validate() error {
if o.address == "" {
return fmt.Errorf("empty connection address")
}
Expand Down
64 changes: 64 additions & 0 deletions dev/gpctl/cmd/api/workspaces-get.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
// Licensed under the GNU Affero General Public License (AGPL).
// See License-AGPL.txt in the project root for license information.

package api

import (
"context"
"fmt"
"os"

"github.com/gitpod-io/gitpod/common-go/log"
v1 "github.com/gitpod-io/gitpod/public-api/v1"
"github.com/spf13/cobra"
"google.golang.org/grpc"
)

func newWorkspacesGetCommand() *cobra.Command {
var workspaceID string

cmd := &cobra.Command{
Use: "get",
Short: "Retrieve details about a workspace by ID",
Example: " get --id 1234",
Run: func(cmd *cobra.Command, args []string) {
if workspaceID == "" {
log.Log.Fatal("no workspace id specified, use --id to set it")
}

conn, err := validateAndConnect(connOpts)
if err != nil {
log.Log.WithError(err).Fatal()
}

workspace, err := getWorkspace(cmd.Context(), conn, workspaceID)

log.Log.WithError(err).WithField("workspace", workspace.String()).Debugf("Workspace response")
if err != nil {
log.Log.WithError(err).Fatal("Failed to retrieve workspace.")
return
}

if err := printProtoMsg(os.Stdout, workspace); err != nil {
log.Log.WithError(err).Fatal("Failed to serialize proto message and print it.")
}
},
}

cmd.Flags().StringVar(&workspaceID, "id", "", "Workspace ID")

return cmd
}

func getWorkspace(ctx context.Context, conn *grpc.ClientConn, workspaceID string) (*v1.GetWorkspaceResponse, error) {
service := v1.NewWorkspacesServiceClient(conn)

log.Log.Debugf("Retrieving workspace ID: %s", workspaceID)
resp, err := service.GetWorkspace(ctx, &v1.GetWorkspaceRequest{WorkspaceId: workspaceID})
if err != nil {
return nil, fmt.Errorf("failed to retrieve workspace (ID: %s): %w", workspaceID, err)
}

return resp, nil
}
64 changes: 64 additions & 0 deletions dev/gpctl/cmd/api/workspaces-ownertoken.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
// Licensed under the GNU Affero General Public License (AGPL).
// See License-AGPL.txt in the project root for license information.

package api

import (
"context"
"fmt"
"os"

"github.com/gitpod-io/gitpod/common-go/log"
v1 "github.com/gitpod-io/gitpod/public-api/v1"
"github.com/spf13/cobra"
"google.golang.org/grpc"
)

func newWorkspacesOwnerTokenCommand() *cobra.Command {
var workspaceID string

cmd := &cobra.Command{
Use: "ownertoken",
Copy link
Member

Choose a reason for hiding this comment

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

I'd possibly call this owner-token just for readability, up to you.

Short: "Retrieve the owner token for a given workspace ID",
Example: " ownertoken --id 1234",
Run: func(cmd *cobra.Command, args []string) {
if workspaceID == "" {
log.Log.Fatal("no workspace id specified, use --id to set it")
}

conn, err := validateAndConnect(connOpts)
if err != nil {
log.Log.WithError(err).Fatal()
}

ownerToken, err := getOwnerToken(cmd.Context(), conn, workspaceID)

log.Log.WithError(err).WithField("ownertoken", ownerToken.String()).Debugf("Owner token response")
if err != nil {
log.Log.WithError(err).Fatal("Failed to retrieve owner token.")
return
}

if err := printProtoMsg(os.Stdout, ownerToken); err != nil {
log.Log.WithError(err).Fatal("Failed to serialize proto message and print it.")
}
},
}

cmd.Flags().StringVar(&workspaceID, "id", "", "Workspace ID")

return cmd
}

func getOwnerToken(ctx context.Context, conn *grpc.ClientConn, workspaceID string) (*v1.GetOwnerTokenResponse, error) {
service := v1.NewWorkspacesServiceClient(conn)

log.Log.Debugf("Retrieving owner token from workspace ID: %s", workspaceID)
resp, err := service.GetOwnerToken(ctx, &v1.GetOwnerTokenRequest{WorkspaceId: workspaceID})
if err != nil {
return nil, fmt.Errorf("failed to retrieve workspace (ID: %s): %w", workspaceID, err)
}

return resp, nil
}
61 changes: 3 additions & 58 deletions dev/gpctl/cmd/api/workspaces.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,12 @@
package api

import (
"context"
"fmt"
"github.com/gitpod-io/gitpod/common-go/log"
v1 "github.com/gitpod-io/gitpod/public-api/v1"
"io"

"github.com/spf13/cobra"
"google.golang.org/grpc"
"google.golang.org/protobuf/encoding/protojson"
"google.golang.org/protobuf/proto"
"io"
"os"
)

func newWorkspacesCommand() *cobra.Command {
Expand All @@ -24,62 +20,11 @@ func newWorkspacesCommand() *cobra.Command {
}

cmd.AddCommand(newWorkspacesGetCommand())
cmd.AddCommand(newWorkspacesOwnerTokenCommand())

return cmd
}

func newWorkspacesGetCommand() *cobra.Command {
var workspaceID string

cmd := &cobra.Command{
Use: "get",
Short: "Retrieve details about a workspace by ID",
Example: " get --id 1234",
Run: func(cmd *cobra.Command, args []string) {
if workspaceID == "" {
log.Log.Fatal("no workspace id specified, use --id to set it")
}

if err := connOpts.Validate(); err != nil {
log.Log.WithError(err).Fatal("Invalid connections options.")
}

conn, err := newConn(connOpts)
if err != nil {
log.Log.WithError(err).Fatal("Failed to establish gRPC connection")
}

workspace, err := getWorkspace(cmd.Context(), conn, workspaceID)

log.Log.WithError(err).WithField("workspace", workspace.String()).Debugf("Workspace response")
if err != nil {
log.Log.WithError(err).Fatal("Failed to retrieve workspace.")
return
}

if err := printProtoMsg(os.Stdout, workspace); err != nil {
log.Log.WithError(err).Fatal("Failed to serialize proto message and print it.")
}
},
}

cmd.Flags().StringVar(&workspaceID, "id", "", "Workspace ID")

return cmd
}

func getWorkspace(ctx context.Context, conn *grpc.ClientConn, workspaceID string) (*v1.GetWorkspaceResponse, error) {
service := v1.NewWorkspacesServiceClient(conn)

log.Log.Debugf("Retrieving workspace ID: %s", workspaceID)
resp, err := service.GetWorkspace(ctx, &v1.GetWorkspaceRequest{WorkspaceId: workspaceID})
if err != nil {
return nil, fmt.Errorf("failed to retrieve workspace (ID: %s): %w", workspaceID, err)
}

return resp, nil
}

func printProtoMsg(w io.Writer, m proto.Message) error {
b, err := protojson.Marshal(m)
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion scripts/protoc-generator.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ install_dependencies() {
lint() {
local PROTO_DIR=${1:-.}

docker run --volume "$PWD/$PROTO_DIR:/workspace" --workdir /workspace bufbuild/buf lint || exit 1
docker run --rm --volume "$PWD/$PROTO_DIR:/workspace" --workdir /workspace bufbuild/buf lint || exit 1
}

go_protoc() {
Expand Down