Merge lp:~bac/juju-core/get-endpoints into lp:~juju/juju-core/trunk

[Brad Crittenden]

Add GetEndpoints to the API.

https://codereview.appspot.com/7668045/

[Brad Crittenden (bac)]

Reviewers: mp+154843_code.launchpad.net,

Message:
Please take a look.

Description:
Add GetEndpoints to the API.

https://code.launchpad.net/~bac/juju-core/get-endpoints/+merge/154843

(do not edit description out of merge proposal)

Please review this at https://codereview.appspot.com/7668045/

Affected files:
   A [revision details]
   M state/api/apiclient.go
   M state/api/params/params.go
   M state/apiserver/api_test.go
   M state/apiserver/apiserver.go

[Dimiter Naydenov (dimitern)]

LGTM modulo the suggestions below.

https://codereview.appspot.com/7668045/diff/2001/state/api/params/params.go
File state/api/params/params.go (right):

https://codereview.appspot.com/7668045/diff/2001/state/api/params/params.go#newcode152
state/api/params/params.go:152: // of service names or an empty array to
indicate all services.
should empty and nil here mean the same thing (len=0)?

https://codereview.appspot.com/7668045/diff/2001/state/apiserver/api_test.go
File state/apiserver/api_test.go (right):

https://codereview.appspot.com/7668045/diff/2001/state/apiserver/api_test.go#newcode1447
state/apiserver/api_test.go:1447: // normalize will replace the list
with a map keyed by name for
which list? (i know, but it'll help to be a bit more descriptive in the
comment).

https://codereview.appspot.com/7668045/diff/2001/state/apiserver/apiserver.go
File state/apiserver/apiserver.go (right):

https://codereview.appspot.com/7668045/diff/2001/state/apiserver/apiserver.go#newcode471
state/apiserver/apiserver.go:471: if meta == nil {
you don't need this if at all, since if len(meta) == 0, the range loop
won't run anyway.

https://codereview.appspot.com/7668045/diff/2001/state/apiserver/apiserver.go#newcode481
state/apiserver/apiserver.go:481: // rel["limit"] =
strconv.Itoa(value.Limit)
then remove this line

https://codereview.appspot.com/7668045/

Unmerged revisions

1030. By Brad Crittenden on 2013-03-22

Remove 'limit' from GetEndpoints data per conversation with William.

1029. By Brad Crittenden on 2013-03-22

Added another test for GetEndpoints

1028. By Brad Crittenden on 2013-03-22

Add GetEndpoints to the API

1027. By Brad Crittenden on 2013-03-21

before expected rewrite

1026. By Brad Crittenden on 2013-03-20

Merge from trunk

1025. By Brad Crittenden on 2013-03-20

checkpoint

1024. By Brad Crittenden on 2013-03-19

linking branch

1023. By Brad Crittenden on 2013-03-19

Add destroy-relation to API.

R=dimitern, fwereade, dfc
CC=
https://codereview.appspot.com/7610046

1022. By Aaron Bentley on 2013-03-19

Add category list to charms

Added category list to charms to support charmworld, which will display charm
categories. While most charms will have only one, some will fit into multiple
categories, such as Apache, which is both a web server and a proxy.

There will be an official list of categories, but supplying an unofficial
category is a lint error, not a syntax error, so this branch does not address
that. The order of the values is not significant, so in Python terms
categories are a set, not a list, but since none of JSON, BSON and Go has
direct support for sets, a list is used.

This branch also adds tests to ensure that Meta objects can be roundtripped
via BSON.

R=dfc, fwereade, jameinel
CC=
https://codereview.appspot.com/7762043

1021. By William Reade on 2013-03-19

cmd/juju: bootstrap accepts --constraints

...and passes them on to environs.Bootstrap, which passes them on to
Environ.Bootstrap. Only the dummy provider actually handles constraints
at the moment -- so we can test the bootstrap command -- all the others
will be implemented in followups.

R=dimitern, jameinel, dfc, thumper
CC=
https://codereview.appspot.com/7610048

=== modified file 'state/api/apiclient.go'
--- state/api/apiclient.go	2013-03-21 09:32:47 +0000
+++ state/api/apiclient.go	2013-03-22 14:08:21 +0000
@@ -199,6 +199,17 @@
 	return info, clientError(err)
 }
 
+// GetEndpoints returns the endpoints for the specified services.  If
+// no services are passed then endpoints for all services are returned.
+func (c *Client) GetEndpoints(services []string) (*params.GetEndpointsResults, error) {
+	args := params.GetEndpoints{
+		Services: services,
+	}
+	result := new(params.GetEndpointsResults)
+	err := c.st.client.Call("Client", "", "GetEndpoints", args, result)
+	return result, clientError(err)
+}
+
 // AllWatcher holds information allowing us to get Deltas describing changes
 // to the entire environment.
 type AllWatcher struct {

=== modified file 'state/api/params/params.go'
--- state/api/params/params.go	2013-03-21 09:32:47 +0000
+++ state/api/params/params.go	2013-03-22 14:08:21 +0000
@@ -154,6 +154,26 @@
 	Constraints constraints.Value
 }
 
