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

[Leo Arias]

Added a suite for testing the examples.

This branch is a request for comments. What I want to do is move as many tests that use examples to the examples_test.go. And use local snaps for the other tests. For example, in order to test that the info command works, we don't need to install anything from the store. This will better split the fast and slow tests, the errors due to the store or the examples will be in a single suite, and the data dir will contain just the things needed for most of the tests, no more and no less.

[Sergio Schvezov (sergiusens)]

On Thu, Oct 8, 2015 at 3:56 AM, Leo Arias <email address hidden> wrote:

> The proposal to merge lp:~elopio/snappy/examples1 into lp:snappy has been
> updated.
>
> Description changed to:
>
> This branch is a request for comments. What I want to do is move as many
> tests that use examples to the examples_test.go. And use local snaps for
> the other tests. For example, in order to test that the info command works,
> we don't need to install anything from the store. This will better split
> the fast and slow tests, the errors due to the store or the examples will
> be in a single suite, and the data dir will contain just the things needed
> for most of the tests, no more and no less.
>

The only gotcha is sideloading attributes, signed by store snaps are not
sideloaded ones while unsinged ones are.

[Leo Arias (elopio)]

We'll test things from the store too. First, as a side-effect of the examples suite, but we also need a store suite, to test things that are different when things come from the store.

[Federico Gimenez (fgimenez)]

LGTM, thanks :)

review: Approve

[Snappy Tarmac (snappydevtarmac)]

The attempt to merge lp:~elopio/snappy/examples1 into lp:snappy failed. Below is the output from the failed tests.

Checking docs
Checking formatting
Formatting wrong in following files
_integration-tests/tests/examples_test.go

Crushing failure and despair.

# we always run in a fresh dir in tarmac
export GOPATH=$(mktemp -d)
trap 'rm -rf "$GOPATH"' EXIT

# this is a hack, but not sure tarmac is golang friendly
mkdir -p $GOPATH/src/launchpad.net/snappy
cp -a . $GOPATH/src/launchpad.net/snappy/
cd $GOPATH/src/launchpad.net/snappy

sh -v ./run-checks
#!/bin/sh

set -eu

if which goctest >/dev/null; then
    goctest="goctest"
else
    goctest="go test"
fi

QUICK=""
if [ "${1:-}" = "--quick" ]; then
    QUICK=yes
fi

endmsg() {
    if [ $? -eq 0 ]; then
        p="success.txt"
        m="All good, what could possibly go wrong."
    else
        p="failure.txt"
        m="Crushing failure and despair."
    fi
    echo
    if [ -t 1 -a -z "$QUICK" ]; then
        cat "data/$p"
    else
        echo "$m"
    fi
}
trap endmsg EXIT

