cmdparser.go

package config

import (
	"io"
	"os"

	flags "github.com/jessevdk/go-flags"
)

// LoggingOpts specifies the logging configuration
type LoggingOpts struct {
	LogLevel      string `long:"log-level" mapstructure:"log-level" description:"Verbosity level for stdout and log file" choice:"debug" choice:"info" choice:"error" default:"info"`
	LogDBLevel    string `long:"log-database-level" mapstructure:"log-database-level" description:"Verbosity level for database storing" choice:"debug" choice:"info" choice:"error" choice:"none" default:"info"`
	LogFile       string `long:"log-file" mapstructure:"log-file" description:"File name to store logs"`
	LogFileFormat string `long:"log-file-format" mapstructure:"log-file-format" description:"Format of file logs" choice:"json" choice:"text" default:"json"`
	LogFileRotate bool   `long:"log-file-rotate" mapstructure:"log-file-rotate" description:"Rotate log files"`
	LogFileSize   int    `long:"log-file-size" mapstructure:"log-file-size" description:"Maximum size in MB of the log file before it gets rotated" default:"100"`
	LogFileAge    int    `long:"log-file-age" mapstructure:"log-file-age" description:"Number of days to retain old log files, 0 means forever" default:"0"`
	LogFileNumber int    `long:"log-file-number" mapstructure:"log-file-number" description:"Maximum number of old log files to retain, 0 to retain all" default:"0"`
}

// StartOpts specifies the application startup options
type StartOpts struct {
	File    string `short:"f" long:"file" description:"SQL script file to execute during startup"`
	Init    bool   `long:"init" description:"Initialize database schema to the latest version and exit. Can be used with --upgrade"`
	Upgrade bool   `long:"upgrade" description:"Upgrade database to the latest version"`
	Debug   bool   `long:"debug" description:"Run in debug mode. Only asynchronous chains will be executed"`
}

// ResourceOpts specifies the maximum resources available to application
type ResourceOpts struct {
	CronWorkers     int `long:"cron-workers" mapstructure:"cron-workers" description:"Number of parallel workers for scheduled chains" default:"16"`
	IntervalWorkers int `long:"interval-workers" mapstructure:"interval-workers" description:"Number of parallel workers for interval chains" default:"16"`
	ChainTimeout    int `long:"chain-timeout" mapstructure:"chain-timeout" description:"Abort any chain that takes more than the specified number of milliseconds"`
	TaskTimeout     int `long:"task-timeout" mapstructure:"task-timeout" description:"Abort any task within a chain that takes more than the specified number of milliseconds"`
}

// RestAPIOpts fot internal web server impleenting REST API
type RestAPIOpts struct {
	Port int `long:"rest-port" mapstructure:"rest-port" description:"REST API port" env:"PGTT_RESTPORT" default:"0"`
}

// CmdOptions holds command line options passed
type CmdOptions struct {
	ClientName     string       `short:"c" long:"clientname" description:"Unique name for application instance" env:"PGTT_CLIENTNAME"`
	Config         string       `long:"config" description:"YAML configuration file"`
	ConnStr        string       `long:"connstr" description:"Connection string" env:"PGTT_CONNSTR"`
	Logging        LoggingOpts  `group:"Logging" mapstructure:"Logging"`
	Start          StartOpts    `group:"Start" mapstructure:"Start"`
	Resource       ResourceOpts `group:"Resource" mapstructure:"Resource"`
	RESTApi        RestAPIOpts  `group:"REST" mapstructure:"REST"`
	NoProgramTasks bool         `long:"no-program-tasks" mapstructure:"no-program-tasks" description:"Disable executing of PROGRAM tasks" env:"PGTT_NOPROGRAMTASKS"`
	NoHelpMessage  bool         `long:"no-help" mapstructure:"no-help" hidden:"system use"`
	Version        bool         `short:"v" long:"version" mapstructure:"version" description:"Output detailed version information" env:"PGTT_VERSION"`
}

// Verbose returns true if the debug log is enabled
func (c CmdOptions) Verbose() bool {
	return c.Logging.LogLevel == "debug"
}

// VersionOnly returns true if the `--version` is the only argument
func (c CmdOptions) VersionOnly() bool {
	return len(os.Args) == 2 && c.Version
}

// NewCmdOptions returns a new instance of CmdOptions with default values
func NewCmdOptions(args ...string) *CmdOptions {
	cmdOpts := new(CmdOptions)
	_, _ = flags.NewParser(cmdOpts, flags.PrintErrors).ParseArgs(args)
	return cmdOpts
}

var nonOptionArgs []string

// Parse will parse command line arguments and initialize pgengine
func Parse(writer io.Writer) (*flags.Parser, error) {
	cmdOpts := new(CmdOptions)
	parser := flags.NewParser(cmdOpts, flags.PrintErrors)
	var err error
	if nonOptionArgs, err = parser.Parse(); err != nil {
		if !flags.WroteHelp(err) && !cmdOpts.NoHelpMessage {
			parser.WriteHelp(writer)
			return nil, err
		}
	}
	if cmdOpts.Start.File != "" {
		if _, err := os.Stat(cmdOpts.Start.File); os.IsNotExist(err) {
			return nil, err
		}
	}
	//non-option arguments
	if len(nonOptionArgs) > 0 && cmdOpts.ConnStr == "" {
		cmdOpts.ConnStr = nonOptionArgs[0]
	}
	return parser, nil
}