+// GetEndpoints has the parameters for making the GetEndpoints call, an array
+// of service names or an empty array to indicate all services.
+type GetEndpoints struct {
+	Services []string
+}
+
+// GetEndpointsResults is the return structure for the GetEndpoints call.
+type GetEndpointsResults struct {
+	// The Endpoints is a pretty complicated scheme of maps to maps.  The
+	// keys for each level are shown here:
+	//            svcname    provides
+	//                       requires
+	//                                    interface
+	//                                    name
+	//                                    role
+	//                                    etc
+	//                                           value
+	Endpoints map[string]map[string][]map[string]string
+}
+
 // Delta holds details of a change to the environment.
 type Delta struct {
 	// If Removed is true, the entity has been removed;

=== modified file 'state/apiserver/api_test.go'
--- state/apiserver/api_test.go	2013-03-21 09:32:47 +0000
+++ state/apiserver/api_test.go	2013-03-22 14:08:21 +0000
@@ -151,6 +151,10 @@
 	about: "Client.DestroyRelation",
 	op:    opClientDestroyRelation,
 	allow: []string{"user-admin", "user-other"},
+}, {
+	about: "Client.GetEndpoints",
+	op:    opClientGetEndpoints,
+	allow: []string{"user-admin", "user-other"},
 },
 }
 
@@ -273,6 +277,15 @@
 	return func() {}, nil
 }
 
