Documentation ¶
Index ¶
- type Action
- type ActionImpl
- type CreateAction
- type CreateActionImpl
- type DeleteAction
- type DeleteActionImpl
- 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 FakeDiscovery
- func (c *FakeDiscovery) ServerGroups() (*unversioned.APIGroupList, error)
- func (c *FakeDiscovery) ServerResources() (map[string]*unversioned.APIResourceList, error)
- func (c *FakeDiscovery) ServerResourcesForGroupVersion(groupVersion string) (*unversioned.APIResourceList, error)
- func (c *FakeDiscovery) ServerVersion() (*version.Info, error)
- type GenericAction
- type GenericActionImpl
- type GetAction
- type GetActionImpl
- type ListAction
- type ListActionImpl
- type ListRestrictions
- type ObjectScheme
- type ObjectTracker
- type PatchActionImpl
- func NewPatchAction(resource unversioned.GroupVersionResource, namespace string, name string, ...) PatchActionImpl
- func NewPatchSubresourceAction(resource unversioned.GroupVersionResource, namespace, name string, ...) PatchActionImpl
- func NewRootPatchAction(resource unversioned.GroupVersionResource, name string, patch []byte) PatchActionImpl
- func NewRootPatchSubresourceAction(resource unversioned.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 unversioned.GroupVersionResource, object runtime.Object) UpdateActionImpl
- func NewRootUpdateSubresourceAction(resource unversioned.GroupVersionResource, subresource string, ...) UpdateActionImpl
- func NewUpdateAction(resource unversioned.GroupVersionResource, namespace string, ...) UpdateActionImpl
- func NewUpdateSubresourceAction(resource unversioned.GroupVersionResource, subresource string, ...) UpdateActionImpl
- type WatchAction
- type WatchActionImpl
- type WatchReactionFunc
- type WatchReactor
- type WatchRestrictions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Action ¶
type Action interface { GetNamespace() string GetVerb() string GetResource() unversioned.GroupVersionResource GetSubresource() string Matches(verb, resource string) bool }
type ActionImpl ¶
type ActionImpl struct { Namespace string Verb string Resource unversioned.GroupVersionResource Subresource string }
func (ActionImpl) GetNamespace ¶
func (a ActionImpl) GetNamespace() string
func (ActionImpl) GetResource ¶
func (a ActionImpl) GetResource() unversioned.GroupVersionResource
func (ActionImpl) GetSubresource ¶
func (a ActionImpl) GetSubresource() string
func (ActionImpl) GetVerb ¶
func (a ActionImpl) GetVerb() string
func (ActionImpl) Matches ¶
func (a ActionImpl) Matches(verb, resource string) bool
type CreateAction ¶
type CreateActionImpl ¶
type CreateActionImpl struct { ActionImpl Object runtime.Object }
func NewCreateAction ¶
func NewCreateAction(resource unversioned.GroupVersionResource, namespace string, object runtime.Object) CreateActionImpl
func NewRootCreateAction ¶
func NewRootCreateAction(resource unversioned.GroupVersionResource, object runtime.Object) CreateActionImpl
func (CreateActionImpl) GetObject ¶
func (a CreateActionImpl) GetObject() runtime.Object
type DeleteAction ¶
type DeleteActionImpl ¶
type DeleteActionImpl struct { ActionImpl Name string }
func NewDeleteAction ¶
func NewDeleteAction(resource unversioned.GroupVersionResource, namespace, name string) DeleteActionImpl
func NewRootDeleteAction ¶
func NewRootDeleteAction(resource unversioned.GroupVersionResource, name string) DeleteActionImpl
func (DeleteActionImpl) GetName ¶
func (a DeleteActionImpl) GetName() string
type DeleteCollectionActionImpl ¶
type DeleteCollectionActionImpl struct { ActionImpl ListRestrictions ListRestrictions }
func NewDeleteCollectionAction ¶
func NewDeleteCollectionAction(resource unversioned.GroupVersionResource, namespace string, opts api.ListOptions) DeleteCollectionActionImpl
func NewRootDeleteCollectionAction ¶
func NewRootDeleteCollectionAction(resource unversioned.GroupVersionResource, opts api.ListOptions) DeleteCollectionActionImpl
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 map[string]*unversioned.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 ¶
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 ¶
Invokes records the provided Action and then invokes the ReactFn (if provided). 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 ReactFn (if provided).
func (*Fake) InvokesWatch ¶
InvokesWatch records the provided Action and then invokes the ReactFn (if provided).
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 FakeDiscovery ¶
type FakeDiscovery struct {
*Fake
}
TODO: this probably should be moved to somewhere else.
func (*FakeDiscovery) ServerGroups ¶
func (c *FakeDiscovery) ServerGroups() (*unversioned.APIGroupList, error)
func (*FakeDiscovery) ServerResources ¶
func (c *FakeDiscovery) ServerResources() (map[string]*unversioned.APIResourceList, error)
func (*FakeDiscovery) ServerResourcesForGroupVersion ¶
func (c *FakeDiscovery) ServerResourcesForGroupVersion(groupVersion string) (*unversioned.APIResourceList, error)
func (*FakeDiscovery) ServerVersion ¶
func (c *FakeDiscovery) ServerVersion() (*version.Info, error)
type GenericAction ¶
type GenericAction interface { Action GetValue() interface{} }
type GenericActionImpl ¶
type GenericActionImpl struct { ActionImpl Value interface{} }
func (GenericActionImpl) GetValue ¶
func (a GenericActionImpl) GetValue() interface{}
type GetActionImpl ¶
type GetActionImpl struct { ActionImpl Name string }
func NewGetAction ¶
func NewGetAction(resource unversioned.GroupVersionResource, namespace, name string) GetActionImpl
func NewRootGetAction ¶
func NewRootGetAction(resource unversioned.GroupVersionResource, name string) GetActionImpl
func (GetActionImpl) GetName ¶
func (a GetActionImpl) GetName() string
type ListAction ¶
type ListAction interface { Action GetListRestrictions() ListRestrictions }
type ListActionImpl ¶
type ListActionImpl struct { ActionImpl ListRestrictions ListRestrictions }
func NewListAction ¶
func NewListAction(resource unversioned.GroupVersionResource, namespace string, opts api.ListOptions) ListActionImpl
func NewRootListAction ¶
func NewRootListAction(resource unversioned.GroupVersionResource, opts api.ListOptions) ListActionImpl
func (ListActionImpl) GetListRestrictions ¶
func (a ListActionImpl) GetListRestrictions() ListRestrictions
type ListRestrictions ¶
type ObjectScheme ¶
type ObjectScheme interface { runtime.ObjectCreater runtime.ObjectCopier runtime.ObjectTyper }
ObjectScheme abstracts the implementation of common operations on objects.
type ObjectTracker ¶ added in v1.4.0
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(gvk unversioned.GroupVersionKind, ns, name string) (runtime.Object, error) // Update updates an existing object in the tracker. Update(obj runtime.Object) error // List retrieves all objects of a given kind in the given // namespace. Only non-List kinds are accepted. List(gvk unversioned.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(gvk unversioned.GroupVersionKind, ns, name string) 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 ¶ added in v1.4.0
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 PatchActionImpl ¶
type PatchActionImpl struct { ActionImpl Name string Patch []byte }
func NewPatchAction ¶
func NewPatchAction(resource unversioned.GroupVersionResource, namespace string, name string, patch []byte) PatchActionImpl
func NewPatchSubresourceAction ¶ added in v1.3.0
func NewPatchSubresourceAction(resource unversioned.GroupVersionResource, namespace, name string, patch []byte, subresources ...string) PatchActionImpl
func NewRootPatchAction ¶
func NewRootPatchAction(resource unversioned.GroupVersionResource, name string, patch []byte) PatchActionImpl
func NewRootPatchSubresourceAction ¶ added in v1.4.0
func NewRootPatchSubresourceAction(resource unversioned.GroupVersionResource, name string, patch []byte, subresources ...string) PatchActionImpl
func (PatchActionImpl) GetName ¶ added in v1.4.0
func (a PatchActionImpl) GetName() string
func (PatchActionImpl) GetPatch ¶ added in v1.4.0
func (a PatchActionImpl) GetPatch() []byte
type ProxyGetAction ¶
type ProxyGetActionImpl ¶
type ProxyGetActionImpl struct { ActionImpl Scheme string Name string Port string Path string Params map[string]string }
func NewProxyGetAction ¶
func NewProxyGetAction(resource unversioned.GroupVersionResource, namespace, scheme, name, port, path string, params map[string]string) ProxyGetActionImpl
func (ProxyGetActionImpl) GetName ¶
func (a ProxyGetActionImpl) GetName() string
func (ProxyGetActionImpl) GetParams ¶
func (a ProxyGetActionImpl) GetParams() map[string]string
func (ProxyGetActionImpl) GetPath ¶
func (a ProxyGetActionImpl) GetPath() string
func (ProxyGetActionImpl) GetPort ¶
func (a ProxyGetActionImpl) GetPort() string
func (ProxyGetActionImpl) GetScheme ¶
func (a ProxyGetActionImpl) GetScheme() string
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 ¶
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
func ObjectReaction ¶
func ObjectReaction(tracker ObjectTracker, mapper meta.RESTMapper) 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.
func (*SimpleProxyReactor) Handles ¶
func (r *SimpleProxyReactor) Handles(action Action) bool
func (*SimpleProxyReactor) React ¶
func (r *SimpleProxyReactor) React(action Action) (bool, restclient.ResponseWrapper, error)
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
func (*SimpleReactor) Handles ¶
func (r *SimpleReactor) Handles(action Action) bool
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
func (*SimpleWatchReactor) Handles ¶
func (r *SimpleWatchReactor) Handles(action Action) bool
type UpdateAction ¶
type UpdateActionImpl ¶
type UpdateActionImpl struct { ActionImpl Object runtime.Object }
func NewRootUpdateAction ¶
func NewRootUpdateAction(resource unversioned.GroupVersionResource, object runtime.Object) UpdateActionImpl
func NewRootUpdateSubresourceAction ¶
func NewRootUpdateSubresourceAction(resource unversioned.GroupVersionResource, subresource string, object runtime.Object) UpdateActionImpl
func NewUpdateAction ¶
func NewUpdateAction(resource unversioned.GroupVersionResource, namespace string, object runtime.Object) UpdateActionImpl
func NewUpdateSubresourceAction ¶
func NewUpdateSubresourceAction(resource unversioned.GroupVersionResource, subresource string, namespace string, object runtime.Object) UpdateActionImpl
func (UpdateActionImpl) GetObject ¶
func (a UpdateActionImpl) GetObject() runtime.Object
type WatchAction ¶
type WatchAction interface { Action GetWatchRestrictions() WatchRestrictions }
type WatchActionImpl ¶
type WatchActionImpl struct { ActionImpl WatchRestrictions WatchRestrictions }
func NewRootWatchAction ¶
func NewRootWatchAction(resource unversioned.GroupVersionResource, opts api.ListOptions) WatchActionImpl
func NewWatchAction ¶
func NewWatchAction(resource unversioned.GroupVersionResource, namespace string, opts api.ListOptions) WatchActionImpl
func (WatchActionImpl) GetWatchRestrictions ¶
func (a WatchActionImpl) GetWatchRestrictions() WatchRestrictions
type WatchReactionFunc ¶
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.