Merge lp:~niemeyer/pyjuju/go-final-formula-meta into lp:pyjuju/go

[Gustavo Niemeyer]

This branch adds support for parsing relations in the metadata.yaml file, completing support for metadata parsing in Go.

[William Reade (fwereade)]

+1. As you know, I fret about duplication, but I agree that test data is not really where we need to worry ;).

review: Approve

[Kapil Thangavelu (hazmat)]

i learned some new golang stuff from this branch. looks good.

review: Approve

=== modified file 'formula/formula.go'
--- formula/formula.go	2011-08-29 21:58:23 +0000
+++ formula/formula.go	2011-08-29 21:58:23 +0000
@@ -34,11 +34,24 @@
 	return
 }
 
+// Relation represents a single relation defined in the formula
+// metadata.yaml file.
+type Relation struct {
+	Interface string
+	Optional bool
+	Limit int
+}
+
+// Meta represents all the known content that may be defined
+// within a formula's metadata.yaml file.
 type Meta struct {
 	Name        string
 	Revision    int
 	Summary     string
 	Description string
+	Provides    map[string]Relation
+	Requires    map[string]Relation
+	Peers       map[string]Relation
 }
 
 // ReadMeta reads a metadata.yaml file and returns its representation.
@@ -74,9 +87,32 @@
 	meta.Revision = int(m["revision"].(int64))
 	meta.Summary = m["summary"].(string)
 	meta.Description = m["description"].(string)
+	meta.Provides = parseRelations(m["provides"])
+	meta.Requires = parseRelations(m["requires"])
+	meta.Peers = parseRelations(m["peers"])
 	return
 }
 
+func parseRelations(relations interface{}) map[string]Relation {
+	if relations == nil {
+		return nil
+	}
+	result := make(map[string]Relation)
+	for name, rel := range relations.(schema.MapType) {
+		relMap := rel.(schema.MapType)
+		relation := Relation{}
+		relation.Interface = relMap["interface"].(string)
+		relation.Optional = relMap["optional"].(bool)
+		if relMap["limit"] != nil {
+			// Schema defaults to int64, but we know
+			// the int range should be more than enough.
+			relation.Limit = int(relMap["limit"].(int64))
+		}
+		result[name.(string)] = relation
+	}
+	return result
+}
+
 // Schema coercer that expands the interface shorthand notation.
 // A consistent format is easier to work with than considering the
 // potential difference everywhere.

=== modified file 'formula/formula_test.go'
--- formula/formula_test.go	2011-08-29 21:58:23 +0000
+++ formula/formula_test.go	2011-08-29 21:58:23 +0000
@@ -38,10 +38,12 @@
 	c.Assert(err, Matches, `Missing formula revision: "local:foo-x"`)
 }
 
-const dummyMeta = "testrepo/dummy/metadata.yaml"
+func repoMeta(name string) (path string) {
+	return filepath.Join("testrepo", name, "metadata.yaml")
+}
 
 func (s *S) TestReadMeta(c *C) {
-	meta, err := formula.ReadMeta(dummyMeta)
+	meta, err := formula.ReadMeta(repoMeta("dummy"))
 	c.Assert(err, IsNil)
 	c.Assert(meta.Name, Equals, "dummy")
 	c.Assert(meta.Revision, Equals, 1)
@@ -51,7 +53,7 @@
 }
 
 func (s *S) TestParseMeta(c *C) {
-	data, err := ioutil.ReadFile(dummyMeta)
+	data, err := ioutil.ReadFile(repoMeta("dummy"))
 	c.Assert(err, IsNil)
 
 	meta, err := formula.ParseMeta(data)
@@ -64,7 +66,7 @@
 }
 
 func (s *S) TestMetaHeader(c *C) {
-	yaml := ReadYaml(dummyMeta)
+	yaml := ReadYaml(repoMeta("dummy"))
 	yaml["ensemble"] = "foo"
 	data := DumpYaml(yaml)
 
@@ -73,7 +75,7 @@
 }
 
 func (s *S) TestMetaErrorWithPath(c *C) {
-	yaml := ReadYaml(dummyMeta)
+	yaml := ReadYaml(repoMeta("dummy"))
 	yaml["ensemble"] = "foo"
 	data := DumpYaml(yaml)
 
@@ -89,6 +91,29 @@
 	c.Assert(err, Matches, `/.*/mymeta\.yaml: ensemble: expected "formula", got "foo"`)
 }
 