echo Checking docs
./mdlint.py docs/*.md

echo Checking formatting
fmt=$(gofmt -l .)

if [ -n "$fmt" ]; then
    echo "Formatting wrong in following files"
    echo "$fmt"
    exit 1
fi

[lp:~elopio/snappy/examples1]

754. By Leo Arias on 2015-10-09

Fixed fmt.

=== added file '_integration-tests/tests/examples_test.go'
--- _integration-tests/tests/examples_test.go	1970-01-01 00:00:00 +0000
+++ _integration-tests/tests/examples_test.go	2015-10-09 16:18:31 +0000
@@ -0,0 +1,72 @@
+// -*- 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 tests
+
+import (
+	"net/http"
+
+	"launchpad.net/snappy/_integration-tests/testutils/cli"
+	"launchpad.net/snappy/_integration-tests/testutils/common"
+	"launchpad.net/snappy/_integration-tests/testutils/wait"
+
+	"gopkg.in/check.v1"
+)
+
+var _ = check.Suite(&webserverExampleSuite{})
+
+type webserverExampleSuite struct {
+	common.SnappySuite
+}
+
+func (s *webserverExampleSuite) TestNetworkingServiceMustBeStarted(c *check.C) {
+	baseAppName := "xkcd-webserver"
+	appName := baseAppName + ".canonical"
+	common.InstallSnap(c, appName)
+	defer common.RemoveSnap(c, appName)
+
+	err := wait.ForServerOnPort(c, 80)
+	c.Assert(err, check.IsNil)
+
+	resp, err := http.Get("http://localhost")
+	c.Assert(err, check.IsNil)
+	c.Check(resp.Status, check.Equals, "200 OK")
+	c.Assert(resp.Proto, check.Equals, "HTTP/1.0")
+}
+
+var _ = check.Suite(&frameworkExampleSuite{})
+
+type frameworkExampleSuite struct {
+	common.SnappySuite
+}
+
+func (s *frameworkExampleSuite) TestFrameworkClient(c *check.C) {
+	common.InstallSnap(c, "hello-dbus-fwk.canonical")
+	defer common.RemoveSnap(c, "hello-dbus-fwk.canonical")
+
+	common.InstallSnap(c, "hello-dbus-app.canonical")
+	defer common.RemoveSnap(c, "hello-dbus-app.canonical")
+
+	output := cli.ExecCommand(c, "hello-dbus-app.client")
+
+	expected := "PASS\n"
+
+	c.Assert(output, check.Equals, expected,
+		check.Commentf("Expected output %s not found, %s", expected, output))
+}

=== modified file '_integration-tests/tests/info_test.go'
--- _integration-tests/tests/info_test.go	2015-09-30 11:27:49 +0000
+++ _integration-tests/tests/info_test.go	2015-10-09 16:18:31 +0000
@@ -21,7 +21,9 @@
 
 import (
 	"fmt"
+	"os"
 
+	"launchpad.net/snappy/_integration-tests/testutils/build"
 	"launchpad.net/snappy/_integration-tests/testutils/cli"
 	"launchpad.net/snappy/_integration-tests/testutils/common"
 
@@ -53,15 +55,17 @@
 }
 
 func (s *infoSuite) TestInfoMustPrintInstalledApps(c *check.C) {
-	common.InstallSnap(c, "hello-world")
-	s.AddCleanup(func() {
-		common.RemoveSnap(c, "hello-world")
-	})
+	snapPath, err := build.LocalSnap(c, build.BasicSnapName)
+	defer os.Remove(snapPath)
+	c.Assert(err, check.IsNil)
+	common.InstallSnap(c, snapPath)
+	defer common.RemoveSnap(c, build.BasicSnapName)
+
 	infoOutput := cli.ExecCommand(c, "snappy", "info")
 
 	expected := "(?ms)" +
 		".*" +
-		"^apps: .*hello-world.*\n"
+		"^apps: .*" + build.BasicSnapName + "\\.sideload.*\n"
 	c.Assert(infoOutput, check.Matches, expected)
 }
 

=== modified file '_integration-tests/tests/installApp_test.go'
--- _integration-tests/tests/installApp_test.go	2015-09-30 11:27:49 +0000
+++ _integration-tests/tests/installApp_test.go	2015-10-09 16:18:31 +0000
@@ -20,12 +20,10 @@
 package tests
 
 import (
-	"net/http"
 	"os/exec"
 
 	"launchpad.net/snappy/_integration-tests/testutils/cli"
 	"launchpad.net/snappy/_integration-tests/testutils/common"
-	"launchpad.net/snappy/_integration-tests/testutils/wait"
 
 	"gopkg.in/check.v1"
 )
@@ -84,35 +82,6 @@
 	c.Assert(string(echoOutput), check.Matches, expected)
 }
 
-func (s *installAppSuite) TestInfoMustPrintInstalledPackageInformation(c *check.C) {
-	common.InstallSnap(c, "hello-world")
-	s.AddCleanup(func() {
-		common.RemoveSnap(c, "hello-world")
-	})
-
-	infoOutput := cli.ExecCommand(c, "snappy", "info")
-
-	expected := "(?ms).*^apps: hello-world.canonical\n"
-	c.Assert(infoOutput, check.Matches, expected)
-}
-
-func (s *installAppSuite) TestAppNetworkingServiceMustBeStarted(c *check.C) {
-	baseAppName := "xkcd-webserver"
-	appName := baseAppName + ".canonical"
-	common.InstallSnap(c, appName)
-	s.AddCleanup(func() {
-		common.RemoveSnap(c, appName)
-	})
-
-	err := wait.ForServerOnPort(c, 80)
-	c.Assert(err, check.IsNil)
-
-	resp, err := http.Get("http://localhost")
-	c.Assert(err, check.IsNil)
-	c.Check(resp.Status, check.Equals, "200 OK")
-	c.Assert(resp.Proto, check.Equals, "HTTP/1.0")
-}
-
 func (s *installAppSuite) TestInstallUnexistingAppMustPrintError(c *check.C) {
 	cmd := exec.Command("sudo", "snappy", "install", "unexisting.canonical")
 	output, err := cmd.CombinedOutput()

=== modified file '_integration-tests/tests/installFramework_test.go'
--- _integration-tests/tests/installFramework_test.go	2015-10-08 05:47:08 +0000
+++ _integration-tests/tests/installFramework_test.go	2015-10-09 16:18:31 +0000
@@ -20,7 +20,6 @@
 package tests
 
 import (
-	"launchpad.net/snappy/_integration-tests/testutils/cli"
 	"launchpad.net/snappy/_integration-tests/testutils/common"
 
 	"gopkg.in/check.v1"
@@ -45,18 +44,3 @@
 
 	c.Assert(installOutput, check.Matches, expected)
 }
-
-func (s *installFrameworkSuite) TestFrameworkClient(c *check.C) {
-	common.InstallSnap(c, "hello-dbus-fwk.canonical")
-	defer common.RemoveSnap(c, "hello-dbus-fwk.canonical")
-
-	common.InstallSnap(c, "hello-dbus-app.canonical")
-	defer common.RemoveSnap(c, "hello-dbus-app.canonical")
-
-	output := cli.ExecCommand(c, "hello-dbus-app.client")
-
-	expected := "PASS\n"
-
-	c.Assert(output, check.Equals, expected,
-		check.Commentf("Expected output %s not found, %s", expected, output))
-}