2 * Copyright (C) 2017 "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 "github.com/Sirupsen/logrus"
32 "github.com/iotbzh/xds-agent/lib/xaapiv1"
33 common "github.com/iotbzh/xds-common/golib"
34 "github.com/joho/godotenv"
35 socketio_client "github.com/sebd71/go-socket.io-client"
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 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 // IOsk Global variable that hold SocketIo client
74 var IOsk *socketio_client.Client
76 // exitError exists this program with the specified error
77 func exitError(code int, f string, a ...interface{}) {
78 err := fmt.Sprintf(f, a...)
79 fmt.Fprintf(os.Stderr, err+"\n")
85 var earlyDebug []string
87 // Allow to set app name from cli (useful for debugging)
89 AppName = os.Getenv("XDS_APPNAME")
92 panic("Invalid setup, AppName not define !")
94 if AppNativeName == "" {
95 AppNativeName = AppName[4:]
97 appUsage := fmt.Sprintf("command line tool for X(cross) Development System.")
98 appDescription := fmt.Sprintf("%s utility for X(cross) Development System\n", AppName)
100 Setting of global options is driven either by environment variables or by command
101 line options or using a config file knowning that the following priority order is used:
102 1. use option value (for example --url option),
103 2. else use variable 'XDS_xxx' (for example 'XDS_AGENT_URL' variable) when a
104 config file is specified with '--config|-c' option,
105 3. else use 'XDS_xxx' (for example 'XDS_AGENT_URL') environment variable.
108 # Get help of 'projects' sub-command
109 ` + AppName + ` projects --help
112 ` + AppName + ` sdks ls
115 ` + AppName + ` prj add --label="myProject" --type=cs --path=$HOME/xds-workspace/myProject
118 // Create a new App instance
122 app.Version = AppVersion + " (" + AppSubVersion + ")"
123 app.Authors = appAuthors
124 app.Copyright = appCopyright
125 app.Metadata = make(map[string]interface{})
126 app.Metadata["version"] = AppVersion
127 app.Metadata["git-tag"] = AppSubVersion
128 app.Metadata["logger"] = Log
130 // Create env vars help
131 dynDesc := "\nENVIRONMENT VARIABLES:"
132 for _, f := range app.Flags {
133 var env, usage string
136 fs := f.(cli.StringFlag)
140 fb := f.(cli.BoolFlag)
144 exitError(1, "Un-implemented option type")
147 dynDesc += fmt.Sprintf("\n %s \t\t %s", env, usage)
150 app.Description = appDescription + dynDesc
152 // Declare global flags
153 app.Flags = []cli.Flag{
156 EnvVar: "XDS_CONFIG",
157 Usage: "env config file to source on startup",
161 EnvVar: "XDS_LOGLEVEL",
162 Usage: "logging level (supported levels: panic, fatal, error, warn, info, debug)",
163 Value: defaultLogLevel,
167 EnvVar: "XDS_AGENT_URL",
168 Value: "localhost:8800",
169 Usage: "local XDS agent url",
172 Name: "url-server, us",
173 EnvVar: "XDS_SERVER_URL",
175 Usage: "overwrite remote XDS server url (default value set in xds-agent-config.json file)",
178 Name: "timestamp, ts",
179 EnvVar: "XDS_TIMESTAMP",
180 Usage: "prefix output with timestamp",
185 app.Commands = []cli.Command{}
187 initCmdProjects(&app.Commands)
188 initCmdSdks(&app.Commands)
189 initCmdExec(&app.Commands)
190 initCmdMisc(&app.Commands)
192 // Add --config option to all commands to support --config option either before or after command verb
193 // IOW support following both syntaxes:
194 // xds-cli exec --config myprj.conf ...
195 // xds-cli --config myprj.conf exec ...
196 for i, cmd := range app.Commands {
197 if len(cmd.Flags) > 0 {
198 app.Commands[i].Flags = append(cmd.Flags, cli.StringFlag{Hidden: true, Name: "config, c"})
200 for j, subCmd := range cmd.Subcommands {
201 app.Commands[i].Subcommands[j].Flags = append(subCmd.Flags, cli.StringFlag{Hidden: true, Name: "config, c"})
205 sort.Sort(cli.FlagsByName(app.Flags))
206 sort.Sort(cli.CommandsByName(app.Commands))
208 // Early and manual processing of --config option in order to set XDS_xxx
209 // variables before parsing of option by app cli
210 confFile := os.Getenv("XDS_CONFIG")
211 for idx, a := range os.Args[1:] {
212 if a == "-c" || a == "--config" || a == "-config" {
213 confFile = os.Args[idx+2]
218 // Load config file if requested
220 earlyDebug = append(earlyDebug, fmt.Sprintf("confFile detected: %v", confFile))
221 if !common.Exists(confFile) {
222 exitError(1, "Error env config file not found")
224 // Load config file variables that will overwrite env variables
225 err := godotenv.Overload(confFile)
227 exitError(1, "Error loading env config file "+confFile)
230 // Keep confFile settings in a map
231 EnvConfFileMap, err = godotenv.Read(confFile)
233 exitError(1, "Error reading env config file "+confFile)
235 earlyDebug = append(earlyDebug, fmt.Sprintf("EnvConfFileMap: %v", EnvConfFileMap))
238 app.Before = func(ctx *cli.Context) error {
241 // Don't init anything when no argument or help option is set
245 for _, a := range ctx.Args() {
247 case "-h", "--h", "-help", "--help":
252 loglevel := ctx.String("log")
253 // Set logger level and formatter
254 if Log.Level, err = logrus.ParseLevel(loglevel); err != nil {
255 msg := fmt.Sprintf("Invalid log level : \"%v\"\n", loglevel)
256 return cli.NewExitError(msg, 1)
258 Log.Formatter = &logrus.TextFormatter{}
260 Log.Infof("%s version: %s", AppName, app.Version)
261 for _, str := range earlyDebug {
264 Log.Debugf("\nEnvironment: %v\n", os.Environ())
266 if err = XdsConnInit(ctx); err != nil {
267 // Directly call HandleExitCoder to avoid to print help (ShowAppHelp)
268 // Note that this function wil never return and program will exit
269 cli.HandleExitCoder(err)
275 // Close HTTP client and WS connection on exit
283 // XdsConnInit Initialized HTTP and WebSocket connection to XDS agent
284 func XdsConnInit(ctx *cli.Context) error {
287 // Define HTTP and WS url
288 agentURL := ctx.String("url")
289 serverURL := ctx.String("url-server")
291 // Allow to only set port number
292 if match, _ := regexp.MatchString("^([0-9]+)$", agentURL); match {
293 agentURL = "http://localhost:" + ctx.String("url")
295 if match, _ := regexp.MatchString("^([0-9]+)$", serverURL); match {
296 serverURL = "http://localhost:" + ctx.String("url-server")
298 // Add http prefix if missing
299 if agentURL != "" && !strings.HasPrefix(agentURL, "http://") {
300 agentURL = "http://" + agentURL
302 if serverURL != "" && !strings.HasPrefix(serverURL, "http://") {
303 serverURL = "http://" + serverURL
306 // Create HTTP client
307 Log.Debugln("Connect HTTP client on ", agentURL)
308 conf := common.HTTPClientConfig{
309 URLPrefix: "/api/v1",
310 HeaderClientKeyName: "Xds-Agent-Sid",
313 LogPrefix: "XDSAGENT: ",
314 LogLevel: common.HTTPLogLevelWarning,
317 HTTPCli, err = common.HTTPNewClient(agentURL, conf)
319 errmsg := err.Error()
320 if m, err := regexp.MatchString("Get http.?://", errmsg); m && err == nil {
321 i := strings.LastIndex(errmsg, ":")
322 errmsg = "Cannot connection to " + agentURL + errmsg[i:]
324 return cli.NewExitError(errmsg, 1)
326 HTTPCli.SetLogLevel(ctx.String("loglevel"))
327 Log.Infoln("HTTP session ID : ", HTTPCli.GetClientID())
329 // Create io Websocket client
330 Log.Debugln("Connecting IO.socket client on ", agentURL)
332 opts := &socketio_client.Options{
333 Transport: "websocket",
334 Header: make(map[string][]string),
336 opts.Header["XDS-AGENT-SID"] = []string{HTTPCli.GetClientID()}
338 IOsk, err = socketio_client.NewClient(agentURL, opts)
340 return cli.NewExitError("IO.socket connection error: "+err.Error(), 1)
343 IOsk.On("error", func(err error) {
344 fmt.Println("ERROR Websocket: ", err.Error())
347 ctx.App.Metadata["httpCli"] = HTTPCli
348 ctx.App.Metadata["ioskCli"] = IOsk
350 // Display version in logs (debug helpers)
351 ver := xaapiv1.XDSVersion{}
352 if err := XdsVersionGet(&ver); err != nil {
353 return cli.NewExitError("ERROR while retrieving XDS version: "+err.Error(), 1)
355 Log.Infof("XDS Agent/Server version: %v", ver)
357 // Get current config and update connection to server when needed
358 xdsConf := xaapiv1.APIConfig{}
359 if err := XdsConfigGet(&xdsConf); err != nil {
360 return cli.NewExitError("ERROR while getting XDS config: "+err.Error(), 1)
362 svrCfg := xdsConf.Servers[XdsServerIndexGet()]
363 if (serverURL != "" && svrCfg.URL != serverURL) || !svrCfg.Connected {
365 svrCfg.URL = serverURL
367 svrCfg.ConnRetry = 10
368 if err := XdsConfigSet(xdsConf); err != nil {
369 return cli.NewExitError("ERROR while updating XDS server URL: "+err.Error(), 1)
376 // XdsConnClose Terminate connection to XDS agent
377 func XdsConnClose() {
378 Log.Debugf("Closing HTTP client session...")
380 if httpCli, ok := app.Metadata["httpCli"]; ok {
381 c := httpCli.(*common.HTTPClient)
385 Log.Debugf("Closing WebSocket connection...")
387 if ioskCli, ok := app.Metadata["ioskCli"]; ok {
388 c := ioskCli.(*socketio_client.Client)
393 // NewTableWriter Create a writer that inserts padding around tab-delimited
394 func NewTableWriter() *tabwriter.Writer {
395 writer := new(tabwriter.Writer)
396 writer.Init(os.Stdout, 0, 8, 0, '\t', 0)