Documentation
¶
Index ¶
- func ExtractFromListOptions(opts interface{}) (labelSelector labels.Selector, fieldSelector fields.Selector, ...)
- type Action
- type ActionImpl
- type CreateAction
- type CreateActionImpl
- func NewCreateAction(resource schema.GroupVersionResource, namespace string, object runtime.Object) CreateActionImpl
- func NewCreateSubresourceAction(resource schema.GroupVersionResource, name, subresource string, ...) CreateActionImpl
- func NewRootCreateAction(resource schema.GroupVersionResource, object runtime.Object) CreateActionImpl
- type DeleteAction
- type DeleteActionImpl
- type DeleteCollectionAction
- type DeleteCollectionActionImpl
- type Fake
- func (c *Fake) Actions() []Action
- func (c *Fake) AddProxyReactor(resource string, reaction ProxyReactionFunc)
- func (c *Fake) AddReactor(verb, resource string, reaction ReactionFunc)
- func (c *Fake) AddWatchReactor(resource string, reaction WatchReactionFunc)
- func (c *Fake) ClearActions()
- func (c *Fake) Invokes(action Action, defaultReturnObj runtime.Object) (runtime.Object, error)
- func (c *Fake) InvokesProxy(action Action) restclient.ResponseWrapper
- func (c *Fake) InvokesWatch(action Action) (watch.Interface, error)
- func (c *Fake) PrependProxyReactor(resource string, reaction ProxyReactionFunc)
- func (c *Fake) PrependReactor(verb, resource string, reaction ReactionFunc)
- func (c *Fake) PrependWatchReactor(resource string, reaction WatchReactionFunc)
- type GenericAction
- type GenericActionImpl
- type GetAction
- type GetActionImpl
- type ListAction
- type ListActionImpl
- func NewListAction(resource schema.GroupVersionResource, kind schema.GroupVersionKind, ...) ListActionImpl
- func NewListSubresourceAction(resource schema.GroupVersionResource, name, subresource string, ...) ListActionImpl
- func NewRootListAction(resource schema.GroupVersionResource, kind schema.GroupVersionKind, ...) ListActionImpl
- type ListRestrictions
- type ObjectScheme
- type ObjectTracker
- type PatchAction
- type PatchActionImpl
- func NewPatchAction(resource schema.GroupVersionResource, namespace string, name string, ...) PatchActionImpl
- func NewPatchSubresourceAction(resource schema.GroupVersionResource, namespace, name string, patch []byte, ...) PatchActionImpl
- func NewRootPatchAction(resource schema.GroupVersionResource, name string, patch []byte) PatchActionImpl
- func NewRootPatchSubresourceAction(resource schema.GroupVersionResource, name string, patch []byte, ...) PatchActionImpl
- type ProxyGetAction
- type ProxyGetActionImpl
- type ProxyReactionFunc
- type ProxyReactor
- type ReactionFunc
- type Reactor
- type SimpleProxyReactor
- type SimpleReactor
- type SimpleWatchReactor
- type UpdateAction
- type UpdateActionImpl
- func NewRootUpdateAction(resource schema.GroupVersionResource, object runtime.Object) UpdateActionImpl
- func NewRootUpdateSubresourceAction(resource schema.GroupVersionResource, subresource string, ...) UpdateActionImpl
- func NewUpdateAction(resource schema.GroupVersionResource, namespace string, object runtime.Object) UpdateActionImpl
- func NewUpdateSubresourceAction(resource schema.GroupVersionResource, subresource string, namespace string, ...) UpdateActionImpl
- type WatchAction
- type WatchActionImpl
- type WatchReactionFunc
- type WatchReactor
- type WatchRestrictions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ExtractFromListOptions ¶
func ExtractFromListOptions(opts interface{}) (labelSelector labels.Selector, fieldSelector fields.Selector, resourceVersion string)
Types ¶
type Action ¶
type Action interface {
GetNamespace() string
GetVerb() string
GetResource() schema.GroupVersionResource
GetSubresource() string
Matches(verb, resource string) bool
// DeepCopy is used to copy an action to avoid any risk of accidental mutation. Most people never need to call this
// because the invocation logic deep copies before calls to storage and reactors.
DeepCopy() Action
}
type ActionImpl ¶
type ActionImpl struct {
Namespace string
Verb string
Resource schema.GroupVersionResource
Subresource string
}
func (ActionImpl) GetNamespace ¶
func (a ActionImpl) GetNamespace() string
func (ActionImpl) GetResource ¶
func (a ActionImpl) GetResource() schema.GroupVersionResource
func (ActionImpl) GetSubresource ¶
func (a ActionImpl) GetSubresource() string
type CreateAction ¶
type CreateAction interface {
Action
GetObject() runtime.Object
}
type CreateActionImpl ¶
type CreateActionImpl struct {
ActionImpl
Name string
Object runtime.Object
}
func NewCreateAction ¶
func NewCreateAction(resource schema.GroupVersionResource, namespace string, object runtime.Object) CreateActionImpl
func NewCreateSubresourceAction ¶ added in v1.8.0
func NewCreateSubresourceAction(resource schema.GroupVersionResource, name, subresource string, namespace string, object runtime.Object) CreateActionImpl
func NewRootCreateAction ¶
func NewRootCreateAction(resource schema.GroupVersionResource, object runtime.Object) CreateActionImpl
type DeleteAction ¶
type DeleteAction interface {
Action
GetName() string
}
type DeleteActionImpl ¶
type DeleteActionImpl struct {
ActionImpl
Name string
}
func NewDeleteAction ¶
func NewDeleteAction(resource schema.GroupVersionResource, namespace, name string) DeleteActionImpl
func NewRootDeleteAction ¶
func NewRootDeleteAction(resource schema.GroupVersionResource, name string) DeleteActionImpl
type DeleteCollectionAction ¶ added in v1.8.0
type DeleteCollectionAction interface {
Action
GetListRestrictions() ListRestrictions
}
type DeleteCollectionActionImpl ¶
type DeleteCollectionActionImpl struct {
ActionImpl
ListRestrictions ListRestrictions
}
func NewDeleteCollectionAction ¶
func NewDeleteCollectionAction(resource schema.GroupVersionResource, namespace string, opts interface{}) DeleteCollectionActionImpl
func NewRootDeleteCollectionAction ¶
func NewRootDeleteCollectionAction(resource schema.GroupVersionResource, opts interface{}) DeleteCollectionActionImpl
func (DeleteCollectionActionImpl) DeepCopy ¶ added in v1.11.0
func (a DeleteCollectionActionImpl) DeepCopy() Action
func (DeleteCollectionActionImpl) GetListRestrictions ¶
func (a DeleteCollectionActionImpl) GetListRestrictions() ListRestrictions
type Fake ¶
type Fake struct {
sync.RWMutex
// ReactionChain is the list of reactors that will be attempted for every
// request in the order they are tried.
ReactionChain []Reactor
// WatchReactionChain is the list of watch reactors that will be attempted
// for every request in the order they are tried.
WatchReactionChain []WatchReactor
// ProxyReactionChain is the list of proxy reactors that will be attempted
// for every request in the order they are tried.
ProxyReactionChain []ProxyReactor
Resources []*metav1.APIResourceList
// contains filtered or unexported fields
}
Fake implements client.Interface. Meant to be embedded into a struct to get a default implementation. This makes faking out just the method you want to test easier.
func (*Fake) Actions ¶
func (c *Fake) Actions() []Action
Actions returns a chronologically ordered slice fake actions called on the fake client.
func (*Fake) AddProxyReactor ¶
func (c *Fake) AddProxyReactor(resource string, reaction ProxyReactionFunc)
AddProxyReactor appends a reactor to the end of the chain.
func (*Fake) AddReactor ¶
func (c *Fake) AddReactor(verb, resource string, reaction ReactionFunc)
AddReactor appends a reactor to the end of the chain.
func (*Fake) AddWatchReactor ¶
func (c *Fake) AddWatchReactor(resource string, reaction WatchReactionFunc)
AddWatchReactor appends a reactor to the end of the chain.
func (*Fake) ClearActions ¶
func (c *Fake) ClearActions()
ClearActions clears the history of actions called on the fake client.
func (*Fake) Invokes ¶
func (c *Fake) Invokes(action Action, defaultReturnObj runtime.Object) (runtime.Object, error)
Invokes records the provided Action and then invokes the ReactionFunc that handles the action if one exists. defaultReturnObj is expected to be of the same type a normal call would return.
func (*Fake) InvokesProxy ¶
func (c *Fake) InvokesProxy(action Action) restclient.ResponseWrapper
InvokesProxy records the provided Action and then invokes the ReactionFunc that handles the action if one exists.
func (*Fake) InvokesWatch ¶
func (c *Fake) InvokesWatch(action Action) (watch.Interface, error)
InvokesWatch records the provided Action and then invokes the ReactionFunc that handles the action if one exists.
func (*Fake) PrependProxyReactor ¶
func (c *Fake) PrependProxyReactor(resource string, reaction ProxyReactionFunc)
PrependProxyReactor adds a reactor to the beginning of the chain.
func (*Fake) PrependReactor ¶
func (c *Fake) PrependReactor(verb, resource string, reaction ReactionFunc)
PrependReactor adds a reactor to the beginning of the chain.
func (*Fake) PrependWatchReactor ¶
func (c *Fake) PrependWatchReactor(resource string, reaction WatchReactionFunc)
PrependWatchReactor adds a reactor to the beginning of the chain.
type GenericAction ¶
type GenericAction interface {
Action
GetValue() interface{}
}
type GenericActionImpl ¶
type GenericActionImpl struct {
ActionImpl
Value interface{}
}
type GetActionImpl ¶
type GetActionImpl struct {
ActionImpl
Name string
}
func NewGetAction ¶
func NewGetAction(resource schema.GroupVersionResource, namespace, name string) GetActionImpl
func NewGetSubresourceAction ¶ added in v1.8.0
func NewGetSubresourceAction(resource schema.GroupVersionResource, namespace, subresource, name string) GetActionImpl
func NewRootGetAction ¶
func NewRootGetAction(resource schema.GroupVersionResource, name string) GetActionImpl
type ListAction ¶
type ListAction interface {
Action
GetListRestrictions() ListRestrictions
}
type ListActionImpl ¶
type ListActionImpl struct {
ActionImpl
Kind schema.GroupVersionKind
Name string
ListRestrictions ListRestrictions
}
func NewListAction ¶
func NewListAction(resource schema.GroupVersionResource, kind schema.GroupVersionKind, namespace string, opts interface{}) ListActionImpl
func NewListSubresourceAction ¶ added in v1.8.0
func NewListSubresourceAction(resource schema.GroupVersionResource, name, subresource string, kind schema.GroupVersionKind, namespace string, opts interface{}) ListActionImpl
func NewRootListAction ¶
func NewRootListAction(resource schema.GroupVersionResource, kind schema.GroupVersionKind, opts interface{}) ListActionImpl
func (ListActionImpl) GetKind ¶ added in v1.7.0
func (a ListActionImpl) GetKind() schema.GroupVersionKind
func (ListActionImpl) GetListRestrictions ¶
func (a ListActionImpl) GetListRestrictions() ListRestrictions
type ListRestrictions ¶
type ListRestrictions struct {
Labels labels.Selector
Fields fields.Selector
}
type ObjectScheme ¶
type ObjectScheme interface {
runtime.ObjectCreater
runtime.ObjectTyper
}
ObjectScheme abstracts the implementation of common operations on objects.
type ObjectTracker ¶
type ObjectTracker interface {
// Add adds an object to the tracker. If object being added
// is a list, its items are added separately.
Add(obj runtime.Object) error
// Get retrieves the object by its kind, namespace and name.
Get(gvr schema.GroupVersionResource, ns, name string) (runtime.Object, error)
// Create adds an object to the tracker in the specified namespace.
Create(gvr schema.GroupVersionResource, obj runtime.Object, ns string) error
// Update updates an existing object in the tracker in the specified namespace.
Update(gvr schema.GroupVersionResource, obj runtime.Object, ns string) error
// List retrieves all objects of a given kind in the given
// namespace. Only non-List kinds are accepted.
List(gvr schema.GroupVersionResource, gvk schema.GroupVersionKind, ns string) (runtime.Object, error)
// Delete deletes an existing object from the tracker. If object
// didn't exist in the tracker prior to deletion, Delete returns
// no error.
Delete(gvr schema.GroupVersionResource, ns, name string) error
// Watch watches objects from the tracker. Watch returns a channel
// which will push added / modified / deleted object.
Watch(gvr schema.GroupVersionResource, ns string) (watch.Interface, error)
}
ObjectTracker keeps track of objects. It is intended to be used to fake calls to a server by returning objects based on their kind, namespace and name.
func NewObjectTracker ¶
func NewObjectTracker(scheme ObjectScheme, decoder runtime.Decoder) ObjectTracker
NewObjectTracker returns an ObjectTracker that can be used to keep track of objects for the fake clientset. Mostly useful for unit tests.
type PatchAction ¶ added in v1.8.0
type PatchAction interface {
Action
GetName() string
GetPatch() []byte
}
type PatchActionImpl ¶
type PatchActionImpl struct {
ActionImpl
Name string
Patch []byte
}
func NewPatchAction ¶
func NewPatchAction(resource schema.GroupVersionResource, namespace string, name string, patch []byte) PatchActionImpl
func NewPatchSubresourceAction ¶
func NewPatchSubresourceAction(resource schema.GroupVersionResource, namespace, name string, patch []byte, subresources ...string) PatchActionImpl
func NewRootPatchAction ¶
func NewRootPatchAction(resource schema.GroupVersionResource, name string, patch []byte) PatchActionImpl
func NewRootPatchSubresourceAction ¶
func NewRootPatchSubresourceAction(resource schema.GroupVersionResource, name string, patch []byte, subresources ...string) PatchActionImpl
type ProxyGetAction ¶
type ProxyGetAction interface {
Action
GetScheme() string
GetName() string
GetPort() string
GetPath() string
GetParams() map[string]string
}
type ProxyGetActionImpl ¶
type ProxyGetActionImpl struct {
ActionImpl
Scheme string
Name string
Port string
Path string
Params map[string]string
}
func NewProxyGetAction ¶
func NewProxyGetAction(resource schema.GroupVersionResource, namespace, scheme, name, port, path string, params map[string]string) ProxyGetActionImpl
type ProxyReactionFunc ¶
type ProxyReactionFunc func(action Action) (handled bool, ret restclient.ResponseWrapper, err error)
ProxyReactionFunc is a function that returns a ResponseWrapper interface for a given Action. If "handled" is false, then the test client will ignore the results and continue to the next ProxyReactionFunc.
type ProxyReactor ¶
type ProxyReactor interface {
// Handles indicates whether or not this Reactor deals with a given
// action.
Handles(action Action) bool
// React handles a watch action and returns results. It may choose to
// delegate by indicating handled=false.
React(action Action) (handled bool, ret restclient.ResponseWrapper, err error)
}
ProxyReactor is an interface to allow the composition of proxy get functions.
type ReactionFunc ¶
type ReactionFunc func(action Action) (handled bool, ret runtime.Object, err error)
ReactionFunc is a function that returns an object or error for a given Action. If "handled" is false, then the test client will ignore the results and continue to the next ReactionFunc. A ReactionFunc can describe reactions on subresources by testing the result of the action's GetSubresource() method.
func ObjectReaction ¶
func ObjectReaction(tracker ObjectTracker) ReactionFunc
ObjectReaction returns a ReactionFunc that applies core.Action to the given tracker.
type Reactor ¶
type Reactor interface {
// Handles indicates whether or not this Reactor deals with a given
// action.
Handles(action Action) bool
// React handles the action and returns results. It may choose to
// delegate by indicated handled=false.
React(action Action) (handled bool, ret runtime.Object, err error)
}
Reactor is an interface to allow the composition of reaction functions.
type SimpleProxyReactor ¶
type SimpleProxyReactor struct {
Resource string
Reaction ProxyReactionFunc
}
SimpleProxyReactor is a ProxyReactor. Each reaction function is attached to a given resource. "*" matches everything for that value. For instance, *,pods matches all verbs on pods. This allows for easier composition of reaction functions.
type SimpleReactor ¶
type SimpleReactor struct {
Verb string
Resource string
Reaction ReactionFunc
}
SimpleReactor is a Reactor. Each reaction function is attached to a given verb,resource tuple. "*" in either field matches everything for that value. For instance, *,pods matches all verbs on pods. This allows for easier composition of reaction functions
type SimpleWatchReactor ¶
type SimpleWatchReactor struct {
Resource string
Reaction WatchReactionFunc
}
SimpleWatchReactor is a WatchReactor. Each reaction function is attached to a given resource. "*" matches everything for that value. For instance, *,pods matches all verbs on pods. This allows for easier composition of reaction functions
type UpdateAction ¶
type UpdateAction interface {
Action
GetObject() runtime.Object
}
type UpdateActionImpl ¶
type UpdateActionImpl struct {
ActionImpl
Object runtime.Object
}
func NewRootUpdateAction ¶
func NewRootUpdateAction(resource schema.GroupVersionResource, object runtime.Object) UpdateActionImpl
func NewRootUpdateSubresourceAction ¶
func NewRootUpdateSubresourceAction(resource schema.GroupVersionResource, subresource string, object runtime.Object) UpdateActionImpl
func NewUpdateAction ¶
func NewUpdateAction(resource schema.GroupVersionResource, namespace string, object runtime.Object) UpdateActionImpl
func NewUpdateSubresourceAction ¶
func NewUpdateSubresourceAction(resource schema.GroupVersionResource, subresource string, namespace string, object runtime.Object) UpdateActionImpl
type WatchAction ¶
type WatchAction interface {
Action
GetWatchRestrictions() WatchRestrictions
}
type WatchActionImpl ¶
type WatchActionImpl struct {
ActionImpl
WatchRestrictions WatchRestrictions
}
func NewRootWatchAction ¶
func NewRootWatchAction(resource schema.GroupVersionResource, opts interface{}) WatchActionImpl
func NewWatchAction ¶
func NewWatchAction(resource schema.GroupVersionResource, namespace string, opts interface{}) WatchActionImpl
func (WatchActionImpl) GetWatchRestrictions ¶
func (a WatchActionImpl) GetWatchRestrictions() WatchRestrictions
type WatchReactionFunc ¶
type WatchReactionFunc func(action Action) (handled bool, ret watch.Interface, err error)
WatchReactionFunc is a function that returns a watch interface. If "handled" is false, then the test client will ignore the results and continue to the next ReactionFunc.
func DefaultWatchReactor ¶
func DefaultWatchReactor(watchInterface watch.Interface, err error) WatchReactionFunc
type WatchReactor ¶
type WatchReactor interface {
// Handles indicates whether or not this Reactor deals with a given
// action.
Handles(action Action) bool
// React handles a watch action and returns results. It may choose to
// delegate by indicating handled=false.
React(action Action) (handled bool, ret watch.Interface, err error)
}
WatchReactor is an interface to allow the composition of watch functions.
type WatchRestrictions ¶
type WatchRestrictions struct {
Labels labels.Selector
Fields fields.Selector
ResourceVersion string
}