cmd-sdks.go

   1 /*
   2  * Copyright (C) 2017-2018 "IoT.bzh"
   3  * Author Sebastien Douheret <sebastien@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  */
  18
  19 package main
  20
  21 import (
  22         "fmt"
  23         "os"
  24         "regexp"
  25         "sort"
  26
  27         "gerrit.automotivelinux.org/gerrit/src/xds/xds-agent.git/lib/xaapiv1"
  28         "github.com/urfave/cli"
  29 )
  30
  31 func initCmdSdks(cmdDef *[]cli.Command) {
  32         *cmdDef = append(*cmdDef, cli.Command{
  33                 Name:     "sdks",
  34                 Aliases:  []string{"sdk"},
  35                 HideHelp: true,
  36                 Usage:    "SDKs commands group",
  37                 Subcommands: []cli.Command{
  38                         {
  39                                 Name:   "get",
  40                                 Usage:  "Get a property of a SDK",
  41                                 Action: sdksGet,
  42                                 Flags: []cli.Flag{
  43                                         cli.StringFlag{
  44                                                 Name:   "id",
  45                                                 Usage:  "sdk id",
  46                                                 EnvVar: "XDS_SDK_ID",
  47                                         },
  48                                 },
  49                         },
  50                         {
  51                                 Name:    "list",
  52                                 Aliases: []string{"ls"},
  53                                 Usage:   "List installed SDKs",
  54                                 Action:  sdksList,
  55                                 Flags: []cli.Flag{
  56                                         cli.BoolFlag{
  57                                                 Name:  "all, a",
  58                                                 Usage: "display all existing sdks (installed + downloadable)",
  59                                         },
  60                                         cli.StringFlag{
  61                                                 Name:  "filter, f",
  62                                                 Usage: "regexp to filter output (filtering done only on ID, Name, Version and Arch fields) ",
  63                                         },
  64                                         cli.BoolFlag{
  65                                                 Name:  "verbose, v",
  66                                                 Usage: "display verbose output",
  67                                         },
  68                                 },
  69                         },
  70                         {
  71                                 Name:    "install",
  72                                 Aliases: []string{"i"},
  73                                 Usage:   "Install a SDK",
  74                                 Action:  sdksInstall,
  75                                 Flags: []cli.Flag{
  76                                         cli.StringFlag{
  77                                                 Name:   "id",
  78                                                 Usage:  "sdk id to install",
  79                                                 EnvVar: "XDS_SDK_ID",
  80                                         },
  81                                         cli.StringFlag{
  82                                                 Name:  "file, f",
  83                                                 Usage: "use this file to install SDK",
  84                                         },
  85                                         cli.BoolFlag{
  86                                                 Name:  "debug",
  87                                                 Usage: "enable debug mode (useful to investigate install issue)",
  88                                         },
  89                                         cli.BoolFlag{
  90                                                 Name:  "force",
  91                                                 Usage: "force SDK installation when already installed",
  92                                         },
  93                                         cli.BoolFlag{
  94                                                 Name:  "short, s",
  95                                                 Usage: "short output, only print create sdk id (useful from scripting)",
  96                                         },
  97                                 },
  98                         },
  99                         {
 100                                 Name:    "uninstall",
 101                                 Aliases: []string{"rm"},
 102                                 Usage:   "UnInstall an existing SDK",
 103                                 Action:  sdksUnInstall,
 104                                 Flags: []cli.Flag{
 105                                         cli.StringFlag{
 106                                                 Name:   "id",
 107                                                 Usage:  "sdk id to un-install",
 108                                                 EnvVar: "XDS_SDK_ID",
 109                                         },
 110                                         cli.BoolFlag{
 111                                                 Name:  "force, f",
 112                                                 Usage: "remove confirmation prompt before removal",
 113                                         },
 114                                 },
 115                         },
 116                         {
 117                                 Name:    "abort",
 118                                 Aliases: []string{"a"},
 119                                 Usage:   "Abort an install action",
 120                                 Action:  sdksAbort,
 121                                 Flags: []cli.Flag{
 122                                         cli.StringFlag{
 123                                                 Name:   "id",
 124                                                 Usage:  "sdk id to which abort action",
 125                                                 EnvVar: "XDS_SDK_ID",
 126                                         },
 127                                 },
 128                         },
 129                 },
 130         })
 131 }
 132
 133 func sdksList(ctx *cli.Context) error {
 134         // Get SDKs list
 135         sdks := []xaapiv1.SDK{}
 136         if err := _sdksListGet(&sdks); err != nil {
 137                 return cli.NewExitError(err.Error(), 1)
 138         }
 139
 140         _displaySdks(sdks, ctx.Bool("verbose"), ctx.Bool("all"), ctx.String("filter"))
 141         return nil
 142 }
 143
 144 func sdksGet(ctx *cli.Context) error {
 145         id := GetID(ctx, "XDS_SDK_ID")
 146         if id == "" {
 147                 return cli.NewExitError("id parameter or option must be set", 1)
 148         }
 149         sdks := xaapiv1.SDK{}
 150         url := XdsServerComputeURL("/sdks/" + id)
 151         if err := HTTPCli.Get(url, &sdks); err != nil {
 152                 return cli.NewExitError(err.Error(), 1)
 153         }
 154
 155         _displaySdks([]xaapiv1.SDK{sdks}, true, true, "")
 156         return nil
 157 }
 158
 159 func _displaySdks(sdks []xaapiv1.SDK, verbose bool, all bool, filter string) {
 160         // Display result
 161         first := true
 162         writer := NewTableWriter()
 163         for _, s := range sdks {
 164                 if s.Status != xaapiv1.SdkStatusInstalled &&
 165                         s.Status != xaapiv1.SdkStatusInstalling &&
 166                         !all {
 167                         continue
 168                 }
 169                 if filter != "" {
 170                         re := regexp.MustCompile(filter)
 171                         if !(re.MatchString(s.ID) || re.MatchString(s.Name) ||
 172                                 re.MatchString(s.Profile) || re.MatchString(s.Arch) ||
 173                                 re.MatchString(s.Version)) {
 174                                 continue
 175                         }
 176                 }
 177
 178                 if verbose {
 179                         if !first {
 180                                 fmt.Fprintln(writer)
 181                         }
 182                         fmt.Fprintln(writer, "ID\t"+s.ID)
 183                         fmt.Fprintln(writer, "Name\t"+s.Name)
 184                         fmt.Fprintln(writer, "Description\t"+s.Description)
 185                         fmt.Fprintln(writer, "Profile\t"+s.Profile)
 186                         fmt.Fprintln(writer, "Arch\t"+s.Arch)
 187                         fmt.Fprintln(writer, "Version\t"+s.Version)
 188                         fmt.Fprintln(writer, "Status\t"+s.Status)
 189                         fmt.Fprintln(writer, "Path\t"+s.Path)
 190                         fmt.Fprintln(writer, "Url\t"+s.URL)
 191
 192                 } else {
 193                         if first {
 194                                 if all {
 195                                         fmt.Fprintf(writer, "List of available SDKs: \n")
 196                                 } else {
 197                                         fmt.Fprintf(writer, "List of installed SDKs: \n")
 198                                 }
 199                                 fmt.Fprintf(writer, "ID\t NAME\t STATUS\t VERSION\t ARCH\n")
 200                         }
 201                         fmt.Fprintf(writer, "%s\t %s\t %s\t %s\t %s\n", s.ID[:8], s.Name, s.Status, s.Version, s.Arch)
 202                 }
 203                 first = false
 204         }
 205         writer.Flush()
 206 }
 207
 208 // Sort SDKs by ID
 209 type _SdkByID []xaapiv1.SDK
 210
 211 func (s _SdkByID) Len() int           { return len(s) }
 212 func (s _SdkByID) Swap(i, j int)      { s[i], s[j] = s[j], s[i] }
 213 func (s _SdkByID) Less(i, j int) bool { return s[i].ID < s[j].ID }
 214
 215 // _sdksListGet Get the list of existing sdks
 216 func _sdksListGet(sdks *[]xaapiv1.SDK) error {
 217         url := XdsServerComputeURL("/sdks")
 218         if err := HTTPCli.Get(url, &sdks); err != nil {
 219                 return err
 220         }
 221         Log.Debugf("Result of %s: %v", url, sdks)
 222
 223         sort.Sort(_SdkByID(*sdks))
 224
 225         return nil
 226 }
 227
 228 func sdksInstall(ctx *cli.Context) error {
 229         id := GetID(ctx, "XDS_SDK_ID")
 230         file := ctx.String("file")
 231         force := ctx.Bool("force")
 232         shortOut := ctx.Bool("short")
 233
 234         if id == "" && file == "" {
 235                 return cli.NewExitError("id or file parameter or option must be set", 1)
 236         }
 237
 238         // Process Socket IO events
 239         type exitResult struct {
 240                 error string
 241                 code  int
 242         }
 243         exitChan := make(chan exitResult, 1)
 244
 245         IOSkClient.On("disconnection", func(err error) {
 246                 Log.Debugf("WS disconnection event with err: %v\n", err)
 247                 errMsg := ""
 248                 if err != nil {
 249                         errMsg = err.Error()
 250                 }
 251                 exitChan <- exitResult{errMsg, 2}
 252         })
 253
 254         IOSkClient.On(xaapiv1.EVTSDKManagement, func(ev xaapiv1.EventMsg) {
 255                 sdkEvt, _ := ev.DecodeSDKMgtMsg()
 256
 257                 if sdkEvt.Action != xaapiv1.SdkMgtActionInstall {
 258                         Log.Debugf("EVTSDKManagement (action %s) IGNORED", sdkEvt.Action)
 259                         return
 260                 }
 261
 262                 if !shortOut && len(sdkEvt.Stdout) > 0 {
 263                         os.Stdout.Write([]byte(sdkEvt.Stdout))
 264                 }
 265                 if !shortOut && len(sdkEvt.Stderr) > 0 {
 266                         os.Stderr.Write([]byte(sdkEvt.Stderr))
 267                 }
 268
 269                 if sdkEvt.Exited {
 270                         exitChan <- exitResult{sdkEvt.Error, sdkEvt.Code}
 271                 }
 272         })
 273
 274         IOSkClient.On(xaapiv1.EVTSDKStateChange, func(ev xaapiv1.EventMsg) {
 275                 sdk, _ := ev.DecodeSDKEvent()
 276                 Log.Debugf("EVTSDKStateChange: %v", sdk)
 277         })
 278
 279         evReg := xaapiv1.EventRegisterArgs{Name: xaapiv1.EVTAll}
 280         if err := HTTPCli.Post("/events/register", &evReg, nil); err != nil {
 281                 return cli.NewExitError(err, 1)
 282         }
 283
 284         url := XdsServerComputeURL("/sdks")
 285         sdks := xaapiv1.SDKInstallArgs{
 286                 ID:       id,
 287                 Filename: file,
 288                 Force:    force,
 289         }
 290
 291         if ctx.Bool("debug") {
 292                 sdks.InstallArgs = []string{"--debug"}
 293         }
 294
 295         newSdk := xaapiv1.SDK{}
 296         if err := HTTPCli.Post(url, &sdks, &newSdk); err != nil {
 297                 return cli.NewExitError(err, 1)
 298         }
 299         Log.Debugf("Result of %s: %v", url, newSdk)
 300         if !shortOut {
 301                 fmt.Printf("Installation of '%s' SDK successfully started.\n", newSdk.Name)
 302         }
 303
 304         // TODO: trap CTRL+C and print question: "Installation of xxx is in progress, press 'a' to abort, 'b' to continue in background or 'c' to continue installation"
 305
 306         // Wait exit
 307         select {
 308         case res := <-IOSkClient.ServerDiscoChan:
 309                 Log.Debugf("XDS Server disconnected %v", res)
 310                 return cli.NewExitError(res.error, res.code)
 311
 312         case res := <-exitChan:
 313                 if res.code == 0 {
 314                         Log.Debugln("Exit successfully")
 315                         if shortOut {
 316                                 fmt.Println(newSdk.ID)
 317                         } else {
 318                                 fmt.Println("SDK ID " + newSdk.ID + " successfully installed.")
 319                         }
 320                 }
 321                 if res.error != "" {
 322                         Log.Debugln("Exit with ERROR: ", res.error)
 323                 }
 324                 return cli.NewExitError(res.error, res.code)
 325         }
 326 }
 327
 328 func sdksUnInstall(ctx *cli.Context) error {
 329         id := GetID(ctx, "XDS_SDK_ID")
 330         if id == "" {
 331                 return cli.NewExitError("id parameter or option must be set", 1)
 332         }
 333
 334         if !ctx.Bool("force") {
 335                 if !Confirm("Do you permanently remove SDK id '" + id + "' [yes/No] ? ") {
 336                         return nil
 337                 }
 338         }
 339
 340         delSdk := xaapiv1.SDK{}
 341         url := XdsServerComputeURL("/sdks/" + id)
 342         if err := HTTPCli.Delete(url, &delSdk); err != nil {
 343                 return cli.NewExitError(err, 1)
 344         }
 345
 346         Log.Debugf("Result of %s: %v", url, delSdk)
 347
 348         fmt.Println("SDK ID " + delSdk.ID + " successfully deleted.")
 349         return nil
 350 }
 351
 352 func sdksAbort(ctx *cli.Context) error {
 353         id := GetID(ctx, "XDS_SDK_ID")
 354         if id == "" {
 355                 return cli.NewExitError("id parameter or option must be set", 1)
 356         }
 357
 358         sdks := xaapiv1.SDKInstallArgs{ID: id}
 359         newSdk := xaapiv1.SDK{}
 360         url := XdsServerComputeURL("/sdks/abortinstall")
 361         if err := HTTPCli.Post(url, &sdks, &newSdk); err != nil {
 362                 return cli.NewExitError(err, 1)
 363         }
 364
 365         Log.Debugf("Result of %s: %v", url, newSdk)
 366         return nil
 367 }