Improved SDK installation output and add -debug option.
[src/xds/xds-cli.git] / cmd-sdks.go
1 /*
2  * Copyright (C) 2017 "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         "github.com/iotbzh/xds-agent/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                                 },
93                         },
94                         {
95                                 Name:    "uninstall",
96                                 Aliases: []string{"rm"},
97                                 Usage:   "UnInstall an existing SDK",
98                                 Action:  sdksUnInstall,
99                                 Flags: []cli.Flag{
100                                         cli.StringFlag{
101                                                 Name:   "id",
102                                                 Usage:  "sdk id to un-install",
103                                                 EnvVar: "XDS_SDK_ID",
104                                         },
105                                 },
106                         },
107                         {
108                                 Name:    "abort",
109                                 Aliases: []string{"a"},
110                                 Usage:   "Abort an install action",
111                                 Action:  sdksAbort,
112                                 Flags: []cli.Flag{
113                                         cli.StringFlag{
114                                                 Name:   "id",
115                                                 Usage:  "sdk id to which abort action",
116                                                 EnvVar: "XDS_SDK_ID",
117                                         },
118                                 },
119                         },
120                 },
121         })
122 }
123
124 func sdksList(ctx *cli.Context) error {
125         // Get SDKs list
126         sdks := []xaapiv1.SDK{}
127         if err := _sdksListGet(&sdks); err != nil {
128                 return cli.NewExitError(err.Error(), 1)
129         }
130
131         _displaySdks(sdks, ctx.Bool("verbose"), ctx.Bool("all"), ctx.String("filter"))
132         return nil
133 }
134
135 func sdksGet(ctx *cli.Context) error {
136         id := GetID(ctx)
137         if id == "" {
138                 return cli.NewExitError("id parameter or option must be set", 1)
139         }
140         sdks := xaapiv1.SDK{}
141         url := XdsServerComputeURL("/sdks/" + id)
142         if err := HTTPCli.Get(url, &sdks); err != nil {
143                 return cli.NewExitError(err.Error(), 1)
144         }
145
146         _displaySdks([]xaapiv1.SDK{sdks}, true, true, "")
147         return nil
148 }
149
150 func _displaySdks(sdks []xaapiv1.SDK, verbose bool, all bool, filter string) {
151         // Display result
152         first := true
153         writer := NewTableWriter()
154         for _, s := range sdks {
155                 if s.Status != xaapiv1.SdkStatusInstalled && !all {
156                         continue
157                 }
158                 if filter != "" {
159                         re := regexp.MustCompile(filter)
160                         if !(re.MatchString(s.ID) || re.MatchString(s.Name) ||
161                                 re.MatchString(s.Profile) || re.MatchString(s.Arch) ||
162                                 re.MatchString(s.Version)) {
163                                 continue
164                         }
165                 }
166
167                 if verbose {
168                         if !first {
169                                 fmt.Fprintln(writer)
170                         }
171                         fmt.Fprintln(writer, "ID\t"+s.ID)
172                         fmt.Fprintln(writer, "Name\t"+s.Name)
173                         fmt.Fprintln(writer, "Description\t"+s.Description)
174                         fmt.Fprintln(writer, "Profile\t"+s.Profile)
175                         fmt.Fprintln(writer, "Arch\t"+s.Arch)
176                         fmt.Fprintln(writer, "Version\t"+s.Version)
177                         fmt.Fprintln(writer, "Status\t"+s.Status)
178                         fmt.Fprintln(writer, "Path\t"+s.Path)
179                         fmt.Fprintln(writer, "Url\t"+s.URL)
180
181                 } else {
182                         if first {
183                                 if all {
184                                         fmt.Fprintf(writer, "List of available SDKs: \n")
185                                 } else {
186                                         fmt.Fprintf(writer, "List of installed SDKs: \n")
187                                 }
188                                 fmt.Fprintf(writer, "ID\t NAME\t STATUS\t VERSION\t ARCH\n")
189                         }
190                         fmt.Fprintf(writer, "%s\t %s\t %s\t %s\t %s\n", s.ID[:8], s.Name, s.Status, s.Version, s.Arch)
191                 }
192                 first = false
193         }
194         writer.Flush()
195 }
196
197 func _sdksListGet(sdks *[]xaapiv1.SDK) error {
198         url := XdsServerComputeURL("/sdks")
199         if err := HTTPCli.Get(url, &sdks); err != nil {
200                 return err
201         }
202         Log.Debugf("Result of %s: %v", url, sdks)
203
204         return nil
205 }
206
207 func sdksInstall(ctx *cli.Context) error {
208         id := GetID(ctx)
209         file := ctx.String("file")
210         force := ctx.Bool("force")
211
212         if id == "" && file == "" {
213                 return cli.NewExitError("id or file parameter or option must be set", 1)
214         }
215
216         // Process Socket IO events
217         type exitResult struct {
218                 error string
219                 code  int
220         }
221         exitChan := make(chan exitResult, 1)
222
223         IOsk.On("disconnection", func(err error) {
224                 Log.Debugf("WS disconnection event with err: %v\n", err)
225                 errMsg := ""
226                 if err != nil {
227                         errMsg = err.Error()
228                 }
229                 exitChan <- exitResult{errMsg, 2}
230         })
231
232         IOsk.On(xaapiv1.EVTSDKInstall, func(ev xaapiv1.EventMsg) {
233                 sdkEvt, _ := ev.DecodeSDKMsg()
234
235                 if sdkEvt.Stdout != "" {
236                         fmt.Printf("%s", sdkEvt.Stdout)
237                 }
238                 if sdkEvt.Stderr != "" {
239                         fmt.Fprintf(os.Stderr, "%s", sdkEvt.Stderr)
240                 }
241
242                 if sdkEvt.Exited {
243                         exitChan <- exitResult{sdkEvt.Error, sdkEvt.Code}
244                 }
245         })
246
247         evReg := xaapiv1.EventRegisterArgs{Name: xaapiv1.EVTSDKInstall}
248         if err := HTTPCli.Post("/events/register", &evReg, nil); err != nil {
249                 return cli.NewExitError(err, 1)
250         }
251
252         url := XdsServerComputeURL("/sdks")
253         sdks := xaapiv1.SDKInstallArgs{
254                 ID:       id,
255                 Filename: file,
256                 Force:    force,
257         }
258
259         if ctx.Bool("debug") {
260                 sdks.InstallArgs = []string{"--debug"}
261         }
262
263         newSdk := xaapiv1.SDK{}
264         if err := HTTPCli.Post(url, &sdks, &newSdk); err != nil {
265                 return cli.NewExitError(err, 1)
266         }
267         Log.Debugf("Result of %s: %v", url, newSdk)
268         fmt.Printf("Installation of '%s' SDK successfully started.\n", newSdk.Name)
269
270         // 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"
271
272         // Wait exit
273         select {
274         case res := <-exitChan:
275                 if res.code == 0 {
276                         Log.Debugln("Exit successfully")
277                         fmt.Println("SDK ID " + newSdk.ID + " successfully installed.")
278                 }
279                 if res.error != "" {
280                         Log.Debugln("Exit with ERROR: ", res.error)
281                 }
282                 return cli.NewExitError(res.error, res.code)
283         }
284 }
285
286 func sdksUnInstall(ctx *cli.Context) error {
287         id := GetID(ctx)
288         if id == "" {
289                 return cli.NewExitError("id parameter or option must be set", 1)
290         }
291
292         delSdk := xaapiv1.SDK{}
293         url := XdsServerComputeURL("/sdks/" + id)
294         if err := HTTPCli.Delete(url, &delSdk); err != nil {
295                 return cli.NewExitError(err, 1)
296         }
297
298         Log.Debugf("Result of %s: %v", url, delSdk)
299
300         fmt.Println("SDK ID " + delSdk.ID + " successfully deleted.")
301         return nil
302 }
303
304 func sdksAbort(ctx *cli.Context) error {
305         id := GetID(ctx)
306         if id == "" {
307                 return cli.NewExitError("id parameter or option must be set", 1)
308         }
309
310         sdks := xaapiv1.SDKInstallArgs{ID: id}
311         newSdk := xaapiv1.SDK{}
312         url := XdsServerComputeURL("/sdks/abortinstall")
313         if err := HTTPCli.Post(url, &sdks, &newSdk); err != nil {
314                 return cli.NewExitError(err, 1)
315         }
316
317         Log.Debugf("Result of %s: %v", url, newSdk)
318         return nil
319 }