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         /* SEB UPDATE DOC
  80                 appDescription += `
  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.
  87         `
  88         */
  89         // Create a new App instance
  90         app := cli.NewApp()
  91         app.Name = AppName
  92         app.Usage = appUsage
  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
 100
 101         // Create env vars help
 102         dynDesc := "\nENVIRONMENT VARIABLES:"
 103         for _, f := range app.Flags {
 104                 var env, usage string
 105                 switch f.(type) {
 106                 case cli.StringFlag:
 107                         fs := f.(cli.StringFlag)
 108                         env = fs.EnvVar
 109                         usage = fs.Usage
 110                 case cli.BoolFlag:
 111                         fb := f.(cli.BoolFlag)
 112                         env = fb.EnvVar
 113                         usage = fb.Usage
 114                 default:
 115                         exitError(1, "Un-implemented option type")
 116                 }
 117                 if env != "" {
 118                         dynDesc += fmt.Sprintf("\n %s \t\t %s", env, usage)
 119                 }
 120         }
 121         app.Description = appDescription + dynDesc
 122
 123         // Declare global flags
 124         app.Flags = []cli.Flag{
 125                 cli.StringFlag{
 126                         Name:   "config, c",
 127                         EnvVar: "XDS_CONFIG",
 128                         Usage:  "env config file to source on startup",
 129                 },
 130                 cli.StringFlag{
 131                         Name:   "log, l",
 132                         EnvVar: "XDS_LOGLEVEL",
 133                         Usage:  "logging level (supported levels: panic, fatal, error, warn, info, debug)",
 134                         Value:  defaultLogLevel,
 135                 },
 136                 cli.StringFlag{
 137                         Name:   "url",
 138                         EnvVar: "XDS_SERVER_URL",
 139                         Value:  "localhost:8000",
 140                         Usage:  "remote XDS server url",
 141                 },
 142                 cli.BoolFlag{
 143                         Name:   "timestamp, ts",
 144                         EnvVar: "XDS_TIMESTAMP",
 145                         Usage:  "prefix output with timestamp",
 146                 },
 147         }
 148
 149         // Declare commands
 150         app.Commands = []cli.Command{}
 151
 152         initCmdProjects(&app.Commands)
 153         initCmdSdks(&app.Commands)
 154         initCmdExec(&app.Commands)
 155         initCmdMisc(&app.Commands)
 156
 157         sort.Sort(cli.FlagsByName(app.Flags))
 158         sort.Sort(cli.CommandsByName(app.Commands))
 159
 160         app.Before = func(ctx *cli.Context) error {
 161                 var err error
 162
 163                 // Load config file if requested
 164                 confFile := ctx.String("config")
 165                 if confFile != "" {
 166                         if !common.Exists(confFile) {
 167                                 exitError(1, "Error env config file not found")
 168                         }
 169                         // Load config file variables that will overwrite env variables
 170                         err := godotenv.Overload(confFile)
 171                         if err != nil {
 172                                 exitError(1, "Error loading env config file "+confFile)
 173                         }
 174                         // Keep confFile settings in a map
 175                         EnvConfFileMap, err = godotenv.Read(confFile)
 176                         if err != nil {
 177                                 exitError(1, "Error reading env config file "+confFile)
 178                         }
 179                 }
 180
 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)
 186                 }
 187                 Log.Formatter = &logrus.TextFormatter{}
 188
 189                 Log.Infof("%s version: %s", AppName, app.Version)
 190                 Log.Debugf("Environment: %v", os.Environ())
 191
 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)
 196                 }
 197
 198                 return nil
 199         }
 200
 201         // Close HTTP client and WS connection on exit
 202         defer func() {
 203                 XdsConnClose()
 204         }()
 205
 206         app.Run(os.Args)
 207 }
 208
 209 // XdsConnInit Initialized HTTP and WebSocket connection to XDS agent
 210 func XdsConnInit(ctx *cli.Context) error {
 211         var err error
 212
 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")
 217         }
 218
 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",
 224                 CsrfDisable:         true,
 225                 LogOut:              Log.Out,
 226                 LogPrefix:           "XDSAGENT: ",
 227                 LogLevel:            common.HTTPLogLevelWarning,
 228         }
 229
 230         HTTPCli, err = common.HTTPNewClient(baseURL, conf)
 231         if err != nil {
 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:]
 236                 }
 237                 return cli.NewExitError(errmsg, 1)
 238         }
 239         HTTPCli.SetLogLevel(ctx.String("loglevel"))
 240
 241         // Create io Websocket client
 242         Log.Debugln("Connecting IO.socket client on ", baseURL)
 243
 244         opts := &socketio_client.Options{
 245                 Transport: "websocket",
 246                 Header:    make(map[string][]string),
 247         }
 248         opts.Header["XDS-AGENT-SID"] = []string{HTTPCli.GetClientID()}
 249
 250         IOsk, err = socketio_client.NewClient(baseURL, opts)
 251         if err != nil {
 252                 return cli.NewExitError("IO.socket connection error: "+err.Error(), 1)
 253         }
 254
 255         IOsk.On("error", func(err error) {
 256                 fmt.Println("ERROR Websocket: ", err.Error())
 257         })
 258
 259         ctx.App.Metadata["httpCli"] = HTTPCli
 260         ctx.App.Metadata["ioskCli"] = IOsk
 261
 262         return nil
 263 }
 264
 265 // XdsConnClose Terminate connection to XDS agent
 266 func XdsConnClose() {
 267         Log.Debugf("Closing HTTP client session...")
 268         /* TODO
 269         if httpCli, ok := app.Metadata["httpCli"]; ok {
 270                 c := httpCli.(*common.HTTPClient)
 271         }
 272         */
 273
 274         Log.Debugf("Closing WebSocket connection...")
 275         /*
 276                 if ioskCli, ok := app.Metadata["ioskCli"]; ok {
 277                         c := ioskCli.(*socketio_client.Client)
 278                 }
 279         */
 280 }
 281
 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)
 286         return writer
 287 }