Merge branch '17165-vscode-training-doc' refs #17165
[arvados.git] / sdk / go / arvadostest / api.go
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: Apache-2.0
4
5 package arvadostest
6
7 import (
8         "context"
9         "encoding/json"
10         "errors"
11         "net/url"
12         "reflect"
13         "runtime"
14         "sync"
15
16         "git.arvados.org/arvados.git/sdk/go/arvados"
17 )
18
19 var ErrStubUnimplemented = errors.New("stub unimplemented")
20
21 type APIStub struct {
22         // The error to return from every stubbed API method.
23         Error error
24         calls []APIStubCall
25         mtx   sync.Mutex
26 }
27
28 // BaseURL implements federation.backend
29 func (as *APIStub) BaseURL() url.URL {
30         return url.URL{Scheme: "https", Host: "apistub.example.com"}
31 }
32 func (as *APIStub) ConfigGet(ctx context.Context) (json.RawMessage, error) {
33         as.appendCall(ctx, as.ConfigGet, nil)
34         return nil, as.Error
35 }
36 func (as *APIStub) Login(ctx context.Context, options arvados.LoginOptions) (arvados.LoginResponse, error) {
37         as.appendCall(ctx, as.Login, options)
38         return arvados.LoginResponse{}, as.Error
39 }
40 func (as *APIStub) Logout(ctx context.Context, options arvados.LogoutOptions) (arvados.LogoutResponse, error) {
41         as.appendCall(ctx, as.Logout, options)
42         return arvados.LogoutResponse{}, as.Error
43 }
44 func (as *APIStub) CollectionCreate(ctx context.Context, options arvados.CreateOptions) (arvados.Collection, error) {
45         as.appendCall(ctx, as.CollectionCreate, options)
46         return arvados.Collection{}, as.Error
47 }
48 func (as *APIStub) CollectionUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.Collection, error) {
49         as.appendCall(ctx, as.CollectionUpdate, options)
50         return arvados.Collection{}, as.Error
51 }
52 func (as *APIStub) CollectionGet(ctx context.Context, options arvados.GetOptions) (arvados.Collection, error) {
53         as.appendCall(ctx, as.CollectionGet, options)
54         return arvados.Collection{}, as.Error
55 }
56 func (as *APIStub) CollectionList(ctx context.Context, options arvados.ListOptions) (arvados.CollectionList, error) {
57         as.appendCall(ctx, as.CollectionList, options)
58         return arvados.CollectionList{}, as.Error
59 }
60 func (as *APIStub) CollectionProvenance(ctx context.Context, options arvados.GetOptions) (map[string]interface{}, error) {
61         as.appendCall(ctx, as.CollectionProvenance, options)
62         return nil, as.Error
63 }
64 func (as *APIStub) CollectionUsedBy(ctx context.Context, options arvados.GetOptions) (map[string]interface{}, error) {
65         as.appendCall(ctx, as.CollectionUsedBy, options)
66         return nil, as.Error
67 }
68 func (as *APIStub) CollectionDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.Collection, error) {
69         as.appendCall(ctx, as.CollectionDelete, options)
70         return arvados.Collection{}, as.Error
71 }
72 func (as *APIStub) CollectionTrash(ctx context.Context, options arvados.DeleteOptions) (arvados.Collection, error) {
73         as.appendCall(ctx, as.CollectionTrash, options)
74         return arvados.Collection{}, as.Error
75 }
76 func (as *APIStub) CollectionUntrash(ctx context.Context, options arvados.UntrashOptions) (arvados.Collection, error) {
77         as.appendCall(ctx, as.CollectionUntrash, options)
78         return arvados.Collection{}, as.Error
79 }
80 func (as *APIStub) ContainerCreate(ctx context.Context, options arvados.CreateOptions) (arvados.Container, error) {
81         as.appendCall(ctx, as.ContainerCreate, options)
82         return arvados.Container{}, as.Error
83 }
84 func (as *APIStub) ContainerUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.Container, error) {
85         as.appendCall(ctx, as.ContainerUpdate, options)
86         return arvados.Container{}, as.Error
87 }
88 func (as *APIStub) ContainerGet(ctx context.Context, options arvados.GetOptions) (arvados.Container, error) {
89         as.appendCall(ctx, as.ContainerGet, options)
90         return arvados.Container{}, as.Error
91 }
92 func (as *APIStub) ContainerList(ctx context.Context, options arvados.ListOptions) (arvados.ContainerList, error) {
93         as.appendCall(ctx, as.ContainerList, options)
94         return arvados.ContainerList{}, as.Error
95 }
96 func (as *APIStub) ContainerDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.Container, error) {
97         as.appendCall(ctx, as.ContainerDelete, options)
98         return arvados.Container{}, as.Error
99 }
100 func (as *APIStub) ContainerLock(ctx context.Context, options arvados.GetOptions) (arvados.Container, error) {
101         as.appendCall(ctx, as.ContainerLock, options)
102         return arvados.Container{}, as.Error
103 }
104 func (as *APIStub) ContainerUnlock(ctx context.Context, options arvados.GetOptions) (arvados.Container, error) {
105         as.appendCall(ctx, as.ContainerUnlock, options)
106         return arvados.Container{}, as.Error
107 }
108 func (as *APIStub) ContainerSSH(ctx context.Context, options arvados.ContainerSSHOptions) (arvados.ContainerSSHConnection, error) {
109         as.appendCall(ctx, as.ContainerSSH, options)
110         return arvados.ContainerSSHConnection{}, as.Error
111 }
112 func (as *APIStub) ContainerRequestCreate(ctx context.Context, options arvados.CreateOptions) (arvados.ContainerRequest, error) {
113         as.appendCall(ctx, as.ContainerRequestCreate, options)
114         return arvados.ContainerRequest{}, as.Error
115 }
116 func (as *APIStub) ContainerRequestUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.ContainerRequest, error) {
117         as.appendCall(ctx, as.ContainerRequestUpdate, options)
118         return arvados.ContainerRequest{}, as.Error
119 }
120 func (as *APIStub) ContainerRequestGet(ctx context.Context, options arvados.GetOptions) (arvados.ContainerRequest, error) {
121         as.appendCall(ctx, as.ContainerRequestGet, options)
122         return arvados.ContainerRequest{}, as.Error
123 }
124 func (as *APIStub) ContainerRequestList(ctx context.Context, options arvados.ListOptions) (arvados.ContainerRequestList, error) {
125         as.appendCall(ctx, as.ContainerRequestList, options)
126         return arvados.ContainerRequestList{}, as.Error
127 }
128 func (as *APIStub) ContainerRequestDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.ContainerRequest, error) {
129         as.appendCall(ctx, as.ContainerRequestDelete, options)
130         return arvados.ContainerRequest{}, as.Error
131 }
132 func (as *APIStub) SpecimenCreate(ctx context.Context, options arvados.CreateOptions) (arvados.Specimen, error) {
133         as.appendCall(ctx, as.SpecimenCreate, options)
134         return arvados.Specimen{}, as.Error
135 }
136 func (as *APIStub) SpecimenUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.Specimen, error) {
137         as.appendCall(ctx, as.SpecimenUpdate, options)
138         return arvados.Specimen{}, as.Error
139 }
140 func (as *APIStub) SpecimenGet(ctx context.Context, options arvados.GetOptions) (arvados.Specimen, error) {
141         as.appendCall(ctx, as.SpecimenGet, options)
142         return arvados.Specimen{}, as.Error
143 }
144 func (as *APIStub) SpecimenList(ctx context.Context, options arvados.ListOptions) (arvados.SpecimenList, error) {
145         as.appendCall(ctx, as.SpecimenList, options)
146         return arvados.SpecimenList{}, as.Error
147 }
148 func (as *APIStub) SpecimenDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.Specimen, error) {
149         as.appendCall(ctx, as.SpecimenDelete, options)
150         return arvados.Specimen{}, as.Error
151 }
152 func (as *APIStub) UserCreate(ctx context.Context, options arvados.CreateOptions) (arvados.User, error) {
153         as.appendCall(ctx, as.UserCreate, options)
154         return arvados.User{}, as.Error
155 }
156 func (as *APIStub) UserUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.User, error) {
157         as.appendCall(ctx, as.UserUpdate, options)
158         return arvados.User{}, as.Error
159 }
160 func (as *APIStub) UserUpdateUUID(ctx context.Context, options arvados.UpdateUUIDOptions) (arvados.User, error) {
161         as.appendCall(ctx, as.UserUpdateUUID, options)
162         return arvados.User{}, as.Error
163 }
164 func (as *APIStub) UserActivate(ctx context.Context, options arvados.UserActivateOptions) (arvados.User, error) {
165         as.appendCall(ctx, as.UserActivate, options)
166         return arvados.User{}, as.Error
167 }
168 func (as *APIStub) UserSetup(ctx context.Context, options arvados.UserSetupOptions) (map[string]interface{}, error) {
169         as.appendCall(ctx, as.UserSetup, options)
170         return nil, as.Error
171 }
172 func (as *APIStub) UserUnsetup(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
173         as.appendCall(ctx, as.UserUnsetup, options)
174         return arvados.User{}, as.Error
175 }
176 func (as *APIStub) UserGet(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
177         as.appendCall(ctx, as.UserGet, options)
178         return arvados.User{}, as.Error
179 }
180 func (as *APIStub) UserGetCurrent(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
181         as.appendCall(ctx, as.UserGetCurrent, options)
182         return arvados.User{}, as.Error
183 }
184 func (as *APIStub) UserGetSystem(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
185         as.appendCall(ctx, as.UserGetSystem, options)
186         return arvados.User{}, as.Error
187 }
188 func (as *APIStub) UserList(ctx context.Context, options arvados.ListOptions) (arvados.UserList, error) {
189         as.appendCall(ctx, as.UserList, options)
190         return arvados.UserList{}, as.Error
191 }
192 func (as *APIStub) UserDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.User, error) {
193         as.appendCall(ctx, as.UserDelete, options)
194         return arvados.User{}, as.Error
195 }
196 func (as *APIStub) UserMerge(ctx context.Context, options arvados.UserMergeOptions) (arvados.User, error) {
197         as.appendCall(ctx, as.UserMerge, options)
198         return arvados.User{}, as.Error
199 }
200 func (as *APIStub) UserBatchUpdate(ctx context.Context, options arvados.UserBatchUpdateOptions) (arvados.UserList, error) {
201         as.appendCall(ctx, as.UserBatchUpdate, options)
202         return arvados.UserList{}, as.Error
203 }
204 func (as *APIStub) UserAuthenticate(ctx context.Context, options arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
205         as.appendCall(ctx, as.UserAuthenticate, options)
206         return arvados.APIClientAuthorization{}, as.Error
207 }
208 func (as *APIStub) APIClientAuthorizationCurrent(ctx context.Context, options arvados.GetOptions) (arvados.APIClientAuthorization, error) {
209         as.appendCall(ctx, as.APIClientAuthorizationCurrent, options)
210         return arvados.APIClientAuthorization{}, as.Error
211 }
212
213 func (as *APIStub) appendCall(ctx context.Context, method interface{}, options interface{}) {
214         as.mtx.Lock()
215         defer as.mtx.Unlock()
216         as.calls = append(as.calls, APIStubCall{method, ctx, options})
217 }
218
219 func (as *APIStub) Calls(method interface{}) []APIStubCall {
220         as.mtx.Lock()
221         defer as.mtx.Unlock()
222         var calls []APIStubCall
223         for _, call := range as.calls {
224                 if method == nil || (runtime.FuncForPC(reflect.ValueOf(call.Method).Pointer()).Name() ==
225                         runtime.FuncForPC(reflect.ValueOf(method).Pointer()).Name()) {
226                         calls = append(calls, call)
227                 }
228         }
229         return calls
230 }
231
232 type APIStubCall struct {
233         Method  interface{}
234         Context context.Context
235         Options interface{}
236 }