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

[Leo Arias]

Extract the integration adt-run helpers to a package.

[Federico Gimenez (fgimenez)]

Very nice main.go! :D

Instead of having a single AdtRun method and passing to it the results of calling other public methods of the same package I would leave it as a private adtRun and expose an AdtRunRemote, which takes an ip and a port as its last arguments, and a AdtRunLocal with an imagePath parameter.

Maybe we could also design a type for gathering the common options of both methods, what do you think?

Thanks!

[Federico Gimenez (fgimenez)]

Or maybe create a type with fields for the common options and pass them to the constructor, this would be cleaner IMO, let me know what do you think

[lp:~elopio/snappy/extract_integration_adt-run]

617. By Leo Arias on 2015-07-28

Merged with prerequisite.

618. By Leo Arias on 2015-07-28

Refactored as suggested by fgimenez.

[Leo Arias (elopio)]

Federico, please check it again. I've pushed most things to autopkgtest.go, but didn't introduce any type.

I'm not quite convinced about rootPath and baseDir, basically because the name says the same but they are totally different. I'll think of a better name for each, and for a better name for both in a type. I'm about to leave, so if you are happy with this as a first step, please top-approve. And if you have the change you want in mind, please make an MP.

Thanks for the review!

[Federico Gimenez (fgimenez)]

Ok, thanks, i'll propose another branch for us to discuss how to structure this

review: Approve