+func (s *S) TestParseMetaRelations(c *C) {
+	meta, err := formula.ReadMeta(repoMeta("mysql"))
+	c.Assert(err, IsNil)
+	c.Assert(meta.Provides["server"], Equals, formula.Relation{Interface: "mysql"})
+	c.Assert(meta.Requires, IsNil)
+	c.Assert(meta.Peers, IsNil)
+
+	meta, err = formula.ReadMeta(repoMeta("riak"))
+	c.Assert(err, IsNil)
+	c.Assert(meta.Provides["endpoint"], Equals, formula.Relation{Interface: "http"})
+	c.Assert(meta.Provides["admin"], Equals, formula.Relation{Interface: "http"})
+	c.Assert(meta.Peers["ring"], Equals, formula.Relation{Interface: "riak", Limit: 1})
+	c.Assert(meta.Requires, IsNil)
+
+	meta, err = formula.ReadMeta(repoMeta("wordpress"))
+	c.Assert(err, IsNil)
+	c.Assert(meta.Provides["url"], Equals, formula.Relation{Interface: "http"})
+	c.Assert(meta.Requires["db"], Equals, formula.Relation{Interface: "mysql", Limit: 1})
+	c.Assert(meta.Requires["cache"], Equals, formula.Relation{Interface: "varnish", Limit: 2, Optional: true})
+	c.Assert(meta.Peers, IsNil)
+
+}
+
 // Test rewriting of a given interface specification into long form.
 //
 // InterfaceExpander uses `coerce` to do one of two things:

=== added directory 'formula/testrepo'
=== added directory 'formula/testrepo/dummy'
=== added file 'formula/testrepo/dummy/.ignored'
--- formula/testrepo/dummy/.ignored	1970-01-01 00:00:00 +0000
+++ formula/testrepo/dummy/.ignored	2011-08-29 21:58:23 +0000
@@ -0,0 +1,1 @@
+#
\ No newline at end of file

=== added directory 'formula/testrepo/dummy/build'
=== added file 'formula/testrepo/dummy/build/ignored'
=== added file 'formula/testrepo/dummy/config.yaml'
--- formula/testrepo/dummy/config.yaml	1970-01-01 00:00:00 +0000
+++ formula/testrepo/dummy/config.yaml	2011-08-29 21:58:23 +0000
@@ -0,0 +1,5 @@
+options:
+  title: {default: My Title, description: A descriptive title used for the service., type: str}
+  outlook: {description: No default outlook., type: str}
+  username: {default: admin001, description: The name of the initial account (given admin permissions)., type: regex, validator: '\w{8}'}
+  skill-level: {description: A number indicating skill., type: int}

=== added directory 'formula/testrepo/dummy/empty'
=== added file 'formula/testrepo/dummy/metadata.yaml'
--- formula/testrepo/dummy/metadata.yaml	1970-01-01 00:00:00 +0000
+++ formula/testrepo/dummy/metadata.yaml	2011-08-29 21:58:23 +0000
@@ -0,0 +1,7 @@
+ensemble: formula
+name: dummy
+revision: 1
+summary: "That's a dummy formula."
+description: |
+    This is a longer description which
+    potentially contains multiple lines.

=== added directory 'formula/testrepo/dummy/src'
=== added file 'formula/testrepo/dummy/src/hello.c'
--- formula/testrepo/dummy/src/hello.c	1970-01-01 00:00:00 +0000
+++ formula/testrepo/dummy/src/hello.c	2011-08-29 21:58:23 +0000
@@ -0,0 +1,7 @@
+#include <stdio.h>
+
+main()
+{
+    printf ("Hello World!\n");
+    return 0;
+}

=== added directory 'formula/testrepo/mysql'
=== added file 'formula/testrepo/mysql/metadata.yaml'
--- formula/testrepo/mysql/metadata.yaml	1970-01-01 00:00:00 +0000
+++ formula/testrepo/mysql/metadata.yaml	2011-08-29 21:58:23 +0000
@@ -0,0 +1,7 @@
+ensemble: formula
+name: mysql
+revision: 1
+summary: "Database engine"
+description: "A pretty popular database"
+provides:
+  server: mysql

=== added directory 'formula/testrepo/mysql2'
=== added file 'formula/testrepo/mysql2/metadata.yaml'
--- formula/testrepo/mysql2/metadata.yaml	1970-01-01 00:00:00 +0000
+++ formula/testrepo/mysql2/metadata.yaml	2011-08-29 21:58:23 +0000
@@ -0,0 +1,11 @@
+ensemble: formula
+name: mysql2
+revision: 1
+summary: "Database engine"
+description: "A pretty popular database"
+provides:
+  prod:
+    interface: mysql
+  dev:
+    interface: mysql
+    limit: 2

