main.go

   1 // xds-cli: command line tool used to control / interface X(cross) Development System.
   2 package main
   3
   4 import (
   5         "fmt"
   6         "os"
   7         "regexp"
   8         "sort"
   9         "strings"
  10         "text/tabwriter"
  11
  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"
  17 )
  18
  19 var appAuthors = []cli.Author{
  20         cli.Author{Name: "Sebastien Douheret", Email: "sebastien@iot.bzh"},
  21 }
  22
  23 // AppName name of this application
  24 var AppName = "xds-cli"
  25
  26 // AppNativeName native command name that this application can overload
  27 var AppNativeName = "cli"
  28
  29 // AppVersion Version of this application
  30 // (set by Makefile)
  31 var AppVersion = "?.?.?"
  32
  33 // AppSubVersion is the git tag id added to version string
  34 // Should be set by compilation -ldflags "-X main.AppSubVersion=xxx"
  35 // (set by Makefile)
  36 var AppSubVersion = "unknown-dev"
  37
  38 // Application details
  39 const (
  40         appCopyright    = "Apache-2.0"
  41         defaultLogLevel = "error"
  42 )
  43
  44 // Log Global variable that hold logger
  45 var Log = logrus.New()
  46
  47 // EnvConfFileMap Global variable that hold environment vars loaded from config file
  48 var EnvConfFileMap map[string]string
  49
  50 // HTTPCli Global variable that hold HTTP Client
  51 var HTTPCli *common.HTTPClient
  52
  53 // IOsk Global variable that hold SocketIo client
  54 var IOsk *socketio_client.Client
  55
  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")
  60         os.Exit(code)
  61 }
  62
  63 // main
  64 func main() {
  65         EnvConfFileMap := make(map[string]string)
  66
  67         // Allow to set app name from cli (useful for debugging)
  68         if AppName == "" {
  69                 AppName = os.Getenv("XDS_APPNAME")
  70         }
  71         if AppName == "" {
  72                 panic("Invalid setup, AppName not define !")
  73         }
  74         if AppNativeName == "" {
  75                 AppNativeName = AppName[4:]
  76         }
  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)
  79         appDescription += `
  80     Setting of global options is driven either by environment variables or by command
  81     line options or using a config file knowning that the following priority order is used:
  82       1. use option value (for example --url option),
  83       2. else use variable 'XDS_xxx' (for example 'XDS_SERVER_URL' variable) when a
  84          config file is specified with '--config|-c' option,
  85       3. else use 'XDS_xxx' (for example 'XDS_SERVER_URL') environment variable.
  86
  87     Examples:
  88     # Get help of 'projects' sub-command
  89     ` + AppName + ` projects --help
  90
  91     # List all SDKs
  92     ` + AppName + ` sdks ls
  93
  94     # Add a new project
  95     ` + AppName + ` prj add --label="myProject" --type=cs --path=$HOME/xds-workspace/myProject
  96 `
  97
  98         // Create a new App instance
  99         app := cli.NewApp()
 100         app.Name = AppName
 101         app.Usage = appUsage
 102         app.Version = AppVersion + " (" + AppSubVersion + ")"
 103         app.Authors = appAuthors
 104         app.Copyright = appCopyright
 105         app.Metadata = make(map[string]interface{})
 106         app.Metadata["version"] = AppVersion
 107         app.Metadata["git-tag"] = AppSubVersion
 108         app.Metadata["logger"] = Log
 109
 110         // Create env vars help
 111         dynDesc := "\nENVIRONMENT VARIABLES:"
 112         for _, f := range app.Flags {
 113                 var env, usage string
 114                 switch f.(type) {
 115                 case cli.StringFlag:
 116                         fs := f.(cli.StringFlag)
 117                         env = fs.EnvVar
 118                         usage = fs.Usage
 119                 case cli.BoolFlag:
 120                         fb := f.(cli.BoolFlag)
 121                         env = fb.EnvVar
 122                         usage = fb.Usage
 123                 default:
 124                         exitError(1, "Un-implemented option type")
 125                 }
 126                 if env != "" {
 127                         dynDesc += fmt.Sprintf("\n %s \t\t %s", env, usage)
 128                 }
 129         }
 130         app.Description = appDescription + dynDesc
 131
 132         // Declare global flags
 133         app.Flags = []cli.Flag{
 134                 cli.StringFlag{
 135                         Name:   "config, c",
 136                         EnvVar: "XDS_CONFIG",
 137                         Usage:  "env config file to source on startup",
 138                 },
 139                 cli.StringFlag{
 140                         Name:   "log, l",
 141                         EnvVar: "XDS_LOGLEVEL",
 142                         Usage:  "logging level (supported levels: panic, fatal, error, warn, info, debug)",
 143                         Value:  defaultLogLevel,
 144                 },
 145                 cli.StringFlag{
 146                         Name:   "url",
 147                         EnvVar: "XDS_SERVER_URL",
 148                         Value:  "localhost:8000",
 149                         Usage:  "remote XDS server url",
 150                 },
 151                 cli.BoolFlag{
 152                         Name:   "timestamp, ts",
 153                         EnvVar: "XDS_TIMESTAMP",
 154                         Usage:  "prefix output with timestamp",
 155                 },
 156         }
 157
 158         // Declare commands
 159         app.Commands = []cli.Command{}
 160
 161         initCmdProjects(&app.Commands)
 162         initCmdSdks(&app.Commands)
 163         initCmdExec(&app.Commands)
 164         initCmdMisc(&app.Commands)
 165
 166         sort.Sort(cli.FlagsByName(app.Flags))
 167         sort.Sort(cli.CommandsByName(app.Commands))
 168
 169         app.Before = func(ctx *cli.Context) error {
 170                 var err error
 171
 172                 // Don't init anything when no argument or help option is set
 173                 if ctx.NArg() == 0 {
 174                         return nil
 175                 }
 176                 for _, a := range ctx.Args() {
 177                         switch a {
 178                         case "-h", "--h", "-help", "--help":
 179                                 return nil
 180                         }
 181                 }
 182
 183                 // Load config file if requested
 184                 confFile := ctx.String("config")
 185                 if confFile != "" {
 186                         if !common.Exists(confFile) {
 187                                 exitError(1, "Error env config file not found")
 188                         }
 189                         // Load config file variables that will overwrite env variables
 190                         err := godotenv.Overload(confFile)
 191                         if err != nil {
 192                                 exitError(1, "Error loading env config file "+confFile)
 193                         }
 194                         // Keep confFile settings in a map
 195                         EnvConfFileMap, err = godotenv.Read(confFile)
 196                         if err != nil {
 197                                 exitError(1, "Error reading env config file "+confFile)
 198                         }
 199                 }
 200
 201                 loglevel := ctx.String("log")
 202                 // Set logger level and formatter
 203                 if Log.Level, err = logrus.ParseLevel(loglevel); err != nil {
 204                         msg := fmt.Sprintf("Invalid log level : \"%v\"\n", loglevel)
 205                         return cli.NewExitError(msg, 1)
 206                 }
 207                 Log.Formatter = &logrus.TextFormatter{}
 208
 209                 Log.Infof("%s version: %s", AppName, app.Version)
 210                 Log.Debugf("Environment: %v", os.Environ())
 211
 212                 if err = XdsConnInit(ctx); err != nil {
 213                         // Directly call HandleExitCoder to avoid to print help (ShowAppHelp)
 214                         // Note that this function wil never return and program will exit
 215                         cli.HandleExitCoder(err)
 216                 }
 217
 218                 return nil
 219         }
 220
 221         // Close HTTP client and WS connection on exit
 222         defer func() {
 223                 XdsConnClose()
 224         }()
 225
 226         app.Run(os.Args)
 227 }
 228
 229 // XdsConnInit Initialized HTTP and WebSocket connection to XDS agent
 230 func XdsConnInit(ctx *cli.Context) error {
 231         var err error
 232
 233         // Define HTTP and WS url
 234         baseURL := ctx.String("url")
 235         if !strings.HasPrefix(ctx.String("url"), "http://") {
 236                 baseURL = "http://" + ctx.String("url")
 237         }
 238
 239         // Create HTTP client
 240         Log.Debugln("Connect HTTP client on ", baseURL)
 241         conf := common.HTTPClientConfig{
 242                 URLPrefix:           "/api/v1",
 243                 HeaderClientKeyName: "Xds-Agent-Sid",
 244                 CsrfDisable:         true,
 245                 LogOut:              Log.Out,
 246                 LogPrefix:           "XDSAGENT: ",
 247                 LogLevel:            common.HTTPLogLevelWarning,
 248         }
 249
 250         HTTPCli, err = common.HTTPNewClient(baseURL, conf)
 251         if err != nil {
 252                 errmsg := err.Error()
 253                 if m, err := regexp.MatchString("Get http.?://", errmsg); m && err == nil {
 254                         i := strings.LastIndex(errmsg, ":")
 255                         errmsg = "Cannot connection to " + baseURL + errmsg[i:]
 256                 }
 257                 return cli.NewExitError(errmsg, 1)
 258         }
 259         HTTPCli.SetLogLevel(ctx.String("loglevel"))
 260         Log.Infoln("HTTP session ID : ", HTTPCli.GetClientID())
 261
 262         // Create io Websocket client
 263         Log.Debugln("Connecting IO.socket client on ", baseURL)
 264
 265         opts := &socketio_client.Options{
 266                 Transport: "websocket",
 267                 Header:    make(map[string][]string),
 268         }
 269         opts.Header["XDS-AGENT-SID"] = []string{HTTPCli.GetClientID()}
 270
 271         IOsk, err = socketio_client.NewClient(baseURL, opts)
 272         if err != nil {
 273                 return cli.NewExitError("IO.socket connection error: "+err.Error(), 1)
 274         }
 275
 276         IOsk.On("error", func(err error) {
 277                 fmt.Println("ERROR Websocket: ", err.Error())
 278         })
 279
 280         ctx.App.Metadata["httpCli"] = HTTPCli
 281         ctx.App.Metadata["ioskCli"] = IOsk
 282
 283         return nil
 284 }
 285
 286 // XdsConnClose Terminate connection to XDS agent
 287 func XdsConnClose() {
 288         Log.Debugf("Closing HTTP client session...")
 289         /* TODO
 290         if httpCli, ok := app.Metadata["httpCli"]; ok {
 291                 c := httpCli.(*common.HTTPClient)
 292         }
 293         */
 294
 295         Log.Debugf("Closing WebSocket connection...")
 296         /*
 297                 if ioskCli, ok := app.Metadata["ioskCli"]; ok {
 298                         c := ioskCli.(*socketio_client.Client)
 299                 }
 300         */
 301 }
 302
 303 // NewTableWriter Create a writer that inserts padding around tab-delimited
 304 func NewTableWriter() *tabwriter.Writer {
 305         writer := new(tabwriter.Writer)
 306         writer.Init(os.Stdout, 0, 8, 0, '\t', 0)
 307         return writer
 308 }