cmd

Documentation

Overview

Package cmd is the cobra cli implementation for the core server

Index

• Constants
• Variables
• func Execute()
• func GetInviteStatusEnum(status string) (enums.InviteStatus, error)
• func GetKeyring() (keyring.Keyring, error)
• func GetRoleEnum(role string) (enums.Role, error)
• func GetTokenFromKeyring(ctx context.Context) (*oauth2.Token, string, error)
• func JSONPrint(s []byte) error
• func ParseBytes(v []byte) (map[string]interface{}, error)
• func ParseJSON(v string) (map[string]interface{}, error)
• func SetupClient(ctx context.Context) (*openlaneclient.OpenlaneClient, error)
• func SetupClientWithAuth(ctx context.Context) (*openlaneclient.OpenlaneClient, error)
• func StoreAuthCookies(client *openlaneclient.OpenlaneClient)
• func StoreSession(session string) error
• func StoreSessionCookies(client *openlaneclient.OpenlaneClient)
• func StoreToken(token *oauth2.Token) error
• type RequiredFieldMissingError
  • func NewRequiredFieldMissingError(f string) *RequiredFieldMissingError
  • func (e *RequiredFieldMissingError) Error() string

Constants

const (
	TableOutput = "table"
	JSONOutput  = "json"
)

Variables

var (
	// ErrTokenRequired is returned when no authentication token is provided
	ErrTokenRequired = errors.New("ACCESS_TOKEN not set")

	// ErrInvalidRole is returned when an invalid role is provided for a member
	ErrInvalidRole = errors.New("invalid role, only member and admin are allowed")

	// ErrInvalidInviteStatus is returned when an invalid status is provided for an invite
	ErrInvalidInviteStatus = errors.New("invalid status, only sent, required, accepted, expired are allowed")

	// ErrUnsupportedProvider is returned when an invalid provider is specified during login
	ErrUnsupportedProvider = errors.New("invalid provider, only Github and Google are supported")

	// ErrNotFound is returned when a resource is not found
	ErrNotFound = errors.New("resource not found")

	// ErrSessionNotFound is returned when a session is not found
	ErrSessionNotFound = errors.New("session not found")
)

var (
	OutputFormat string
	InputFile    string
	Config       *koanf.Koanf
)

var (
	// RootHost contains the root url for the API
	RootHost string
	// GraphAPIHost contains the url for the graph api
	GraphAPIHost string
)

var RootCmd = &cobra.Command{
	Use:   appName,
	Short: "the openlane cli",
	PersistentPreRun: func(cmd *cobra.Command, args []string) {
		initConfiguration(cmd)
	},
}

RootCmd represents the base command when called without any subcommands

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func GetInviteStatusEnum

func GetInviteStatusEnum(status string) (enums.InviteStatus, error)

GetInviteStatusEnum returns the invitation status if valid, otherwise returns an error

func GetKeyring

func GetKeyring() (keyring.Keyring, error)

GetKeyring will return the already loaded keyring so that we don't prompt users for passwords multiple times

func GetRoleEnum

func GetRoleEnum(role string) (enums.Role, error)

GetRoleEnum returns the Role if valid, otherwise returns an error

func GetTokenFromKeyring

func GetTokenFromKeyring(ctx context.Context) (*oauth2.Token, string, error)

GetTokenFromKeyring will return the oauth token from the keyring if the token is expired, but the refresh token is still valid, the token will be refreshed

func JSONPrint

func JSONPrint(s []byte) error

JSONPrint prints a JSON formatted string with color

func ParseBytes

func ParseBytes(v []byte) (map[string]interface{}, error)

ParseBytes parses buffered bytes into a map

func ParseJSON

func ParseJSON(v string) (map[string]interface{}, error)

ParseJSON parses a JSON formatted string into a map

func SetupClient

func SetupClient(ctx context.Context) (*openlaneclient.OpenlaneClient, error)

SetupClient will setup the client without the Authorization header this is used for endpoints that do not require authentication, e.g. `v1/login`

func SetupClientWithAuth

func SetupClientWithAuth(ctx context.Context) (*openlaneclient.OpenlaneClient, error)

SetupClientWithAuth will setup the openlane client with the the bearer token passed in the Authorization header and the session cookie passed in the Cookie header. If the token is expired, it will be refreshed. The token and session will be stored in the keyring for future requests

func StoreAuthCookies

func StoreAuthCookies(client *openlaneclient.OpenlaneClient)

StoreAuthCookies gets the auth cookies from the cookie jar if they exist and stores them in the keychain for future requests

func StoreSession

func StoreSession(session string) error

StoreSession in local keyring

func StoreSessionCookies

func StoreSessionCookies(client *openlaneclient.OpenlaneClient)

StoreSessionCookies gets the session cookie from the cookie jar and stores it in the keychain for future requests

func StoreToken

func StoreToken(token *oauth2.Token) error

StoreToken in local keyring

Types

type RequiredFieldMissingError

type RequiredFieldMissingError struct {
	// Field contains the required field that was missing from the input
	Field string
}

RequiredFieldMissingError is returned when a field is required but not provided

func NewRequiredFieldMissingError

func NewRequiredFieldMissingError(f string) *RequiredFieldMissingError

NewRequiredFieldMissingError returns an error for a missing required field

func (*RequiredFieldMissingError) Error

func (e *RequiredFieldMissingError) Error() string

Error returns the RequiredFieldMissingError in string format