+func opClientGetEndpoints(c *C, st *api.State, mst *state.State) (func(), error) {
+	endpoints, err := st.Client().GetEndpoints([]string{})
+	if err != nil {
+		return func() {}, err
+	}
+	c.Assert(endpoints, NotNil)
+	return func() {}, nil
+}
+
 func opClientStatus(c *C, st *api.State, mst *state.State) (func(), error) {
 	status, err := st.Client().Status()
 	if err != nil {
@@ -1375,6 +1388,157 @@
 	c.Assert(err, ErrorMatches, `relation "wordpress:db mysql:server" not found`)
 }
 
+<<<<<<< TREE
+=======
+// makeExpectedWordpress returns the expected endpoints for wordpress.
+func makeExpectedWordpress() map[string][]map[string]string {
+	results := map[string][]map[string]string{
+		"provides": []map[string]string{
+			map[string]string{
+				"name":      "url",
+				"interface": "http",
+				"optional":  "false",
+				"scope":     "global",
+			},
+			map[string]string{
+				"name":      "logging-dir",
+				"interface": "logging",
+				"scope":     "container",
+				"optional":  "false",
+			},
+		},
+		"requires": []map[string]string{
+			map[string]string{
+				"name":      "db",
+				"interface": "mysql",
+				"optional":  "false",
+				"scope":     "global",
+			},
+			map[string]string{
+				"name":      "cache",
+				"interface": "varnish",
+				"optional":  "true",
+				"scope":     "global",
+			},
+		},
+	}
+	return results
+}
+
+// makeExpectedLogging returns the expected endpoints for logging.
+func makeExpectedLogging() map[string][]map[string]string {
+	results := map[string][]map[string]string{
+
+		"provides": []map[string]string{
+			map[string]string{
+				"name":      "logging-client",
+				"interface": "logging",
+				"scope":     "global",
+				"optional":  "false",
+			},
+		},
+
+		"requires": []map[string]string{
+			map[string]string{
+				"name":      "logging-directory",
+				"interface": "logging",
+				"scope":     "container",
+				"optional":  "false",
+			},
+			map[string]string{
+				"name":      "info",
+				"interface": "juju-info",
+				"scope":     "container",
+				"optional":  "false",
+			},
+		},
+	}
+	return results
+}
+
+// makeExpectedMysql returns the expected endpoints for mysql.
+func makeExpectedMysql() map[string][]map[string]string {
+	results := map[string][]map[string]string{
+
+		"provides": []map[string]string{
+			map[string]string{
+				"name":      "server",
+				"scope":     "global",
+				"optional":  "false",
+				"interface": "mysql",
+			},
+		},
+
+		"requires": []map[string]string{},
+	}
+	return results
+}
+
+// normalize will replace the list with a map keyed by name for
+// easier comparison.
+func normalize(r map[string]map[string][]map[string]string) map[string]map[string]map[string]map[string]string {
+	res := map[string]map[string]map[string]map[string]string{}
+	for k1, v1 := range r {
+		res[k1] = map[string]map[string]map[string]string{}
+		for k2, v2 := range v1 {
+			res[k1][k2] = map[string]map[string]string{}
+			for _, v3 := range v2 {
+				res[k1][k2][v3["name"]] = v3
+			}
+		}
+	}
+	return res
+}
+
+func (s *suite) TestGetEndpointsAll(c *C) {
+	s.setUpScenario(c)
+	result, err := s.APIState.Client().GetEndpoints([]string{})
+	c.Assert(err, IsNil)
+	c.Assert(result, NotNil)
+	c.Assert(result.Endpoints, NotNil)
+	expected := make(map[string]map[string][]map[string]string)
+	expected["wordpress"] = makeExpectedWordpress()
+	expected["logging"] = makeExpectedLogging()
+	expected["mysql"] = makeExpectedMysql()
+	normalized := normalize(expected)
+	obtained := normalize(result.Endpoints)
+	c.Assert(obtained, DeepEquals, normalized)
+}
+
+func (s *suite) TestGetEndpointsOne(c *C) {
+	s.setUpScenario(c)
+	result, err := s.APIState.Client().GetEndpoints([]string{"wordpress"})
+	c.Assert(err, IsNil)
+	c.Assert(result, NotNil)
+	c.Assert(result.Endpoints, NotNil)
+
+	expected := make(map[string]map[string][]map[string]string)
+	expected["wordpress"] = makeExpectedWordpress()
+
+	normalized := normalize(expected)
+	obtained := normalize(result.Endpoints)
+	c.Assert(obtained, DeepEquals, normalized)
+}
+
+func (s *suite) TestGetEndpointsMost(c *C) {
+	s.setUpScenario(c)
+	result, err := s.APIState.Client().GetEndpoints([]string{"mysql", "wordpress"})
+	c.Assert(err, IsNil)
+	c.Assert(result, NotNil)
+	c.Assert(result.Endpoints, NotNil)
+
+	expected := make(map[string]map[string][]map[string]string)
+	expected["wordpress"] = makeExpectedWordpress()
+	expected["mysql"] = makeExpectedMysql()
+
+	normalized := normalize(expected)
+	obtained := normalize(result.Endpoints)
+	c.Assert(obtained, DeepEquals, normalized)
+}
+
+// This test will be thrown away, at least in part, once the stub code in
+// state/megawatcher.go is implemented.
+>>>>>>> MERGE-SOURCE
 func (s *suite) TestClientWatchAll(c *C) {
 	// A very simple end-to-end test, because
 	// all the logic is tested elsewhere.

=== modified file 'state/apiserver/apiserver.go'
--- state/apiserver/apiserver.go	2013-03-21 09:32:47 +0000
+++ state/apiserver/apiserver.go	2013-03-22 14:08:21 +0000
@@ -435,6 +435,66 @@
 	return entity.SetAnnotations(args.Pairs)
 }
 
+// GetEndpoints returns the endpoints for the specified services.  If
+// no services are passed then endpoints for all services are returned.
+func (c *srvClient) GetEndpoints(args params.GetEndpoints) (params.GetEndpointsResults, error) {
+
+	var results params.GetEndpointsResults
+	var services []*state.Service
+	srvState := c.root.srv.state
+
+	if len(args.Services) == 0 {
+		var err error
+		services, err = srvState.AllServices()
+		if err != nil {
+			return params.GetEndpointsResults{}, err
+		}
+	} else {
+		for _, name := range args.Services {
+			s, err := srvState.Service(name)
+			if err != nil {
+				return params.GetEndpointsResults{}, err
+			}
+			services = append(services, s)
+		}
+	}
+	results.Endpoints = make(map[string]map[string][]map[string]string)
+
+	for _, svc := range services {
+		charm, _, err := svc.Charm()
+		if err != nil {
+			return params.GetEndpointsResults{}, err
+		}
+		metadata := charm.Meta()
+		svcName := svc.Name()
+		results.Endpoints[svcName] = make(map[string][]map[string]string)
+		results.Endpoints[svcName]["provides"] = flatten(metadata.Provides)
+		results.Endpoints[svcName]["requires"] = flatten(metadata.Requires)
+	}
+
+	return results, nil
+
+}
+
+func flatten(meta map[string]charm.Relation) []map[string]string {
+	var results []map[string]string
+	if meta == nil {
+		return results
+	}
+	for key, value := range meta {
+		rel := make(map[string]string)
+		rel["name"] = key
+		rel["interface"] = value.Interface
+		rel["optional"] = strconv.FormatBool(value.Optional)
+		// Note, "limit" is explicitly not returned, per discussion with
+		// fwereade.
+		// rel["limit"] = strconv.Itoa(value.Limit)
+		rel["scope"] = string(value.Scope)
+		results = append(results, rel)
+	}
+	return results
+}
+
 // Login logs in with the provided credentials.
 // All subsequent requests on the connection will
 // act as the authenticated user.