Merge lp:~xavi-garcia-mena/go-unityscopes/utils-series into lp:go-unityscopes/v2

[Xavi Garcia]

Added series package, to represent the possible combinations for chroots when crosscompiling.

Added series package, to represent the possible combinations for chroots when crosscompiling.

Unmerged revisions

71. By Xavi Garcia on 2015-07-24

Added utilites series information to describe the different configurations we can face when crosscompiling go scopes

70. By Xavi Garcia on 2015-07-24

Added utils directory with tools for building. Added common test utils package. Added utils command package to run system commands

=== added directory 'utils/series'
=== added file 'utils/series/series.go'
--- utils/series/series.go	1970-01-01 00:00:00 +0000
+++ utils/series/series.go	2015-07-24 14:21:26 +0000
@@ -0,0 +1,111 @@
+package series
+
+import (
+	"fmt"
+)
+
+// seriesInformation is a not exported type that stores the information related to a series.
+type seriesInformation struct {
+	Name     string
+	Packages []string
+}
+
+// Series stores information about a series like the chroot name and the packages it needs to be installed in the chroot.
+type Series struct {
+	seriesData map[string]seriesInformation
+}
+
+// NewSeries returns a Series structure filled with its data and ready to be used.
+func NewSeries() Series {
+	s := Series{
+		seriesData: make(map[string]seriesInformation),
+	}
+
+	// set all the series data
+	// this could be done with an xml or json file
+	// in the future to be more flexible and easy
+	// to modify
+	var vivid seriesInformation
+	vivid.Name = "ubuntu-sdk-15.04"
+	vivid.Packages = []string{"golang-go",
+		"golang-go-linux-arm",
+		"golang-go-dbus-dev",
+		"golang-go-xdg-dev",
+		"golang-gocheck-dev",
+		"golang-gosqlite-dev",
+		"golang-uuid-dev",
+		"libgcrypt20-dev:armhf",
+		"libglib2.0-dev:armhf",
+		"libwhoopsie-dev:armhf",
+		"libdbus-1-dev:armhf",
+		"libnih-dbus-dev:armhf",
+		"libsqlite3-dev:armhf",
+		"crossbuild-essential-armhf",
+	}
+	s.seriesData["vivid"] = vivid
+
+	// TODO add future series (wily, etc)
+
+	return s
+}
+
+// GetValidSeries returns a list containing the valid series names.
+func (s Series) GetValidSeries() []string {
+	series := make([]string, len(s.seriesData), len(s.seriesData))
+	var i int
+	for k, _ := range s.seriesData {
+		series[i] = k
+		i++
+	}
+	return series
+}
+
+// PrintValidSeries prints the list of valid series, so the user can choose which one to use.
+func (s Series) PrintValidSeries() {
+	for _, k := range s.GetValidSeries() {
+		fmt.Printf("    %s\n", k)
+	}
+}
+
+// CheckValid checks if the given series name is valid.
+// Parameters:
+// series: the series name to check if it's valid (vidid, for example)
+//
+// Returns: true if the series name is valid, false otherwise. If the series name is not valid it prints the available ones.
+func (s Series) CheckValid(series string) bool {
+	if _, ok := s.seriesData[series]; !ok {
+		fmt.Println("ERROR: Wrong series name.")
+		fmt.Println("Valid series are:")
+		s.PrintValidSeries()
+		return false
+	}
+	return true
+}
+
+// GetChrootName returns the name to the chroot for the given series.
+// Parameters:
+// series: the series name to get the chroot name (vidid, for example)
+//
+// Returns: If the series does not exist it prints the list of valid series and returns an
+// empty string, otherwise it returns the chroot name (for example: ubuntu-sdk-15.04)
+func (s Series) GetChrootName(series string) string {
+	if s.CheckValid(series) {
+		return s.seriesData[series].Name
+	} else {
+		return ""
+	}
+}
+
+// GetPackagesList returns the list of packages needed by the given series.
+// Parameters:
+// series: the series name to get the list of needed packages.
+//
+// If the series does not exist it prints the list of valid series and returns an
+// empty string slice.
+func (s Series) GetPackagesList(series string) []string {
+	if s.CheckValid(series) {
+		return s.seriesData[series].Packages
+	} else {
+		return []string{}
+	}
+}
 
=== added file 'utils/series/series_test.go'
--- utils/series/series_test.go	1970-01-01 00:00:00 +0000
+++ utils/series/series_test.go	2015-07-24 14:21:26 +0000
@@ -0,0 +1,85 @@
+package series_test
+
+import (
+	. "gopkg.in/check.v1"
+	"launchpad.net/go-unityscopes/v2/utils/series"
+	"launchpad.net/go-unityscopes/v2/utils/testutils"
+	"testing"
+)
+
+type S struct{}
+
+func init() {
+	Suite(&S{})
+}
+
+func TestAll(t *testing.T) {
+	TestingT(t)
+}
+
+func (s *S) TestPrintValidSeries(c *C) {
+	var capture testutils.CaptureStdOut
+	// capture stdout to instpect that the result of the print method is correct.
+	capture.Capture()
+
+	series := series.NewSeries()
+	series.PrintValidSeries()
+
+	capture.StopCapture()
+
+	c.Check(capture.GetCapuredOut(), Equals, "    vivid\n")
+}
+
+func (s *S) TestGetValidSeries(c *C) {
+	series := series.NewSeries()
+	c.Check(series.GetValidSeries(), DeepEquals, []string{"vivid"})
+}
+
+func (s *S) TestCheckValidSeriesOK(c *C) {
+	series := series.NewSeries()
+	c.Check(series.CheckValid("vivid"), Equals, true)
+}
+
+func (s *S) TestCheckValidSeriesBadKey(c *C) {
+	series := series.NewSeries()
+	c.Check(series.CheckValid("bad-key"), Equals, false)
+}
+
+func (s *S) TestCheckValidSeriesEmptyKey(c *C) {
+	series := series.NewSeries()
+	c.Check(series.CheckValid(""), Equals, false)
+}
+
+func (s *S) TestCheckValidSeriesChrootName(c *C) {
+	series := series.NewSeries()
+	c.Check(series.GetChrootName("vivid"), Equals, "ubuntu-sdk-15.04")
+}
+
+func (s *S) TestCheckValidBadSeriesChrootName(c *C) {
+	series := series.NewSeries()
+	c.Check(series.GetChrootName("bad-key"), Equals, "")
+}
+
+func (s *S) TestCheckValidSeriesPackages(c *C) {
+	series := series.NewSeries()
+	c.Check(series.GetPackagesList("vivid"), DeepEquals, []string{"golang-go",
+		"golang-go-linux-arm",
+		"golang-go-dbus-dev",
+		"golang-go-xdg-dev",
+		"golang-gocheck-dev",
+		"golang-gosqlite-dev",
+		"golang-uuid-dev",
+		"libgcrypt20-dev:armhf",
+		"libglib2.0-dev:armhf",
+		"libwhoopsie-dev:armhf",
+		"libdbus-1-dev:armhf",
+		"libnih-dbus-dev:armhf",
+		"libsqlite3-dev:armhf",
+		"crossbuild-essential-armhf",
+	})
+}
+
+func (s *S) TestCheckValidBadSeriesPackages(c *C) {
+	series := series.NewSeries()
+	c.Check(series.GetPackagesList("bad-key"), DeepEquals, []string{})
+}