2 * Copyright (C) 2018 "IoT.bzh"
3 * Author Sebastien Douheret <sebastien@iot.bzh>
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
31 "github.com/golang/crypto/ssh/terminal"
33 "gerrit.automotivelinux.org/gerrit/src/xds/xds-agent.git/lib/xaapiv1"
34 "github.com/urfave/cli"
37 func initCmdTargets(cmdDef *[]cli.Command) {
38 *cmdDef = append(*cmdDef, cli.Command{
40 Aliases: []string{"tgt"},
42 Usage: "targets commands group",
43 Subcommands: []cli.Command{
46 Aliases: []string{"a"},
47 Usage: "Add a new target",
52 Usage: "target name (free form string)",
60 Usage: "short output, only print create target id (useful from scripting)",
64 Usage: "target type (standard|std)",
70 Usage: "Get properties of a target",
76 EnvVar: "XDS_TARGET_ID",
82 Aliases: []string{"ls"},
83 Usage: "List existing targets",
88 Usage: "display verbose output",
94 Aliases: []string{"rm"},
95 Usage: "Remove an existing target",
96 Action: targetsRemove,
101 EnvVar: "XDS_TARGET_ID",
105 Usage: "remove confirmation prompt before removal",
111 Aliases: []string{"term"},
112 Usage: "Open a target terminal",
113 Action: terminalOpen,
118 EnvVar: "XDS_TARGET_ID",
122 Usage: "passthrough options set to command line used to start terminal",
126 Usage: "terminal id",
127 EnvVar: "XDS_TERMINAL_ID",
131 Usage: "user name used to connect terminal",
132 EnvVar: "XDS_TERMINAL_USER",
137 Name: "terminal-remove",
138 Aliases: []string{"term-rm"},
139 Usage: "Remove a target terminal",
140 Action: terminalRemove,
145 EnvVar: "XDS_TARGET_ID",
149 Usage: "terminal id",
150 EnvVar: "XDS_TERMINAL_ID",
158 func targetsList(ctx *cli.Context) error {
160 tgts := []xaapiv1.TargetConfig{}
161 if err := TargetsListGet(&tgts); err != nil {
162 return cli.NewExitError(err.Error(), 1)
164 _displayTargets(tgts, ctx.Bool("verbose"))
168 func targetsGet(ctx *cli.Context) error {
171 return cli.NewExitError("id parameter or option must be set", 1)
173 tgts := make([]xaapiv1.TargetConfig, 1)
174 url := XdsServerComputeURL("/targets/" + id)
175 if err := HTTPCli.Get(url, &tgts[0]); err != nil {
176 return cli.NewExitError(err, 1)
178 _displayTargets(tgts, true)
182 func _displayTargets(tgts []xaapiv1.TargetConfig, verbose bool) {
185 writer := NewTableWriter()
186 for _, tgt := range tgts {
191 fmt.Fprintln(writer, "ID:\t", tgt.ID)
192 fmt.Fprintln(writer, "Name:\t", tgt.Name)
193 fmt.Fprintln(writer, "Type:\t", tgt.Type)
194 fmt.Fprintln(writer, "IP:\t", tgt.IP)
195 fmt.Fprintln(writer, "Status:\t", tgt.Status)
196 if len(tgt.Terms) > 0 {
198 for _, tt := range tgt.Terms {
199 tmNfo += "\t ID:\t" + tt.ID + "\n"
200 tmNfo += "\t Name:\t" + tt.Name + "\n"
201 tmNfo += "\t Status:\t" + tt.Status + "\n"
202 tmNfo += "\t User:\t" + tt.User + "\n"
203 tmNfo += "\t Options:\t" + strings.Join(tt.Options, " ") + "\n"
204 tmNfo += fmt.Sprintf("\t Size:\t%v x %v\n", tt.Cols, tt.Rows)
206 fmt.Fprintln(writer, "Terminals:", tmNfo)
208 fmt.Fprintln(writer, "Terminals:\t None")
213 fmt.Fprintln(writer, "ID\t Name\t IP\t Terminals #")
215 fmt.Fprintln(writer, tgt.ID[0:8], "\t", tgt.Name, "\t", tgt.IP, "\t", len(tgt.Terms))
222 func targetsAdd(ctx *cli.Context) error {
224 // Decode target type
225 var tType xaapiv1.TargetType
226 switch strings.ToLower(ctx.String("type")) {
227 case "standard", "std":
228 tType = xaapiv1.TypeTgtStandard
230 tType = xaapiv1.TypeTgtStandard
233 tgt := xaapiv1.TargetConfig{
234 Name: ctx.String("name"),
236 IP: ctx.String("ip"),
239 Log.Infof("POST /target %v", tgt)
240 newTgt := xaapiv1.TargetConfig{}
241 err := HTTPCli.Post(XdsServerComputeURL("/targets"), tgt, &newTgt)
243 return cli.NewExitError(err, 1)
246 if ctx.Bool("short") {
247 fmt.Println(newTgt.ID)
249 fmt.Printf("New target '%s' (id %v) successfully created.\n", newTgt.Name, newTgt.ID)
255 func targetsRemove(ctx *cli.Context) error {
256 var res xaapiv1.TargetConfig
259 return cli.NewExitError("id parameter or option must be set", 1)
262 if !ctx.Bool("force") {
263 if !Confirm("Do you permanently remove target id '" + id + "' [yes/No] ? ") {
268 if err := HTTPCli.Delete(XdsServerComputeURL("/targets/"+id), &res); err != nil {
269 return cli.NewExitError(err, 1)
272 fmt.Println("Target ID " + res.ID + " successfully deleted.")
276 func terminalOpen(ctx *cli.Context) error {
278 tgt, term, err := GetTargetAndTerminalIDs(ctx, true)
280 return cli.NewExitError(err.Error(), 1)
283 return cli.NewExitError("cannot identify target", 1)
287 // Create a new terminal when needed
288 newTerm := xaapiv1.TerminalConfig{
289 Name: "ssh session from xds-cli",
290 Type: xaapiv1.TypeTermSSH,
291 User: ctx.String("user"),
292 Options: ctx.StringSlice("options"),
295 url := XdsServerComputeURL("/targets/" + tgt.ID + "/terminals")
296 if err := HTTPCli.Post(url, &newTerm, term); err != nil {
297 return cli.NewExitError(err.Error(), 1)
299 Log.Debugf("New terminal created: %v", term)
301 // Update terminal config when needed
303 if ctx.String("user") != "" {
304 term.User = ctx.String("user")
307 if len(ctx.StringSlice("options")) > 0 {
308 term.Options = ctx.StringSlice("options")
312 url := XdsServerComputeURL("/targets/" + tgt.ID + "/terminals/" + term.ID)
313 if err := HTTPCli.Put(url, &term, term); err != nil {
314 return cli.NewExitError(err.Error(), 1)
316 Log.Debugf("Update terminal config: %v", term)
320 // Process Socket IO events
321 type exitResult struct {
325 exitChan := make(chan exitResult, 1)
327 IOsk.On("disconnection", func(err error) {
328 Log.Debugf("WS disconnection event with err: %v\n", err)
329 exitChan <- exitResult{err, 2}
332 IOsk.On(xaapiv1.TerminalOutEvent, func(ev xaapiv1.TerminalOutMsg) {
334 fmt.Printf(ev.Stdout)
337 fmt.Fprintf(os.Stderr, ev.Stderr)
341 IOsk.On(xaapiv1.TerminalExitEvent, func(ev xaapiv1.TerminalExitMsg) {
342 exitChan <- exitResult{ev.Error, ev.Code}
345 /* FIXME - use raw mode to support escape keys, arrows keys, control char...
346 // import "github.com/golang/crypto/ssh/terminal"
348 oldState, err := terminal.MakeRaw(int(os.Stdin.Fd()))
350 defer terminal.Restore(int(os.Stdin.Fd()), oldState)
354 // Send stdin though WS
357 reader := bufio.NewReader(os.Stdin)
359 sc := bufio.NewScanner(reader)
362 Log.Debugf("Terminal Send command <%v>", command)
363 IOsk.Emit(xaapiv1.TerminalInEvent, command+"\n")
366 exitChan <- exitResult{sc.Err(), 3}
369 // CTRL-D exited scanner, so send it explicitly
370 IOsk.Emit(xaapiv1.TerminalInEvent, "\x04\n")
371 time.Sleep(time.Millisecond * 100)
373 if paranoia--; paranoia <= 0 {
374 msg := "Abnormal loop detected on stdin"
375 Log.Errorf("Abnormal loop detected on stdin")
377 // Send signal to gently exit terminal session
378 TerminalSendSignal(tgt, term, syscall.SIGTERM)
380 exitChan <- exitResult{fmt.Errorf(msg), int(syscall.ELOOP)}
386 err = OnSignals(func(sig os.Signal) {
387 Log.Debugf("Send signal %v", sig)
388 if IsWinResizeSignal(sig) {
389 TerminalResize(tgt, term)
390 } else if IsInterruptSignal(sig) {
391 IOsk.Emit(xaapiv1.TerminalInEvent, "\x03\n")
393 TerminalSendSignal(tgt, term, sig)
397 return cli.NewExitError(err.Error(), 1)
401 url := XdsServerComputeURL("/targets/" + tgt.ID + "/terminals/" + term.ID + "/open")
402 LogPost("POST %v", url)
403 if err := HTTPCli.Post(url, nil, term); err != nil {
404 return cli.NewExitError(err.Error(), 1)
407 // Wait exit - blocking
409 case res := <-exitChan:
412 Log.Debugln("Exit Target Terminal successfully")
414 if res.error != nil {
415 Log.Debugln("Exit Target Terminal with ERROR: ", res.error.Error())
416 errStr = res.error.Error()
418 return cli.NewExitError(errStr, res.code)
422 func terminalRemove(ctx *cli.Context) error {
424 tgt, term, err := GetTargetAndTerminalIDs(ctx, false)
426 return cli.NewExitError(err.Error(), 1)
428 if tgt == nil || tgt.ID == "" {
429 return cli.NewExitError("cannot identify target id", 1)
431 if term == nil || term.ID == "" {
432 return cli.NewExitError("cannot identify terminal id", 1)
435 // Send delete command
436 url := XdsServerComputeURL("/targets/" + tgt.ID + "/terminals/" + term.ID)
437 LogPost("DELETE %v", url)
438 if err := HTTPCli.Delete(url, term); err != nil {
439 return cli.NewExitError(err.Error(), 1)
449 // TerminalResize Send command to resize target terminal
450 func TerminalResize(tgt *xaapiv1.TargetConfig, term *xaapiv1.TerminalConfig) {
451 col, row, err := terminal.GetSize(int(os.Stdin.Fd()))
453 Log.Errorf("Error cannot get terminal size: %v", err)
455 Log.Debugf("Terminal resizing rows %v, cols %v", row, col)
456 sz := xaapiv1.TerminalResizeArgs{Rows: uint16(row), Cols: uint16(col)}
457 url := XdsServerComputeURL("/targets/" + tgt.ID + "/terminals/" + term.ID + "/resize")
458 if err := HTTPCli.Post(url, &sz, nil); err != nil {
459 Log.Errorf("Error while resizing terminal (term %v): %v", sz, err)
463 // TerminalSendSignal Send a signal to a target terminal
464 func TerminalSendSignal(tgt *xaapiv1.TargetConfig, term *xaapiv1.TerminalConfig, sig os.Signal) {
465 url := XdsServerComputeURL("/targets/" + tgt.ID + "/terminals/" + term.ID + "/signal/" + sig.String())
466 if err := HTTPCli.Post(url, nil, nil); err != nil {
467 Log.Errorf("Error to send signal %v: %v", sig, err)
471 // GetTargetAndTerminalIDs Retrieve Target and Terminal definition from IDs
472 func GetTargetAndTerminalIDs(ctx *cli.Context, useFirstFree bool) (*xaapiv1.TargetConfig, *xaapiv1.TerminalConfig, error) {
474 idArg := ctx.String("id")
475 tidArg := GetIDName(ctx, "termId")
477 tidArg = GetIDName(ctx, "tid")
479 if idArg == "" && tidArg == "" {
480 return nil, nil, fmt.Errorf("id or termId argument must be set")
483 tgts := []xaapiv1.TargetConfig{}
484 if err := TargetsListGet(&tgts); err != nil {
491 for ii, tt := range tgts {
492 for jj, ttm := range tt.Terms {
493 if idArg == "" && compareID(ttm.ID, tidArg) {
498 if idArg != "" && compareID(tt.ID, idArg) && compareID(ttm.ID, tidArg) {
506 return nil, nil, fmt.Errorf("Multiple IDs found, please set -id and -tid with full ID notation")
507 } else if matching == 1 {
508 return &tgts[ti], &tgts[ti].Terms[tj], nil
511 // Allow to create a new terminal when only target id is set
512 idArg = GetIDName(ctx, "id")
514 for _, tt := range tgts {
515 if compareID(tt.ID, idArg) {
521 return nil, nil, fmt.Errorf("No matching id found")
524 // Sort targets by Name
525 type _TgtByName []xaapiv1.TargetConfig
527 func (s _TgtByName) Len() int { return len(s) }
528 func (s _TgtByName) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
529 func (s _TgtByName) Less(i, j int) bool { return s[i].Name < s[j].Name }
531 // TargetsListGet Get the list of existing targets
532 func TargetsListGet(tgts *[]xaapiv1.TargetConfig) error {
534 if err := HTTPCli.HTTPGet(XdsServerComputeURL("/targets"), &data); err != nil {
537 Log.Debugf("Result of /targets: %v", string(data[:]))
539 if err := json.Unmarshal(data, &tgts); err != nil {
543 sort.Sort(_TgtByName(*tgts))