-
Notifications
You must be signed in to change notification settings - Fork 13
/
service.go
457 lines (397 loc) · 14.3 KB
/
service.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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
package apic
import (
"encoding/base64"
"encoding/binary"
"encoding/json"
"fmt"
"net/http"
"strconv"
defs "github.com/Axway/agent-sdk/pkg/apic/definitions"
"github.com/Axway/agent-sdk/pkg/util"
"github.com/Axway/agent-sdk/pkg/util/log"
coreapi "github.com/Axway/agent-sdk/pkg/api"
v1 "github.com/Axway/agent-sdk/pkg/apic/apiserver/models/api/v1"
management "github.com/Axway/agent-sdk/pkg/apic/apiserver/models/management/v1alpha1"
unifiedcatalog "github.com/Axway/agent-sdk/pkg/apic/unifiedcatalog/models"
utilerrors "github.com/Axway/agent-sdk/pkg/util/errors"
)
type actionType int
const (
addAPI = iota
updateAPI = iota
)
const (
apiServerPageSize = 20
tenMB = 10485760
)
// PublishService - processes the API to create/update apiservice, revision, instance and consumer instance
func (c *ServiceClient) PublishService(serviceBody *ServiceBody) (*management.APIService, error) {
logger := c.logger.WithField("serviceName", serviceBody.NameToPush).WithField("apiID", serviceBody.RestAPIID)
if serviceBody.PrimaryKey != "" {
logger = logger.WithField("primaryKey", serviceBody.PrimaryKey)
}
// if the team is set in the config, use that team name and id for all services
if c.cfg.GetTeamName() != "" {
if teamID, found := c.getTeamFromCache(c.cfg.GetTeamName()); found {
serviceBody.TeamName = c.cfg.GetTeamName()
serviceBody.teamID = teamID
logger.Debugf("setting team name (%s) and team id (%s)", serviceBody.TeamName, serviceBody.teamID)
}
}
// there is a current envoy restriction with the payload size (10mb). Quick check on the size
if binary.Size(serviceBody.SpecDefinition) >= tenMB {
// if greater than 10mb, return
err := fmt.Errorf("service %s carries a payload greater than 10mb. Service not created.", serviceBody.APIName)
logger.WithError(err).Error("error processing service")
return nil, err
}
// API Service
logger.Trace("processing service")
apiSvc, err := c.processService(serviceBody)
if err != nil {
logger.WithError(err).Error("processing service")
return nil, err
}
// Update description title after creating APIService to include the stage name if it exists
c.postAPIServiceUpdate(serviceBody)
// RevisionProcessor
logger.Trace("processing revision")
err = c.processRevision(serviceBody)
if err != nil {
logger.WithError(err).Error("processing revision")
return nil, err
}
// InstanceProcessor
logger.Trace("processing instance")
err = c.processInstance(serviceBody)
if err != nil {
logger.WithError(err).Error("processing instance")
return nil, err
}
// TODO - consumer instance not needed after deprecation of unified catalog
if !c.cfg.IsMarketplaceSubsEnabled() {
// ConsumerInstanceProcessor
logger.Trace("processing consumer instance")
err = c.processConsumerInstance(serviceBody)
if err != nil {
logger.WithError(err).Error("processing consumer instance")
return nil, err
}
}
logger.Trace("adding spec hashes to service")
serviceBody.specHashes[serviceBody.specHash] = serviceBody.serviceContext.revisionName
details := util.GetAgentDetails(apiSvc)
details[specHashes] = serviceBody.specHashes
util.SetAgentDetails(apiSvc, details)
if err := c.CreateSubResource(apiSvc.ResourceMeta, map[string]interface{}{defs.XAgentDetails: details}); err != nil {
logger.Error("error adding spec hashes in x-agent-details, retrying")
// if the update failed try once more
if err := c.CreateSubResource(apiSvc.ResourceMeta, map[string]interface{}{defs.XAgentDetails: details}); err != nil {
logger.WithError(err).Error("could not add spec hashes in x-agent-details")
}
}
ri, _ := apiSvc.AsInstance()
c.caches.AddAPIService(ri)
if err != nil {
logger.WithError(err).Error("adding service to cache")
}
return apiSvc, nil
}
// DeleteServiceByName -
func (c *ServiceClient) DeleteServiceByName(name string) error {
_, err := c.apiServiceDeployAPI(http.MethodDelete, c.cfg.GetServicesURL()+"/"+name, nil)
if err != nil {
return err
}
return nil
}
// RegisterSubscriptionWebhook - Adds a new Subscription webhook. There is a single webhook
// per environment
func (c *ServiceClient) RegisterSubscriptionWebhook() error {
// if the default is already set up, do nothing
webhookCfg := c.cfg.GetSubscriptionConfig().GetSubscriptionApprovalWebhookConfig()
if webhookCfg == nil || !webhookCfg.IsConfigured() {
return nil
}
// create the secret
err := c.createSecret()
if err != nil {
return utilerrors.Wrap(ErrCreateSecret, err.Error())
}
err = c.createWebhook()
if err != nil {
return utilerrors.Wrap(ErrCreateWebhook, err.Error())
}
return nil
}
// GetCatalogItemIDForConsumerInstance -
func (c *ServiceClient) GetCatalogItemIDForConsumerInstance(id string) (string, error) {
return c.getCatalogItemIDForConsumerInstance(id)
}
// DeleteConsumerInstance -
func (c *ServiceClient) DeleteConsumerInstance(name string) error {
return c.deleteConsumerInstance(name)
}
// DeleteAPIServiceInstance deletes an api service instance in central by name
func (c *ServiceClient) DeleteAPIServiceInstance(name string) error {
_, err := c.apiServiceDeployAPI(http.MethodDelete, c.cfg.GetInstancesURL()+"/"+name, nil)
if err != nil && err.Error() != strconv.Itoa(http.StatusNotFound) {
return err
}
return nil
}
// GetConsumerInstanceByID -
func (c *ServiceClient) GetConsumerInstanceByID(consumerInstanceID string) (*management.ConsumerInstance, error) {
return c.getConsumerInstanceByID(consumerInstanceID)
}
// GetConsumerInstancesByExternalAPIID - DEPRECATED
func (c *ServiceClient) GetConsumerInstancesByExternalAPIID(externalAPIID string) ([]*management.ConsumerInstance, error) {
log.DeprecationWarningReplace("GetConsumerInstancesByExternalAPIID", "")
return c.getConsumerInstancesByExternalAPIID(externalAPIID)
}
// GetSubscriptionsForCatalogItem -
func (c *ServiceClient) GetSubscriptionsForCatalogItem(states []string, instanceID string) ([]CentralSubscription, error) {
return c.getSubscriptionsForCatalogItem(states, instanceID)
}
// GetSubscriptionDefinitionPropertiesForCatalogItem -
func (c *ServiceClient) GetSubscriptionDefinitionPropertiesForCatalogItem(catalogItemID, propertyKey string) (SubscriptionSchema, error) {
return c.getSubscriptionDefinitionPropertiesForCatalogItem(catalogItemID, propertyKey)
}
// UpdateSubscriptionDefinitionPropertiesForCatalogItem -
func (c *ServiceClient) UpdateSubscriptionDefinitionPropertiesForCatalogItem(catalogItemID, propertyKey string, subscriptionSchema SubscriptionSchema) error {
return c.updateSubscriptionDefinitionPropertiesForCatalogItem(catalogItemID, propertyKey, subscriptionSchema)
}
// postApiServiceUpdate - called after APIService was created or updated.
// Update description and title after updating or creating APIService to include the stage name if it exists
func (c *ServiceClient) postAPIServiceUpdate(serviceBody *ServiceBody) {
if serviceBody.Stage != "" {
stageDescription := fmt.Sprintf("%s: %s", serviceBody.StageDescriptor, serviceBody.Stage)
if len(serviceBody.Description) > 0 {
stageDescription = fmt.Sprintf(", %s", stageDescription)
if len(serviceBody.Description)+len(stageDescription) >= maxDescriptionLength {
description := serviceBody.Description[0 : maxDescriptionLength-len(strEllipsis)-len(stageDescription)]
serviceBody.Description = fmt.Sprintf("%s%s%s", description, strEllipsis, stageDescription)
} else {
serviceBody.Description = fmt.Sprintf("%s%s", serviceBody.Description, stageDescription)
}
} else {
serviceBody.Description = stageDescription
}
serviceBody.NameToPush = fmt.Sprintf("%v (%s: %v)", serviceBody.NameToPush, serviceBody.StageDescriptor, serviceBody.Stage)
} else if c.cfg.GetAppendEnvironmentToTitle() {
// Append the environment name to the title, if set
serviceBody.NameToPush = fmt.Sprintf("%v (%v)", serviceBody.NameToPush, c.cfg.GetEnvironmentName())
}
}
func buildAgentDetailsSubResource(
serviceBody *ServiceBody, isAPIService bool, additional map[string]interface{},
) map[string]interface{} {
details := make(map[string]interface{})
externalAPIID := serviceBody.RestAPIID
// check to see if is an APIService
if !isAPIService && serviceBody.Stage != "" {
details[defs.AttrExternalAPIStage] = serviceBody.Stage
}
if serviceBody.PrimaryKey != "" {
details[defs.AttrExternalAPIPrimaryKey] = serviceBody.PrimaryKey
}
details[defs.AttrExternalAPIID] = externalAPIID
details[defs.AttrExternalAPIName] = serviceBody.APIName
details[defs.AttrCreatedBy] = serviceBody.CreatedBy
return util.MergeMapStringInterface(details, additional)
}
func isValidAuthPolicy(auth string) bool {
for _, item := range ValidPolicies {
if item == auth {
return true
}
}
return false
}
// Sanitize name to be path friendly and follow this regex: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*
func sanitizeAPIName(name string) string {
return util.ConvertToDomainNameCompliant(name)
}
// apiServiceDeployAPI -
func (c *ServiceClient) apiServiceDeployAPI(method, url string, buffer []byte) (*v1.ResourceInstance, error) {
ri, err := c.executeAPIServiceAPI(method, url, buffer)
return ri, err
}
// executeAPIServiceAPI -
func (c *ServiceClient) executeAPIServiceAPI(method, url string, buffer []byte) (*v1.ResourceInstance, error) {
headers, err := c.createHeader()
if err != nil {
return nil, err
}
request := coreapi.Request{
Method: method,
URL: url,
QueryParams: nil,
Headers: headers,
Body: buffer,
}
response, err := c.apiClient.Send(request)
if err != nil {
return nil, err
}
// Check to see if rollback was processed
if method == http.MethodDelete && response.Code == http.StatusNoContent {
return nil, nil
}
if response.Code >= http.StatusBadRequest {
responseErr := readResponseErrors(response.Code, response.Body)
return nil, utilerrors.Wrap(ErrRequestQuery, responseErr)
}
ri := &v1.ResourceInstance{}
json.Unmarshal(response.Body, ri)
return ri, nil
}
// create the on-and-only secret for the environment
func (c *ServiceClient) createSecret() error {
s := c.DefaultSubscriptionApprovalWebhook.GetSecret()
spec := management.SecretSpec{
Data: map[string]string{DefaultSubscriptionWebhookAuthKey: base64.StdEncoding.EncodeToString([]byte(s))},
}
secret := management.Secret{
ResourceMeta: v1.ResourceMeta{Name: DefaultSubscriptionWebhookName},
Spec: spec,
}
buffer, err := json.Marshal(secret)
if err != nil {
return err
}
headers, err := c.createHeader()
if err != nil {
return err
}
request := coreapi.Request{
Method: coreapi.POST,
URL: c.cfg.GetAPIServerSecretsURL(),
Headers: headers,
Body: buffer,
}
response, err := c.apiClient.Send(request)
if err != nil {
return err
}
if !(response.Code == http.StatusCreated || response.Code == http.StatusConflict) {
responseErr := readResponseErrors(response.Code, response.Body)
return utilerrors.Wrap(ErrRequestQuery, responseErr)
}
if response.Code == http.StatusConflict {
request = coreapi.Request{
Method: coreapi.PUT,
URL: c.cfg.GetAPIServerSecretsURL() + "/" + DefaultSubscriptionWebhookName,
Headers: headers,
Body: buffer,
}
response, err := c.apiClient.Send(request)
if err != nil {
return err
}
if response.Code != http.StatusOK {
responseErr := readResponseErrors(response.Code, response.Body)
return utilerrors.Wrap(ErrRequestQuery, responseErr)
}
}
return nil
}
// create the on-and-only subscription approval webhook for the environment
func (c *ServiceClient) createWebhook() error {
webhookCfg := c.cfg.GetSubscriptionConfig().GetSubscriptionApprovalWebhookConfig()
specSecret := management.WebhookSpecAuthSecret{
Name: DefaultSubscriptionWebhookName,
Key: DefaultSubscriptionWebhookAuthKey,
}
authSpec := management.WebhookSpecAuth{
Secret: specSecret,
}
webSpec := management.WebhookSpec{
Auth: authSpec,
Enabled: true,
Url: webhookCfg.GetURL(),
Headers: webhookCfg.GetWebhookHeaders(),
}
webhook := management.Webhook{
ResourceMeta: v1.ResourceMeta{Name: DefaultSubscriptionWebhookName},
Spec: webSpec,
}
buffer, err := json.Marshal(webhook)
if err != nil {
return err
}
headers, err := c.createHeader()
if err != nil {
return err
}
request := coreapi.Request{
Method: coreapi.POST,
URL: c.cfg.GetAPIServerWebhooksURL(),
Headers: headers,
Body: buffer,
}
response, err := c.apiClient.Send(request)
if err != nil {
return err
}
if !(response.Code == http.StatusCreated || response.Code == http.StatusConflict) {
responseErr := readResponseErrors(response.Code, response.Body)
return utilerrors.Wrap(ErrRequestQuery, responseErr)
}
if response.Code == http.StatusConflict {
request = coreapi.Request{
Method: coreapi.PUT,
URL: c.cfg.GetAPIServerWebhooksURL() + "/" + DefaultSubscriptionWebhookName,
Headers: headers,
Body: buffer,
}
response, err := c.apiClient.Send(request)
if err != nil {
return err
}
if response.Code != http.StatusOK {
responseErr := readResponseErrors(response.Code, response.Body)
return utilerrors.Wrap(ErrRequestQuery, responseErr)
}
}
return nil
}
// getCatalogItemAPIServerInfoProperty -
func (c *ServiceClient) getCatalogItemAPIServerInfoProperty(catalogID, subscriptionID string) (*APIServerInfo, error) {
headers, err := c.createHeader()
if err != nil {
return nil, err
}
subscriptionRelationshipsURL := c.cfg.GetCatalogItemSubscriptionRelationshipURL(catalogID, subscriptionID)
request := coreapi.Request{
Method: coreapi.GET,
URL: subscriptionRelationshipsURL,
Headers: headers,
}
response, err := c.apiClient.Send(request)
if err != nil {
return nil, err
}
if response.Code != http.StatusOK {
responseErr := readResponseErrors(response.Code, response.Body)
return nil, utilerrors.Wrap(ErrRequestQuery, responseErr)
}
relationships := make([]unifiedcatalog.EntityRelationship, 0)
json.Unmarshal(response.Body, &relationships)
apiserverInfo := new(APIServerInfo)
for _, relationship := range relationships {
if relationship.Key == "apiServerInfo" {
switch relationship.Type {
case "API_SERVER_CONSUMER_INSTANCE_ID":
apiserverInfo.ConsumerInstance.ID = relationship.Value
case "API_SERVER_CONSUMER_INSTANCE_NAME":
apiserverInfo.ConsumerInstance.Name = relationship.Value
case "API_SERVER_ENVIRONMENT_ID":
apiserverInfo.Environment.ID = relationship.Value
case "API_SERVER_ENVIRONMENT_NAME":
apiserverInfo.Environment.Name = relationship.Value
}
}
}
return apiserverInfo, nil
}