1 // xds-cli: command line tool used to control / interface X(cross) Development System.
12 "github.com/Sirupsen/logrus"
13 common "github.com/iotbzh/xds-common/golib"
14 "github.com/joho/godotenv"
15 socketio_client "github.com/sebd71/go-socket.io-client"
16 "github.com/urfave/cli"
19 var appAuthors = []cli.Author{
20 cli.Author{Name: "Sebastien Douheret", Email: "sebastien@iot.bzh"},
23 // AppName name of this application
24 var AppName = "xds-cli"
26 // AppNativeName native command name that this application can overload
27 var AppNativeName = "cli"
29 // AppVersion Version of this application
31 var AppVersion = "?.?.?"
33 // AppSubVersion is the git tag id added to version string
34 // Should be set by compilation -ldflags "-X main.AppSubVersion=xxx"
36 var AppSubVersion = "unknown-dev"
38 // Application details
40 appCopyright = "Apache-2.0"
41 defaultLogLevel = "error"
44 // Log Global variable that hold logger
45 var Log = logrus.New()
47 // EnvConfFileMap Global variable that hold environment vars loaded from config file
48 var EnvConfFileMap map[string]string
50 // HTTPCli Global variable that hold HTTP Client
51 var HTTPCli *common.HTTPClient
53 // IOsk Global variable that hold SocketIo client
54 var IOsk *socketio_client.Client
56 // exitError exists this program with the specified error
57 func exitError(code int, f string, a ...interface{}) {
58 err := fmt.Sprintf(f, a...)
59 fmt.Fprintf(os.Stderr, err+"\n")
65 EnvConfFileMap := make(map[string]string)
67 // Allow to set app name from cli (useful for debugging)
69 AppName = os.Getenv("XDS_APPNAME")
72 panic("Invalid setup, AppName not define !")
74 if AppNativeName == "" {
75 AppNativeName = AppName[4:]
77 appUsage := fmt.Sprintf("command line tool for X(cross) Development System.")
78 appDescription := fmt.Sprintf("%s utility for X(cross) Development System\n", AppName)
81 xds-cli configuration is driven either by environment variables or by command line
82 options or using a config file knowning that the following priority order is used:
83 1. use option value (for example use project ID set by --id option),
84 2. else use variable 'XDS_xxx' (for example 'XDS_PROJECT_ID' variable) when a
85 config file is specified with '--config|-c' option,
86 3. else use 'XDS_xxx' (for example 'XDS_PROJECT_ID') environment variable.
89 // Create a new App instance
93 app.Version = AppVersion + " (" + AppSubVersion + ")"
94 app.Authors = appAuthors
95 app.Copyright = appCopyright
96 app.Metadata = make(map[string]interface{})
97 app.Metadata["version"] = AppVersion
98 app.Metadata["git-tag"] = AppSubVersion
99 app.Metadata["logger"] = Log
101 // Create env vars help
102 dynDesc := "\nENVIRONMENT VARIABLES:"
103 for _, f := range app.Flags {
104 var env, usage string
107 fs := f.(cli.StringFlag)
111 fb := f.(cli.BoolFlag)
115 exitError(1, "Un-implemented option type")
118 dynDesc += fmt.Sprintf("\n %s \t\t %s", env, usage)
121 app.Description = appDescription + dynDesc
123 // Declare global flags
124 app.Flags = []cli.Flag{
127 EnvVar: "XDS_CONFIG",
128 Usage: "env config file to source on startup",
132 EnvVar: "XDS_LOGLEVEL",
133 Usage: "logging level (supported levels: panic, fatal, error, warn, info, debug)",
134 Value: defaultLogLevel,
138 EnvVar: "XDS_SERVER_URL",
139 Value: "localhost:8000",
140 Usage: "remote XDS server url",
143 Name: "timestamp, ts",
144 EnvVar: "XDS_TIMESTAMP",
145 Usage: "prefix output with timestamp",
150 app.Commands = []cli.Command{}
152 initCmdProjects(&app.Commands)
153 initCmdSdks(&app.Commands)
154 initCmdExec(&app.Commands)
155 initCmdMisc(&app.Commands)
157 sort.Sort(cli.FlagsByName(app.Flags))
158 sort.Sort(cli.CommandsByName(app.Commands))
160 app.Before = func(ctx *cli.Context) error {
163 // Load config file if requested
164 confFile := ctx.String("config")
166 if !common.Exists(confFile) {
167 exitError(1, "Error env config file not found")
169 // Load config file variables that will overwrite env variables
170 err := godotenv.Overload(confFile)
172 exitError(1, "Error loading env config file "+confFile)
174 // Keep confFile settings in a map
175 EnvConfFileMap, err = godotenv.Read(confFile)
177 exitError(1, "Error reading env config file "+confFile)
181 loglevel := ctx.String("log")
182 // Set logger level and formatter
183 if Log.Level, err = logrus.ParseLevel(loglevel); err != nil {
184 msg := fmt.Sprintf("Invalid log level : \"%v\"\n", loglevel)
185 return cli.NewExitError(msg, 1)
187 Log.Formatter = &logrus.TextFormatter{}
189 Log.Infof("%s version: %s", AppName, app.Version)
190 Log.Debugf("Environment: %v", os.Environ())
192 if err = XdsConnInit(ctx); err != nil {
193 // Directly call HandleExitCoder to avoid to print help (ShowAppHelp)
194 // Note that this function wil never return and program will exit
195 cli.HandleExitCoder(err)
201 // Close HTTP client and WS connection on exit
209 // XdsConnInit Initialized HTTP and WebSocket connection to XDS agent
210 func XdsConnInit(ctx *cli.Context) error {
213 // Define HTTP and WS url
214 baseURL := ctx.String("url")
215 if !strings.HasPrefix(ctx.String("url"), "http://") {
216 baseURL = "http://" + ctx.String("url")
219 // Create HTTP client
220 Log.Debugln("Connect HTTP client on ", baseURL)
221 conf := common.HTTPClientConfig{
222 URLPrefix: "/api/v1",
223 HeaderClientKeyName: "Xds-Agent-Sid",
226 LogPrefix: "XDSAGENT: ",
227 LogLevel: common.HTTPLogLevelWarning,
230 HTTPCli, err = common.HTTPNewClient(baseURL, conf)
232 errmsg := err.Error()
233 if m, err := regexp.MatchString("Get http.?://", errmsg); m && err == nil {
234 i := strings.LastIndex(errmsg, ":")
235 errmsg = "Cannot connection to " + baseURL + errmsg[i:]
237 return cli.NewExitError(errmsg, 1)
239 HTTPCli.SetLogLevel(ctx.String("loglevel"))
241 // Create io Websocket client
242 Log.Debugln("Connecting IO.socket client on ", baseURL)
244 opts := &socketio_client.Options{
245 Transport: "websocket",
246 Header: make(map[string][]string),
248 opts.Header["XDS-AGENT-SID"] = []string{HTTPCli.GetClientID()}
250 IOsk, err = socketio_client.NewClient(baseURL, opts)
252 return cli.NewExitError("IO.socket connection error: "+err.Error(), 1)
255 IOsk.On("error", func(err error) {
256 fmt.Println("ERROR Websocket: ", err.Error())
259 ctx.App.Metadata["httpCli"] = HTTPCli
260 ctx.App.Metadata["ioskCli"] = IOsk
265 // XdsConnClose Terminate connection to XDS agent
266 func XdsConnClose() {
267 Log.Debugf("Closing HTTP client session...")
269 if httpCli, ok := app.Metadata["httpCli"]; ok {
270 c := httpCli.(*common.HTTPClient)
274 Log.Debugf("Closing WebSocket connection...")
276 if ioskCli, ok := app.Metadata["ioskCli"]; ok {
277 c := ioskCli.(*socketio_client.Client)
282 // NewTableWriter Create a writer that inserts padding around tab-delimited
283 func NewTableWriter() *tabwriter.Writer {
284 writer := new(tabwriter.Writer)
285 writer.Init(os.Stdout, 0, 8, 0, '\t', 0)