Add boot-firmware command

cmd/pebble/cmd_boot_firmware.go

@@ -0,0 +1,128 @@
+// Copyright (c) 2022 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"
+	"os"
+	"syscall"
+	"time"
+
+	"github.com/jessevdk/go-flags"
+
+	"github.com/canonical/pebble/client"
+	. "github.com/canonical/pebble/cmd"
+	"github.com/canonical/pebble/internal/boot"
+	"github.com/canonical/pebble/internal/daemon"
+	"github.com/canonical/pebble/internal/logger"
+	"github.com/canonical/pebble/internal/plan"
+)
+
+type cmdBootFirmware struct {
+	clientMixin
+
+	Force   bool `long:"force"`
+	Verbose bool `short:"v" long:"verbose"`
+}
+
+var bootFirmwareDescs = map[string]string{
+	"force":   `Skip all checks`,
+	"verbose": `Log all output from services to stdout`,
+}
+
+var shortBootFirmwareHelp = `Bootstrap a system with Pebble running as PID 1`
+
+var longBootFirmwareHelp = `
+The boot-firmware command performs checks on the running system, prepares the
+environment to get a working system and starts the Pebble daemon.
+`
+
+func (cmd *cmdBootFirmware) Execute(args []string) error {
+	if len(args) > 1 {
+		return ErrExtraArgs
+	}
+
+	if !cmd.Force {
+		if err := boot.CheckBootstrap(); err != nil {
+			return err
+		}
+	}
+
+	if err := boot.Bootstrap(); err != nil {
+		return err
+	}
+
+	t0 := time.Now().Truncate(time.Millisecond)
+
+	pebbleDir, socketPath := getEnvPaths()
+	if err := os.MkdirAll(pebbleDir, 0755); err != nil {
+		return err
+	}
+	if _, err := plan.ReadDir(pebbleDir); err != nil {
+		return err
+	}
+
+	dopts := daemon.Options{
+		Dir:        pebbleDir,
+		SocketPath: socketPath,
+	}
+	if cmd.Verbose {
+		dopts.ServiceOutput = os.Stdout
+	}
+
+	d, err := daemon.New(&dopts)
+	if err != nil {
+		return err
+	}
+	if err := d.Init(); err != nil {
+		return err
+	}
+
+	d.Version = Version
+	d.Start()
+
+	logger.Debugf("activation done in %v", time.Now().Truncate(time.Millisecond).Sub(t0))
+
+	servopts := client.ServiceOptions{}
+	changeID, err := cmd.client.AutoStart(&servopts)
+	if err != nil {
+		logger.Noticef("Cannot start default services: %v", err)
+	} else {
+		logger.Noticef("Started default services with change %s.", changeID)
+	}
+
+out:
+	for {
+		select {
+		case <-d.Dying():
+			logger.Noticef("Server exiting!")
+			break out
+		}
+	}
+
+	cmd.client.CloseIdleConnections()
+	if err := d.Stop(nil); err != nil {
+		return err
+	}
+
+	if err := syscall.Reboot(syscall.LINUX_REBOOT_CMD_RESTART); err != nil {
+		return fmt.Errorf("cannot reboot: %w", err)
+	}
+	return nil
+}
+
+func init() {
+	addCommand("boot-firmware", shortBootFirmwareHelp, longBootFirmwareHelp, func() flags.Commander { return &cmdBootFirmware{} }, bootFirmwareDescs, nil)
+}

cmd/pebble/cmd_boot_firmware_common_test.go

@@ -0,0 +1,48 @@
+//go:build !termus
+// +build !termus
+
+// Copyright (c) 2023 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 (
+	. "gopkg.in/check.v1"
+
+	pebble "github.com/canonical/pebble/cmd/pebble"
+)
+
+func (s *PebbleSuite) TestBootFirmwareExtraArgs(c *C) {
+	rest, err := pebble.Parser(pebble.Client()).ParseArgs([]string{"boot-firmware", "extra", "args"})
+	c.Assert(err, Equals, pebble.ErrExtraArgs)
+	c.Assert(rest, HasLen, 1)
+	c.Check(s.Stdout(), Equals, "")
+	c.Check(s.Stderr(), Equals, "")
+}
+
+func (s *PebbleSuite) TestBootFirmware(c *C) {
+	rest, err := pebble.Parser(pebble.Client()).ParseArgs([]string{"boot-firmware"})
+	c.Assert(err, ErrorMatches, "cannot bootstrap an unsupported platform")
+	c.Assert(rest, HasLen, 1)
+	c.Check(s.Stdout(), Equals, "")
+	c.Check(s.Stderr(), Equals, "")
+}
+
+func (s *PebbleSuite) TestBootFirmwareForce(c *C) {
+	rest, err := pebble.Parser(pebble.Client()).ParseArgs([]string{"boot-firmware", "--force"})
+	c.Assert(err, ErrorMatches, "cannot bootstrap an unsupported platform")
+	c.Assert(rest, HasLen, 1)
+	c.Check(s.Stdout(), Equals, "")
+	c.Check(s.Stderr(), Equals, "")
+}

cmd/pebble/cmd_boot_firmware_termus_test.go

