main.go

   1 /*
   2  * Copyright (C) 2017 "IoT.bzh"
   3  * Author Sebastien Douheret <sebastien@iot.bzh>
   4  *
   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
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  *
  17  *
  18  * xds-cli: command line tool used to control / interface X(cross) Development System.
  19  */
  20
  21 package main
  22
  23 import (
  24         "fmt"
  25         "os"
  26         "regexp"
  27         "sort"
  28         "strings"
  29         "text/tabwriter"
  30
  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"
  37 )
  38
  39 var appAuthors = []cli.Author{
  40         cli.Author{Name: "Sebastien Douheret", Email: "sebastien@iot.bzh"},
  41 }
  42
  43 // AppName name of this application
  44 var AppName = "xds-cli"
  45
  46 // AppNativeName native command name that this application can overload
  47 var AppNativeName = "cli"
  48
  49 // AppVersion Version of this application
  50 // (set by Makefile)
  51 var AppVersion = "?.?.?"
  52
  53 // AppSubVersion is the git tag id added to version string
  54 // Should be set by compilation -ldflags "-X main.AppSubVersion=xxx"
  55 // (set by Makefile)
  56 var AppSubVersion = "unknown-dev"
  57
  58 // Application details
  59 const (
  60         appCopyright    = "Copyright (C) 2017 IoT.bzh - Apache-2.0"
  61         defaultLogLevel = "error"
  62 )
  63
  64 // Log Global variable that hold logger
  65 var Log = logrus.New()
  66
  67 // EnvConfFileMap Global variable that hold environment vars loaded from config file
  68 var EnvConfFileMap map[string]string
  69
  70 // HTTPCli Global variable that hold HTTP Client
  71 var HTTPCli *common.HTTPClient
  72
  73 // IOsk Global variable that hold SocketIo client
  74 var IOsk *socketio_client.Client
  75
  76 // exitError exists this program with the specified error
  77 func exitError(code int, f string, a ...interface{}) {
  78         earlyDisplay()
  79         err := fmt.Sprintf(f, a...)
  80         fmt.Fprintf(os.Stderr, err+"\n")
  81         os.Exit(code)
  82 }
  83
  84 // earlyDebug Used to log info before logger has been initialized
  85 var earlyDebug []string
  86
  87 func earlyPrintf(format string, args ...interface{}) {
  88         earlyDebug = append(earlyDebug, fmt.Sprintf(format, args...))
  89 }
  90
  91 func earlyDisplay() {
  92         for _, str := range earlyDebug {
  93                 Log.Infof("%s", str)
  94         }
  95         earlyDebug = []string{}
  96 }
  97
  98 // main
  99 func main() {
 100
 101         // Allow to set app name from cli (useful for debugging)
 102         if AppName == "" {
 103                 AppName = os.Getenv("XDS_APPNAME")
 104         }
 105         if AppName == "" {
 106                 panic("Invalid setup, AppName not define !")
 107         }
 108         if AppNativeName == "" {
 109                 AppNativeName = AppName[4:]
 110         }
 111         appUsage := fmt.Sprintf("command line tool for X(cross) Development System.")
 112         appDescription := fmt.Sprintf("%s utility for X(cross) Development System\n", AppName)
 113         appDescription += `
 114     Setting of global options is driven either by environment variables or by command
 115     line options or using a config file knowning that the following priority order is used:
 116       1. use option value (for example --url option),
 117       2. else use variable 'XDS_xxx' (for example 'XDS_AGENT_URL' variable) when a
 118          config file is specified with '--config|-c' option,
 119       3. else use 'XDS_xxx' (for example 'XDS_AGENT_URL') environment variable.
 120
 121     Examples:
 122     # Get help of 'projects' sub-command
 123     ` + AppName + ` projects --help
 124
 125     # List all SDKs
 126     ` + AppName + ` sdks ls
 127
 128     # Add a new project
 129     ` + AppName + ` prj add --label="myProject" --type=cs --path=$HOME/xds-workspace/myProject
 130 `
 131
 132         // Create a new App instance
 133         app := cli.NewApp()
 134         app.Name = AppName
 135         app.Usage = appUsage
 136         app.Version = AppVersion + " (" + AppSubVersion + ")"
 137         app.Authors = appAuthors
 138         app.Copyright = appCopyright
 139         app.Metadata = make(map[string]interface{})
 140         app.Metadata["version"] = AppVersion
 141         app.Metadata["git-tag"] = AppSubVersion
 142         app.Metadata["logger"] = Log
 143
 144         // Create env vars help
 145         dynDesc := "\nENVIRONMENT VARIABLES:"
 146         for _, f := range app.Flags {
 147                 var env, usage string
 148                 switch f.(type) {
 149                 case cli.StringFlag:
 150                         fs := f.(cli.StringFlag)
 151                         env = fs.EnvVar
 152                         usage = fs.Usage
 153                 case cli.BoolFlag:
 154                         fb := f.(cli.BoolFlag)
 155                         env = fb.EnvVar
 156                         usage = fb.Usage
 157                 default:
 158                         exitError(1, "Un-implemented option type")
 159                 }
 160                 if env != "" {
 161                         dynDesc += fmt.Sprintf("\n %s \t\t %s", env, usage)
 162                 }
 163         }
 164         app.Description = appDescription + dynDesc
 165
 166         // Declare global flags
 167         app.Flags = []cli.Flag{
 168                 cli.StringFlag{
 169                         Name:   "config, c",
 170                         EnvVar: "XDS_CONFIG",
 171                         Usage:  "env config file to source on startup",
 172                 },
 173                 cli.StringFlag{
 174                         Name:   "log, l",
 175                         EnvVar: "XDS_LOGLEVEL",
 176                         Usage:  "logging level (supported levels: panic, fatal, error, warn, info, debug)",
 177                         Value:  defaultLogLevel,
 178                 },
 179                 cli.StringFlag{
 180                         Name:   "url, u",
 181                         EnvVar: "XDS_AGENT_URL",
 182                         Value:  "localhost:8800",
 183                         Usage:  "local XDS agent url",
 184                 },
 185                 cli.StringFlag{
 186                         Name:   "url-server, us",
 187                         EnvVar: "XDS_SERVER_URL",
 188                         Value:  "",
 189                         Usage:  "overwrite remote XDS server url (default value set in xds-agent-config.json file)",
 190                 },
 191                 cli.BoolFlag{
 192                         Name:   "timestamp, ts",
 193                         EnvVar: "XDS_TIMESTAMP",
 194                         Usage:  "prefix output with timestamp",
 195                 },
 196         }
 197
 198         // Declare commands
 199         app.Commands = []cli.Command{}
 200
 201         initCmdProjects(&app.Commands)
 202         initCmdSdks(&app.Commands)
 203         initCmdExec(&app.Commands)
 204         initCmdMisc(&app.Commands)
 205
 206         // Add --config option to all commands to support --config option either before or after command verb
 207         // IOW support following both syntaxes:
 208         //   xds-cli exec --config myprj.conf ...
 209         //   xds-cli --config myprj.conf exec ...
 210         for i, cmd := range app.Commands {
 211                 if len(cmd.Flags) > 0 {
 212                         app.Commands[i].Flags = append(cmd.Flags, cli.StringFlag{Hidden: true, Name: "config, c"})
 213                 }
 214                 for j, subCmd := range cmd.Subcommands {
 215                         app.Commands[i].Subcommands[j].Flags = append(subCmd.Flags, cli.StringFlag{Hidden: true, Name: "config, c"})
 216                 }
 217         }
 218
 219         sort.Sort(cli.FlagsByName(app.Flags))
 220         sort.Sort(cli.CommandsByName(app.Commands))
 221
 222         // Early and manual processing of --config option in order to set XDS_xxx
 223         // variables before parsing of option by app cli
 224         confFile := os.Getenv("XDS_CONFIG")
 225         for idx, a := range os.Args[1:] {
 226                 if a == "-c" || a == "--config" || a == "-config" {
 227                         confFile = os.Args[idx+2]
 228                         break
 229                 }
 230         }
 231
 232         // Load config file if requested
 233         if confFile != "" {
 234                 earlyPrintf("confFile detected: %v", confFile)
 235                 confFile, err := common.ResolveEnvVar(confFile)
 236                 if err != nil {
 237                         exitError(1, "Error while resolving confFile: %v", err)
 238                 }
 239                 earlyPrintf("Resolved confFile: %v", confFile)
 240                 if !common.Exists(confFile) {
 241                         exitError(1, "Error env config file not found")
 242                 }
 243                 // Load config file variables that will overwrite env variables
 244                 err = godotenv.Overload(confFile)
 245                 if err != nil {
 246                         exitError(1, "Error loading env config file "+confFile)
 247                 }
 248
 249                 // Keep confFile settings in a map
 250                 EnvConfFileMap, err = godotenv.Read(confFile)
 251                 if err != nil {
 252                         exitError(1, "Error reading env config file "+confFile)
 253                 }
 254                 earlyPrintf("EnvConfFileMap: %v", EnvConfFileMap)
 255         }
 256
 257         app.Before = func(ctx *cli.Context) error {
 258                 var err error
 259
 260                 // Don't init anything when no argument or help option is set
 261                 if ctx.NArg() == 0 {
 262                         return nil
 263                 }
 264                 for _, a := range ctx.Args() {
 265                         switch a {
 266                         case "-h", "--h", "-help", "--help":
 267                                 return nil
 268                         }
 269                 }
 270
 271                 loglevel := ctx.String("log")
 272                 // Set logger level and formatter
 273                 if Log.Level, err = logrus.ParseLevel(loglevel); err != nil {
 274                         msg := fmt.Sprintf("Invalid log level : \"%v\"\n", loglevel)
 275                         return cli.NewExitError(msg, 1)
 276                 }
 277                 Log.Formatter = &logrus.TextFormatter{}
 278
 279                 Log.Infof("%s version: %s", AppName, app.Version)
 280                 earlyDisplay()
 281                 Log.Debugf("\nEnvironment: %v\n", os.Environ())
 282
 283                 if err = XdsConnInit(ctx); err != nil {
 284                         // Directly call HandleExitCoder to avoid to print help (ShowAppHelp)
 285                         // Note that this function wil never return and program will exit
 286                         cli.HandleExitCoder(err)
 287                 }
 288
 289                 return nil
 290         }
 291
 292         // Close HTTP client and WS connection on exit
 293         defer func() {
 294                 XdsConnClose()
 295         }()
 296
 297         app.Run(os.Args)
 298 }
 299
 300 // XdsConnInit Initialized HTTP and WebSocket connection to XDS agent
 301 func XdsConnInit(ctx *cli.Context) error {
 302         var err error
 303
 304         // Define HTTP and WS url
 305         agentURL := ctx.String("url")
 306         serverURL := ctx.String("url-server")
 307
 308         // Allow to only set port number
 309         if match, _ := regexp.MatchString("^([0-9]+)$", agentURL); match {
 310                 agentURL = "http://localhost:" + ctx.String("url")
 311         }
 312         if match, _ := regexp.MatchString("^([0-9]+)$", serverURL); match {
 313                 serverURL = "http://localhost:" + ctx.String("url-server")
 314         }
 315         // Add http prefix if missing
 316         if agentURL != "" && !strings.HasPrefix(agentURL, "http://") {
 317                 agentURL = "http://" + agentURL
 318         }
 319         if serverURL != "" && !strings.HasPrefix(serverURL, "http://") {
 320                 serverURL = "http://" + serverURL
 321         }
 322
 323         // Create HTTP client
 324         Log.Debugln("Connect HTTP client on ", agentURL)
 325         conf := common.HTTPClientConfig{
 326                 URLPrefix:           "/api/v1",
 327                 HeaderClientKeyName: "Xds-Agent-Sid",
 328                 CsrfDisable:         true,
 329                 LogOut:              Log.Out,
 330                 LogPrefix:           "XDSAGENT: ",
 331                 LogLevel:            common.HTTPLogLevelDebug,
 332         }
 333
 334         HTTPCli, err = common.HTTPNewClient(agentURL, conf)
 335         if err != nil {
 336                 errmsg := err.Error()
 337                 m, err := regexp.MatchString("Get http.?://", errmsg)
 338                 if (m && err == nil) || strings.Contains(errmsg, "Failed to get device ID") {
 339                         i := strings.LastIndex(errmsg, ":")
 340                         newErr := "Cannot connection to " + agentURL
 341                         if i > 0 {
 342                                 newErr += " (" + strings.TrimSpace(errmsg[i+1:]) + ")"
 343                         } else {
 344                                 newErr += " (" + strings.TrimSpace(errmsg) + ")"
 345                         }
 346                         errmsg = newErr
 347                 }
 348                 return cli.NewExitError(errmsg, 1)
 349         }
 350         HTTPCli.SetLogLevel(ctx.String("loglevel"))
 351         Log.Infoln("HTTP session ID : ", HTTPCli.GetClientID())
 352
 353         // Create io Websocket client
 354         Log.Debugln("Connecting IO.socket client on ", agentURL)
 355
 356         opts := &socketio_client.Options{
 357                 Transport: "websocket",
 358                 Header:    make(map[string][]string),
 359         }
 360         opts.Header["XDS-AGENT-SID"] = []string{HTTPCli.GetClientID()}
 361
 362         IOsk, err = socketio_client.NewClient(agentURL, opts)
 363         if err != nil {
 364                 return cli.NewExitError("IO.socket connection error: "+err.Error(), 1)
 365         }
 366
 367         IOsk.On("error", func(err error) {
 368                 fmt.Println("ERROR Websocket: ", err.Error())
 369         })
 370
 371         ctx.App.Metadata["httpCli"] = HTTPCli
 372         ctx.App.Metadata["ioskCli"] = IOsk
 373
 374         // Display version in logs (debug helpers)
 375         ver := xaapiv1.XDSVersion{}
 376         if err := XdsVersionGet(&ver); err != nil {
 377                 return cli.NewExitError("ERROR while retrieving XDS version: "+err.Error(), 1)
 378         }
 379         Log.Infof("XDS Agent/Server version: %v", ver)
 380
 381         // Get current config and update connection to server when needed
 382         xdsConf := xaapiv1.APIConfig{}
 383         if err := XdsConfigGet(&xdsConf); err != nil {
 384                 return cli.NewExitError("ERROR while getting XDS config: "+err.Error(), 1)
 385         }
 386         svrCfg := xdsConf.Servers[XdsServerIndexGet()]
 387         if (serverURL != "" && svrCfg.URL != serverURL) || !svrCfg.Connected {
 388                 Log.Infof("Update XDS Server config: serverURL=%v, svrCfg=%v", serverURL, svrCfg)
 389                 if serverURL != "" {
 390                         svrCfg.URL = serverURL
 391                 }
 392                 svrCfg.ConnRetry = 10
 393                 if err := XdsConfigSet(xdsConf); err != nil {
 394                         return cli.NewExitError("ERROR while updating XDS server URL: "+err.Error(), 1)
 395                 }
 396         }
 397
 398         return nil
 399 }
 400
 401 // XdsConnClose Terminate connection to XDS agent
 402 func XdsConnClose() {
 403         Log.Debugf("Closing HTTP client session...")
 404         /* TODO
 405         if httpCli, ok := app.Metadata["httpCli"]; ok {
 406                 c := httpCli.(*common.HTTPClient)
 407         }
 408         */
 409
 410         Log.Debugf("Closing WebSocket connection...")
 411         /*
 412                 if ioskCli, ok := app.Metadata["ioskCli"]; ok {
 413                         c := ioskCli.(*socketio_client.Client)
 414                 }
 415         */
 416 }
 417
 418 // NewTableWriter Create a writer that inserts padding around tab-delimited
 419 func NewTableWriter() *tabwriter.Writer {
 420         writer := new(tabwriter.Writer)
 421         writer.Init(os.Stdout, 0, 8, 0, '\t', 0)
 422         return writer
 423 }