Merge lp:~elopio/snappy/add_tests_tests into lp:~snappy-dev/snappy/snappy-moved-to-github

[Leo Arias]

Refactored the helpers to be able to add tests for them.
Added tests for the config helpers.

I used as an example the config package. Now thinking about it again is the worst example, because we will get rid of it in favor of the test arguments. Oh well...

[Federico Gimenez (fgimenez)]

Great! Very good idea the config encapsulation and the helpers folder =)

review: Approve

=== added directory '_integration-tests/helpers'
=== renamed directory '_integration-tests/common' => '_integration-tests/helpers/common'
=== modified file '_integration-tests/helpers/common/common.go'
--- _integration-tests/common/common.go	2015-07-22 15:12:24 +0000
+++ _integration-tests/helpers/common/common.go	2015-07-22 19:10:34 +0000
@@ -20,7 +20,6 @@
 package common
 
 import (
-	"encoding/json"
 	"fmt"
 	"io/ioutil"
 	"os"
@@ -31,6 +30,8 @@
 	"strings"
 
 	check "gopkg.in/check.v1"
+
+	"launchpad.net/snappy/_integration-tests/helpers/config"
 )
 
 const (
@@ -40,9 +41,9 @@
 	channelCfgFile  = "/etc/system-image/channel.ini"
 )
 
-// Config is a map of strings that contains the configurations values passed
-// from the host to the testbed.
-var Config map[string]string
+// Cfg is a struct that contains the configurations values passed from the
+// host to the testbed.
+var Cfg config.Config
 
 // SnappySuite is a structure used as a base test suite for all the snappy
 // integration tests.
