2021-03-01 19:49:43 +00:00
package steward
import (
"flag"
"fmt"
2021-03-25 10:28:26 +00:00
"log"
2021-03-01 19:49:43 +00:00
"os"
"path/filepath"
2021-03-24 06:05:41 +00:00
"strings"
2021-03-01 19:49:43 +00:00
toml "github.com/pelletier/go-toml"
)
2021-03-24 06:05:41 +00:00
// --- flag string slice
// flagStringSlice is a type used when a flag value contains
// comma separated values like `-myflag="somevalue,anothervalue`.
// If a flag of this type is used, and it contains a value, the
// Set(string) method will call the Parse() method.
// The comma separated content will then be split, and put into
// the []values field, and the `ok` field will be set to true, so
// it can be used to check if the flag was used and contained any
// values.
2021-03-24 09:14:17 +00:00
type flagNodeSlice struct {
2021-03-24 06:05:41 +00:00
value string
2021-03-25 10:28:26 +00:00
OK bool
Values [ ] node
2021-03-24 06:05:41 +00:00
}
2021-04-06 09:02:58 +00:00
// String method
2021-03-24 09:14:17 +00:00
func ( f * flagNodeSlice ) String ( ) string {
2021-03-24 06:05:41 +00:00
return ""
}
// Set will be called when this flag type is used as a flag.Var.
// It will put the comma separated string value given as input into
// the `value`field, then call the Parse function to split those
// comma separated values into []values.
2021-03-24 09:14:17 +00:00
func ( f * flagNodeSlice ) Set ( s string ) error {
2021-03-24 06:05:41 +00:00
f . value = s
f . Parse ( )
return nil
}
2021-03-25 10:28:26 +00:00
// If the flag value "RST" is given, set the default values
// for each of the flag var's fields, and return back.
// Since we reset the actual flag values, it is also these
// blank values that will be written to the config file, and
// making the change persistent in the system. This will also
// be reflected in values stored in the config file, since the
// config file is written after the flags have been parsed.
2021-03-24 09:14:17 +00:00
func ( f * flagNodeSlice ) Parse ( ) error {
2021-03-24 06:05:41 +00:00
if len ( f . value ) == 0 {
return nil
}
2021-03-25 10:28:26 +00:00
split := strings . Split ( f . value , "," )
// Reset values if RST was the flag value.
if split [ 0 ] == "RST" {
f . OK = false
f . value = ""
f . Values = [ ] node { }
return nil
}
2021-03-24 06:05:41 +00:00
fv := f . value
sp := strings . Split ( fv , "," )
2021-03-25 10:28:26 +00:00
f . OK = true
f . Values = [ ] node { }
2021-03-24 09:14:17 +00:00
for _ , v := range sp {
2021-03-25 10:28:26 +00:00
f . Values = append ( f . Values , node ( v ) )
2021-03-24 09:14:17 +00:00
}
2021-03-24 06:05:41 +00:00
return nil
}
// --- Configuration
2021-03-01 19:49:43 +00:00
type Configuration struct {
// The configuration folder on disk
ConfigFolder string
// some unique string to identify this Edge unit
NodeName string
// the address of the message broker
BrokerAddress string
// The number of the profiling port
ProfilingPort string
// host and port for prometheus listener, e.g. localhost:2112
PromHostAndPort string
// set to true if this is the node that should receive the error log's from other nodes
DefaultMessageTimeout int
// default amount of retries that will be done before a message is thrown away, and out of the system
DefaultMessageRetries int
2021-03-02 12:46:02 +00:00
// Publisher data folder
SubscribersDataFolder string
2021-03-12 09:41:03 +00:00
// central node to receive messages published from nodes
2021-03-12 10:13:42 +00:00
CentralNodeName string
2021-04-05 04:54:18 +00:00
2021-04-05 06:37:24 +00:00
// Make the current node send hello messages to central at given interval in seconds
2021-04-06 03:46:07 +00:00
StartPubREQHello int
2021-04-05 06:37:24 +00:00
2021-03-24 09:14:17 +00:00
// Start the central error logger.
// Takes a comma separated string of nodes to receive from or "*" for all nodes.
2021-04-06 05:56:49 +00:00
StartSubREQErrorLog flagNodeSlice
2021-03-25 12:39:59 +00:00
// Subscriber for hello messages
2021-04-06 03:46:07 +00:00
StartSubREQHello flagNodeSlice
2021-03-26 08:08:47 +00:00
// Subscriber for text logging
2021-04-05 06:17:04 +00:00
StartSubREQTextToLogFile flagNodeSlice
2021-03-26 08:08:47 +00:00
// Subscriber for Echo Request
2021-04-06 04:08:26 +00:00
StartSubREQPing flagNodeSlice
2021-03-26 08:08:47 +00:00
// Subscriber for Echo Reply
2021-04-06 04:08:26 +00:00
StartSubREQPong flagNodeSlice
2021-03-26 08:08:47 +00:00
// Subscriber for CLICommandRequest
2021-04-04 09:19:17 +00:00
StartSubREQCliCommand flagNodeSlice
2021-04-05 04:54:18 +00:00
// Subscriber for REQnCliCommand
StartSubREQnCliCommand flagNodeSlice
2021-04-05 05:27:39 +00:00
// Subscriber for REQTextToConsole
StartSubREQTextToConsole flagNodeSlice
2021-03-01 19:49:43 +00:00
}
2021-04-06 09:02:58 +00:00
// NewConfiguration will set a default Configuration,
// and return a *Configuration.
2021-03-01 19:49:43 +00:00
func NewConfiguration ( ) * Configuration {
c := Configuration { }
return & c
}
2021-03-12 10:13:42 +00:00
// Default configuration
2021-03-02 05:51:08 +00:00
func newConfigurationDefaults ( ) Configuration {
c := Configuration {
2021-04-05 05:27:39 +00:00
ConfigFolder : "./etc" ,
BrokerAddress : "127.0.0.1:4222" ,
ProfilingPort : "" ,
PromHostAndPort : "" ,
DefaultMessageTimeout : 10 ,
DefaultMessageRetries : 1 ,
2021-04-06 03:46:07 +00:00
StartPubREQHello : 30 ,
2021-04-06 07:06:26 +00:00
SubscribersDataFolder : "./var" ,
2021-04-05 05:27:39 +00:00
CentralNodeName : "" ,
2021-04-06 05:56:49 +00:00
StartSubREQErrorLog : flagNodeSlice { Values : [ ] node { } } ,
2021-04-06 03:46:07 +00:00
StartSubREQHello : flagNodeSlice { OK : true , Values : [ ] node { "*" } } ,
2021-04-05 06:17:04 +00:00
StartSubREQTextToLogFile : flagNodeSlice { OK : true , Values : [ ] node { "*" } } ,
2021-04-06 04:08:26 +00:00
StartSubREQPing : flagNodeSlice { OK : true , Values : [ ] node { "*" } } ,
StartSubREQPong : flagNodeSlice { OK : true , Values : [ ] node { "*" } } ,
2021-04-05 05:27:39 +00:00
StartSubREQCliCommand : flagNodeSlice { OK : true , Values : [ ] node { "*" } } ,
StartSubREQnCliCommand : flagNodeSlice { OK : true , Values : [ ] node { "*" } } ,
StartSubREQTextToConsole : flagNodeSlice { OK : true , Values : [ ] node { "*" } } ,
2021-03-02 05:51:08 +00:00
}
return c
}
2021-04-06 09:02:58 +00:00
// CheckFlags will parse all flags
2021-03-24 09:14:17 +00:00
func ( c * Configuration ) CheckFlags ( ) error {
2021-03-02 05:51:08 +00:00
// Create an empty default config
var fc Configuration
2021-03-24 09:14:17 +00:00
// NB: Disabling the config file options for now.
2021-03-02 05:51:08 +00:00
// Read file config. Set system default if it can't find config file.
2021-03-25 10:28:26 +00:00
fc , err := c . ReadConfigFile ( )
if err != nil {
log . Printf ( "%v\n" , err )
fc = newConfigurationDefaults ( )
}
* c = fc
2021-03-01 19:49:43 +00:00
2021-03-12 05:14:54 +00:00
flag . StringVar ( & c . ConfigFolder , "configFolder" , fc . ConfigFolder , "folder who contains the config file. Defaults to ./etc/. If other folder is used this flag must be specified at startup." )
2021-03-24 09:14:17 +00:00
flag . StringVar ( & c . NodeName , "nodeName" , fc . NodeName , "some unique string to identify this Edge unit" )
2021-03-01 19:49:43 +00:00
flag . StringVar ( & c . BrokerAddress , "brokerAddress" , fc . BrokerAddress , "the address of the message broker" )
flag . StringVar ( & c . ProfilingPort , "profilingPort" , fc . ProfilingPort , "The number of the profiling port" )
flag . StringVar ( & c . PromHostAndPort , "promHostAndPort" , fc . PromHostAndPort , "host and port for prometheus listener, e.g. localhost:2112" )
flag . IntVar ( & c . DefaultMessageTimeout , "defaultMessageTimeout" , fc . DefaultMessageTimeout , "default message timeout in seconds. This can be overridden on the message level" )
flag . IntVar ( & c . DefaultMessageRetries , "defaultMessageRetries" , fc . DefaultMessageRetries , "default amount of retries that will be done before a message is thrown away, and out of the system" )
2021-03-02 12:46:02 +00:00
flag . StringVar ( & c . SubscribersDataFolder , "subscribersDataFolder" , fc . SubscribersDataFolder , "The data folder where subscribers are allowed to write their data if needed" )
2021-03-12 10:13:42 +00:00
flag . StringVar ( & c . CentralNodeName , "centralNodeName" , fc . CentralNodeName , "The name of the central node to receive messages published by this node" )
2021-03-02 12:46:02 +00:00
2021-04-06 03:46:07 +00:00
flag . IntVar ( & c . StartPubREQHello , "startPubREQHello" , fc . StartPubREQHello , "Make the current node send hello messages to central at given interval in seconds" )
2021-03-25 12:39:59 +00:00
2021-04-06 05:56:49 +00:00
flag . Var ( & c . StartSubREQErrorLog , "startSubREQErrorLog" , "Specify comma separated list for nodes to allow messages from. Use \"*\" for from all. Value RST will turn off subscriber." )
2021-04-06 03:46:07 +00:00
flag . Var ( & c . StartSubREQHello , "startSubREQHello" , "Specify comma separated list for nodes to allow messages from. Use \"*\" for from all. Value RST will turn off subscriber." )
2021-04-05 06:17:04 +00:00
flag . Var ( & c . StartSubREQTextToLogFile , "startSubREQTextToLogFile" , "Specify comma separated list for nodes to allow messages from. Use \"*\" for from all. Value RST will turn off subscriber." )
2021-04-06 04:08:26 +00:00
flag . Var ( & c . StartSubREQPing , "startSubREQPing" , "Specify comma separated list for nodes to allow messages from. Use \"*\" for from all. Value RST will turn off subscriber." )
flag . Var ( & c . StartSubREQPong , "startSubREQPong" , "Specify comma separated list for nodes to allow messages from. Use \"*\" for from all. Value RST will turn off subscriber." )
2021-04-04 09:19:17 +00:00
flag . Var ( & c . StartSubREQCliCommand , "startSubREQCliCommand" , "Specify comma separated list for nodes to allow messages from. Use \"*\" for from all. Value RST will turn off subscriber." )
2021-04-05 04:54:18 +00:00
flag . Var ( & c . StartSubREQnCliCommand , "startSubREQnCliCommand" , "Specify comma separated list for nodes to allow messages from. Use \"*\" for from all. Value RST will turn off subscriber." )
2021-04-05 05:27:39 +00:00
flag . Var ( & c . StartSubREQTextToConsole , "startSubREQTextToConsole" , "Specify comma separated list for nodes to allow messages from. Use \"*\" for from all. Value RST will turn off subscriber." )
2021-03-24 09:14:17 +00:00
2021-03-01 19:49:43 +00:00
flag . Parse ( )
2021-03-24 09:14:17 +00:00
// Check that mandatory flag values have been set.
switch {
case c . NodeName == "" :
return fmt . Errorf ( "error: the nodeName config option or flag cannot be empty, check -help" )
case c . CentralNodeName == "" :
return fmt . Errorf ( "error: the centralNodeName config option or flag cannot be empty, check -help" )
2021-03-01 19:49:43 +00:00
}
2021-03-24 09:14:17 +00:00
2021-03-25 10:28:26 +00:00
// NB: Disabling the config file options for now.
if err := c . WriteConfigFile ( ) ; err != nil {
log . Printf ( "error: checkFlags: failed writing config file: %v\n" , err )
os . Exit ( 1 )
}
2021-03-24 09:14:17 +00:00
return nil
2021-03-01 19:49:43 +00:00
}
2021-03-24 06:05:41 +00:00
// Reads the current config file from disk.
2021-03-01 19:49:43 +00:00
func ( c * Configuration ) ReadConfigFile ( ) ( Configuration , error ) {
fp := filepath . Join ( "./etc/" , "config.toml" )
if _ , err := os . Stat ( fp ) ; os . IsNotExist ( err ) {
return Configuration { } , fmt . Errorf ( "error: no config file found %v: %v" , fp , err )
}
f , err := os . OpenFile ( fp , os . O_RDONLY , 0600 )
if err != nil {
2021-03-02 12:46:02 +00:00
return Configuration { } , fmt . Errorf ( "error: ReadConfigFile: failed to open file: %v" , err )
2021-03-01 19:49:43 +00:00
}
defer f . Close ( )
var conf Configuration
dec := toml . NewDecoder ( f )
err = dec . Decode ( & conf )
if err != nil {
return Configuration { } , fmt . Errorf ( "error: decode toml file %v: %v" , fp , err )
}
fmt . Printf ( "%+v\n" , c )
return conf , nil
}
2021-03-02 05:51:08 +00:00
// WriteConfigFile will write the current config to file. If the file or the
// directory for the config file does not exist it will be created.
2021-03-01 19:49:43 +00:00
func ( c * Configuration ) WriteConfigFile ( ) error {
if _ , err := os . Stat ( c . ConfigFolder ) ; os . IsNotExist ( err ) {
2021-03-02 05:51:08 +00:00
err := os . Mkdir ( c . ConfigFolder , 0700 )
2021-03-01 19:49:43 +00:00
if err != nil {
return fmt . Errorf ( "error: failed to create directory %v: %v" , c . ConfigFolder , err )
}
}
fp := filepath . Join ( c . ConfigFolder , "config.toml" )
f , err := os . OpenFile ( fp , os . O_RDWR | os . O_CREATE | os . O_TRUNC , 0600 )
if err != nil {
2021-03-02 12:46:02 +00:00
return fmt . Errorf ( "error: WriteConfigFile: failed to open file: %v" , err )
2021-03-01 19:49:43 +00:00
}
defer f . Close ( )
enc := toml . NewEncoder ( f )
enc . Encode ( c )
return nil
}