testutils

Documentation

Overview

Package testutils provides test utility functions for the CLI package

Index

• func CreateTestKubeconfig(t *testing.T, namespace string) string
• func CreateTestRecord(clock clockwork.Clock, name, uid, namespace string, ...) *pb.Record
• func ExecuteCommand(c *cobra.Command, args ...string) (string, error)
• func MockRESTClientFromRecords(records []*pb.Record) (*client.RESTClient, error)
• func ReadKubeconfigExtension(t *testing.T, kubeconfigPath, extensionName string, target interface{}) (bool, error)
• func ReadKubeconfigExtensionRaw(t *testing.T, kubeconfigPath, extensionName string) ([]byte, error)
• func TimePtr(t time.Time) *time.Time
• func UpdateKubeconfigNamespace(t *testing.T, kubeconfigPath, newNamespace string)
• type Params
  • func NewParams() *Params
  • func (p *Params) APIPath() string
  • func (p *Params) Host() string
  • func (p *Params) KubeConfigPath() string
  • func (p *Params) KubeContext() string
  • func (p *Params) Namespace() string
  • func (p *Params) RESTClient() *client.RESTClient
  • func (p *Params) SetAPIPath(path string)
  • func (p *Params) SetHost(host string)
  • func (p *Params) SetKubeConfigPath(path string)
  • func (p *Params) SetKubeContext(context string)
  • func (p *Params) SetNamespace(ns string)
  • func (p *Params) SetRESTClient(client *client.RESTClient)
  • func (p *Params) SetSkipTLSVerify(skip bool)
  • func (p *Params) SetToken(token string)
  • func (p *Params) SkipTLSVerify() bool
  • func (p *Params) Token() string

Functions

func CreateTestKubeconfig

func CreateTestKubeconfig(t *testing.T, namespace string) string

CreateTestKubeconfig creates a temporary kubeconfig file for testing If namespace is empty, no namespace is set in the context

func CreateTestRecord

func CreateTestRecord(clock clockwork.Clock, name, uid, namespace string, startTime, endTime *time.Time, conditionStatus string, labels map[string]string) *pb.Record

CreateTestRecord creates a test record with all possible options Use empty string for namespace to use default, nil for labels to omit them

func ExecuteCommand

func ExecuteCommand(c *cobra.Command, args ...string) (string, error)

ExecuteCommand executes the root command passing the args and returns the output as a string and error

func MockRESTClientFromRecords

func MockRESTClientFromRecords(records []*pb.Record) (*client.RESTClient, error)

MockRESTClientFromRecords creates a mock REST client with comprehensive filtering support

func ReadKubeconfigExtension

func ReadKubeconfigExtension(t *testing.T, kubeconfigPath, extensionName string, target interface{}) (bool, error)

ReadKubeconfigExtension reads and unmarshals a kubeconfig extension into the provided target The target parameter should be a pointer to the struct you want to unmarshal into Returns true if the extension was found and unmarshaled successfully, false if not found

func ReadKubeconfigExtensionRaw

func ReadKubeconfigExtensionRaw(t *testing.T, kubeconfigPath, extensionName string) ([]byte, error)

ReadKubeconfigExtensionRaw reads the tekton-results extension from a kubeconfig file as raw data This avoids import cycles by not depending on config package types

func TimePtr

func TimePtr(t time.Time) *time.Time

TimePtr converts time.Time to *time.Time

func UpdateKubeconfigNamespace

func UpdateKubeconfigNamespace(t *testing.T, kubeconfigPath, newNamespace string)

UpdateKubeconfigNamespace updates the namespace of the current context in a kubeconfig file

Types

type Params

type Params struct {
	// contains filtered or unexported fields
}

Params implements common.Params interface for testing This allows injecting fake/mock clients during tests

func NewParams

func NewParams() *Params

NewParams creates a new test Params with sensible defaults

func (*Params) APIPath

func (p *Params) APIPath() string

APIPath returns the API path

func (*Params) Host

func (p *Params) Host() string

Host returns the API host

func (*Params) KubeConfigPath

func (p *Params) KubeConfigPath() string

KubeConfigPath returns the kubeconfig file path

func (*Params) KubeContext

func (p *Params) KubeContext() string

KubeContext returns the kubernetes context

func (*Params) Namespace

func (p *Params) Namespace() string

Namespace returns the kubernetes namespace

func (*Params) RESTClient

func (p *Params) RESTClient() *client.RESTClient

RESTClient returns the injected REST client for testing

func (*Params) SetAPIPath

func (p *Params) SetAPIPath(path string)

SetAPIPath sets the API path

func (*Params) SetHost

func (p *Params) SetHost(host string)

SetHost sets the API host

func (*Params) SetKubeConfigPath

func (p *Params) SetKubeConfigPath(path string)

SetKubeConfigPath sets the kubeconfig file path

func (*Params) SetKubeContext

func (p *Params) SetKubeContext(context string)

SetKubeContext sets the kubernetes context

func (*Params) SetNamespace

func (p *Params) SetNamespace(ns string)

SetNamespace sets the kubernetes namespace, preserving default if empty

func (*Params) SetRESTClient

func (p *Params) SetRESTClient(client *client.RESTClient)

SetRESTClient injects a REST client for testing purposes

func (*Params) SetSkipTLSVerify

func (p *Params) SetSkipTLSVerify(skip bool)

SetSkipTLSVerify sets whether to skip TLS verification

func (*Params) SetToken

func (p *Params) SetToken(token string)

SetToken sets the authentication token

func (*Params) SkipTLSVerify

func (p *Params) SkipTLSVerify() bool

SkipTLSVerify returns whether to skip TLS verification

func (*Params) Token

func (p *Params) Token() string

Token returns the authentication token