This repository has been archived by the owner on Nov 28, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 28
/
templates.go
414 lines (357 loc) · 11.5 KB
/
templates.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
/*******************************************************************************
* Copyright (c) 2019 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v2.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v20.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package apiroutes
import (
"bytes"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"net/url"
"time"
"github.com/eclipse/codewind-installer/pkg/config"
"github.com/eclipse/codewind-installer/pkg/connections"
"github.com/eclipse/codewind-installer/pkg/sechttp"
"github.com/eclipse/codewind-installer/pkg/utils"
)
type (
// Template represents a project template.
Template struct {
Label string `json:"label"`
Description string `json:"description"`
Language string `json:"language"`
URL string `json:"url"`
ProjectType string `json:"projectType"`
ProjectStyle string `json:"projectStyle,omitempty"`
Source string `json:"source,omitempty"`
SourceID string `json:"sourceId,omitempty"`
}
// RepoCreationOptions is the request body for PFE's POST /templates/repositories API
RepoCreationOptions struct {
URL string `json:"url,omitempty"`
Description string `json:"description,omitempty"`
Name string `json:"name,omitempty"`
GitCredentials *utils.GitCredentials `json:"gitCredentials,omitempty"`
}
// RepoOperation represents a requested operation on a template repository.
RepoOperation struct {
Operation string `json:"op"`
URL string `json:"url"`
Value string `json:"value"`
}
// SubResponseFromBatchOperation represents a sub-response
// to a requested operation on a template repository.
SubResponseFromBatchOperation struct {
Status int `json:"status"`
RequestedOperation RepoOperation `json:"requestedOperation"`
Error string `json:"error"`
}
)
// GetTemplates gets project templates from PFE's REST API.
// Filter them using the function arguments
func GetTemplates(conID, projectStyle string, showEnabledOnly bool) ([]Template, error) {
conInfo, conInfoErr := connections.GetConnectionByID(conID)
if conInfoErr != nil {
return nil, conInfoErr.Err
}
conURL, conErr := config.PFEOriginFromConnection(conInfo)
if conErr != nil {
return nil, conErr.Err
}
req, err := http.NewRequest("GET", conURL+"/api/v1/templates", nil)
if err != nil {
return nil, err
}
query := req.URL.Query()
if projectStyle != "" {
query.Add("projectStyle", projectStyle)
}
if showEnabledOnly {
query.Add("showEnabledOnly", "true")
}
req.URL.RawQuery = query.Encode()
client := &http.Client{}
resp, httpSecError := HTTPRequestWithRetryOnLock(client, req, conInfo)
if httpSecError != nil {
return nil, httpSecError
}
defer resp.Body.Close()
// May return 204, no content, which means no resp.Body to parse.
if resp.StatusCode == 204 {
return []Template{}, nil
}
byteArray, err := ioutil.ReadAll(resp.Body)
if err != nil {
return nil, err
}
var templates []Template
err = json.Unmarshal(byteArray, &templates)
if err != nil {
return nil, err
}
return templates, nil
}
// GetTemplateStyles gets all template styles from PFE's REST API
func GetTemplateStyles(conID string) ([]string, error) {
conInfo, conInfoErr := connections.GetConnectionByID(conID)
if conInfoErr != nil {
return nil, conInfoErr.Err
}
conURL, conErr := config.PFEOriginFromConnection(conInfo)
if conErr != nil {
return nil, conErr.Err
}
req, err := http.NewRequest("GET", conURL+"/api/v1/templates/styles", nil)
if err != nil {
return nil, err
}
client := &http.Client{}
resp, httpSecError := HTTPRequestWithRetryOnLock(client, req, conInfo)
if httpSecError != nil {
return nil, httpSecError
}
defer resp.Body.Close()
byteArray, err := ioutil.ReadAll(resp.Body)
if err != nil {
return nil, err
}
var styles []string
err = json.Unmarshal(byteArray, &styles)
if err != nil {
return nil, err
}
return styles, nil
}
// GetTemplateRepos gets all template repos from PFE's REST API
func GetTemplateRepos(conID string) ([]utils.TemplateRepo, error) {
conInfo, conInfoErr := connections.GetConnectionByID(conID)
if conInfoErr != nil {
return nil, conInfoErr.Err
}
conURL, conErr := config.PFEOriginFromConnection(conInfo)
if conErr != nil {
return nil, conErr.Err
}
req, err := http.NewRequest("GET", conURL+"/api/v1/templates/repositories", nil)
if err != nil {
return nil, err
}
client := &http.Client{}
resp, httpSecError := HTTPRequestWithRetryOnLock(client, req, conInfo)
if httpSecError != nil {
return nil, httpSecError
}
defer resp.Body.Close()
byteArray, err := ioutil.ReadAll(resp.Body)
if err != nil {
return nil, err
}
var repos []utils.TemplateRepo
err = json.Unmarshal(byteArray, &repos)
if err != nil {
return nil, err
}
return repos, nil
}
// AddTemplateRepoToPFE adds a template repo to PFE and
// returns the new list of existing repos
func AddTemplateRepoToPFE(conID, URL, description, name string, gitCredentials *utils.GitCredentials) ([]utils.TemplateRepo, error) {
if _, err := url.ParseRequestURI(URL); err != nil {
return nil, fmt.Errorf("Error: '%s' is not a valid URL", URL)
}
conInfo, conInfoErr := connections.GetConnectionByID(conID)
if conInfoErr != nil {
return nil, conInfoErr.Err
}
conURL, conErr := config.PFEOriginFromConnection(conInfo)
if conErr != nil {
return nil, conErr.Err
}
requestBody := RepoCreationOptions{
URL: URL,
Description: description,
Name: name,
GitCredentials: gitCredentials,
}
buf := new(bytes.Buffer)
json.NewEncoder(buf).Encode(requestBody)
req, err := http.NewRequest("POST", conURL+"/api/v1/templates/repositories", buf)
if err != nil {
return nil, err
}
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, httpSecError := HTTPRequestWithRetryOnLock(client, req, conInfo)
if httpSecError != nil {
return nil, httpSecError
}
defer resp.Body.Close()
byteArray, readErr := ioutil.ReadAll(resp.Body)
if readErr != nil {
return nil, readErr
}
if resp.StatusCode != 200 {
return nil, fmt.Errorf("Error: %s - %s", http.StatusText(resp.StatusCode), string(byteArray))
}
var repos []utils.TemplateRepo
unmarshalErr := json.Unmarshal(byteArray, &repos)
if unmarshalErr != nil {
return nil, unmarshalErr
}
return repos, nil
}
// DeleteTemplateRepoFromPFE deletes a template repo from PFE and
// returns the new list of existing repos
func DeleteTemplateRepoFromPFE(conID, URL string) ([]utils.TemplateRepo, error) {
if _, err := url.ParseRequestURI(URL); err != nil {
return nil, fmt.Errorf("Error: '%s' is not a valid URL", URL)
}
values := map[string]string{"url": URL}
jsonValue, _ := json.Marshal(values)
conInfo, conInfoErr := connections.GetConnectionByID(conID)
if conInfoErr != nil {
return nil, conInfoErr.Err
}
conURL, conErr := config.PFEOriginFromConnection(conInfo)
if conErr != nil {
return nil, conErr.Err
}
req, err := http.NewRequest("DELETE", conURL+"/api/v1/templates/repositories", bytes.NewBuffer(jsonValue))
if err != nil {
return nil, err
}
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, httpSecError := HTTPRequestWithRetryOnLock(client, req, conInfo)
if httpSecError != nil {
return nil, httpSecError
}
if resp.StatusCode != 200 {
return nil, fmt.Errorf("Error: PFE responded with status code %d", resp.StatusCode)
}
defer resp.Body.Close()
byteArray, err := ioutil.ReadAll(resp.Body)
if err != nil {
return nil, err
}
var repos []utils.TemplateRepo
err = json.Unmarshal(byteArray, &repos)
if err != nil {
return nil, err
}
return repos, nil
}
// EnableTemplateRepos enables a template repo in PFE and
// returns the new list of template repos
func EnableTemplateRepos(conID string, repoURLs []string) ([]utils.TemplateRepo, error) {
if repoURLs == nil {
return nil, fmt.Errorf("Error: '%s' is not a valid URL", repoURLs)
}
var operations []RepoOperation
for _, URL := range repoURLs {
if _, err := url.ParseRequestURI(URL); err != nil {
return nil, fmt.Errorf("Error: '%s' is not a valid URL", URL)
}
operation := RepoOperation{
Operation: "enable",
URL: URL,
Value: "true",
}
operations = append(operations, operation)
}
_, err := BatchPatchTemplateRepos(conID, operations)
if err != nil {
return nil, err
}
repos, err := GetTemplateRepos(conID)
if err != nil {
return nil, err
}
return repos, nil
}
// DisableTemplateRepos enables a template repo in PFE and
// returns the new list of template repos
func DisableTemplateRepos(conID string, repoURLs []string) ([]utils.TemplateRepo, error) {
if repoURLs == nil {
return nil, fmt.Errorf("Error: '%s' is not a valid URL", repoURLs)
}
var operations []RepoOperation
for _, URL := range repoURLs {
if _, err := url.ParseRequestURI(URL); err != nil {
return nil, fmt.Errorf("Error: '%s' is not a valid URL", URL)
}
operation := RepoOperation{
Operation: "enable",
URL: URL,
Value: "false",
}
operations = append(operations, operation)
}
_, err := BatchPatchTemplateRepos(conID, operations)
if err != nil {
return nil, err
}
repos, err := GetTemplateRepos(conID)
if err != nil {
return nil, err
}
return repos, nil
}
// BatchPatchTemplateRepos requests that PFE perform batch operations on template repositories and
// returns a list of sub-responses to the requested operations
func BatchPatchTemplateRepos(conID string, operations []RepoOperation) ([]SubResponseFromBatchOperation, error) {
jsonValue, _ := json.Marshal(operations)
conInfo, conInfoErr := connections.GetConnectionByID(conID)
if conInfoErr != nil {
return nil, conInfoErr.Err
}
conURL, conErr := config.PFEOriginFromConnection(conInfo)
if conErr != nil {
return nil, conErr.Err
}
req, err := http.NewRequest("PATCH", conURL+"/api/v1/batch/templates/repositories", bytes.NewBuffer(jsonValue))
if err != nil {
return nil, err
}
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, httpSecError := HTTPRequestWithRetryOnLock(client, req, conInfo)
if httpSecError != nil {
return nil, httpSecError
}
if resp.StatusCode != 207 {
return nil, fmt.Errorf("Error: PFE responded with status code %d", resp.StatusCode)
}
defer resp.Body.Close()
byteArray, err := ioutil.ReadAll(resp.Body)
if err != nil {
return nil, err
}
var subResponsesFromBatchOperation []SubResponseFromBatchOperation
err = json.Unmarshal(byteArray, &subResponsesFromBatchOperation)
if err != nil {
return nil, err
}
return subResponsesFromBatchOperation, nil
}
// HTTPRequestWithRetryOnLock : Retries a request until either the maxHTTPRetries limit has been hit or the response status code is not equal to 423 (templates locked HTTP code)
func HTTPRequestWithRetryOnLock(httpClient utils.HTTPClient, originalRequest *http.Request, connection *connections.Connection) (*http.Response, *sechttp.HTTPSecError) {
// maxHTTPRetries is the total number of retries
maxHTTPRetries := 4
for i := 0; i < maxHTTPRetries; i++ {
resp, httpSecError := sechttp.DispatchHTTPRequest(httpClient, originalRequest, connection)
if httpSecError != nil || resp.StatusCode != http.StatusLocked {
return resp, httpSecError
}
time.Sleep(time.Second)
}
return sechttp.DispatchHTTPRequest(httpClient, originalRequest, connection)
}