func ExtractFromListOptions(opts interface{}) (labelSelector labels.Selector, fieldSelector fields.Selector, resourceVersion string)
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 struct {
Namespace string
Verb string
Resource schema.GroupVersionResource
Subresource string
}
func (a ActionImpl) DeepCopy() Action
func (a ActionImpl) GetNamespace() string
func (a ActionImpl) GetResource() schema.GroupVersionResource
func (a ActionImpl) GetSubresource() string
func (a ActionImpl) GetVerb() string
func (a ActionImpl) Matches(verb, resource string) bool
type CreateAction interface {
Action
GetObject() runtime.Object
}
type CreateActionImpl struct {
ActionImpl
Name string
Object runtime.Object
}
func NewCreateAction(resource schema.GroupVersionResource, namespace string, object runtime.Object) CreateActionImpl
func NewCreateSubresourceAction(resource schema.GroupVersionResource, name, subresource, namespace string, object runtime.Object) CreateActionImpl
func NewRootCreateAction(resource schema.GroupVersionResource, object runtime.Object) CreateActionImpl
func NewRootCreateSubresourceAction(resource schema.GroupVersionResource, name, subresource string, object runtime.Object) CreateActionImpl
func (a CreateActionImpl) DeepCopy() Action
func (a CreateActionImpl) GetObject() runtime.Object
type DeleteAction interface {
Action
GetName() string
GetDeleteOptions() metav1.DeleteOptions
}
type DeleteActionImpl struct {
ActionImpl
Name string
DeleteOptions metav1.DeleteOptions
}
func NewDeleteAction(resource schema.GroupVersionResource, namespace, name string) DeleteActionImpl
func NewDeleteActionWithOptions(resource schema.GroupVersionResource, namespace, name string, opts metav1.DeleteOptions) DeleteActionImpl
func NewDeleteSubresourceAction(resource schema.GroupVersionResource, subresource, namespace, name string) DeleteActionImpl
func NewRootDeleteAction(resource schema.GroupVersionResource, name string) DeleteActionImpl
func NewRootDeleteActionWithOptions(resource schema.GroupVersionResource, name string, opts metav1.DeleteOptions) DeleteActionImpl
func NewRootDeleteSubresourceAction(resource schema.GroupVersionResource, subresource string, name string) DeleteActionImpl
func (a DeleteActionImpl) DeepCopy() Action
func (a DeleteActionImpl) GetDeleteOptions() metav1.DeleteOptions
func (a DeleteActionImpl) GetName() string
type DeleteCollectionAction interface {
Action
GetListRestrictions() ListRestrictions
}
type DeleteCollectionActionImpl struct {
ActionImpl
ListRestrictions ListRestrictions
}
func NewDeleteCollectionAction(resource schema.GroupVersionResource, namespace string, opts interface{}) DeleteCollectionActionImpl
func NewRootDeleteCollectionAction(resource schema.GroupVersionResource, opts interface{}) DeleteCollectionActionImpl
func (a DeleteCollectionActionImpl) DeepCopy() Action
func (a DeleteCollectionActionImpl) GetListRestrictions() ListRestrictions
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.
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
}
func (c *Fake) Actions() []Action
Actions returns a chronologically ordered slice fake actions called on the fake client.
func (c *Fake) AddProxyReactor(resource string, reaction ProxyReactionFunc)
AddProxyReactor appends a reactor to the end of the chain.
func (c *Fake) AddReactor(verb, resource string, reaction ReactionFunc)
AddReactor appends a reactor to the end of the chain.
func (c *Fake) AddWatchReactor(resource string, reaction WatchReactionFunc)
AddWatchReactor appends a reactor to the end of the chain.
func (c *Fake) ClearActions()
ClearActions clears the history of actions called on the fake client.
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 (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 (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 (c *Fake) PrependProxyReactor(resource string, reaction ProxyReactionFunc)
PrependProxyReactor adds a reactor to the beginning of the chain.
func (c *Fake) PrependReactor(verb, resource string, reaction ReactionFunc)
PrependReactor adds a reactor to the beginning of the chain.
func (c *Fake) PrependWatchReactor(resource string, reaction WatchReactionFunc)
PrependWatchReactor adds a reactor to the beginning of the chain.
type FakeClient interface {
// Tracker gives access to the ObjectTracker internal to the fake client.
Tracker() ObjectTracker
// AddReactor appends a reactor to the end of the chain.
AddReactor(verb, resource string, reaction ReactionFunc)
// PrependReactor adds a reactor to the beginning of the chain.
PrependReactor(verb, resource string, reaction ReactionFunc)
// AddWatchReactor appends a reactor to the end of the chain.
AddWatchReactor(resource string, reaction WatchReactionFunc)
// PrependWatchReactor adds a reactor to the beginning of the chain.
PrependWatchReactor(resource string, reaction WatchReactionFunc)
// AddProxyReactor appends a reactor to the end of the chain.
AddProxyReactor(resource string, reaction ProxyReactionFunc)
// PrependProxyReactor adds a reactor to the beginning of the chain.
PrependProxyReactor(resource string, reaction ProxyReactionFunc)
// 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.
Invokes(action Action, defaultReturnObj runtime.Object) (runtime.Object, error)
// InvokesWatch records the provided Action and then invokes the ReactionFunc
// that handles the action if one exists.
InvokesWatch(action Action) (watch.Interface, error)
// InvokesProxy records the provided Action and then invokes the ReactionFunc
// that handles the action if one exists.
InvokesProxy(action Action) restclient.ResponseWrapper
// ClearActions clears the history of actions called on the fake client.
ClearActions()
// Actions returns a chronologically ordered slice fake actions called on the
// fake client.
Actions() []Action
}
type GenericAction interface {
Action
GetValue() interface{}
}
type GenericActionImpl struct {
ActionImpl
Value interface{}
}
func (a GenericActionImpl) DeepCopy() Action
func (a GenericActionImpl) GetValue() interface{}
type GetAction interface {
Action
GetName() string
}
type GetActionImpl struct {
ActionImpl
Name string
}
func NewGetAction(resource schema.GroupVersionResource, namespace, name string) GetActionImpl
func NewGetSubresourceAction(resource schema.GroupVersionResource, namespace, subresource, name string) GetActionImpl
func NewRootGetAction(resource schema.GroupVersionResource, name string) GetActionImpl
func NewRootGetSubresourceAction(resource schema.GroupVersionResource, subresource, name string) GetActionImpl
func (a GetActionImpl) DeepCopy() Action
func (a GetActionImpl) GetName() string
type ListAction interface {
Action
GetListRestrictions() ListRestrictions
}
type ListActionImpl struct {
ActionImpl
Kind schema.GroupVersionKind
Name string
ListRestrictions ListRestrictions
}
func NewListAction(resource schema.GroupVersionResource, kind schema.GroupVersionKind, namespace string, opts interface{}) ListActionImpl
func NewRootListAction(resource schema.GroupVersionResource, kind schema.GroupVersionKind, opts interface{}) ListActionImpl
func (a ListActionImpl) DeepCopy() Action
func (a ListActionImpl) GetKind() schema.GroupVersionKind
func (a ListActionImpl) GetListRestrictions() ListRestrictions
type ListRestrictions struct {
Labels labels.Selector
Fields fields.Selector
}
ObjectScheme abstracts the implementation of common operations on objects.
type ObjectScheme interface {
runtime.ObjectCreater
runtime.ObjectTyper
}
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.
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)
}
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 interface {
Action
GetName() string
GetPatchType() types.PatchType
GetPatch() []byte
}
type PatchActionImpl struct {
ActionImpl
Name string
PatchType types.PatchType
Patch []byte
}
func NewPatchAction(resource schema.GroupVersionResource, namespace string, name string, pt types.PatchType, patch []byte) PatchActionImpl
func NewPatchSubresourceAction(resource schema.GroupVersionResource, namespace, name string, pt types.PatchType, patch []byte, subresources ...string) PatchActionImpl
func NewRootPatchAction(resource schema.GroupVersionResource, name string, pt types.PatchType, patch []byte) PatchActionImpl
func NewRootPatchSubresourceAction(resource schema.GroupVersionResource, name string, pt types.PatchType, patch []byte, subresources ...string) PatchActionImpl
func (a PatchActionImpl) DeepCopy() Action
func (a PatchActionImpl) GetName() string
func (a PatchActionImpl) GetPatch() []byte
func (a PatchActionImpl) GetPatchType() types.PatchType
type ProxyGetAction interface {
Action
GetScheme() string
GetName() string
GetPort() string
GetPath() string
GetParams() map[string]string
}
type ProxyGetActionImpl struct {
ActionImpl
Scheme string
Name string
Port string
Path string
Params map[string]string
}
func NewProxyGetAction(resource schema.GroupVersionResource, namespace, scheme, name, port, path string, params map[string]string) ProxyGetActionImpl
func (a ProxyGetActionImpl) DeepCopy() Action
func (a ProxyGetActionImpl) GetName() string
func (a ProxyGetActionImpl) GetParams() map[string]string
func (a ProxyGetActionImpl) GetPath() string
func (a ProxyGetActionImpl) GetPort() string
func (a ProxyGetActionImpl) GetScheme() string
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 ProxyReactionFunc func(action Action) (handled bool, ret restclient.ResponseWrapper, err error)
ProxyReactor is an interface to allow the composition of proxy get functions.
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)
}
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.
type ReactionFunc func(action Action) (handled bool, ret runtime.Object, err error)
func ObjectReaction(tracker ObjectTracker) ReactionFunc
ObjectReaction returns a ReactionFunc that applies core.Action to the given tracker.
Reactor is an interface to allow the composition of reaction functions.
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)
}
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 SimpleProxyReactor struct {
Resource string
Reaction ProxyReactionFunc
}
func (r *SimpleProxyReactor) Handles(action Action) bool
func (r *SimpleProxyReactor) React(action Action) (bool, restclient.ResponseWrapper, error)
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 SimpleReactor struct {
Verb string
Resource string
Reaction ReactionFunc
}
func (r *SimpleReactor) Handles(action Action) bool
func (r *SimpleReactor) React(action Action) (bool, runtime.Object, error)
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 SimpleWatchReactor struct {
Resource string
Reaction WatchReactionFunc
}
func (r *SimpleWatchReactor) Handles(action Action) bool
func (r *SimpleWatchReactor) React(action Action) (bool, watch.Interface, error)
type UpdateAction interface {
Action
GetObject() runtime.Object
}
type UpdateActionImpl struct {
ActionImpl
Object runtime.Object
}
func NewRootUpdateAction(resource schema.GroupVersionResource, object runtime.Object) UpdateActionImpl
func NewRootUpdateSubresourceAction(resource schema.GroupVersionResource, subresource string, object runtime.Object) UpdateActionImpl
func NewUpdateAction(resource schema.GroupVersionResource, namespace string, object runtime.Object) UpdateActionImpl
func NewUpdateSubresourceAction(resource schema.GroupVersionResource, subresource string, namespace string, object runtime.Object) UpdateActionImpl
func (a UpdateActionImpl) DeepCopy() Action
func (a UpdateActionImpl) GetObject() runtime.Object
type WatchAction interface {
Action
GetWatchRestrictions() WatchRestrictions
}
type WatchActionImpl struct {
ActionImpl
WatchRestrictions WatchRestrictions
}
func NewRootWatchAction(resource schema.GroupVersionResource, opts interface{}) WatchActionImpl
func NewWatchAction(resource schema.GroupVersionResource, namespace string, opts interface{}) WatchActionImpl
func (a WatchActionImpl) DeepCopy() Action
func (a WatchActionImpl) GetWatchRestrictions() WatchRestrictions
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.
type WatchReactionFunc func(action Action) (handled bool, ret watch.Interface, err error)
func DefaultWatchReactor(watchInterface watch.Interface, err error) WatchReactionFunc
WatchReactor is an interface to allow the composition of watch functions.
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)
}
type WatchRestrictions struct {
Labels labels.Selector
Fields fields.Selector
ResourceVersion string
}