/
client.go
330 lines (295 loc) · 10.6 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
// Copyright 2015 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.
package applicationoffers
import (
"github.com/juju/charm/v8"
"github.com/juju/errors"
"github.com/juju/loggo"
"github.com/juju/names/v4"
"gopkg.in/macaroon-bakery.v2/bakery"
"github.com/juju/juju/api/base"
"github.com/juju/juju/apiserver/params"
"github.com/juju/juju/core/crossmodel"
"github.com/juju/juju/core/permission"
"github.com/juju/juju/core/relation"
)
var logger = loggo.GetLogger("juju.api.applicationoffers")
// Client allows access to the cross model management API end points.
type Client struct {
base.ClientFacade
facade base.FacadeCaller
}
// NewClient creates a new client for accessing the application offers API.
func NewClient(st base.APICallCloser) *Client {
frontend, backend := base.NewClientFacade(st, "ApplicationOffers")
return &Client{ClientFacade: frontend, facade: backend}
}
// Offer prepares application's endpoints for consumption.
func (c *Client) Offer(modelUUID, application string, endpoints []string, offerName string, desc string) ([]params.ErrorResult, error) {
// TODO(wallyworld) - support endpoint aliases
ep := make(map[string]string)
for _, name := range endpoints {
ep[name] = name
}
offers := []params.AddApplicationOffer{
{
ModelTag: names.NewModelTag(modelUUID).String(),
ApplicationName: application,
ApplicationDescription: desc,
Endpoints: ep,
OfferName: offerName,
},
}
out := params.ErrorResults{}
if err := c.facade.FacadeCall("Offer", params.AddApplicationOffers{Offers: offers}, &out); err != nil {
return nil, errors.Trace(err)
}
return out.Results, nil
}
// ListOffers gets all remote applications that have been offered from this Juju model.
// Each returned application satisfies at least one of the the specified filters.
func (c *Client) ListOffers(filters ...crossmodel.ApplicationOfferFilter) ([]*crossmodel.ApplicationOfferDetails, error) {
var paramsFilter params.OfferFilters
for _, f := range filters {
filterTerm := params.OfferFilter{
OwnerName: f.OwnerName,
ModelName: f.ModelName,
OfferName: f.OfferName,
ApplicationName: f.ApplicationName,
Endpoints: make([]params.EndpointFilterAttributes, len(f.Endpoints)),
AllowedConsumerTags: make([]string, len(f.AllowedConsumers)),
ConnectedUserTags: make([]string, len(f.ConnectedUsers)),
}
for i, ep := range f.Endpoints {
filterTerm.Endpoints[i].Name = ep.Name
filterTerm.Endpoints[i].Interface = ep.Interface
filterTerm.Endpoints[i].Role = ep.Role
}
for i, u := range f.AllowedConsumers {
filterTerm.AllowedConsumerTags[i] = names.NewUserTag(u).String()
}
for i, u := range f.ConnectedUsers {
filterTerm.ConnectedUserTags[i] = names.NewUserTag(u).String()
}
paramsFilter.Filters = append(paramsFilter.Filters, filterTerm)
}
offers := params.QueryApplicationOffersResults{}
err := c.facade.FacadeCall("ListApplicationOffers", paramsFilter, &offers)
if err != nil {
return nil, errors.Trace(err)
}
return convertOffersResultsToModel(offers.Results)
}
func convertOffersResultsToModel(items []params.ApplicationOfferAdminDetails) ([]*crossmodel.ApplicationOfferDetails, error) {
result := make([]*crossmodel.ApplicationOfferDetails, len(items))
var err error
for i, one := range items {
if result[i], err = offerParamsToDetails(one); err != nil {
return nil, errors.Trace(err)
}
}
return result, nil
}
func offerParamsToDetails(offer params.ApplicationOfferAdminDetails) (*crossmodel.ApplicationOfferDetails, error) {
eps := make([]charm.Relation, len(offer.Endpoints))
for i, ep := range offer.Endpoints {
eps[i] = charm.Relation{
Name: ep.Name,
Role: ep.Role,
Interface: ep.Interface,
}
}
result := &crossmodel.ApplicationOfferDetails{
ApplicationName: offer.ApplicationName,
ApplicationDescription: offer.ApplicationDescription,
OfferName: offer.OfferName,
CharmURL: offer.CharmURL,
OfferURL: offer.OfferURL,
Endpoints: eps,
}
for _, oc := range offer.Connections {
modelTag, err := names.ParseModelTag(oc.SourceModelTag)
if err != nil {
return nil, errors.Trace(err)
}
result.Connections = append(result.Connections, crossmodel.OfferConnection{
SourceModelUUID: modelTag.Id(),
Username: oc.Username,
Endpoint: oc.Endpoint,
RelationId: oc.RelationId,
Status: relation.Status(oc.Status.Status),
Message: oc.Status.Info,
Since: oc.Status.Since,
IngressSubnets: oc.IngressSubnets,
})
}
for _, u := range offer.Users {
result.Users = append(result.Users, crossmodel.OfferUserDetails{
UserName: u.UserName,
DisplayName: u.DisplayName,
Access: permission.Access(u.Access),
})
}
return result, nil
}
// GrantOffer grants a user access to the specified offers.
func (c *Client) GrantOffer(user, access string, offerURLs ...string) error {
return c.modifyOfferUser(params.GrantOfferAccess, user, access, offerURLs)
}
// RevokeOffer revokes a user's access to the specified offers.
func (c *Client) RevokeOffer(user, access string, offerURLs ...string) error {
return c.modifyOfferUser(params.RevokeOfferAccess, user, access, offerURLs)
}
func (c *Client) modifyOfferUser(action params.OfferAction, user, access string, offerURLs []string) error {
var args params.ModifyOfferAccessRequest
if !names.IsValidUser(user) {
return errors.Errorf("invalid username: %q", user)
}
userTag := names.NewUserTag(user)
offerAccess := permission.Access(access)
if err := permission.ValidateOfferAccess(offerAccess); err != nil {
return errors.Trace(err)
}
for _, offerURL := range offerURLs {
args.Changes = append(args.Changes, params.ModifyOfferAccess{
UserTag: userTag.String(),
Action: action,
Access: params.OfferAccessPermission(offerAccess),
OfferURL: offerURL,
})
}
var result params.ErrorResults
err := c.facade.FacadeCall("ModifyOfferAccess", args, &result)
if err != nil {
return errors.Trace(err)
}
if len(result.Results) != len(args.Changes) {
return errors.Errorf("expected %d results, got %d", len(args.Changes), len(result.Results))
}
for i, r := range result.Results {
if r.Error != nil && r.Error.Code == params.CodeAlreadyExists {
logger.Warningf("offer %q is already shared with %q", offerURLs[i], userTag.Id())
result.Results[i].Error = nil
}
}
return result.Combine()
}
// ApplicationOffer returns offered remote application details for a given URL.
func (c *Client) ApplicationOffer(urlStr string) (*crossmodel.ApplicationOfferDetails, error) {
url, err := crossmodel.ParseOfferURL(urlStr)
if err != nil {
return nil, errors.Trace(err)
}
if url.Source != "" {
return nil, errors.NotSupportedf("query for non-local application offers")
}
found := params.ApplicationOffersResults{}
err = c.facade.FacadeCall("ApplicationOffers", params.OfferURLs{[]string{urlStr}, bakery.LatestVersion}, &found)
if err != nil {
return nil, errors.Trace(err)
}
result := found.Results
if len(result) != 1 {
return nil, errors.Errorf("expected to find one result for url %q but found %d", url, len(result))
}
theOne := result[0]
if theOne.Error != nil {
return nil, errors.Trace(theOne.Error)
}
return offerParamsToDetails(*theOne.Result)
}
// FindApplicationOffers returns all application offers matching the supplied filter.
func (c *Client) FindApplicationOffers(filters ...crossmodel.ApplicationOfferFilter) ([]*crossmodel.ApplicationOfferDetails, error) {
// We need at least one filter. The default filter will list all local applications.
if len(filters) == 0 {
return nil, errors.New("at least one filter must be specified")
}
var paramsFilter params.OfferFilters
for _, f := range filters {
filterTerm := params.OfferFilter{
OfferName: f.OfferName,
ModelName: f.ModelName,
OwnerName: f.OwnerName,
}
filterTerm.Endpoints = make([]params.EndpointFilterAttributes, len(f.Endpoints))
for i, ep := range f.Endpoints {
filterTerm.Endpoints[i].Name = ep.Name
filterTerm.Endpoints[i].Interface = ep.Interface
filterTerm.Endpoints[i].Role = ep.Role
}
paramsFilter.Filters = append(paramsFilter.Filters, filterTerm)
}
offers := params.QueryApplicationOffersResults{}
err := c.facade.FacadeCall("FindApplicationOffers", paramsFilter, &offers)
if err != nil {
return nil, errors.Trace(err)
}
return convertOffersResultsToModel(offers.Results)
}
// GetConsumeDetails returns details necessary to consue an offer at a given URL.
func (c *Client) GetConsumeDetails(urlStr string) (params.ConsumeOfferDetails, error) {
url, err := crossmodel.ParseOfferURL(urlStr)
if err != nil {
return params.ConsumeOfferDetails{}, errors.Trace(err)
}
if url.Source != "" {
return params.ConsumeOfferDetails{}, errors.NotSupportedf("query for application offers on another controller")
}
found := params.ConsumeOfferDetailsResults{}
offerURLs := params.OfferURLs{[]string{urlStr}, bakery.LatestVersion}
var args interface{}
if c.facade.BestAPIVersion() < 3 {
args = offerURLs
} else {
args = params.ConsumeOfferDetailsArg{
OfferURLs: offerURLs,
}
}
err = c.facade.FacadeCall("GetConsumeDetails", args, &found)
if err != nil {
return params.ConsumeOfferDetails{}, errors.Trace(err)
}
result := found.Results
if len(result) != 1 {
return params.ConsumeOfferDetails{}, errors.Errorf("expected to find one result for url %q but found %d", url, len(result))
}
theOne := result[0]
if theOne.Error != nil {
return params.ConsumeOfferDetails{}, errors.Trace(theOne.Error)
}
return params.ConsumeOfferDetails{
Offer: theOne.Offer,
Macaroon: theOne.Macaroon,
ControllerInfo: theOne.ControllerInfo,
}, nil
}
// DestroyOffers removes the specified application offers.
func (c *Client) DestroyOffers(force bool, offerURLs ...string) error {
if len(offerURLs) == 0 {
return nil
}
if force {
if bestVer := c.BestAPIVersion(); bestVer < 2 {
return errors.NotImplementedf("DestroyOffers() with force (need v2+, have v%d)", bestVer)
}
}
args := params.DestroyApplicationOffers{
Force: force,
OfferURLs: make([]string, len(offerURLs)),
}
for i, url := range offerURLs {
if _, err := crossmodel.ParseOfferURL(url); err != nil {
return errors.Trace(err)
}
args.OfferURLs[i] = url
}
var result params.ErrorResults
err := c.facade.FacadeCall("DestroyOffers", args, &result)
if err != nil {
return errors.Trace(err)
}
if len(result.Results) != len(args.OfferURLs) {
return errors.Errorf("expected %d results, got %d", len(args.OfferURLs), len(result.Results))
}
return result.Combine()
}