-
Notifications
You must be signed in to change notification settings - Fork 4
/
client.go
432 lines (359 loc) · 10.4 KB
/
client.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
package client
import (
"bytes"
"crypto/tls"
"crypto/x509"
"encoding/json"
"fmt"
"io/ioutil"
"net"
"net/http"
"net/url"
"os"
"os/user"
"path"
"path/filepath"
"strings"
"sync"
"time"
"github.com/google/uuid"
"github.com/Donders-Institute/hpc-qaas/internal/server"
log "github.com/sirupsen/logrus"
)
// WebhookConfigInfo is a data structure containing the information (and/or attributes) of a webhook.
type WebhookConfigInfo struct {
ID string
Description string
CreationTime string
Script string
WebhookURL string
}
// WebhookConfig provides client interfaces for managing webhook registry on the QaaS server, using the RESTful interface.
type WebhookConfig struct {
QaasHost string
QaasPort int
QaasCertFile string
}
// New provisions a new WebhookConfig for QaaS and registry the new webhook at the QaaS server.
func (s *WebhookConfig) New(script string) (*url.URL, error) {
// check existence of the script and its type.
scriptAbs, err := filepath.Abs(script)
if err != nil {
return nil, err
}
fi, err := os.Lstat(scriptAbs)
if err != nil {
return nil, err
}
if !fi.Mode().IsRegular() {
return nil, fmt.Errorf("not a regular file: %s", script)
}
// get current user
cuser, err := user.Current()
if err != nil {
return nil, err
}
id := uuid.New().String()
workdir := path.Join(cuser.HomeDir, ".qaas", id)
if err := os.MkdirAll(workdir, 0700); err != nil {
return nil, err
}
// provision necessary directory
// - write path to the script.sh file
f, err := os.Create(path.Join(workdir, "script.sh"))
if err != nil {
return nil, err
}
defer f.Close()
if _, err := f.WriteString(fmt.Sprintf("%s\n", scriptAbs)); err != nil {
return nil, err
}
// call QaaS to register the webhook
myURL := url.URL{
Scheme: "https",
Host: fmt.Sprintf("%s:%d", s.QaasHost, s.QaasPort),
Path: server.ConfigurationPath,
}
var response server.ConfigurationResponse
cgroup, err := user.LookupGroupId(cuser.Gid)
if err != nil {
return nil, err
}
httpCode, err := s.httpPutJSON(&myURL,
&server.ConfigurationRequest{
Hash: id,
Groupname: cgroup.Name,
Username: cuser.Username,
Description: "",
},
&response)
log.Debugf("response data: %+v", response)
if err != nil {
return nil, fmt.Errorf("error registering webhook on QaaS server: +%v (HTTP CODE: %d)", err, httpCode)
}
webhookURL, err := url.Parse(response.Webhook)
if err != nil {
return nil, err
}
return webhookURL, nil
}
// List retrieves a list of webhooks of the current user.
// The information of webhooks is returned with a channel.
func (s *WebhookConfig) List() (chan WebhookConfigInfo, error) {
// channel for webhook ids found in local QaaS directory.
chanWebhookID := make(chan string)
// channel for webhook information found in the remote QaaS server.
chanWebhookConfigInfo := make(chan WebhookConfigInfo)
wg := new(sync.WaitGroup)
nworkers := 4
wg.Add(nworkers)
for i := 0; i < nworkers; i++ {
go func() {
for id := range chanWebhookID {
info, err := s.GetInfo(id)
if err != nil {
log.Errorln(err)
} else {
chanWebhookConfigInfo <- info
}
}
wg.Done()
}()
}
// go routine feeding webhook ids to chanWebhookID, and wait for all local webhook ids are visited to get webhookInfo
go func() {
// perform ID fetching from user's home directory only when the current user can be determined.
if cuser, err := user.Current(); err == nil {
// add names of the items under $HOME/.gass into the list if:
//
// - the item is a directory
// - the name of the item can be passed by uuid.Parse() function
if items, err := ioutil.ReadDir(path.Join(cuser.HomeDir, ".qaas")); err == nil {
for _, f := range items {
if !f.IsDir() {
continue
}
if _, err := uuid.Parse(f.Name()); err == nil {
chanWebhookID <- f.Name()
}
}
}
}
close(chanWebhookID)
wg.Wait()
close(chanWebhookConfigInfo)
}()
return chanWebhookConfigInfo, nil
}
// GetInfo retrieves information of a single Webhook configuration referred by the hash id.
func (s *WebhookConfig) GetInfo(id string) (WebhookConfigInfo, error) {
info := WebhookConfigInfo{ID: id}
// get current user
cuser, err := user.Current()
if err != nil {
return info, err
}
// get current user's primary group
cgroup, err := user.LookupGroupId(cuser.Gid)
if err != nil {
return info, err
}
myURL := url.URL{
Scheme: "https",
Host: fmt.Sprintf("%s:%d", s.QaasHost, s.QaasPort),
Path: path.Join(server.ConfigurationPath, id),
}
var response server.ConfigurationInfoResponse
httpCode, err := s.httpGetJSON(&myURL,
&server.ConfigurationRequest{
Hash: id,
Groupname: cgroup.Name,
Username: cuser.Username,
Description: "",
},
&response)
log.Debugf("response data: %+v", response)
if err != nil {
return info, fmt.Errorf("error retrieving webhook info from the QaaS server: %+v (HTTP CODE: %d)", err, httpCode)
}
if id != response.Webhook.Hash {
return info, fmt.Errorf("expect webhook id: %s, server returns id: %s", id, response.Webhook.Hash)
}
info.Description = response.Webhook.Description
info.CreationTime = response.Webhook.Created
info.WebhookURL = response.Webhook.URL
// read local script from the webhook's working directory
if script, err := ioutil.ReadFile(path.Join(cuser.HomeDir, ".qaas", id, "script.sh")); err != nil {
log.Errorf("cannot locate script of webhook: %s\n", id)
} else {
// remove tailing "\n"
info.Script = strings.TrimSuffix(string(script), "\n")
}
return info, nil
}
// Delete removes a webhook with the given id.
//
// The deletion maily removes webhook registry from QaaS server.
// If removeDir is true, the local webhook working directory is removed when the webhook is unregistered from the QaaS server.
func (s *WebhookConfig) Delete(id string, removeDir bool) error {
// check if there is a webhook directory in user's .qaas directory.
cuser, err := user.Current()
if err != nil {
return err
}
workdir := path.Join(cuser.HomeDir, ".qaas", id)
w, err := os.Lstat(workdir)
if err != nil {
return err
}
if !w.IsDir() {
return fmt.Errorf("not a directory: %s", workdir)
}
// // check if we can get the given webhook from the server.
// // call QaaS to register the webhook
// myURL := url.URL{
// Scheme: "https",
// Host: fmt.Sprintf("%s:%d", s.QaasHost, s.QaasPort),
// Path: path.Join(server.ConfigurationPath, id),
// }
// var response server.ConfigurationResponse
// httpCode, err := s.httpGetJSON(&myURL, nil, &response)
// if err != nil {
// return err
// }
// if httpCode != 200 {
// return fmt.Errorf("fail to find webhook %s: %+v (HTTP CODE: %d)", id, err, httpCode)
// }
// make DELETE call to the server and receive response.
myURL := url.URL{
Scheme: "https",
Host: fmt.Sprintf("%s:%d", s.QaasHost, s.QaasPort),
Path: path.Join(server.ConfigurationPath, id),
}
cgroup, err := user.LookupGroupId(cuser.Gid)
if err != nil {
return err
}
httpCode, err := s.httpDelete(&myURL,
&server.ConfigurationRequest{
Hash: id,
Groupname: cgroup.Name,
Username: cuser.Username,
Description: "",
},
)
if err != nil {
return fmt.Errorf("fail to delete webhook %s: %+v (HTTP CODE: %d)", id, err, httpCode)
}
// remove webhook folder conditionally
if removeDir {
return os.RemoveAll(workdir)
}
return nil
}
// httpPutJSON makes a HTTP PUT request with provided JSON data.
func (s *WebhookConfig) httpPutJSON(url *url.URL, request interface{}, response interface{}) (int, error) {
data, err := json.Marshal(request)
if err != nil {
return 0, err
}
log.Debugf("request data: %s", string(data))
c := s.newHTTPSClient()
req, err := http.NewRequest("PUT", url.String(), bytes.NewReader(data))
if err != nil {
return 0, err
}
req.Header.Set("accept", "application/json")
req.Header.Set("content-type", "application/json")
// make HTTP PUT call
rsp, err := c.Do(req)
if err != nil {
return 0, err
}
defer rsp.Body.Close()
if rsp.StatusCode != 200 {
return rsp.StatusCode, fmt.Errorf("%s", rsp.Status)
}
return rsp.StatusCode, json.NewDecoder(rsp.Body).Decode(response)
}
// httpGetJSON makes a HTTP GET request to the given url and returns unmarshals JSON response.
func (s *WebhookConfig) httpGetJSON(url *url.URL, request interface{}, response interface{}) (int, error) {
c := s.newHTTPSClient()
var req *http.Request
if request != nil {
// with JSON request body in the GET call
data, err := json.Marshal(request)
if err != nil {
return 0, err
}
log.Debugf("request data: %s", string(data))
req, err = http.NewRequest("GET", url.String(), bytes.NewReader(data))
if err != nil {
return 0, err
}
req.Header.Set("content-type", "application/json")
} else {
// without request body in the GET call
var err error
req, err = http.NewRequest("GET", url.String(), nil)
if err != nil {
return 0, err
}
}
req.Header.Set("content-type", "application/json")
// make HTTP GET call
rsp, err := c.Do(req)
if err != nil {
return 0, err
}
defer rsp.Body.Close()
if rsp.StatusCode != 200 {
return rsp.StatusCode, fmt.Errorf("%s", rsp.Status)
}
return rsp.StatusCode, json.NewDecoder(rsp.Body).Decode(response)
}
// httpDelete makes a HTTP DELETE request to the given url.
func (s *WebhookConfig) httpDelete(url *url.URL, request interface{}) (int, error) {
data, err := json.Marshal(request)
if err != nil {
return 0, err
}
log.Debugf("request data: %s", string(data))
c := s.newHTTPSClient()
req, err := http.NewRequest("DELETE", url.String(), bytes.NewReader(data))
if err != nil {
return 0, err
}
req.Header.Set("content-type", "application/json")
// make HTTP DELETE call
rsp, err := c.Do(req)
if err != nil {
return 0, err
}
defer rsp.Body.Close()
if rsp.StatusCode != 200 {
return rsp.StatusCode, fmt.Errorf("%s", rsp.Status)
}
return rsp.StatusCode, nil
}
// newHTTPSClient sets up the client instance ready for making HTTPs requests.
func (s *WebhookConfig) newHTTPSClient() *http.Client {
rootCertPool := x509.NewCertPool()
if s.QaasCertFile != "" {
pem, _ := ioutil.ReadFile(s.QaasCertFile)
rootCertPool.AppendCertsFromPEM(pem)
}
transport := &http.Transport{
DialContext: (&net.Dialer{
Timeout: 5 * time.Second,
}).DialContext,
TLSHandshakeTimeout: 5 * time.Second,
TLSClientConfig: &tls.Config{
RootCAs: rootCertPool,
},
}
return &http.Client{
Timeout: 10 * time.Second,
Transport: transport,
}
}