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.
31 "gerrit.automotivelinux.org/gerrit/src/xds/xds-agent.git/lib/xaapiv1"
32 common "gerrit.automotivelinux.org/gerrit/src/xds/xds-common.git/golib"
33 "github.com/Sirupsen/logrus"
35 "github.com/joho/godotenv"
36 socketio_client "github.com/sebd71/go-socket.io-client"
37 "github.com/urfave/cli"
40 var appAuthors = []cli.Author{
41 cli.Author{Name: "Sebastien Douheret", Email: "sebastien@iot.bzh"},
44 // AppName name of this application
45 var AppName = "xds-cli"
47 // AppNativeName native command name that this application can overload
48 var AppNativeName = "cli"
50 // AppVersion Version of this application
52 var AppVersion = "?.?.?"
54 // AppSubVersion is the git tag id added to version string
55 // Should be set by compilation -ldflags "-X main.AppSubVersion=xxx"
57 var AppSubVersion = "unknown-dev"
59 // Application details
61 appCopyright = "Copyright (C) 2017-2018 IoT.bzh - Apache-2.0"
62 defaultLogLevel = "error"
65 // Log Global variable that hold logger
66 var Log = logrus.New()
68 // EnvConfFileMap Global variable that hold environment vars loaded from config file
69 var EnvConfFileMap map[string]string
71 // HTTPCli Global variable that hold HTTP Client
72 var HTTPCli *common.HTTPClient
74 // IOsk Global variable that hold SocketIo client
75 var IOsk *socketio_client.Client
77 // exitError exists this program with the specified error
78 func exitError(code int, f string, a ...interface{}) {
80 err := fmt.Sprintf(f, a...)
81 fmt.Fprintf(os.Stderr, err+"\n")
85 // earlyDebug Used to log info before logger has been initialized
86 var earlyDebug []string
88 func earlyPrintf(format string, args ...interface{}) {
89 earlyDebug = append(earlyDebug, fmt.Sprintf(format, args...))
93 for _, str := range earlyDebug {
96 earlyDebug = []string{}
102 // Allow to set app name from cli (useful for debugging)
104 AppName = os.Getenv("XDS_APPNAME")
107 panic("Invalid setup, AppName not define !")
109 if AppNativeName == "" {
110 AppNativeName = AppName[4:]
112 appUsage := fmt.Sprintf("command line tool for X(cross) Development System.")
113 appDescription := fmt.Sprintf("%s utility for X(cross) Development System\n", AppName)
115 Setting of global options is driven either by environment variables or by command
116 line options or using a config file knowning that the following priority order is used:
117 1. use option value (for example --url option),
118 2. else use variable 'XDS_xxx' (for example 'XDS_AGENT_URL' variable) when a
119 config file is specified with '--config|-c' option,
120 3. else use 'XDS_xxx' (for example 'XDS_AGENT_URL') environment variable.
123 # Get help of 'projects' sub-command
124 ` + AppName + ` projects --help
127 ` + AppName + ` sdks ls
130 ` + AppName + ` prj add --label="myProject" --type=cs --path=$HOME/xds-workspace/myProject
133 // Create a new App instance
137 app.Version = AppVersion + " (" + AppSubVersion + ")"
138 app.Authors = appAuthors
139 app.Copyright = appCopyright
140 app.Metadata = make(map[string]interface{})
141 app.Metadata["version"] = AppVersion
142 app.Metadata["git-tag"] = AppSubVersion
143 app.Metadata["logger"] = Log
144 app.EnableBashCompletion = true
146 // Create env vars help
147 dynDesc := "\nENVIRONMENT VARIABLES:"
148 for _, f := range app.Flags {
149 var env, usage string
152 fs := f.(cli.StringFlag)
156 fb := f.(cli.BoolFlag)
160 exitError(1, "Un-implemented option type")
163 dynDesc += fmt.Sprintf("\n %s \t\t %s", env, usage)
166 app.Description = appDescription + dynDesc
168 // Declare global flags
169 app.Flags = []cli.Flag{
172 EnvVar: "XDS_CONFIG",
173 Usage: "env config file to source on startup",
177 EnvVar: "XDS_LOGLEVEL",
178 Usage: "logging level (supported levels: panic, fatal, error, warn, info, debug)",
179 Value: defaultLogLevel,
184 Usage: "filename where logs will be redirected (default stderr)\n\t",
185 EnvVar: "XDS_LOGFILENAME",
189 EnvVar: "XDS_AGENT_URL",
190 Value: "localhost:8800",
191 Usage: "local XDS agent url",
194 Name: "url-server, us",
195 EnvVar: "XDS_SERVER_URL",
197 Usage: "overwrite remote XDS server url (default value set in xds-agent-config.json file)",
200 Name: "timestamp, ts",
201 EnvVar: "XDS_TIMESTAMP",
202 Usage: "prefix output with timestamp",
207 app.Commands = []cli.Command{}
209 initCmdProjects(&app.Commands)
210 initCmdSdks(&app.Commands)
211 initCmdExec(&app.Commands)
212 initCmdTargets(&app.Commands)
213 initCmdMisc(&app.Commands)
215 // Add --config option to all commands to support --config option either before or after command verb
216 // IOW support following both syntaxes:
217 // xds-cli exec --config myPrj.conf ...
218 // xds-cli --config myPrj.conf exec ...
219 for i, cmd := range app.Commands {
220 if len(cmd.Flags) > 0 {
221 app.Commands[i].Flags = append(cmd.Flags, cli.StringFlag{Hidden: true, Name: "config, c"})
223 for j, subCmd := range cmd.Subcommands {
224 app.Commands[i].Subcommands[j].Flags = append(subCmd.Flags, cli.StringFlag{Hidden: true, Name: "config, c"})
228 sort.Sort(cli.FlagsByName(app.Flags))
229 sort.Sort(cli.CommandsByName(app.Commands))
231 // Early and manual processing of --config option in order to set XDS_xxx
232 // variables before parsing of option by app cli
233 confFile := os.Getenv("XDS_CONFIG")
234 for idx, a := range os.Args[1:] {
235 if a == "-c" || a == "--config" || a == "-config" {
236 confFile = os.Args[idx+2]
241 // Load config file if requested
243 earlyPrintf("confFile detected: %v", confFile)
244 confFile, err := common.ResolveEnvVar(confFile)
246 exitError(1, "Error while resolving confFile: %v", err)
248 earlyPrintf("Resolved confFile: %v", confFile)
249 if !common.Exists(confFile) {
250 exitError(1, "Error env config file not found")
252 // Load config file variables that will overwrite env variables
253 err = godotenv.Overload(confFile)
255 exitError(1, "Error loading env config file "+confFile)
258 // Keep confFile settings in a map
259 EnvConfFileMap, err = godotenv.Read(confFile)
261 exitError(1, "Error reading env config file "+confFile)
263 earlyPrintf("EnvConfFileMap: %v", EnvConfFileMap)
266 app.Before = func(ctx *cli.Context) error {
269 // Don't init anything when no argument or help option is set
273 for _, a := range ctx.Args() {
275 case "-h", "--h", "-help", "--help":
280 loglevel := ctx.String("log")
281 // Set logger level and formatter
282 if Log.Level, err = logrus.ParseLevel(loglevel); err != nil {
283 msg := fmt.Sprintf("Invalid log level : \"%v\"\n", loglevel)
284 return cli.NewExitError(msg, 1)
286 Log.Formatter = &logrus.TextFormatter{}
288 if ctx.String("logfile") != "stderr" {
289 logFile, _ := common.ResolveEnvVar(ctx.String("logfile"))
290 fdL, err := os.OpenFile(logFile, os.O_CREATE|os.O_TRUNC|os.O_WRONLY, 0666)
292 msgErr := fmt.Sprintf("Cannot create log file %s", logFile)
293 return cli.NewExitError(msgErr, 1)
295 Log.Infof("Logging to file: %s", logFile)
299 Log.Infof("%s version: %s", AppName, app.Version)
301 Log.Debugf("\nEnvironment: %v\n", os.Environ())
303 if err = XdsConnInit(ctx); err != nil {
304 // Directly call HandleExitCoder to avoid to print help (ShowAppHelp)
305 // Note that this function wil never return and program will exit
306 cli.HandleExitCoder(err)
312 // Close HTTP client and WS connection on exit
317 // Start signals monitoring routine
324 // XdsConnInit Initialized HTTP and WebSocket connection to XDS agent
325 func XdsConnInit(ctx *cli.Context) error {
328 // Define HTTP and WS url
329 agentURL := ctx.String("url")
330 serverURL := ctx.String("url-server")
332 // Allow to only set port number
333 if match, _ := regexp.MatchString("^([0-9]+)$", agentURL); match {
334 agentURL = "http://localhost:" + ctx.String("url")
336 if match, _ := regexp.MatchString("^([0-9]+)$", serverURL); match {
337 serverURL = "http://localhost:" + ctx.String("url-server")
339 // Add http prefix if missing
340 if agentURL != "" && !strings.HasPrefix(agentURL, "http://") {
341 agentURL = "http://" + agentURL
343 if serverURL != "" && !strings.HasPrefix(serverURL, "http://") {
344 serverURL = "http://" + serverURL
347 lvl := common.HTTPLogLevelWarning
348 if Log.Level == logrus.DebugLevel {
349 lvl = common.HTTPLogLevelDebug
352 // Create HTTP client
353 Log.Debugln("Connect HTTP client on ", agentURL)
354 conf := common.HTTPClientConfig{
355 URLPrefix: "/api/v1",
356 HeaderClientKeyName: "Xds-Agent-Sid",
359 LogPrefix: "XDSAGENT: ",
363 HTTPCli, err = common.HTTPNewClient(agentURL, conf)
365 errmsg := err.Error()
366 m, err := regexp.MatchString("Get http.?://", errmsg)
367 if (m && err == nil) || strings.Contains(errmsg, "Failed to get device ID") {
368 i := strings.LastIndex(errmsg, ":")
369 newErr := "Cannot connection to " + agentURL
371 newErr += " (" + strings.TrimSpace(errmsg[i+1:]) + ")"
373 newErr += " (" + strings.TrimSpace(errmsg) + ")"
377 return cli.NewExitError(errmsg, 1)
379 HTTPCli.SetLogLevel(ctx.String("loglevel"))
380 Log.Infoln("HTTP session ID : ", HTTPCli.GetClientID())
382 // Create io Websocket client
383 Log.Debugln("Connecting IO.socket client on ", agentURL)
385 opts := &socketio_client.Options{
386 Transport: "websocket",
387 Header: make(map[string][]string),
389 opts.Header["XDS-AGENT-SID"] = []string{HTTPCli.GetClientID()}
391 IOsk, err = socketio_client.NewClient(agentURL, opts)
393 return cli.NewExitError("IO.socket connection error: "+err.Error(), 1)
396 IOsk.On("error", func(err error) {
397 fmt.Println("ERROR Websocket: ", err.Error())
400 ctx.App.Metadata["httpCli"] = HTTPCli
401 ctx.App.Metadata["ioskCli"] = IOsk
403 // Display version in logs (debug helpers)
404 ver := xaapiv1.XDSVersion{}
405 if err := XdsVersionGet(&ver); err != nil {
406 return cli.NewExitError("ERROR while retrieving XDS version: "+err.Error(), 1)
408 Log.Infof("XDS Agent/Server version: %v", ver)
410 // Get current config and update connection to server when needed
411 xdsConf := xaapiv1.APIConfig{}
412 if err := XdsConfigGet(&xdsConf); err != nil {
413 return cli.NewExitError("ERROR while getting XDS config: "+err.Error(), 1)
415 if len(xdsConf.Servers) < 1 {
416 return cli.NewExitError("No XDS Server connected", 1)
418 svrCfg := xdsConf.Servers[XdsServerIndexGet()]
419 if (serverURL != "" && svrCfg.URL != serverURL) || !svrCfg.Connected {
420 Log.Infof("Update XDS Server config: serverURL=%v, svrCfg=%v", serverURL, svrCfg)
422 svrCfg.URL = serverURL
424 svrCfg.ConnRetry = 10
425 if err := XdsConfigSet(xdsConf); err != nil {
426 return cli.NewExitError("ERROR while updating XDS server URL: "+err.Error(), 1)
433 // XdsConnClose Terminate connection to XDS agent
434 func XdsConnClose() {
435 Log.Debugf("Closing HTTP client session...")
437 if httpCli, ok := app.Metadata["httpCli"]; ok {
438 c := httpCli.(*common.HTTPClient)
442 Log.Debugf("Closing WebSocket connection...")
444 if ioskCli, ok := app.Metadata["ioskCli"]; ok {
445 c := ioskCli.(*socketio_client.Client)
450 // NewTableWriter Create a writer that inserts padding around tab-delimited
451 func NewTableWriter() *tabwriter.Writer {
452 writer := new(tabwriter.Writer)
453 writer.Init(os.Stdout, 0, 8, 0, '\t', 0)