install.go

// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * Copyright (C) 2024 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 ctlcmd

import (
	"fmt"

	"github.com/snapcore/snapd/i18n"
	"github.com/snapcore/snapd/snap"
	"github.com/snapcore/snapd/strutil"
)

var (
	shortInstallHelp = i18n.G("Install components")
	longInstallHelp  = i18n.G(`
The install command installs components.
`)
)

func init() {
	addCommand("install", shortInstallHelp, longInstallHelp, func() command { return &installCommand{} })
}

type installCommand struct {
	baseCommand
	Positional struct {
		Names []string `positional-arg-name:"<snap|snap+comp|+comp>" required:"yes" description:"Components to be installed (snap must be the caller snap if specified)."`
	} `positional-args:"yes"`
	NoWait bool `long:"no-wait" description:"Run the command in asynchronous mode, returning a change id that can be used to determine if the change is ready using the is-ready command."`
}

func (c *installCommand) Execute([]string) error {
	ctx, err := c.ensureContext()
	if err != nil {
		return err
	}

	comps, err := validateSnapAndCompsNames(c.Positional.Names, ctx.InstanceName())
	if err != nil {
		return err
	}

	id, affectedComponents, err := runSnapManagementCommand(ctx, managementCommand{operation: installManagementCommand, components: comps, async: c.NoWait})

	if err != nil {
		if _, ok := err.(*snap.AlreadyInstalledError); !ok {
			return err
		}
	}

	if len(affectedComponents) < len(comps) {
		for _, comp := range comps {
			if !strutil.ListContains(affectedComponents, comp) {
				msg := fmt.Sprintf(i18n.G(`snapctl: component %q is already installed`), comp)
				fmt.Fprintln(c.stderr, msg)
			}
		}
	}

	if c.NoWait {
		fmt.Fprintf(c.stdout, "%s", id)
	}

	return nil
}