@@ -0,0 +1,40 @@
+//go:build termus
+// +build termus
+
+// Copyright (c) 2023 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 (
+	. "gopkg.in/check.v1"
+
+	pebble "github.com/canonical/pebble/cmd/pebble"
+)
+
+func (s *PebbleSuite) TestBootFirmwareExtraArgs(c *C) {
+	rest, err := pebble.Parser(pebble.Client()).ParseArgs([]string{"boot-firmware", "extra", "args"})
+	c.Assert(err, Equals, pebble.ErrExtraArgs)
+	c.Assert(rest, HasLen, 1)
+	c.Check(s.Stdout(), Equals, "")
+	c.Check(s.Stderr(), Equals, "")
+}
+
+func (s *PebbleSuite) TestBootFirmware(c *C) {
+	rest, err := pebble.Parser(pebble.Client()).ParseArgs([]string{"boot-firmware"})
+	c.Assert(err, ErrorMatches, "must run as PID 1. Use --force to suppress this check")
+	c.Assert(rest, HasLen, 1)
+	c.Check(s.Stdout(), Equals, "")
+	c.Check(s.Stderr(), Equals, "")
+}

cmd/pebble/defaults_common.go

@@ -0,0 +1,23 @@
+//go:build !termus
+// +build !termus
+
+// Copyright (c) 2022 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
+
+// defaultPebbleDir is the Pebble directory used if $PEBBLE is not set. It is
+// created by the daemon ("pebble run") if it doesn't exist, and also used by
+// the pebble client.
+const defaultPebbleDir = "/var/lib/pebble/default"

cmd/pebble/defaults_termus.go

@@ -0,0 +1,23 @@
+//go:build termus
+// +build termus
+
+// Copyright (c) 2022 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
+
+// defaultPebbleDir is the Pebble directory used if $PEBBLE is not set. It is
+// created by the daemon ("pebble run") if it doesn't exist, and also used by
+// the pebble client.
+const defaultPebbleDir = "/termus/var/lib/pebble"

cmd/pebble/main.go

@@ -30,6 +30,7 @@ import (
 	"golang.org/x/crypto/ssh/terminal"
 
 	"github.com/canonical/pebble/client"
+	"github.com/canonical/pebble/internal/boot"
 	"github.com/canonical/pebble/internal/logger"
 )
 
@@ -44,11 +45,6 @@ var (
 	noticef = logger.Noticef
 )
 
-// defaultPebbleDir is the Pebble directory used if $PEBBLE is not set. It is
-// created by the daemon ("pebble run") if it doesn't exist, and also used by
-// the pebble client.
-const defaultPebbleDir = "/var/lib/pebble/default"
-
 type options struct {
 	Version func() `long:"version"`
 }
@@ -348,8 +344,15 @@ func run() error {
 		return fmt.Errorf("cannot create client: %v", err)
 	}
 
+	var xtra []string
 	parser := Parser(cli)
-	xtra, err := parser.Parse()
+	if err2 := boot.CheckBootstrap(); err2 == nil {
+		args := append([]string{"boot-firmware"}, os.Args[1:]...)
+		xtra, err = parser.ParseArgs(args)
+	} else {
+		xtra, err = parser.Parse()
+	}
+
 	if err != nil {
 		if e, ok := err.(*flags.Error); ok {
 			switch e.Type {

cmd/pebble/main_common_test.go

@@ -0,0 +1,45 @@
+//go:build !termus
+// +build !termus
+
+// Copyright (c) 2023 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 (
+	"os"
+
+	. "gopkg.in/check.v1"
+
+	pebble "github.com/canonical/pebble/cmd/pebble"
+)
+
+func (s *PebbleSuite) TestGetEnvPaths(c *C) {
+	os.Setenv("PEBBLE", "")
+	os.Setenv("PEBBLE_SOCKET", "")
+	pebbleDir, socketPath := pebble.GetEnvPaths()
+	c.Assert(pebbleDir, Equals, "/var/lib/pebble/default")
+	c.Assert(socketPath, Equals, "/var/lib/pebble/default/.pebble.socket")
+
+	os.Setenv("PEBBLE", "/foo")
+	pebbleDir, socketPath = pebble.GetEnvPaths()
+	c.Assert(pebbleDir, Equals, "/foo")
+	c.Assert(socketPath, Equals, "/foo/.pebble.socket")
+
+	os.Setenv("PEBBLE", "/bar")
+	os.Setenv("PEBBLE_SOCKET", "/path/to/socket")
+	pebbleDir, socketPath = pebble.GetEnvPaths()
+	c.Assert(pebbleDir, Equals, "/bar")
+	c.Assert(socketPath, Equals, "/path/to/socket")
+}

cmd/pebble/main_termus_test.go

@@ -0,0 +1,45 @@
+//go:build termus
+// +build termus
+
+// Copyright (c) 2023 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 (
+	"os"
+
+	. "gopkg.in/check.v1"
+
+	pebble "github.com/canonical/pebble/cmd/pebble"
+)
+
+func (s *PebbleSuite) TestGetEnvPaths(c *C) {
+	os.Setenv("PEBBLE", "")
+	os.Setenv("PEBBLE_SOCKET", "")
+	pebbleDir, socketPath := pebble.GetEnvPaths()
+	c.Assert(pebbleDir, Equals, "/termus/var/lib/pebble")
+	c.Assert(socketPath, Equals, "/termus/var/lib/pebble/.pebble.socket")
+
+	os.Setenv("PEBBLE", "/foo")
+	pebbleDir, socketPath = pebble.GetEnvPaths()
+	c.Assert(pebbleDir, Equals, "/foo")
+	c.Assert(socketPath, Equals, "/foo/.pebble.socket")
+
+	os.Setenv("PEBBLE", "/bar")
+	os.Setenv("PEBBLE_SOCKET", "/path/to/socket")
+	pebbleDir, socketPath = pebble.GetEnvPaths()
+	c.Assert(pebbleDir, Equals, "/bar")
+	c.Assert(socketPath, Equals, "/path/to/socket")
+}