@@ -56,9 +57,11 @@
 	ExecCommand(c, "sudo", "systemctl", "stop", "snappy-autopilot.timer")
 	ExecCommand(c, "sudo", "systemctl", "disable", "snappy-autopilot.timer")
 	if !isInRebootProcess() {
-		Config = readConfig(c)
-		if Config["update"] == "true" || Config["rollback"] == "true" {
-			switchSystemImageConf(c, Config["targetRelease"], Config["targetChannel"], "0")
+		Cfg, err := config.ReadConfig(
+			"_integration-tests/data/output/testconfig.json")
+		c.Assert(err, check.IsNil, check.Commentf("Error reading config: %v", err))
+		if Cfg.Update || Cfg.Rollback {
+			switchSystemImageConf(c, Cfg.TargetRelease, Cfg.TargetChannel, "0")
 			// Always use the installed snappy because we are updating from an old
 			// image, so we should not use the snappy from the branch.
 			output := ExecCommand(c, "sudo", "/usr/bin/snappy", "update")
@@ -68,7 +71,7 @@
 		}
 	} else if CheckRebootMark("setupsuite-update") {
 		RemoveRebootMark(c)
-		if Config["rollback"] == "true" {
+		if Cfg.Rollback {
 			ExecCommand(c, "sudo", "snappy", "rollback", "ubuntu-core")
 			RebootWithMark(c, "setupsuite-rollback")
 		}
@@ -137,18 +140,6 @@
 	s.cleanupHandlers = append(s.cleanupHandlers, f)
 }
 
-func readConfig(c *check.C) map[string]string {
-	b, err := ioutil.ReadFile("_integration-tests/data/output/testconfig.json")
-	c.Assert(
-		err, check.IsNil, check.Commentf("Failed to read test config: %v", err))
-
-	var decoded map[string]string
-	err = json.Unmarshal(b, &decoded)
-	c.Assert(
-		err, check.IsNil, check.Commentf("Failed to decode test config: %v", err))
-	return decoded
-}
-
 func switchSystemImageConf(c *check.C, release, channel, version string) {
 	targets := []string{"/", BaseOtherPath}
 	for _, target := range targets {

=== renamed directory '_integration-tests/config' => '_integration-tests/helpers/config'
=== modified file '_integration-tests/helpers/config/config.go'
--- _integration-tests/config/config.go	2015-07-22 15:12:24 +0000
+++ _integration-tests/helpers/config/config.go	2015-07-22 19:10:34 +0000
@@ -24,51 +24,51 @@
 	"fmt"
 	"io/ioutil"
 	"log"
-	"strconv"
 )
 
 // Config contains the values to pass to the test bed from the host.
 type Config struct {
-	fileName      string
-	release       string
-	channel       string
-	targetRelease string
-	targetChannel string
-	update        bool
-	rollback      bool
+	FileName      string
+	Release       string
+	Channel       string
+	TargetRelease string
+	TargetChannel string
+	Update        bool
+	Rollback      bool
 }
 
 // NewConfig is the Config constructor
 func NewConfig(fileName, release, channel, targetRelease, targetChannel string, update, rollback bool) *Config {
 	return &Config{
-		fileName: fileName, release: release, channel: channel,
-		targetRelease: targetRelease, targetChannel: targetChannel,
-		update: update, rollback: rollback,
+		FileName: fileName, Release: release, Channel: channel,
+		TargetRelease: targetRelease, TargetChannel: targetChannel,
+		Update: update, Rollback: rollback,
 	}
 }
 
 // Write writes the config to a file that will be copied to the test bed.
 func (cfg Config) Write() {
 	fmt.Println("Writing test config...")
-	testConfig := map[string]string{
-		"release": cfg.release,
-		"channel": cfg.channel,
-	}
-	if cfg.targetRelease != "" {
-		testConfig["targetRelease"] = cfg.targetRelease
-	}
-	if cfg.targetChannel != "" {
-		testConfig["targetChannel"] = cfg.targetChannel
-	}
-	testConfig["update"] = strconv.FormatBool(cfg.update)
-	testConfig["rollback"] = strconv.FormatBool(cfg.rollback)
-	fmt.Println(testConfig)
-	encoded, err := json.Marshal(testConfig)
+	fmt.Println(cfg)
+	encoded, err := json.Marshal(cfg)
 	if err != nil {
 		log.Fatalf("Error encoding the test config: %v", err)
 	}
-	err = ioutil.WriteFile(cfg.fileName, encoded, 0644)
+	err = ioutil.WriteFile(cfg.FileName, encoded, 0644)
 	if err != nil {
 		log.Fatalf("Error writing the test config: %v", err)
 	}
 }
+
+// ReadConfig the config from a file
+func ReadConfig(fileName string) (*Config, error) {
+	b, err := ioutil.ReadFile(fileName)
+	if err != nil {
+		return nil, err
+	}
+	var decoded Config
+	if err = json.Unmarshal(b, &decoded); err != nil {
+		return nil, err
+	}
+	return &decoded, nil
+}

=== added file '_integration-tests/helpers/config/config_test.go'
--- _integration-tests/helpers/config/config_test.go	1970-01-01 00:00:00 +0000
+++ _integration-tests/helpers/config/config_test.go	2015-07-22 19:10:34 +0000
@@ -0,0 +1,93 @@
+// -*- Mode: Go; indent-tabs-mode: t -*-
+
+/*
+ * Copyright (C) 2014-2015 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+package config
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"testing"
+
+	check "gopkg.in/check.v1"
+)
+
+// Hook up check.v1 into the "go test" runner
+func Test(t *testing.T) { check.TestingT(t) }
+
+type ConfigSuite struct{}
+
+var _ = check.Suite(&ConfigSuite{})
+
+func testConfigFileName(c *check.C) string {
+	tmpDir, err := ioutil.TempDir("", "")
+	c.Assert(err, check.IsNil, check.Commentf(
+		"Error creating a temporary directory: %v", err))
+	return filepath.Join(tmpDir, "test.config")
+}
+
+func testConfigStruct(fileName string) *Config {
+	return NewConfig(
+		fileName,
+		"testrelease", "testchannel", "testtargetrelease", "testtargetchannel",
+		true, true)
+}
+func testConfigContents(fileName string) string {
+	return `{` +
+		fmt.Sprintf(`"FileName":"%s",`, fileName) +
+		`"Release":"testrelease",` +
+		`"Channel":"testchannel",` +
+		`"TargetRelease":"testtargetrelease",` +
+		`"TargetChannel":"testtargetchannel",` +
+		`"Update":true,` +
+		`"Rollback":true` +
+		`}`
+}
+
+func (s *ConfigSuite) TestWriteConfig(c *check.C) {
+	// Do not print to stdout.
+	devnull, err := os.Open(os.DevNull)
+	c.Assert(err, check.IsNil)
+	oldStdout := os.Stdout
+	os.Stdout = devnull
+	defer func() {
+		os.Stdout = oldStdout
+	}()
+	configFileName := testConfigFileName(c)
+
+	cfg := testConfigStruct(configFileName)
+	cfg.Write()
+
+	writtenConfig, err := ioutil.ReadFile(configFileName)
+	c.Assert(err, check.IsNil, check.Commentf("Error reading config: %v", err))
+	c.Assert(string(writtenConfig), check.Equals, testConfigContents(configFileName))
+}
+
+func (s *ConfigSuite) TestReadConfig(c *check.C) {
+	configFileName := testConfigFileName(c)
+
+	configContents := testConfigContents(configFileName)
+	ioutil.WriteFile(configFileName, []byte(configContents), 0644)
+
+	cfg, err := ReadConfig(configFileName)
+
+	c.Assert(err, check.IsNil, check.Commentf("Error reading config: %v", err))
+	c.Assert(cfg, check.DeepEquals, testConfigStruct(configFileName))
+}

=== renamed directory '_integration-tests/image' => '_integration-tests/helpers/image'
=== modified file '_integration-tests/helpers/image/image.go'
--- _integration-tests/image/image.go	2015-07-22 15:12:24 +0000
+++ _integration-tests/helpers/image/image.go	2015-07-22 19:10:34 +0000
@@ -24,7 +24,7 @@
 	"path/filepath"
 	"strings"
 
-	utils "../utils"
+	"launchpad.net/snappy/_integration-tests/helpers/utils"
 )
 
 // Image type encapsulates image actions

=== renamed directory '_integration-tests/utils' => '_integration-tests/helpers/utils'
=== modified file '_integration-tests/main.go'
--- _integration-tests/main.go	2015-07-22 19:10:34 +0000
+++ _integration-tests/main.go	2015-07-22 19:10:34 +0000
@@ -28,9 +28,9 @@
 	"strconv"
 	"text/template"
 
-	config "./config"
-	image "./image"
-	utils "./utils"
+	"launchpad.net/snappy/_integration-tests/helpers/config"
+	"launchpad.net/snappy/_integration-tests/helpers/image"
+	"launchpad.net/snappy/_integration-tests/helpers/utils"
 )
 
 const (

=== modified file '_integration-tests/tests/apt_test.go'
--- _integration-tests/tests/apt_test.go	2015-07-22 19:10:34 +0000
+++ _integration-tests/tests/apt_test.go	2015-07-22 19:10:34 +0000
@@ -20,7 +20,7 @@
 package tests
 
 import (
-	. "launchpad.net/snappy/_integration-tests/common"
+	. "launchpad.net/snappy/_integration-tests/helpers/common"
 
 	check "gopkg.in/check.v1"
 )

=== modified file '_integration-tests/tests/build_test.go'
--- _integration-tests/tests/build_test.go	2015-07-22 19:10:34 +0000
+++ _integration-tests/tests/build_test.go	2015-07-22 19:10:34 +0000
@@ -24,7 +24,7 @@
 	"os"
 	"os/exec"
 
-	. "launchpad.net/snappy/_integration-tests/common"
+	. "launchpad.net/snappy/_integration-tests/helpers/common"
 
 	. "gopkg.in/check.v1"
 )

=== modified file '_integration-tests/tests/failover_rclocal_crash_test.go'
--- _integration-tests/tests/failover_rclocal_crash_test.go	2015-07-22 19:10:34 +0000
+++ _integration-tests/tests/failover_rclocal_crash_test.go	2015-07-22 19:10:34 +0000
@@ -22,7 +22,7 @@
 import (
 	"fmt"
 
-	. "launchpad.net/snappy/_integration-tests/common"
+	. "launchpad.net/snappy/_integration-tests/helpers/common"
 
 	check "gopkg.in/check.v1"
 )

=== modified file '_integration-tests/tests/failover_systemd_loop_test.go'
--- _integration-tests/tests/failover_systemd_loop_test.go	2015-07-22 19:10:34 +0000
+++ _integration-tests/tests/failover_systemd_loop_test.go	2015-07-22 19:10:34 +0000
@@ -22,7 +22,7 @@
 import (
 	"fmt"
 
-	. "launchpad.net/snappy/_integration-tests/common"
+	. "launchpad.net/snappy/_integration-tests/helpers/common"
 
 	check "gopkg.in/check.v1"
 )

=== modified file '_integration-tests/tests/failover_test.go'
--- _integration-tests/tests/failover_test.go	2015-07-22 19:10:34 +0000
+++ _integration-tests/tests/failover_test.go	2015-07-22 19:10:34 +0000
@@ -22,7 +22,7 @@
 import (
 	check "gopkg.in/check.v1"
 
-	. "launchpad.net/snappy/_integration-tests/common"
+	. "launchpad.net/snappy/_integration-tests/helpers/common"
 )
 
 var _ = check.Suite(&failoverSuite{})

=== modified file '_integration-tests/tests/failover_zero_size_file_test.go'
--- _integration-tests/tests/failover_zero_size_file_test.go	2015-07-22 19:10:34 +0000
+++ _integration-tests/tests/failover_zero_size_file_test.go	2015-07-22 19:10:34 +0000
@@ -25,7 +25,7 @@
 	"path/filepath"
 	"strings"
 
-	. "launchpad.net/snappy/_integration-tests/common"
+	. "launchpad.net/snappy/_integration-tests/helpers/common"
 
 	check "gopkg.in/check.v1"
 )

=== modified file '_integration-tests/tests/info_test.go'
--- _integration-tests/tests/info_test.go	2015-07-22 19:10:34 +0000
+++ _integration-tests/tests/info_test.go	2015-07-22 19:10:34 +0000
@@ -22,7 +22,7 @@
 import (
 	"fmt"
 
-	. "launchpad.net/snappy/_integration-tests/common"
+	. "launchpad.net/snappy/_integration-tests/helpers/common"
 
 	check "gopkg.in/check.v1"
 )
@@ -37,7 +37,7 @@
 	infoOutput := ExecCommand(c, "snappy", "info")
 
 	expected := "(?ms)" +
-		fmt.Sprintf("^release: ubuntu-core/%s/%s\n", Config["release"], Config["channel"]) +
+		fmt.Sprintf("^release: ubuntu-core/%s/%s\n", Cfg.Release, Cfg.Channel) +
 		".*"
 
 	c.Assert(infoOutput, check.Matches, expected)

=== modified file '_integration-tests/tests/installApp_test.go'
--- _integration-tests/tests/installApp_test.go	2015-07-22 19:10:34 +0000
+++ _integration-tests/tests/installApp_test.go	2015-07-22 19:10:34 +0000
@@ -24,7 +24,7 @@
 	"os/exec"
 	"time"
 
-	. "launchpad.net/snappy/_integration-tests/common"
+	. "launchpad.net/snappy/_integration-tests/helpers/common"
 
 	check "gopkg.in/check.v1"
 )

=== modified file '_integration-tests/tests/installFramework_test.go'
--- _integration-tests/tests/installFramework_test.go	2015-07-22 19:10:34 +0000
+++ _integration-tests/tests/installFramework_test.go	2015-07-22 19:10:34 +0000
@@ -23,7 +23,7 @@
 	"fmt"
 	"regexp"
 
-	. "launchpad.net/snappy/_integration-tests/common"
+	. "launchpad.net/snappy/_integration-tests/helpers/common"
 
 	check "gopkg.in/check.v1"
 )

=== modified file '_integration-tests/tests/list_test.go'
--- _integration-tests/tests/list_test.go	2015-07-22 19:10:34 +0000
+++ _integration-tests/tests/list_test.go	2015-07-22 19:10:34 +0000
@@ -23,7 +23,7 @@
 	"fmt"
 	"os"
 
-	. "launchpad.net/snappy/_integration-tests/common"
+	. "launchpad.net/snappy/_integration-tests/helpers/common"
 
 	"github.com/mvo5/goconfigparser"
 	check "gopkg.in/check.v1"

=== modified file '_integration-tests/tests/rollback_test.go'
--- _integration-tests/tests/rollback_test.go	2015-07-22 19:10:34 +0000
+++ _integration-tests/tests/rollback_test.go	2015-07-22 19:10:34 +0000
@@ -22,7 +22,7 @@
 import (
 	"strconv"
 
-	. "launchpad.net/snappy/_integration-tests/common"
+	. "launchpad.net/snappy/_integration-tests/helpers/common"
 
 	check "gopkg.in/check.v1"
 )

=== modified file '_integration-tests/tests/search_test.go'
--- _integration-tests/tests/search_test.go	2015-07-22 19:10:34 +0000
+++ _integration-tests/tests/search_test.go	2015-07-22 19:10:34 +0000
@@ -20,7 +20,7 @@
 package tests
 
 import (
-	. "launchpad.net/snappy/_integration-tests/common"
+	. "launchpad.net/snappy/_integration-tests/helpers/common"
 
 	. "gopkg.in/check.v1"
 )

=== modified file '_integration-tests/tests/update_test.go'
--- _integration-tests/tests/update_test.go	2015-07-22 19:10:34 +0000
+++ _integration-tests/tests/update_test.go	2015-07-22 19:10:34 +0000
@@ -20,7 +20,7 @@
 package tests
 
 import (
-	. "launchpad.net/snappy/_integration-tests/common"
+	. "launchpad.net/snappy/_integration-tests/helpers/common"
 
 	check "gopkg.in/check.v1"
 )

=== modified file '_integration-tests/tests/writablePaths_test.go'
--- _integration-tests/tests/writablePaths_test.go	2015-07-22 19:10:34 +0000
+++ _integration-tests/tests/writablePaths_test.go	2015-07-22 19:10:34 +0000
@@ -27,7 +27,7 @@
 	"path/filepath"
 	"strings"
 
-	. "launchpad.net/snappy/_integration-tests/common"
+	. "launchpad.net/snappy/_integration-tests/helpers/common"
 
 	check "gopkg.in/check.v1"
 )

=== modified file 'run-checks'
--- run-checks	2015-07-22 19:10:34 +0000
+++ run-checks	2015-07-22 19:10:34 +0000
@@ -1,5 +1,5 @@
 #!/bin/sh
-
+1;3803;0c
 set -ev
 
 if which goctest >/dev/null; then
@@ -46,10 +46,11 @@
 echo Running vet
 go vet ./...
 go vet ./_integration-tests/tests/...
+go vet ./_integration-tests/helpers/...
 
 # golint
 echo Running lint
-lint=$(golint ./... && golint ./_integration-tests/tests/...)
+lint=$(golint ./... && golint ./_integration-tests/helpers/... && golint ./_integration-tests/tests/...)
 if [ -n "$lint" ]; then
     echo "Lint complains:"
     echo $lint
@@ -72,7 +73,7 @@
 
 # the rabbit hole
 echo Running the tests for the integration helpers
-$goctest -v -cover ./_integration-tests/common/...
+$goctest -v -cover ./_integration-tests/helpers/...
 
 # integration suite in kvm
 if which adt-run >/dev/null 2>&1; then