2 * Copyright (C) 2017-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.
18 * xds-cli: command line tool used to control / interface X(cross) Development System.
32 "gerrit.automotivelinux.org/gerrit/src/xds/xds-agent.git/lib/xaapiv1"
33 common "gerrit.automotivelinux.org/gerrit/src/xds/xds-common.git/golib"
34 "github.com/Sirupsen/logrus"
35 "github.com/joho/godotenv"
36 "github.com/urfave/cli"
39 var appAuthors = []cli.Author{
40 cli.Author{Name: "Sebastien Douheret", Email: "sebastien@iot.bzh"},
43 // AppName name of this application
44 var AppName = "xds-cli"
46 // AppNativeName native command name that this application can overload
47 var AppNativeName = "cli"
49 // AppVersion Version of this application
51 var AppVersion = "?.?.?"
53 // AppSubVersion is the git tag id added to version string
54 // Should be set by compilation -ldflags "-X main.AppSubVersion=xxx"
56 var AppSubVersion = "unknown-dev"
58 // Application details
60 appCopyright = "Copyright (C) 2017-2018 IoT.bzh - Apache-2.0"
61 defaultLogLevel = "error"
64 // Log Global variable that hold logger
65 var Log = logrus.New()
67 // EnvConfFileMap Global variable that hold environment vars loaded from config file
68 var EnvConfFileMap map[string]string
70 // HTTPCli Global variable that hold HTTP Client
71 var HTTPCli *common.HTTPClient
73 // IOSkClient Global variable that hold SocketIo client
74 var IOSkClient *IOSockClient
76 // exitError exists this program with the specified error
77 func exitError(code int, f string, a ...interface{}) {
79 err := fmt.Sprintf(f, a...)
80 fmt.Fprintf(os.Stderr, err+"\n")
84 // earlyDebug Used to log info before logger has been initialized
85 var earlyDebug []string
87 func earlyPrintf(format string, args ...interface{}) {
88 earlyDebug = append(earlyDebug, fmt.Sprintf(format, args...))
92 for _, str := range earlyDebug {
95 earlyDebug = []string{}
98 // LogSillyf Logging helper used for silly logging (printed on log.debug)
99 func LogSillyf(format string, args ...interface{}) {
100 sillyVal, sillyLog := os.LookupEnv("XDS_LOG_SILLY")
101 if sillyLog && sillyVal == "1" {
102 Log.Debugf("SILLY: "+format, args...)
109 // Allow to set app name from cli (useful for debugging)
111 AppName = os.Getenv("XDS_APPNAME")
114 panic("Invalid setup, AppName not define !")
116 if AppNativeName == "" {
117 AppNativeName = AppName[4:]
119 appUsage := fmt.Sprintf("command line tool for X(cross) Development System.")
120 appDescription := fmt.Sprintf("%s utility for X(cross) Development System\n", AppName)
122 Setting of global options is driven either by environment variables or by command
123 line options or using a config file knowning that the following priority order is used:
124 1. use option value (for example --url option),
125 2. else use variable 'XDS_xxx' (for example 'XDS_AGENT_URL' variable) when a
126 config file is specified with '--config|-c' option,
127 3. else use 'XDS_xxx' (for example 'XDS_AGENT_URL') environment variable.
130 # Get help of 'projects' sub-command
131 ` + AppName + ` projects --help
134 ` + AppName + ` sdks ls
137 ` + AppName + ` prj add --label="myProject" --type=cs --path=$HOME/xds-workspace/myProject
140 // Create a new App instance
144 app.Version = AppVersion + " (" + AppSubVersion + ")"
145 app.Authors = appAuthors
146 app.Copyright = appCopyright
147 app.Metadata = make(map[string]interface{})
148 app.Metadata["version"] = AppVersion
149 app.Metadata["git-tag"] = AppSubVersion
150 app.Metadata["logger"] = Log
151 // FIXME: Disable completion for now, because it's not working with options
152 // (eg. --label) and prevents to complete local path
153 // (IOW current function only completes command and sub-commands)
154 app.EnableBashCompletion = false
156 // Create env vars help
157 dynDesc := "\nENVIRONMENT VARIABLES:"
158 for _, f := range app.Flags {
159 var env, usage string
162 fs := f.(cli.StringFlag)
166 fb := f.(cli.BoolFlag)
170 exitError(1, "Un-implemented option type")
173 dynDesc += fmt.Sprintf("\n %s \t\t %s", env, usage)
176 app.Description = appDescription + dynDesc
178 // Declare global flags
179 app.Flags = []cli.Flag{
182 EnvVar: "XDS_CONFIG",
183 Usage: "env config file to source on startup",
187 EnvVar: "XDS_LOGLEVEL",
188 Usage: "logging level (supported levels: panic, fatal, error, warn, info, debug)",
189 Value: defaultLogLevel,
194 Usage: "filename where logs will be redirected (default stderr)\n\t",
195 EnvVar: "XDS_LOGFILENAME",
199 EnvVar: "XDS_AGENT_URL",
200 Value: "localhost:8800",
201 Usage: "local XDS agent url",
204 Name: "url-server, us",
205 EnvVar: "XDS_SERVER_URL",
207 Usage: "overwrite remote XDS server url (default value set in xds-agent-config.json file)",
210 Name: "timestamp, ts",
211 EnvVar: "XDS_TIMESTAMP",
212 Usage: "prefix output with timestamp",
217 app.Commands = []cli.Command{}
219 initCmdProjects(&app.Commands)
220 initCmdSdks(&app.Commands)
221 initCmdExec(&app.Commands)
222 initCmdTargets(&app.Commands)
223 initCmdMisc(&app.Commands)
225 // Add --config option to all commands to support --config option either before or after command verb
226 // IOW support following both syntaxes:
227 // xds-cli exec --config myPrj.conf ...
228 // xds-cli --config myPrj.conf exec ...
229 for i, cmd := range app.Commands {
230 if len(cmd.Flags) > 0 {
231 app.Commands[i].Flags = append(cmd.Flags, cli.StringFlag{Hidden: true, Name: "config, c"})
233 for j, subCmd := range cmd.Subcommands {
234 app.Commands[i].Subcommands[j].Flags = append(subCmd.Flags, cli.StringFlag{Hidden: true, Name: "config, c"})
238 sort.Sort(cli.FlagsByName(app.Flags))
239 sort.Sort(cli.CommandsByName(app.Commands))
241 // Early and manual processing of --config option in order to set XDS_xxx
242 // variables before parsing of option by app cli
243 confFile := os.Getenv("XDS_CONFIG")
244 for idx, a := range os.Args[1:] {
245 if a == "-c" || a == "--config" || a == "-config" {
246 confFile = os.Args[idx+2]
251 // Load config file if requested
253 earlyPrintf("confFile detected: %v", confFile)
254 confFile, err := common.ResolveEnvVar(confFile)
256 exitError(1, "Error while resolving confFile: %v", err)
258 earlyPrintf("Resolved confFile: %v", confFile)
259 if !common.Exists(confFile) {
260 exitError(1, "Error env config file not found")
262 // Load config file variables that will overwrite env variables
263 err = godotenv.Overload(confFile)
265 exitError(1, "Error loading env config file "+confFile)
268 // Keep confFile settings in a map
269 EnvConfFileMap, err = godotenv.Read(confFile)
271 exitError(1, "Error reading env config file "+confFile)
273 earlyPrintf("EnvConfFileMap: %v", EnvConfFileMap)
276 app.Before = func(ctx *cli.Context) error {
279 // Don't init anything when no argument or help option is set
283 for _, a := range ctx.Args() {
285 case "-h", "--h", "-help", "--help":
290 loglevel := ctx.String("log")
291 // Set logger level and formatter
292 if Log.Level, err = logrus.ParseLevel(loglevel); err != nil {
293 msg := fmt.Sprintf("Invalid log level : \"%v\"\n", loglevel)
294 return cli.NewExitError(msg, 1)
296 Log.Formatter = &logrus.TextFormatter{}
298 if ctx.String("logfile") != "stderr" {
299 logFile, _ := common.ResolveEnvVar(ctx.String("logfile"))
300 fdL, err := os.OpenFile(logFile, os.O_CREATE|os.O_TRUNC|os.O_WRONLY, 0666)
302 msgErr := fmt.Sprintf("Cannot create log file %s", logFile)
303 return cli.NewExitError(msgErr, 1)
305 Log.Infof("Logging to file: %s", logFile)
309 Log.Infof("%s version: %s", AppName, app.Version)
311 Log.Debugf("\nEnvironment: %v\n", os.Environ())
313 if err = XdsConnInit(ctx); err != nil {
314 // Directly call HandleExitCoder to avoid to print help (ShowAppHelp)
315 // Note that this function wil never return and program will exit
316 cli.HandleExitCoder(err)
322 // Close HTTP client and WS connection on exit
327 // Start signals monitoring routine
330 // Default callback to handle interrupt signal
331 // Maybe be overwritten by some subcommand (eg. targets commands)
332 err := OnSignals(func(sig os.Signal) {
333 Log.Debugf("Send signal %v (from main)", sig)
334 if IsInterruptSignal(sig) {
335 err := cli.NewExitError("Interrupted\n", int(syscall.EINTR))
336 cli.HandleExitCoder(err)
340 cli.NewExitError(err.Error(), 1)
348 // XdsConnInit Initialized HTTP and WebSocket connection to XDS agent
349 func XdsConnInit(ctx *cli.Context) error {
352 // Define HTTP and WS url
353 agentURL := ctx.String("url")
354 serverURL := ctx.String("url-server")
356 // Allow to only set port number
357 if match, _ := regexp.MatchString("^([0-9]+)$", agentURL); match {
358 agentURL = "http://localhost:" + ctx.String("url")
360 if match, _ := regexp.MatchString("^([0-9]+)$", serverURL); match {
361 serverURL = "http://localhost:" + ctx.String("url-server")
363 // Add http prefix if missing
364 if agentURL != "" && !strings.HasPrefix(agentURL, "http://") {
365 agentURL = "http://" + agentURL
367 if serverURL != "" && !strings.HasPrefix(serverURL, "http://") {
368 serverURL = "http://" + serverURL
371 lvl := common.HTTPLogLevelWarning
372 if Log.Level == logrus.DebugLevel {
373 lvl = common.HTTPLogLevelDebug
376 // Create HTTP client
377 Log.Debugln("Connect HTTP client on ", agentURL)
378 conf := common.HTTPClientConfig{
379 URLPrefix: "/api/v1",
380 HeaderClientKeyName: "Xds-Agent-Sid",
383 LogPrefix: "XDSAGENT: ",
387 HTTPCli, err = common.HTTPNewClient(agentURL, conf)
389 errmsg := err.Error()
390 m, err := regexp.MatchString("Get http.?://", errmsg)
391 if (m && err == nil) || strings.Contains(errmsg, "Failed to get device ID") {
392 i := strings.LastIndex(errmsg, ":")
393 newErr := "Cannot connection to " + agentURL
395 newErr += " (" + strings.TrimSpace(errmsg[i+1:]) + ")"
397 newErr += " (" + strings.TrimSpace(errmsg) + ")"
401 return cli.NewExitError(errmsg, 1)
403 HTTPCli.SetLogLevel(ctx.String("loglevel"))
404 Log.Infoln("HTTP session ID : ", HTTPCli.GetClientID())
406 // Create io Websocket client
407 Log.Debugln("Connecting IO.socket client on ", agentURL)
409 IOSkClient, err = NewIoSocketClient(agentURL, HTTPCli.GetClientID())
411 return cli.NewExitError(err.Error(), 1)
414 IOSkClient.On("error", func(err error) {
415 fmt.Println("ERROR Websocket: ", err.Error())
418 ctx.App.Metadata["httpCli"] = HTTPCli
419 ctx.App.Metadata["ioskCli"] = IOSkClient
421 // Display version in logs (debug helpers)
422 ver := xaapiv1.XDSVersion{}
423 if err := XdsVersionGet(&ver); err != nil {
424 return cli.NewExitError("ERROR while retrieving XDS version: "+err.Error(), 1)
426 Log.Infof("XDS Agent/Server version: %v", ver)
428 // Get current config and update connection to server when needed
429 xdsConf := xaapiv1.APIConfig{}
430 if err := XdsConfigGet(&xdsConf); err != nil {
431 return cli.NewExitError("ERROR while getting XDS config: "+err.Error(), 1)
433 if len(xdsConf.Servers) < 1 {
434 return cli.NewExitError("No XDS Server connected", 1)
436 svrCfg := xdsConf.Servers[XdsServerIndexGet()]
437 if (serverURL != "" && svrCfg.URL != serverURL) || !svrCfg.Connected {
438 Log.Infof("Update XDS Server config: serverURL=%v, svrCfg=%v", serverURL, svrCfg)
440 svrCfg.URL = serverURL
442 svrCfg.ConnRetry = 10
443 if err := XdsConfigSet(xdsConf); err != nil {
444 return cli.NewExitError("ERROR while updating XDS server URL: "+err.Error(), 1)
451 // XdsConnClose Terminate connection to XDS agent
452 func XdsConnClose() {
453 Log.Debugf("Closing HTTP client session...")
455 if httpCli, ok := app.Metadata["httpCli"]; ok {
456 c := httpCli.(*common.HTTPClient)
460 Log.Debugf("Closing WebSocket connection...")
462 if ioskCli, ok := app.Metadata["ioskCli"]; ok {
463 c := ioskCli.(*socketio_client.Client)
468 // NewTableWriter Create a writer that inserts padding around tab-delimited
469 func NewTableWriter() *tabwriter.Writer {
470 writer := new(tabwriter.Writer)
471 writer.Init(os.Stdout, 0, 8, 0, '\t', 0)