File: cmd_components.go

package info (click to toggle)
snapd 2.72-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 80,412 kB
  • sloc: sh: 16,506; ansic: 16,211; python: 11,213; makefile: 1,919; exp: 190; awk: 58; xml: 22
file content (133 lines) | stat: -rw-r--r-- 3,678 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
// -*- 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 main

import (
	"fmt"
	"sort"

	"github.com/jessevdk/go-flags"

	"github.com/snapcore/snapd/client"
	"github.com/snapcore/snapd/i18n"
	"github.com/snapcore/snapd/snap/naming"
)

var shortComponentsHelp = i18n.G("List available and installed components for installed snaps")
var longComponentsHelp = i18n.G(`
The components command displays a summary of the components that are installed
and available for the set of currently installed snaps.

Components for specific installed snaps can be queried by providing snap names
as positional arguments.
`)

type cmdComponents struct {
	clientMixin
	Positional struct {
		Snaps []installedSnapName `positional-arg-name:"<snap>"`
	} `positional-args:"yes"`
}

func init() {
	addCommand("components",
		shortComponentsHelp,
		longComponentsHelp,
		func() flags.Commander { return &cmdComponents{} },
		nil,
		[]argDesc{{
			name: i18n.G("<snap>"),
			desc: i18n.G("Snaps to consider when listing available and installed components."),
		}},
	)
}

func (x *cmdComponents) Execute(args []string) error {
	if len(args) > 0 {
		return ErrExtraArgs
	}

	names := installedSnapNames(x.Positional.Snaps)
	snaps, err := x.client.List(names, nil)
	if err != nil {
		if err == client.ErrNoSnapsInstalled {
			if len(names) == 0 {
				fmt.Fprintln(Stderr, i18n.G("No snaps are installed yet."))
				return nil
			} else {
				return ErrNoMatchingSnaps
			}
		}
		return err
	}

	anyComps := false
	for _, snap := range snaps {
		anyComps = anyComps || len(snap.Components) > 0
	}

	if !anyComps {
		fmt.Fprintln(Stderr, i18n.G("No components are available for any installed snaps."))
		return nil
	}

	sort.Sort(snapsByName(snaps))

	w := tabWriter()
	fmt.Fprintln(w, i18n.G("Component\tStatus\tType"))
	for _, snap := range snaps {
		sort.Slice(snap.Components, componentsByInstallStatusAndSnapName(snap.Components))
		for _, comp := range snap.Components {
			// note that snap.Name is actually an instance name, and this isn't
			// how we'd usually use a naming.ComponentRef. however, presenting
			// users with a string that they can copy-paste into a "snap
			// install" command seems useful
			name := naming.NewComponentRef(snap.Name, comp.Name).String()
			status := "available"
			if comp.InstallDate != nil {
				status = "installed"
			}
			fmt.Fprintf(w, "%s\t%s\t%s\n", name, status, comp.Type)
		}
	}
	w.Flush()

	return nil
}

// componentsByInstallStatusAndSnapName sorts a slice of components for use in
// the output of the "snap components" command. Installed components are put
// first, followed by available components. Components within those groups are
// sorted lexicographically.
func componentsByInstallStatusAndSnapName(comps []client.Component) func(i int, j int) bool {
	return func(i, j int) bool {
		left, right := comps[i], comps[j]

		if left.InstallDate == nil && right.InstallDate != nil {
			return false
		}

		if left.InstallDate != nil && right.InstallDate == nil {
			return true
		}

		return left.Name < right.Name
	}
}