main.go

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