Merge lp:~wallyworld/juju-core/utopic-support into lp:~go-bot/juju-core/trunk

[Ian Booth]

Split out Ubuntu series lookup

Support for querying Ubuntu series info was
in the simplestreams package. We needed to add
support for "utopic" but it wasn't obvious
where to do it. A previous attempt was made
but only a test constant was changed. This
branch extracts the series stuff into a new
juju/ubuntu package and adds proper "utopic"
support.

We may well need to look at this again when we
want to add supported series support for other
OS's but for now this should be good enough.

https://codereview.appspot.com/92160043/

Split out Ubuntu series lookup

Support for querying Ubuntu series info was
in the simplestreams package. We needed to add
support for "utopic" but it wasn't obvious
where to do it. A previous attempt was made
but only a test constant was changed. This
branch extracts the series stuff into a new
juju/ubuntu package and adds proper "utopic"
support.

We may well need to look at this again when we
want to add supported series support for other
OS's but for now this should be good enough.

https://codereview.appspot.com/92160043/

[Ian Booth (wallyworld)]

Reviewers: mp+218910_code.launchpad.net,

Message:
Please take a look.

Description:
Split out Ubuntu series lookup

Support for querying Ubuntu series info was
in the simplestreams package. We needed to add
support for "utopic" but it wasn't obvious
where to do it. A previous attempt was made
but only a test constant was changed. This
branch extracts the series stuff into a new
juju/ubuntu package and adds proper "utopic"
support.

We may well need to look at this again when we
want to add supported series support for other
OS's but for now this should be good enough.

https://code.launchpad.net/~wallyworld/juju-core/utopic-support/+merge/218910

(do not edit description out of merge proposal)

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

Affected files (+203, -145 lines):
   A [revision details]
   M environs/bootstrap/synctools.go
   M environs/imagemetadata/generate.go
   M environs/imagemetadata/simplestreams.go
   M environs/simplestreams/export_test.go
   M environs/simplestreams/simplestreams.go
   M environs/simplestreams/simplestreams_test.go
   M environs/simplestreams/testing/testing.go
   M environs/sync/sync.go
   M environs/tools/simplestreams.go
   M environs/tools/testing/testing.go
   M environs/tools/tools.go
   A juju/ubuntu/export_test.go
   A juju/ubuntu/package_test.go
   A juju/ubuntu/supportedseries.go
   A juju/ubuntu/supportedseries_test.go

[Andrew Wilkins (axwalk)]

On 2014/05/09 04:46:47, wallyworld wrote:
> Please take a look.

I think version/ubuntu would be even more obvious. Otherwise, LGTM.

https://codereview.appspot.com/92160043/

[Ian Booth (wallyworld)]

On 2014/05/09 04:56:51, axw wrote:
> On 2014/05/09 04:46:47, wallyworld wrote:
> > Please take a look.

> I think version/ubuntu would be even more obvious. Otherwise, LGTM.

Yeah, good idea. Done

https://codereview.appspot.com/92160043/

=== modified file 'environs/bootstrap/synctools.go'
--- environs/bootstrap/synctools.go	2014-04-24 04:01:26 +0000
+++ environs/bootstrap/synctools.go	2014-05-09 05:03:50 +0000
@@ -9,7 +9,6 @@
 
 	"launchpad.net/juju-core/environs"
 	"launchpad.net/juju-core/environs/config"
-	"launchpad.net/juju-core/environs/simplestreams"
 	"launchpad.net/juju-core/environs/sync"
 	envtools "launchpad.net/juju-core/environs/tools"
 	"launchpad.net/juju-core/errors"
@@ -17,6 +16,7 @@
 	coretools "launchpad.net/juju-core/tools"
 	"launchpad.net/juju-core/utils/set"
 	"launchpad.net/juju-core/version"
