diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f43477b..2238ffb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -39,7 +39,7 @@ jobs: run: | echo "Quality Gate: checking test coverage is above threshold ..." echo "Threshold : $TESTCOVERAGE_THRESHOLD %" - # Excluded the concrete strategy + # Excluded the concrete strategy from the coverage calculation, this will be tested in the integration tests cat coverage.tmp.out | grep -v "secureShellStrategy.go" | grep -v "hypertextTransferProtocolStrategy.go" | grep -v "transmissionControlProtocolStrategy.go" > coverage.out totalCoverage=`go tool cover -func=coverage.out | grep total | grep -Eo '[0-9]+\.[0-9]+'` echo "Current test coverage : $totalCoverage %" diff --git a/builder/Builder.go b/builder/Builder.go new file mode 100644 index 0000000..572b99d --- /dev/null +++ b/builder/Builder.go @@ -0,0 +1,125 @@ +package builder + +import ( + "beelzebub/parser" + "beelzebub/protocols" + "beelzebub/tracer" + "errors" + "fmt" + amqp "github.com/rabbitmq/amqp091-go" + log "github.com/sirupsen/logrus" + "io" + "os" +) + +const RabbitmqQueueName = "event" + +type Builder struct { + beelzebubServicesConfiguration []parser.BeelzebubServiceConfiguration + traceStrategy tracer.Strategy + rabbitMQChannel *amqp.Channel + rabbitMQConnection *amqp.Connection + logsFile *os.File +} + +func (b *Builder) setTraceStrategy(traceStrategy tracer.Strategy) { + b.traceStrategy = traceStrategy +} + +func (b *Builder) buildLogger(configurations parser.Logging) error { + logsFile, err := os.OpenFile(configurations.LogsPath, os.O_APPEND|os.O_CREATE|os.O_RDWR, 0666) + if err != nil { + return err + } + + log.SetOutput(io.MultiWriter(os.Stdout, logsFile)) + + log.SetFormatter(&log.JSONFormatter{ + DisableTimestamp: configurations.LogDisableTimestamp, + }) + log.SetReportCaller(configurations.DebugReportCaller) + if configurations.Debug { + log.SetLevel(log.DebugLevel) + } else { + log.SetLevel(log.InfoLevel) + } + b.logsFile = logsFile + return err +} + +func (b *Builder) buildRabbitMQ(rabbitMQURI string) error { + rabbitMQConnection, err := amqp.Dial(rabbitMQURI) + if err != nil { + return err + } + + b.rabbitMQChannel, err = rabbitMQConnection.Channel() + if err != nil { + return err + } + + //creates a queue if it doesn't already exist, or ensures that an existing queue matches the same parameters. + if _, err = b.rabbitMQChannel.QueueDeclare(RabbitmqQueueName, false, false, false, false, nil); err != nil { + return err + } + + b.rabbitMQConnection = rabbitMQConnection + return nil +} + +func (b *Builder) Close() error { + if err := b.rabbitMQChannel.Close(); err != nil { + return err + } + if err := b.rabbitMQConnection.Close(); err != nil { + return err + } + if err := b.logsFile.Close(); err != nil { + return err + } + + return nil +} + +func (b *Builder) Run() error { + // Init Protocol strategies + secureShellStrategy := &protocols.SecureShellStrategy{} + hypertextTransferProtocolStrategy := &protocols.HypertextTransferProtocolStrategy{} + transmissionControlProtocolStrategy := &protocols.TransmissionControlProtocolStrategy{} + + // Init Tracer strategies, and set the trace strategy default HTTP + protocolManager := protocols.InitProtocolManager(b.traceStrategy, hypertextTransferProtocolStrategy) + + for _, beelzebubServiceConfiguration := range b.beelzebubServicesConfiguration { + switch beelzebubServiceConfiguration.Protocol { + case "http": + protocolManager.SetProtocolStrategy(hypertextTransferProtocolStrategy) + break + case "ssh": + protocolManager.SetProtocolStrategy(secureShellStrategy) + break + case "tcp": + protocolManager.SetProtocolStrategy(transmissionControlProtocolStrategy) + break + default: + log.Fatalf("Protocol %s not managed", beelzebubServiceConfiguration.Protocol) + continue + } + + if err := protocolManager.InitService(beelzebubServiceConfiguration); err != nil { + return errors.New(fmt.Sprintf("Error during init protocol: %s, %s", beelzebubServiceConfiguration.Protocol, err.Error())) + } + } + return nil +} + +func (b *Builder) build() *Builder { + return &Builder{ + beelzebubServicesConfiguration: b.beelzebubServicesConfiguration, + traceStrategy: b.traceStrategy, + } +} + +func NewBuilder() *Builder { + return &Builder{} +} diff --git a/builder/Director.go b/builder/Director.go new file mode 100644 index 0000000..35d5238 --- /dev/null +++ b/builder/Director.go @@ -0,0 +1,67 @@ +package builder + +import ( + "beelzebub/parser" + "beelzebub/tracer" + "context" + "encoding/json" + amqp "github.com/rabbitmq/amqp091-go" + log "github.com/sirupsen/logrus" +) + +type Director struct { + builder *Builder +} + +func NewDirector(builder *Builder) *Director { + return &Director{ + builder: builder, + } +} + +func (d *Director) BuildBeelzebub(beelzebubCoreConfigurations *parser.BeelzebubCoreConfigurations, beelzebubServicesConfiguration []parser.BeelzebubServiceConfiguration) (*Builder, error) { + d.builder.beelzebubServicesConfiguration = beelzebubServicesConfiguration + + if err := d.builder.buildLogger(beelzebubCoreConfigurations.Core.Logging); err != nil { + return nil, err + } + + d.builder.setTraceStrategy(d.standardOutStrategy) + + if beelzebubCoreConfigurations.Core.Tracing.RabbitMQEnabled { + d.builder.setTraceStrategy(d.rabbitMQTraceStrategy) + err := d.builder.buildRabbitMQ(beelzebubCoreConfigurations.Core.Tracing.RabbitMQURI) + if err != nil { + return nil, err + } + } + + return d.builder.build(), nil +} + +func (d *Director) standardOutStrategy(event tracer.Event) { + log.WithFields(log.Fields{ + "status": event.Status, + "event": event, + }).Info("New Event") +} + +func (d *Director) rabbitMQTraceStrategy(event tracer.Event) { + log.WithFields(log.Fields{ + "status": event.Status, + "event": event, + }).Info("New Event") + + log.Debug("Push Event on queue") + eventJSON, err := json.Marshal(event) + if err != nil { + log.Error(err.Error()) + return + } + + publishing := amqp.Publishing{ContentType: "application/json", Body: eventJSON} + + if err = d.builder.rabbitMQChannel.PublishWithContext(context.TODO(), "", RabbitmqQueueName, false, false, publishing); err != nil { + log.Error(err.Error()) + } +} diff --git a/go.sum b/go.sum index 606c10a..051b215 100644 --- a/go.sum +++ b/go.sum @@ -9,6 +9,7 @@ github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I= github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI= github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pty v1.1.1 h1:VkoXIwSboBpnk99O/KFauAEILuNHv5DVFKZMBN/gUgw= github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= @@ -20,12 +21,14 @@ github.com/sirupsen/logrus v1.9.0 h1:trlNQbNUG3OdDrDil03MCb1H2o9nJ1x4/5LYw7byDE0 github.com/sirupsen/logrus v1.9.0/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0 h1:1zr/of2m5FGMsad5YfcqgdqdWrIhu+EBEJRhR1U7z/c= github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk= github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/yuin/goldmark v1.3.5 h1:dPmz1Snjq0kmkz159iL7S6WzdahUTHnHB5M56WFVifs= github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= go.uber.org/goleak v1.1.12 h1:gZAh5/EyT/HQwlpkCy6wTpqfH9H8Lz8zbm3dZh+OyzA= go.uber.org/goleak v1.1.12/go.mod h1:cwTWslyiVhfpKIDGSZEM2HlOvcqm+tG4zioyIeLoqMQ= @@ -33,15 +36,19 @@ golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACk golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20220826181053-bd7e27e6170d h1:3qF+Z8Hkrw9sOhrFHti9TlB1Hkac1x+DNRkv0XQiFjo= golang.org/x/crypto v0.0.0-20220826181053-bd7e27e6170d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/lint v0.0.0-20190930215403-16217165b5de h1:5hukYrvBGR8/eNkX5mdUezrA6JiaEZDtJb9Ei+1LlBs= golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/mod v0.4.2 h1:Gz96sIWK3OalVv/I/qNygP42zyoKp3xptRVCWRFEBvo= golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.0.0-20220826154423-83b083e8dc8b h1:ZmngSVLe/wycRns9MKikG9OWIEjGcGAkacif7oYQaUY= golang.org/x/net v0.0.0-20220826154423-83b083e8dc8b/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20210220032951-036812b2e83c h1:5KslGYwFpkhGh+Q16bwMP3cOontH8FOep7tGV86Y7SQ= golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -61,13 +68,16 @@ golang.org/x/term v0.0.0-20220722155259-a9ba230a4035/go.mod h1:jbD1KX2456YbFQfuX golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.5 h1:ouewzE6p+/VEB31YYnTbEJdi8pFqKp4P4n85vwo3DHA= golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE= golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY= diff --git a/main.go b/main.go index 60ff49c..eb8ffc5 100644 --- a/main.go +++ b/main.go @@ -1,74 +1,38 @@ package main import ( + "beelzebub/builder" "beelzebub/parser" - "beelzebub/protocols" - "beelzebub/tracer" - "encoding/json" "fmt" - amqp "github.com/rabbitmq/amqp091-go" log "github.com/sirupsen/logrus" - "io" - "os" ) var quit = make(chan struct{}) -var channel *amqp.Channel - func main() { parser := parser.Init("./configurations/beelzebub.yaml", "./configurations/services/") coreConfigurations, err := parser.ReadConfigurationsCore() failOnError(err, fmt.Sprintf("Error during ReadConfigurationsCore: ")) - fileLogs := configureLoggingByConfigurations(coreConfigurations.Core.Logging) - defer fileLogs.Close() - beelzebubServicesConfiguration, err := parser.ReadConfigurationsServices() failOnError(err, fmt.Sprintf("Error during ReadConfigurationsServices: ")) - if coreConfigurations.Core.Tracing.RabbitMQEnabled { - rabbitMQURI, configured := os.LookupEnv("RABBITMQ_URI") - if !configured { - rabbitMQURI = coreConfigurations.Core.Tracing.RabbitMQURI - } - conn, err := amqp.Dial(rabbitMQURI) - failOnError(err, "Failed to connect to RabbitMQ") - defer conn.Close() - - channel, err = conn.Channel() - failOnError(err, "Failed to open a channel") - defer channel.Close() - } - - // Init Protocol strategies - secureShellStrategy := &protocols.SecureShellStrategy{} - hypertextTransferProtocolStrategy := &protocols.HypertextTransferProtocolStrategy{} - transmissionControlProtocolStrategy := &protocols.TransmissionControlProtocolStrategy{} + beelzebubBuilder := builder.NewBuilder() - // Init protocol manager, with simple log on stout trace strategy and default protocol HTTP - protocolManager := protocols.InitProtocolManager(traceStrategyStdoutAndRabbitMQ, hypertextTransferProtocolStrategy) + director := builder.NewDirector(beelzebubBuilder) - for _, beelzebubServiceConfiguration := range beelzebubServicesConfiguration { - switch beelzebubServiceConfiguration.Protocol { - case "http": - protocolManager.SetProtocolStrategy(hypertextTransferProtocolStrategy) - break - case "ssh": - protocolManager.SetProtocolStrategy(secureShellStrategy) - break - case "tcp": - protocolManager.SetProtocolStrategy(transmissionControlProtocolStrategy) - break - default: - log.Fatalf("Protocol %s not managed", beelzebubServiceConfiguration.Protocol) - continue - } + beelzebubBuilder, err = director.BuildBeelzebub(coreConfigurations, beelzebubServicesConfiguration) + if err != nil { + log.Fatal(err) + } - err := protocolManager.InitService(beelzebubServiceConfiguration) - failOnError(err, fmt.Sprintf("Error during init protocol: %s, ", beelzebubServiceConfiguration.Protocol)) + if err := beelzebubBuilder.Run(); err != nil { + log.Fatal(err) + return } + defer beelzebubBuilder.Close() + <-quit } @@ -77,57 +41,3 @@ func failOnError(err error, msg string) { log.Fatalf("%s: %s", msg, err) } } - -func traceStrategyStdoutAndRabbitMQ(event tracer.Event) { - log.WithFields(log.Fields{ - "status": event.Status, - "event": event, - }).Info("New Event") - - if channel != nil { - log.Debug("Push Event on queue") - eventJSON, err := json.Marshal(event) - failOnError(err, "Failed to Marshal Event") - - queue, err := channel.QueueDeclare( - "event", - false, - false, - false, - false, - nil, - ) - failOnError(err, "Failed to declare a queue") - - err = channel.Publish( - "", - queue.Name, - false, - false, - amqp.Publishing{ - ContentType: "application/json", - Body: eventJSON, - }) - failOnError(err, "Failed to publish a message") - } -} - -func configureLoggingByConfigurations(configurations parser.Logging) *os.File { - file, err := os.OpenFile(configurations.LogsPath, os.O_APPEND|os.O_CREATE|os.O_RDWR, 0666) - if err != nil { - log.Fatalf("error opening file: %v", err) - } - - log.SetOutput(io.MultiWriter(os.Stdout, file)) - - log.SetFormatter(&log.JSONFormatter{ - DisableTimestamp: configurations.LogDisableTimestamp, - }) - log.SetReportCaller(configurations.DebugReportCaller) - if configurations.Debug { - log.SetLevel(log.DebugLevel) - } else { - log.SetLevel(log.InfoLevel) - } - return file -}