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 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
|
// Copyright 2020 PingCAP, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
package cmd
import (
"fmt"
"os"
"sort"
"strings"
"github.com/pingcap/errors"
"github.com/pingcap/tiup/pkg/environment"
"github.com/pingcap/tiup/pkg/repository/v1manifest"
"github.com/pingcap/tiup/pkg/set"
"github.com/pingcap/tiup/pkg/tui"
"github.com/pingcap/tiup/pkg/utils"
"github.com/spf13/cobra"
"golang.org/x/mod/semver"
)
type listOptions struct {
installedOnly bool
verbose bool
showAll bool
}
func newListCmd() *cobra.Command {
var opt listOptions
cmd := &cobra.Command{
Use: "list [component]",
Short: "List the available TiDB components or versions",
Long: `List the available TiDB components if you don't specify any component name,
or list the available versions of a specific component. Display a list of
local caches by default. Use the --installed flag to hide
components or versions which have not been installed.
# List all installed components
tiup list --installed
# List all installed versions of TiDB
tiup list tidb --installed`,
SilenceUsage: true,
SilenceErrors: true,
RunE: func(cmd *cobra.Command, args []string) error {
env := environment.GlobalEnv()
switch len(args) {
case 0:
result, err := showComponentList(env, opt)
result.print()
return err
case 1:
result, err := showComponentVersions(env, args[0], opt)
result.print()
return err
default:
return cmd.Help()
}
},
}
cmd.Flags().BoolVar(&opt.installedOnly, "installed", false, "List installed components only.")
cmd.Flags().BoolVar(&opt.verbose, "verbose", false, "Show detailed component information.")
cmd.Flags().BoolVar(&opt.showAll, "all", false, "Show all components include hidden ones.")
return cmd
}
type listResult struct {
header string
cmpTable [][]string
}
func (lr *listResult) print() {
if lr == nil {
return
}
fmt.Printf("%s", lr.header)
tui.PrintTable(lr.cmpTable, true)
}
func showComponentList(env *environment.Environment, opt listOptions) (*listResult, error) {
// Skip online update in packaged builds
if !opt.installedOnly && !environment.IsPackagedBuild {
err := env.V1Repository().UpdateComponentManifests()
if err != nil {
tui.ColorWarningMsg.Fprint(os.Stderr, "Warn: Update component manifest failed, err_msg=[", err.Error(), "]\n")
}
}
installed, err := env.Profile().InstalledComponents()
if err != nil {
return nil, err
}
var cmpTable [][]string
if opt.verbose {
cmpTable = append(cmpTable, []string{"Name", "Owner", "Installed", "Platforms", "Description"})
} else {
cmpTable = append(cmpTable, []string{"Name", "Owner", "Description"})
}
index := v1manifest.Index{}
_, exists, err := env.V1Repository().LocalLoadManifest(&index)
if err != nil {
return nil, err
}
if !exists {
return nil, errors.Errorf("unreachable: index.json not found in manifests directory")
}
localComponents := set.NewStringSet(installed...)
compIDs := []string{}
components := index.ComponentList()
for id := range components {
compIDs = append(compIDs, id)
}
sort.Strings(compIDs)
for _, id := range compIDs {
comp := components[id]
if opt.installedOnly && !localComponents.Exist(id) {
continue
}
if (!opt.installedOnly && !opt.showAll) && comp.Hidden {
continue
}
filename := v1manifest.ComponentManifestFilename(id)
manifest, err := env.V1Repository().LocalLoadComponentManifest(&comp, filename)
if err != nil {
return nil, err
}
if manifest == nil {
continue
}
if opt.verbose {
installStatus := ""
if localComponents.Exist(id) {
versions, err := env.Profile().InstalledVersions(id)
if err != nil {
return nil, err
}
installStatus = strings.Join(versions, ",")
}
var platforms []string
for p := range manifest.Platforms {
platforms = append(platforms, p)
}
cmpTable = append(cmpTable, []string{
id,
comp.Owner,
installStatus,
strings.Join(platforms, ","),
manifest.Description,
})
} else {
cmpTable = append(cmpTable, []string{
id,
comp.Owner,
manifest.Description,
})
}
}
return &listResult{
header: "Available components:\n",
cmpTable: cmpTable,
}, nil
}
func showComponentVersions(env *environment.Environment, component string, opt listOptions) (*listResult, error) {
versions, err := env.Profile().InstalledVersions(component)
if err != nil {
return nil, err
}
installed := set.NewStringSet(versions...)
var cmpTable [][]string
cmpTable = append(cmpTable, []string{"Version", "Installed", "Release", "Platforms"})
var comp *v1manifest.Component
if opt.installedOnly {
comp, err = env.V1Repository().LocalComponentManifest(component, false)
} else {
comp, err = env.V1Repository().GetComponentManifest(component, false)
}
if err != nil {
return nil, errors.Annotate(err, "failed to fetch component")
}
platforms := make(map[string][]string)
released := make(map[string]string)
for plat := range comp.Platforms {
versions := comp.VersionList(plat)
for ver, verinfo := range versions {
if ver == comp.Nightly {
key := fmt.Sprintf("%s -> %s", utils.NightlyVersionAlias, comp.Nightly)
platforms[key] = append(platforms[key], plat)
released[key] = verinfo.Released
}
platforms[ver] = append(platforms[ver], plat)
released[ver] = verinfo.Released
}
}
verList := []string{}
for v := range platforms {
verList = append(verList, v)
}
sort.Slice(verList, func(p, q int) bool {
return semver.Compare(verList[p], verList[q]) < 0
})
for _, v := range verList {
installStatus := ""
if installed.Exist(v) {
installStatus = "YES"
} else if opt.installedOnly {
continue
}
cmpTable = append(cmpTable, []string{v, installStatus, released[v], strings.Join(platforms[v], ",")})
}
return &listResult{
header: fmt.Sprintf("Available versions for %s:\n", component),
cmpTable: cmpTable,
}, nil
}
|