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