snap: implement new snap reboot command

cmd/snap/cmd_help.go

@@ -216,7 +216,7 @@ var helpCategories = []helpCategory{
 	}, {
 		Label:       i18n.G("Other"),
 		Description: i18n.G("miscellanea"),
-		Commands:    []string{"version", "warnings", "okay", "ack", "known", "model", "create-cohort", "recovery"},
+		Commands:    []string{"version", "warnings", "okay", "ack", "known", "model", "create-cohort", "recovery", "reboot"},
 	}, {
 		Label:       i18n.G("Development"),
 		Description: i18n.G("developer-oriented features"),

cmd/snap/cmd_reboot.go

@@ -0,0 +1,119 @@
+// -*- Mode: Go; indent-tabs-mode: t -*-
+
+/*
+ * Copyright (C) 2020 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 main
+
+import (
+	"fmt"
+
+	"github.com/jessevdk/go-flags"
+
+	"github.com/snapcore/snapd/i18n"
+)
+
+type cmdReboot struct {
+	clientMixin
+	Positional struct {
+		Label string
+	} `positional-args:"true"`
+
+	RunMode     bool `long:"run"`
+	InstallMode bool `long:"install"`
+	RecoverMode bool `long:"recover"`
+}
+
+var shortRebootHelp = i18n.G("Reboot into selected system and mode")
+var longRebootHelp = i18n.G(`
+The reboot command reboots the system into a particular mode of the selected
+recovery system.
+`)
+
+func init() {
+	addCommand("reboot", shortRebootHelp, longRebootHelp, func() flags.Commander {
+		return &cmdReboot{}
+	}, map[string]string{
+		// TRANSLATORS: This should not start with a lowercase letter.
+		"run": i18n.G("Boot into run mode"),
+		// TRANSLATORS: This should not start with a lowercase letter.
+		"install": i18n.G("Boot into install mode"),
+		// TRANSLATORS: This should not start with a lowercase letter.
+		"recover": i18n.G("Boot into recover mode"),
+	}, []argDesc{
+		{
+			// TRANSLATORS: This needs to begin with < and end with >
+			name: i18n.G("<label>"),
+			// TRANSLATORS: This should not start with a lowercase letter.
+			desc: i18n.G("The recovery system label"),
+		},
+	})
+}
+
+func (x *cmdReboot) modeFromCommandline() (string, error) {
+	var mode string
+
+	for _, arg := range []struct {
+		enabled bool
+		mode    string
+	}{
+		{x.RunMode, "run"},
+		{x.RecoverMode, "recover"},
+		{x.InstallMode, "install"},
+	} {
+		if !arg.enabled {
+			continue
+		}
+		if mode != "" {
+			return "", fmt.Errorf("Please specify a single mode")
+		}
+		mode = arg.mode
+	}
+
+	return mode, nil
+}
+
+func (x *cmdReboot) Execute(args []string) error {
+	if len(args) > 0 {
+		return ErrExtraArgs
+	}
+
+	mode, err := x.modeFromCommandline()
+	if err != nil {
+		return err
+	}
+
+	if err := x.client.DoSystemReboot(x.Positional.Label, mode); err != nil {
+		if x.Positional.Label != "" {
+			return fmt.Errorf("cannot reboot into system %q: %v", x.Positional.Label, err)
+		}
+		return fmt.Errorf("cannot reboot: %v", err)
+	}
+
+	switch {
+	case x.Positional.Label != "" && mode != "":
+		fmt.Fprintf(Stdout, "Reboot into %q %q mode.\n", x.Positional.Label, mode)
+	case x.Positional.Label != "":
+		fmt.Fprintf(Stdout, "Reboot into %q.\n", x.Positional.Label)
+	case mode != "":
+		fmt.Fprintf(Stdout, "Reboot into %q mode.\n", mode)
+	default:
+		fmt.Fprintf(Stdout, "Reboot\n")
+	}
+
+	return nil
+}

cmd/snap/cmd_reboot_test.go

@@ -0,0 +1,159 @@
+// -*- Mode: Go; indent-tabs-mode: t -*-
+
+/*
+ * Copyright (C) 2020 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 main_test
+
+import (
+	"fmt"
+	"io/ioutil"
+	"net/http"
+	"strings"
+
+	. "gopkg.in/check.v1"
+
+	snap "github.com/snapcore/snapd/cmd/snap"
+)
+
+func (s *SnapSuite) TestRebootHelp(c *C) {
+	msg := `Usage:
+  snap.test reboot [reboot-OPTIONS] [<label>]
+
+The reboot command reboots the system into a particular mode of the selected
+recovery system.
+
+[reboot command options]
+      --run        Boot into run mode
+      --install    Boot into install mode
+      --recover    Boot into recover mode
+
+[reboot command arguments]
+  <label>:         The recovery system label
+`
+	s.testSubCommandHelp(c, "reboot", msg)
+}
+
+func (s *SnapSuite) TestRebootHappy(c *C) {
+
+	for _, tc := range []struct {
+		cmdline          []string
+		expectedEndpoint string
+		expectedJSON     string
+		expectedMsg      string
+	}{
+		{
+			cmdline:          []string{"reboot"},
+			expectedEndpoint: "/v2/systems",
+			expectedJSON:     `{"action":"reboot","mode":""}`,
+			expectedMsg:      `Reboot`,
+		},
+		{
+			cmdline:          []string{"reboot", "--recover"},
+			expectedEndpoint: "/v2/systems",
+			expectedJSON:     `{"action":"reboot","mode":"recover"}`,
+			expectedMsg:      `Reboot into "recover" mode.`,
+		},
+		{
+			cmdline:          []string{"reboot", "20200101"},
+			expectedEndpoint: "/v2/systems/20200101",
+			expectedJSON:     `{"action":"reboot","mode":""}`,
+			expectedMsg:      `Reboot into "20200101".`,
+		},
+		{
+			cmdline:          []string{"reboot", "--recover", "20200101"},
+			expectedEndpoint: "/v2/systems/20200101",
+			expectedJSON:     `{"action":"reboot","mode":"recover"}`,
+			expectedMsg:      `Reboot into "20200101" "recover" mode.`,
+		},
+	} {
+
+		n := 0
+		s.ResetStdStreams()
+
+		s.RedirectClientToTestServer(func(w http.ResponseWriter, r *http.Request) {
+			switch n {
+			case 0:
+				c.Check(r.Method, Equals, "POST")
+				c.Check(r.URL.Path, Equals, tc.expectedEndpoint, Commentf("%v", tc.cmdline))
+				c.Check(r.URL.RawQuery, Equals, "")
+				body, err := ioutil.ReadAll(r.Body)
+				c.Check(err, IsNil)
+				c.Check(string(body), Equals, tc.expectedJSON+"\n")
+				fmt.Fprintln(w, `{"type": "sync", "result": {}}`)
+			default:
+				c.Fatalf("expected to get 1 requests, now on %d", n+1)
+			}
+
+			n++
+		})
+
+		// The server side will work out if the request is valid
+		rest, err := snap.Parser(snap.Client()).ParseArgs(tc.cmdline)
+		c.Assert(err, IsNil)
+		c.Assert(rest, DeepEquals, []string{})
+		c.Check(s.Stdout(), Equals, tc.expectedMsg+"\n", Commentf("%v", tc.cmdline))
+		c.Check(s.Stderr(), Equals, "")
+	}
+}
+
+func (s *SnapSuite) TestRebootUnhappy(c *C) {
+	s.RedirectClientToTestServer(func(w http.ResponseWriter, r *http.Request) {
+		c.Fatalf("server should not be hit in this test")
+	})
+
+	var tc = []struct {
+		args   []string
+		errStr string
+	}{
+		{
+			args:   []string{"reboot", "--run", "--recover", "20200101"},
+			errStr: "Please specify a single mode",
+		},
+		{
+			args:   []string{"reboot", "--unknown-mode", "20200101"},
+			errStr: "unknown flag `unknown-mode'",
+		},
+	}
+
+	for _, t := range tc {
+		_, err := snap.Parser(snap.Client()).ParseArgs(t.args)
+		c.Check(err, ErrorMatches, t.errStr, Commentf(strings.Join(t.args, " ")))
+	}
+}
+
+func (s *SnapSuite) TestRebootAPIFail(c *C) {
+	n := 0
+	s.RedirectClientToTestServer(func(w http.ResponseWriter, r *http.Request) {
+		switch n {
+		case 0:
+			c.Check(r.Method, Equals, "POST")
+			c.Check(r.URL.Path, Equals, "/v2/systems/20200101")
+			c.Check(r.URL.RawQuery, Equals, "")
+			w.WriteHeader(404)
+			fmt.Fprintln(w, `{"type": "error", "status-code":404, "result": {"message":"requested system does not exist"}}`)
+		default:
+			c.Fatalf("expected to get 1 requests, now on %d", n+1)
+		}
+
+		n++
+	})
+	_, err := snap.Parser(snap.Client()).ParseArgs([]string{"reboot", "--recover", "20200101"})
+	c.Assert(err, ErrorMatches, `cannot reboot into system "20200101": cannot request system action: requested system does not exist`)
+	c.Check(s.Stdout(), Equals, "")
+	c.Check(s.Stderr(), Equals, "")
+}

tests/core/uc20-recovery/task.yaml

@@ -29,12 +29,9 @@ execute: |
         # with spread
         mount -o bind "$PWD/mock-shutdown" /usr/sbin/shutdown
 
-        # request a recovery mode
+        # reboot to recovery mode
         echo "Request rebooting into recovery mode"
-        # response contains maintenance: {"maintenance":{"message":"system is restarting","kind":"system-restart"}}
-        test-snapd-curl.curl -X POST --data '{"action":"do","mode":"recover"}' \
-            -s --unix-socket /run/snapd.socket "http://localhost/v2/systems/$label" | \
-            MATCH '"system-restart"'
+        snap reboot --recover "$label" | MATCH 'Reboot into ".*" "recover" mode'
 
         # snapd schedules a slow timeout and an immediate one, however it is
         # scheduled asynchronously, try keep the check simple
@@ -146,9 +143,7 @@ execute: |
         mount -o bind "$PWD/mock-shutdown" /usr/sbin/shutdown
 
         # request going back to run mode
-        test-snapd-curl.curl -X POST --data '{"action":"do","mode":"run"}' \
-            -s --unix-socket /run/snapd.socket "http://localhost/v2/systems/$label" | \
-            MATCH '"system-restart"'
+        snap reboot --run "$label" | MATCH 'Reboot into ".*" "run" mode."
         # XXX: is this a race between spread seeing REBOOT and machine rebooting?
 
         # see earlier note about shutdown