=== added directory 'formula/testrepo/new'
=== added file 'formula/testrepo/new/metadata.yaml'
--- formula/testrepo/new/metadata.yaml	1970-01-01 00:00:00 +0000
+++ formula/testrepo/new/metadata.yaml	2011-08-29 21:58:23 +0000
@@ -0,0 +1,7 @@
+ensemble: formula
+name: sample
+revision: 2
+summary: "That's a sample formula."
+description: |
+    This is a longer description which
+    potentially contains multiple lines.

=== added directory 'formula/testrepo/old'
=== added file 'formula/testrepo/old/metadata.yaml'
--- formula/testrepo/old/metadata.yaml	1970-01-01 00:00:00 +0000
+++ formula/testrepo/old/metadata.yaml	2011-08-29 21:58:23 +0000
@@ -0,0 +1,7 @@
+ensemble: formula
+name: sample
+revision: 1
+summary: "That's a sample formula."
+description: |
+    This is a longer description which
+    potentially contains multiple lines.

=== added directory 'formula/testrepo/riak'
=== added file 'formula/testrepo/riak/metadata.yaml'
--- formula/testrepo/riak/metadata.yaml	1970-01-01 00:00:00 +0000
+++ formula/testrepo/riak/metadata.yaml	2011-08-29 21:58:23 +0000
@@ -0,0 +1,13 @@
+ensemble: formula
+name: riak
+revision: 7
+summary: "K/V storage engine"
+description: "Scalable K/V Store in Erlang with Clocks :-)"
+provides:
+  endpoint:
+    interface: http
+  admin:
+    interface: http
+peers:
+  ring:
+    interface: riak

=== added directory 'formula/testrepo/varnish'
=== added file 'formula/testrepo/varnish/metadata.yaml'
--- formula/testrepo/varnish/metadata.yaml	1970-01-01 00:00:00 +0000
+++ formula/testrepo/varnish/metadata.yaml	2011-08-29 21:58:23 +0000
@@ -0,0 +1,7 @@
+ensemble: formula
+name: varnish
+revision: 1
+summary: "Database engine"
+description: "Another popular database"
+provides:
+  webcache: varnish

=== added directory 'formula/testrepo/varnish2'
=== added directory 'formula/testrepo/varnish2/hooks'
=== added file 'formula/testrepo/varnish2/hooks/install'
--- formula/testrepo/varnish2/hooks/install	1970-01-01 00:00:00 +0000
+++ formula/testrepo/varnish2/hooks/install	2011-08-29 21:58:23 +0000
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+echo hello world
\ No newline at end of file

=== added file 'formula/testrepo/varnish2/metadata.yaml'
--- formula/testrepo/varnish2/metadata.yaml	1970-01-01 00:00:00 +0000
+++ formula/testrepo/varnish2/metadata.yaml	2011-08-29 21:58:23 +0000
@@ -0,0 +1,7 @@
+ensemble: formula
+name: varnish
+revision: 1
+summary: "Database engine"
+description: "Another popular database"
+provides:
+  webcache: varnish

=== added directory 'formula/testrepo/wordpress'
=== added file 'formula/testrepo/wordpress/config.yaml'
--- formula/testrepo/wordpress/config.yaml	1970-01-01 00:00:00 +0000
+++ formula/testrepo/wordpress/config.yaml	2011-08-29 21:58:23 +0000
@@ -0,0 +1,3 @@
+options:
+  blog-title: {default: My Title, description: A descriptive title used for the blog., type: str}
+

=== added file 'formula/testrepo/wordpress/metadata.yaml'
--- formula/testrepo/wordpress/metadata.yaml	1970-01-01 00:00:00 +0000
+++ formula/testrepo/wordpress/metadata.yaml	2011-08-29 21:58:23 +0000
@@ -0,0 +1,21 @@
+ensemble: formula
+name: wordpress
+revision: 3
+summary: "Blog engine"
+description: "A pretty popular blog engine"
+provides:
+  url:
+    interface: http
+    limit:
+    optional: false
+requires:
+  db:
+    interface: mysql
+    limit: 1
+    optional: false
+  cache:
+    interface: varnish
+    limit: 2
+    optional: true
+
+