=== added directory '_integration-tests/helpers/autopkgtest'
=== added file '_integration-tests/helpers/autopkgtest/autopkgtest.go'
--- _integration-tests/helpers/autopkgtest/autopkgtest.go	1970-01-01 00:00:00 +0000
+++ _integration-tests/helpers/autopkgtest/autopkgtest.go	2015-07-28 12:22:11 +0000
@@ -0,0 +1,99 @@
+// -*- Mode: Go; indent-tabs-mode: t -*-
+
+/*
+ * Copyright (C) 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 autopkgtest
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"strconv"
+	"text/template"
+
+	"log"
+
+	"launchpad.net/snappy/_integration-tests/helpers/build"
+	"launchpad.net/snappy/_integration-tests/helpers/image"
+	"launchpad.net/snappy/_integration-tests/helpers/utils"
+)
+
+const (
+	controlTpl    = "_integration-tests/data/tpl/control"
+	dataOutputDir = "_integration-tests/data/output/"
+)
+
+var controlFile = filepath.Join(dataOutputDir, "control")
+
+// AdtRunLocal starts a kvm running the image passed as argument and runs the
+// autopkgtests using it as the testbed.
+func AdtRunLocal(rootPath, baseDir, testFilter string, img image.Image) {
+	// Run the tests on the latest rolling edge image.
+	if imagePath, err := img.UdfCreate(); err == nil {
+		adtRun(rootPath, baseDir, testFilter, kvmSSHOptions(imagePath))
+	}
+}
+
+// AdtRunRemote runs the autopkgtests using a remote machine as the testbed.
+func AdtRunRemote(rootPath, baseDir, testFilter, testbedIP string, testbedPort int) {
+	utils.ExecCommand("ssh-copy-id", "-p", strconv.Itoa(testbedPort),
+		"ubuntu@"+testbedIP)
+	adtRun(
+		rootPath, baseDir, testFilter, remoteTestbedSSHOptions(testbedIP, testbedPort))
+}
+
+func adtRun(rootPath, baseDir, testFilter string, testbedOptions []string) {
+	createControlFile(testFilter)
+
+	fmt.Println("Calling adt-run...")
+	outputDir := filepath.Join(baseDir, "output")
+	utils.PrepareTargetDir(outputDir)
+
+	cmd := []string{
+		"adt-run", "-B",
+		"--setup-commands", "touch /run/autopkgtest_no_reboot.stamp",
+		"--override-control", controlFile,
+		"--built-tree", rootPath,
+		"--output-dir", outputDir}
+
+	utils.ExecCommand(append(cmd, testbedOptions...)...)
+}
+
+func createControlFile(testFilter string) {
+	type controlData struct {
+		Filter string
+		Test   string
+	}
+
+	tpl, err := template.ParseFiles(controlTpl)
+	if err != nil {
+		log.Panicf("Error reading adt-run control template %s", controlTpl)
+	}
+
+	outputFile, err := os.Create(controlFile)
+	if err != nil {
+		log.Panicf("Error creating control file %s", controlFile)
+	}
+	defer outputFile.Close()
+
+	err = tpl.Execute(outputFile,
+		controlData{Test: build.IntegrationTestName, Filter: testFilter})
+	if err != nil {
+		log.Panicf("execution: %s", err)
+	}
+}

=== added file '_integration-tests/helpers/autopkgtest/ssh.go'
--- _integration-tests/helpers/autopkgtest/ssh.go	1970-01-01 00:00:00 +0000
+++ _integration-tests/helpers/autopkgtest/ssh.go	2015-07-28 12:22:11 +0000
@@ -0,0 +1,46 @@
+// -*- Mode: Go; indent-tabs-mode: t -*-
+
+/*
+ * Copyright (C) 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 autopkgtest
+
+import (
+	"os"
+	"path/filepath"
+	"strconv"
+)
+
+var commonSSHOptions = []string{"---", "ssh"}
+
+func kvmSSHOptions(imagePath string) []string {
+	return append(
+		commonSSHOptions,
+		[]string{
+			"-s", "/usr/share/autopkgtest/ssh-setup/snappy",
+			"--", "-i", imagePath}...)
+}
+
+func remoteTestbedSSHOptions(testbedIP string, testbedPort int) []string {
+	options := []string{
+		"-H", testbedIP,
+		"-p", strconv.Itoa(testbedPort),
+		"-l", "ubuntu",
+		"-i", filepath.Join(os.Getenv("HOME"), ".ssh", "id_rsa"),
+		"--reboot"}
+	return append(commonSSHOptions, options...)
+}

=== modified file '_integration-tests/helpers/utils/utils.go'
--- _integration-tests/helpers/utils/utils.go	2015-07-28 12:05:11 +0000
+++ _integration-tests/helpers/utils/utils.go	2015-07-28 12:22:11 +0000
@@ -36,6 +36,15 @@
 	os.MkdirAll(targetDir, 0777)
 }
 
+// RootPath return the test current working directory.
+func RootPath() string {
+	dir, err := os.Getwd()
+	if err != nil {
+		log.Panic(err)
+	}
+	return dir
+}
+
 // ExecCommand executes the given command and pipes the results to os.Stdout and os.Stderr, returning the resulting error
 func ExecCommand(cmds ...string) error {
 	fmt.Println(strings.Join(cmds, " "))

=== modified file '_integration-tests/main.go'
--- _integration-tests/main.go	2015-07-27 18:36:32 +0000
+++ _integration-tests/main.go	2015-07-28 12:22:11 +0000
@@ -21,13 +21,11 @@
 
 import (
 	"flag"
-	"fmt"
-	"log"
 	"os"
 	"path/filepath"
 	"strconv"
-	"text/template"
 
+	"launchpad.net/snappy/_integration-tests/helpers/autopkgtest"
 	"launchpad.net/snappy/_integration-tests/helpers/build"
 	"launchpad.net/snappy/_integration-tests/helpers/config"
 	"launchpad.net/snappy/_integration-tests/helpers/image"
@@ -40,94 +38,9 @@
 	defaultChannel = "edge"
 	defaultSSHPort = 22
 	dataOutputDir  = "_integration-tests/data/output/"
-	controlTpl     = "_integration-tests/data/tpl/control"
-)
-
-var (
-	commonSSHOptions = []string{"---", "ssh"}
-	configFileName   = filepath.Join(dataOutputDir, "testconfig.json")
-	controlFile      = filepath.Join(dataOutputDir, "control")
-)
-
-func setupAndRunLocalTests(rootPath, testFilter string, img image.Image) {
-	// Run the tests on the latest rolling edge image.
-	if imageName, err := img.UdfCreate(); err == nil {
-		adtRun(rootPath, testFilter, kvmSSHOptions(imageName))
-	}
-}
-
-func setupAndRunRemoteTests(rootPath, testFilter, testbedIP string, testbedPort int) {
-	utils.ExecCommand("ssh-copy-id", "-p", strconv.Itoa(testbedPort),
-		"ubuntu@"+testbedIP)
-	adtRun(rootPath, testFilter, remoteTestbedSSHOptions(testbedIP, testbedPort))
-}
-
-func adtRun(rootPath, testFilter string, testbedOptions []string) {
-	createControlFile(testFilter)
-
-	fmt.Println("Calling adt-run...")
-	outputDir := filepath.Join(baseDir, "output")
-	utils.PrepareTargetDir(outputDir)
-
-	cmd := []string{
-		"adt-run", "-B",
-		"--setup-commands", "touch /run/autopkgtest_no_reboot.stamp",
-		"--override-control", controlFile,
-		"--built-tree", rootPath,
-		"--output-dir", outputDir}
-
-	utils.ExecCommand(append(cmd, testbedOptions...)...)
-}
-
-func kvmSSHOptions(imagePath string) []string {
-	return append(
-		commonSSHOptions,
-		[]string{
-			"-s", "/usr/share/autopkgtest/ssh-setup/snappy",
-			"--", "-i", imagePath}...)
-}
-
-func createControlFile(testFilter string) {
-	type controlData struct {
-		Filter string
-		Test   string
-	}
-
-	tpl, err := template.ParseFiles(controlTpl)
-	if err != nil {
-		log.Panicf("Error reading adt-run control template %s", controlTpl)
-	}
-
-	outputFile, err := os.Create(controlFile)
-	if err != nil {
-		log.Panicf("Error creating control file %s", controlFile)
-	}
-	defer outputFile.Close()
-
-	err = tpl.Execute(outputFile,
-		controlData{Test: build.IntegrationTestName, Filter: testFilter})
-	if err != nil {
-		log.Panicf("execution: %s", err)
-	}
-}
-
-func remoteTestbedSSHOptions(testbedIP string, testbedPort int) []string {
-	options := []string{
-		"-H", testbedIP,
-		"-p", strconv.Itoa(testbedPort),
-		"-l", "ubuntu",
-		"-i", filepath.Join(os.Getenv("HOME"), ".ssh", "id_rsa"),
-		"--reboot"}
-	return append(commonSSHOptions, options...)
-}
-
-func getRootPath() string {
-	dir, err := os.Getwd()
-	if err != nil {
-		log.Panic(err)
-	}
-	return dir
-}
+)
+
+var configFileName = filepath.Join(dataOutputDir, "testconfig.json")
 
 func main() {
 	var (
@@ -172,13 +85,12 @@
 		*update, *rollback)
 	cfg.Write()
 
-	rootPath := getRootPath()
+	rootPath := utils.RootPath()
 
 	if *testbedIP == "" {
 		img := image.NewImage(*imgRelease, *imgChannel, *imgRevision, baseDir)
-		setupAndRunLocalTests(rootPath, *testFilter, *img)
-
+		autopkgtest.AdtRunLocal(rootPath, baseDir, *testFilter, *img)
 	} else {
-		setupAndRunRemoteTests(rootPath, *testFilter, *testbedIP, *testbedPort)
+		autopkgtest.AdtRunRemote(rootPath, baseDir, *testFilter, *testbedIP, *testbedPort)
 	}
 }