+	"launchpad.net/juju-core/version/ubuntu"
 )
 
 const noToolsMessage = `Juju cannot bootstrap because no tools are available for your environment.
@@ -34,7 +34,7 @@
 	logger.Infof("checking that upload is possible")
 	// Check the series are valid.
 	for _, series := range bootstrapSeries {
-		if _, err := simplestreams.SeriesVersion(series); err != nil {
+		if _, err := ubuntu.SeriesVersion(series); err != nil {
 			return err
 		}
 	}

=== modified file 'environs/imagemetadata/generate.go'
--- environs/imagemetadata/generate.go	2014-04-14 12:36:13 +0000
+++ environs/imagemetadata/generate.go	2014-05-09 05:03:50 +0000
@@ -12,6 +12,7 @@
 	"launchpad.net/juju-core/environs/simplestreams"
 	"launchpad.net/juju-core/environs/storage"
 	"launchpad.net/juju-core/errors"
+	"launchpad.net/juju-core/version/ubuntu"
 )
 
 // MergeAndWriteMetadata reads the existing metadata from storage (if any),
@@ -23,7 +24,7 @@
 	if err != nil {
 		return err
 	}
-	seriesVersion, err := simplestreams.SeriesVersion(series)
+	seriesVersion, err := ubuntu.SeriesVersion(series)
 	if err != nil {
 		return err
 	}

=== modified file 'environs/imagemetadata/simplestreams.go'
--- environs/imagemetadata/simplestreams.go	2014-03-20 05:03:57 +0000
+++ environs/imagemetadata/simplestreams.go	2014-05-09 05:03:50 +0000
@@ -12,6 +12,7 @@
 
 	"launchpad.net/juju-core/environs/simplestreams"
 	"launchpad.net/juju-core/juju/arch"
+	"launchpad.net/juju-core/version/ubuntu"
 )
 
 func init() {
@@ -99,7 +100,7 @@
 
 func NewImageConstraint(params simplestreams.LookupParams) *ImageConstraint {
 	if len(params.Series) == 0 {
-		params.Series = simplestreams.SupportedSeries()
+		params.Series = ubuntu.SupportedSeries()
 	}
 	if len(params.Arches) == 0 {
 		params.Arches = arch.AllSupportedArches
@@ -130,7 +131,7 @@
 	ids := make([]string, nrArches*nrSeries)
 	for i, arch := range ic.Arches {
 		for j, series := range ic.Series {
-			version, err := simplestreams.SeriesVersion(series)
+			version, err := ubuntu.SeriesVersion(series)
 			if err != nil {
 				return nil, err
 			}

=== modified file 'environs/simplestreams/export_test.go'
--- environs/simplestreams/export_test.go	2013-10-10 11:40:54 +0000
+++ environs/simplestreams/export_test.go	2014-05-09 05:03:50 +0000
@@ -22,14 +22,3 @@
 func Filter(entries IndexMetadataSlice, match func(*IndexMetadata) bool) IndexMetadataSlice {
 	return entries.filter(match)
 }
-
-func SetSeriesVersions(value map[string]string) func() {
-	origVersions := seriesVersions
-	origUpdated := updatedseriesVersions
-	seriesVersions = value
-	updatedseriesVersions = false
-	return func() {
-		seriesVersions = origVersions
-		updatedseriesVersions = origUpdated
-	}
-}

=== modified file 'environs/simplestreams/simplestreams.go'
--- environs/simplestreams/simplestreams.go	2014-04-30 23:18:40 +0000
+++ environs/simplestreams/simplestreams.go	2014-05-09 05:03:50 +0000
@@ -10,17 +10,13 @@
 package simplestreams
 
 import (
-	"bufio"
 	"encoding/json"
 	"fmt"
-	"io"
 	"io/ioutil"
-	"os"
 	"path"
 	"reflect"
 	"sort"
 	"strings"
-	"sync"
 
 	"github.com/juju/loggo"
 
@@ -94,104 +90,6 @@
 	return p
 }
 
-// seriesVersions provides a mapping between Ubuntu series names and version numbers.
-// The values here are current as of the time of writing. On Ubuntu systems, we update
-// these values from /usr/share/distro-info/ubuntu.csv to ensure we have the latest values.
-// On non-Ubuntu systems, these values provide a nice fallback option.
-// Exported so tests can change the values to ensure the distro-info lookup works.
-var seriesVersions = map[string]string{
-	"precise": "12.04",
-	"quantal": "12.10",
-	"raring":  "13.04",
-	"saucy":   "13.10",
-	"trusty":  "14.04",
-}
-
-var (
-	seriesVersionsMutex   sync.Mutex
-	updatedseriesVersions bool
-)
-
-// SeriesVersion returns the version number for the specified Ubuntu series.
-func SeriesVersion(series string) (string, error) {
-	if series == "" {
-		panic("cannot pass empty series to SeriesVersion()")
-	}
-	seriesVersionsMutex.Lock()
-	defer seriesVersionsMutex.Unlock()
-	if vers, ok := seriesVersions[series]; ok {
-		return vers, nil
-	}
-	updateSeriesVersions()
-	if vers, ok := seriesVersions[series]; ok {
-		return vers, nil
-	}
-	return "", fmt.Errorf("invalid series %q", series)
-}
-
-// SupportedSeries returns the Ubuntu series for which we expect to find metadata.
-func SupportedSeries() []string {
-	seriesVersionsMutex.Lock()
-	defer seriesVersionsMutex.Unlock()
-	updateSeriesVersions()
-	var series []string
-	for s := range seriesVersions {
-		series = append(series, s)
-	}
-	return series
-}
-
-func updateSeriesVersions() {
-	if !updatedseriesVersions {
-		err := updateDistroInfo()
-		if err != nil {
-			logger.Warningf("failed to update distro info: %v", err)
-		}
-		updatedseriesVersions = true
-	}
-}
-
-// updateDistroInfo updates seriesVersions from /usr/share/distro-info/ubuntu.csv if possible..
-func updateDistroInfo() error {
-	// We need to find the series version eg 12.04 from the series eg precise. Use the information found in
-	// /usr/share/distro-info/ubuntu.csv provided by distro-info-data package.
-	f, err := os.Open("/usr/share/distro-info/ubuntu.csv")
-	if err != nil {
-		// On non-Ubuntu systems this file won't exist but that's expected.
-		return nil
-	}
-	defer f.Close()
-	bufRdr := bufio.NewReader(f)
-	// Only find info for precise or later.
-	preciseOrLaterFound := false
-	for {
-		line, err := bufRdr.ReadString('\n')
-		if err == io.EOF {
-			break
-		}
-		if err != nil {
-			return fmt.Errorf("reading distro info file file: %v", err)
-		}
-		// lines are of the form: "12.04 LTS,Precise Pangolin,precise,2011-10-13,2012-04-26,2017-04-26"
-		parts := strings.Split(line, ",")
-		// Ignore any malformed lines.
-		if len(parts) < 3 {
-			continue
-		}
-		series := parts[2]
-		if series == "precise" {
-			preciseOrLaterFound = true
-		}
-		if series != "precise" && !preciseOrLaterFound {
-			continue
-		}
-		// the numeric version may contain a LTS moniker so strip that out.
-		seriesInfo := strings.Split(parts[0], " ")
-		seriesVersions[series] = seriesInfo[0]
-	}
-	return nil
-}
-
 // The following structs define the data model used in the JSON metadata files.
 // Not every model attribute is defined here, only the ones we care about.
 // See the doc/README file in lp:simplestreams for more information.

=== modified file 'environs/simplestreams/simplestreams_test.go'
--- environs/simplestreams/simplestreams_test.go	2014-03-21 03:27:16 +0000
+++ environs/simplestreams/simplestreams_test.go	2014-05-09 05:03:50 +0000
@@ -5,7 +5,6 @@
 
 import (
 	"bytes"
-	"sort"
 	"strings"
 	"testing"
 
@@ -14,7 +13,6 @@
 
 	"launchpad.net/juju-core/environs/simplestreams"
 	sstesting "launchpad.net/juju-core/environs/simplestreams/testing"
-	coretesting "launchpad.net/juju-core/testing"
 	"launchpad.net/juju-core/utils"
 )
 
@@ -403,25 +401,6 @@
 	c.Check(ti.Endpoint, gc.Equals, "https://ec2.us-west-3.amazonaws.com")
 }
 
-func (s *simplestreamsSuite) TestSeriesVersion(c *gc.C) {
-	cleanup := simplestreams.SetSeriesVersions(make(map[string]string))
-	defer cleanup()
-	vers, err := simplestreams.SeriesVersion("precise")
-	if err != nil && err.Error() == `invalid series "precise"` {
-		c.Fatalf(`Unable to lookup series "precise", you may need to: apt-get install distro-info`)
-	}
-	c.Assert(err, gc.IsNil)
-	c.Assert(vers, gc.Equals, "12.04")
-}
-
-func (s *simplestreamsSuite) TestSupportedSeries(c *gc.C) {
-	cleanup := simplestreams.SetSeriesVersions(make(map[string]string))
-	defer cleanup()
-	series := simplestreams.SupportedSeries()
-	sort.Strings(series)
-	c.Assert(series, gc.DeepEquals, coretesting.SupportedSeries)
-}
-
 var getMirrorTests = []struct {
 	region    string
 	endpoint  string

=== modified file 'environs/simplestreams/testing/testing.go'
--- environs/simplestreams/testing/testing.go	2014-03-21 03:27:16 +0000
+++ environs/simplestreams/testing/testing.go	2014-05-09 05:03:50 +0000
@@ -14,6 +14,7 @@
 	"launchpad.net/juju-core/environs/jujutest"
 	"launchpad.net/juju-core/environs/simplestreams"
 	"launchpad.net/juju-core/testing/testbase"
+	"launchpad.net/juju-core/version/ubuntu"
 )
 
 var PrivateKeyPassphrase = "12345"
@@ -535,7 +536,7 @@
 }
 
 func (tc *testConstraint) Ids() ([]string, error) {
-	version, err := simplestreams.SeriesVersion(tc.Series[0])
+	version, err := ubuntu.SeriesVersion(tc.Series[0])
 	if err != nil {
 		return nil, err
 	}

=== modified file 'environs/sync/sync.go'
--- environs/sync/sync.go	2014-04-30 23:18:40 +0000
+++ environs/sync/sync.go	2014-05-09 05:03:50 +0000
@@ -20,6 +20,7 @@
 	coretools "launchpad.net/juju-core/tools"
 	"launchpad.net/juju-core/utils"
 	"launchpad.net/juju-core/version"
+	"launchpad.net/juju-core/version/ubuntu"
 )
 
 var logger = loggo.GetLogger("juju.environs.sync")
@@ -229,7 +230,7 @@
 	}
 	logger.Debugf("generating tarballs for %v", series)
 	for _, series := range series {
-		_, err := simplestreams.SeriesVersion(series)
+		_, err := ubuntu.SeriesVersion(series)
 		if err != nil {
 			return err
 		}

=== modified file 'environs/tools/simplestreams.go'
--- environs/tools/simplestreams.go	2014-04-14 12:36:13 +0000
+++ environs/tools/simplestreams.go	2014-05-09 05:03:50 +0000
@@ -23,6 +23,7 @@
 	coretools "launchpad.net/juju-core/tools"
 	"launchpad.net/juju-core/utils/set"
 	"launchpad.net/juju-core/version"
+	"launchpad.net/juju-core/version/ubuntu"
 )
 
 func init() {
@@ -117,7 +118,7 @@
 func (tc *ToolsConstraint) Ids() ([]string, error) {
 	var allIds []string
 	for _, series := range tc.Series {
-		version, err := simplestreams.SeriesVersion(series)
+		version, err := ubuntu.SeriesVersion(series)
 		if err != nil {
 			return nil, err
 		}
@@ -157,7 +158,7 @@
 }
 
 func (t *ToolsMetadata) productId() (string, error) {
-	seriesVersion, err := simplestreams.SeriesVersion(t.Release)
+	seriesVersion, err := ubuntu.SeriesVersion(t.Release)
 	if err != nil {
 		return "", err
 	}

=== modified file 'environs/tools/testing/testing.go'
--- environs/tools/testing/testing.go	2014-04-30 23:18:40 +0000
+++ environs/tools/testing/testing.go	2014-05-09 05:03:50 +0000
@@ -25,6 +25,7 @@
 	"launchpad.net/juju-core/utils"
 	"launchpad.net/juju-core/utils/set"
 	"launchpad.net/juju-core/version"
+	"launchpad.net/juju-core/version/ubuntu"
 )
 
 // MakeTools creates some fake tools with the given version strings.
@@ -123,7 +124,7 @@
 				toolsMetadata := item.(*tools.ToolsMetadata)
 				toolsMetadataMap[key] = toolsMetadata
 				toolsVersions.Add(key)
-				seriesVersion, err := simplestreams.SeriesVersion(toolsMetadata.Release)
+				seriesVersion, err := ubuntu.SeriesVersion(toolsMetadata.Release)
 				c.Assert(err, gc.IsNil)
 				productId := fmt.Sprintf("com.ubuntu.juju:%s:%s", seriesVersion, toolsMetadata.Arch)
 				expectedProductIds.Add(productId)

=== modified file 'environs/tools/tools.go'
--- environs/tools/tools.go	2014-04-30 23:18:40 +0000
+++ environs/tools/tools.go	2014-05-09 05:03:50 +0000
@@ -14,6 +14,7 @@
 	"launchpad.net/juju-core/juju/arch"
 	coretools "launchpad.net/juju-core/tools"
 	"launchpad.net/juju-core/version"
+	"launchpad.net/juju-core/version/ubuntu"
 )
 
 var logger = loggo.GetLogger("juju.environs.tools")
@@ -54,7 +55,7 @@
 		seriesToSearch = []string{filter.Series}
 	} else {
 		logger.Debugf("no series specified when finding tools, looking for any")
-		seriesToSearch = simplestreams.SupportedSeries()
+		seriesToSearch = ubuntu.SupportedSeries()
 	}
 	toolsConstraint.Series = seriesToSearch
 	return toolsConstraint, nil

=== added directory 'version/ubuntu'
=== added file 'version/ubuntu/export_test.go'
--- version/ubuntu/export_test.go	1970-01-01 00:00:00 +0000
+++ version/ubuntu/export_test.go	2014-05-09 05:03:50 +0000
@@ -0,0 +1,15 @@
+// Copyright 2014 Canonical Ltd.
+// Licensed under the AGPLv3, see LICENCE file for details.
+
+package ubuntu
+
+func SetSeriesVersions(value map[string]string) func() {
+	origVersions := seriesVersions
+	origUpdated := updatedseriesVersions
+	seriesVersions = value
+	updatedseriesVersions = false
+	return func() {
+		seriesVersions = origVersions
+		updatedseriesVersions = origUpdated
+	}
+}

=== added file 'version/ubuntu/package_test.go'
--- version/ubuntu/package_test.go	1970-01-01 00:00:00 +0000
+++ version/ubuntu/package_test.go	2014-05-09 05:03:50 +0000
@@ -0,0 +1,14 @@
+// Copyright 2013 Canonical Ltd.
+// Licensed under the LGPLv3, see COPYING and COPYING.LESSER file for details.
+
+package ubuntu_test
+
+import (
+	"testing"
+
+	gc "launchpad.net/gocheck"
+)
+
+func Test(t *testing.T) {
+	gc.TestingT(t)
+}

=== added file 'version/ubuntu/supportedseries.go'
--- version/ubuntu/supportedseries.go	1970-01-01 00:00:00 +0000
+++ version/ubuntu/supportedseries.go	2014-05-09 05:03:50 +0000
@@ -0,0 +1,116 @@
+// Copyright 2014 Canonical Ltd.
+// Licensed under the AGPLv3, see LICENCE file for details.
+
+package ubuntu
+
+import (
+	"bufio"
+	"fmt"
+	"io"
+	"os"
+	"strings"
+	"sync"
+
+	"github.com/juju/loggo"
+)
+
+var logger = loggo.GetLogger("juju.ubuntu")
+
+// seriesVersions provides a mapping between Ubuntu series names and version numbers.
+// The values here are current as of the time of writing. On Ubuntu systems, we update
+// these values from /usr/share/distro-info/ubuntu.csv to ensure we have the latest values.
+// On non-Ubuntu systems, these values provide a nice fallback option.
+// Exported so tests can change the values to ensure the distro-info lookup works.
+var seriesVersions = map[string]string{
+	"precise": "12.04",
+	"quantal": "12.10",
+	"raring":  "13.04",
+	"saucy":   "13.10",
+	"trusty":  "14.04",
+	"utopic":  "14.10",
+}
+
+var (
+	seriesVersionsMutex   sync.Mutex
+	updatedseriesVersions bool
+)
+
+// SeriesVersion returns the version number for the specified Ubuntu series.
+func SeriesVersion(series string) (string, error) {
+	if series == "" {
+		panic("cannot pass empty series to SeriesVersion()")
+	}
+	seriesVersionsMutex.Lock()
+	defer seriesVersionsMutex.Unlock()
+	if vers, ok := seriesVersions[series]; ok {
+		return vers, nil
+	}
+	updateSeriesVersions()
+	if vers, ok := seriesVersions[series]; ok {
+		return vers, nil
+	}
+	return "", fmt.Errorf("invalid series %q", series)
+}
+
+// SupportedSeries returns the Ubuntu series on which we can run Juju workloads.
+func SupportedSeries() []string {
+	seriesVersionsMutex.Lock()
+	defer seriesVersionsMutex.Unlock()
+	updateSeriesVersions()
+	var series []string
+	for s := range seriesVersions {
+		series = append(series, s)
+	}
+	return series
+}
+
+func updateSeriesVersions() {
+	if !updatedseriesVersions {
+		err := updateDistroInfo()
+		if err != nil {
+			logger.Warningf("failed to update distro info: %v", err)
+		}
+		updatedseriesVersions = true
+	}
+}
+
+// updateDistroInfo updates seriesVersions from /usr/share/distro-info/ubuntu.csv if possible..
+func updateDistroInfo() error {
+	// We need to find the series version eg 12.04 from the series eg precise. Use the information found in
+	// /usr/share/distro-info/ubuntu.csv provided by distro-info-data package.
+	f, err := os.Open("/usr/share/distro-info/ubuntu.csv")
+	if err != nil {
+		// On non-Ubuntu systems this file won't exist but that's expected.
+		return nil
+	}
+	defer f.Close()
+	bufRdr := bufio.NewReader(f)
+	// Only find info for precise or later.
+	preciseOrLaterFound := false
+	for {
+		line, err := bufRdr.ReadString('\n')
+		if err == io.EOF {
+			break
+		}
+		if err != nil {
+			return fmt.Errorf("reading distro info file file: %v", err)
+		}
+		// lines are of the form: "12.04 LTS,Precise Pangolin,precise,2011-10-13,2012-04-26,2017-04-26"
+		parts := strings.Split(line, ",")
+		// Ignore any malformed lines.
+		if len(parts) < 3 {
+			continue
+		}
+		series := parts[2]
+		if series == "precise" {
+			preciseOrLaterFound = true
+		}
+		if series != "precise" && !preciseOrLaterFound {
+			continue
+		}
+		// the numeric version may contain a LTS moniker so strip that out.
+		seriesInfo := strings.Split(parts[0], " ")
+		seriesVersions[series] = seriesInfo[0]
+	}
+	return nil
+}

=== added file 'version/ubuntu/supportedseries_test.go'
--- version/ubuntu/supportedseries_test.go	1970-01-01 00:00:00 +0000
+++ version/ubuntu/supportedseries_test.go	2014-05-09 05:03:50 +0000
@@ -0,0 +1,38 @@
+// Copyright 2013 Canonical Ltd.
+// Licensed under the AGPLv3, see LICENCE file for details.
+
+package ubuntu_test
+
+import (
+	"sort"
+
+	gc "launchpad.net/gocheck"
+
+	"launchpad.net/juju-core/testing/testbase"
+	"launchpad.net/juju-core/version/ubuntu"
+)
+
+type simplestreamsSuite struct {
+	testbase.LoggingSuite
+}
+
+var _ = gc.Suite(&simplestreamsSuite{})
+
+func (s *simplestreamsSuite) TestSeriesVersion(c *gc.C) {
+	cleanup := ubuntu.SetSeriesVersions(make(map[string]string))
+	defer cleanup()
+	vers, err := ubuntu.SeriesVersion("precise")
+	if err != nil && err.Error() == `invalid series "precise"` {
+		c.Fatalf(`Unable to lookup series "precise", you may need to: apt-get install distro-info`)
+	}
+	c.Assert(err, gc.IsNil)
+	c.Assert(vers, gc.Equals, "12.04")
+}
+
+func (s *simplestreamsSuite) TestSupportedSeries(c *gc.C) {
+	cleanup := ubuntu.SetSeriesVersions(make(map[string]string))
+	defer cleanup()
+	series := ubuntu.SupportedSeries()
+	sort.Strings(series)
+	c.Assert(series, gc.DeepEquals, []string{"precise", "quantal", "raring", "saucy", "trusty", "utopic"})
+}