refactoring: Tiny refactoring (#47)

* tiny refactoring name convention, and file name.

* added command line arguments files

* fix typo comment

.github/workflows/ci.yml

@@ -39,8 +39,8 @@ jobs:
       run: |
         echo "Quality Gate: checking test coverage is above threshold ..."
         echo "Threshold             : $TESTCOVERAGE_THRESHOLD %"
-        # Excluded the concrete strategy from the coverage calculation, because tested by integration tests
-        cat coverage.tmp.out | grep -v "secureShellStrategy.go" | grep -v "hypertextTransferProtocolStrategy.go" | grep -v "transmissionControlProtocolStrategy.go" > coverage.out
+        # Excluded the concrete strategy from the unit test coverage, because covered by integration tests
+        cat coverage.tmp.out | grep -v "ssh.go" | grep -v "http.go" | grep -v "tcp.go" > coverage.out
         totalCoverage=`go tool cover -func=coverage.out | grep total | grep -Eo '[0-9]+\.[0-9]+'`
         echo "Current test coverage : $totalCoverage %"
         if (( $(echo "$totalCoverage $TESTCOVERAGE_THRESHOLD" | awk '{print ($1 > $2)}') )); then

Makefile

@@ -4,27 +4,35 @@ ifeq (${DOCKER_COMPOSE},)
 DOCKER_COMPOSE = docker compose
 endif
 
+.PHONY: beelzebub.start
 beelzebub.start:
 	${DOCKER_COMPOSE} build;
 	${DOCKER_COMPOSE} up -d;
 
+.PHONY: beelzebub.stop
 beelzebub.stop:
 	${DOCKER_COMPOSE} down;
 
+.PHONY: test.unit
 test.unit:
 	go test ./...
 
+.PHONY: test.unit.verbose
 test.unit.verbose:
 	go test ./... -v
 
+.PHONY: test.dependencies.start
 test.dependencies.start:
 	${DOCKER_COMPOSE} -f ./integration_test/docker-compose.yml up -d
 
+.PHONY:	test.dependencies.down
 test.dependencies.down:
 	${DOCKER_COMPOSE} -f ./integration_test/docker-compose.yml down
 
+.PHONY: test.integration
 test.integration:
 	INTEGRATION=1 go test ./...
 
+.PHONY: test.integration.verbose
 test.integration.verbose:
 	INTEGRATION=1 go test ./... -v

builder/builder.go

@@ -97,9 +97,9 @@ func (b *Builder) Run() error {
 	}()
 
 	// Init Protocol strategies
-	secureShellStrategy := &strategies.SecureShellStrategy{}
-	hypertextTransferProtocolStrategy := &strategies.HypertextTransferProtocolStrategy{}
-	transmissionControlProtocolStrategy := &strategies.TransmissionControlProtocolStrategy{}
+	secureShellStrategy := &strategies.SSHStrategy{}
+	hypertextTransferProtocolStrategy := &strategies.HTTPStrategy{}
+	transmissionControlProtocolStrategy := &strategies.TCPStrategy{}
 
 	// Init Tracer strategies, and set the trace strategy default HTTP
 	protocolManager := protocols.InitProtocolManager(b.traceStrategy, hypertextTransferProtocolStrategy)

go.mod

@@ -10,8 +10,8 @@ require (
 	github.com/melbahja/goph v1.3.1
 	github.com/prometheus/client_golang v1.15.1
 	github.com/rabbitmq/amqp091-go v1.8.1
-	github.com/sirupsen/logrus v1.9.1
-	github.com/stretchr/testify v1.8.2
+	github.com/sirupsen/logrus v1.9.2
+	github.com/stretchr/testify v1.8.4
 	golang.org/x/crypto v0.9.0
 	gopkg.in/yaml.v3 v3.0.1
 )

go.sum

@@ -52,16 +52,15 @@ github.com/rabbitmq/amqp091-go v1.8.1 h1:RejT1SBUim5doqcL6s7iN6SBmsQqyTgXb1xMlH0
 github.com/rabbitmq/amqp091-go v1.8.1/go.mod h1:+jPrT9iY2eLjRaMSRHUhc3z14E/l85kv/f+6luSD3pc=
 github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ=
 github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
-github.com/sirupsen/logrus v1.9.1 h1:Ou41VVR3nMWWmTiEUnj0OlsgOSCUFgsPAOl6jRIcVtQ=
-github.com/sirupsen/logrus v1.9.1/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
+github.com/sirupsen/logrus v1.9.2 h1:oxx1eChJGI6Uks2ZC4W1zpLlVgqB8ner4EuQwV4Ik1Y=
+github.com/sirupsen/logrus v1.9.2/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/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.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8=
-github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
+github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
+github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
 github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
 go.uber.org/goleak v1.2.1 h1:NBol2c7O1ZokfZ0LEU9K6Whx/KnwvepVetCUhtKja4A=
 go.uber.org/goleak v1.2.1/go.mod h1:qlT2yGI9QafXHhZZLxlSuNsMw3FFLxBr+tBRlmO1xH4=

main.go

@@ -3,14 +3,23 @@ package main
 import (
 	"beelzebub/builder"
 	"beelzebub/parser"
+	"flag"
 	"fmt"
+
 	log "github.com/sirupsen/logrus"
 )
 
 var quit = make(chan struct{})
 
 func main() {
-	parser := parser.Init("./configurations/beelzebub.yaml", "./configurations/services/")
+	var configurationsCorePath string
+	var configurationsServicesDirectory string
+
+	flag.StringVar(&configurationsCorePath, "confCore", "./configurations/beelzebub.yaml", "Provide the path of configurations core")
+	flag.StringVar(&configurationsServicesDirectory, "confServices", "./configurations/services/", "Directory config services")
+	flag.Parse()
+
+	parser := parser.Init(configurationsCorePath, configurationsServicesDirectory)
 
 	coreConfigurations, err := parser.ReadConfigurationsCore()
 	failOnError(err, fmt.Sprintf("Error during ReadConfigurationsCore: "))
@@ -23,14 +32,11 @@ func main() {
 	director := builder.NewDirector(beelzebubBuilder)
 
 	beelzebubBuilder, err = director.BuildBeelzebub(coreConfigurations, beelzebubServicesConfiguration)
-	if err != nil {
-		log.Fatal(err)
-	}
+	failOnError(err, fmt.Sprintf("Error during BuildBeelzebub: "))
+
+	err = beelzebubBuilder.Run()
+	failOnError(err, fmt.Sprintf("Error during run beelzebub core: "))
 
-	if err := beelzebubBuilder.Run(); err != nil {
-		log.Fatal(err)
-		return
-	}
 	defer beelzebubBuilder.Close()
 
 	<-quit

plugins/openai-gpt.go

@@ -4,8 +4,11 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	"github.com/go-resty/resty/v2"
 	"strings"
+
+	log "github.com/sirupsen/logrus"
+
+	"github.com/go-resty/resty/v2"
 )
 
 const ChatGPTPluginName = "OpenAIGPTLinuxTerminal"
@@ -104,7 +107,7 @@ func (openAIGPTVirtualTerminal *OpenAIGPTVirtualTerminal) GetCompletions(command
 	if err != nil {
 		return "", err
 	}
-
+	log.Debug(response)
 	if len(response.Result().(*gptResponse).Choices) == 0 {
 		return "", errors.New("no choices")
 	}

protocols/strategies/http.go

@@ -4,19 +4,20 @@ import (
 	"beelzebub/parser"
 	"beelzebub/tracer"
 	"fmt"
-	"github.com/google/uuid"
-	log "github.com/sirupsen/logrus"
 	"io"
 	"net/http"
 	"regexp"
 	"strings"
+
+	"github.com/google/uuid"
+	log "github.com/sirupsen/logrus"
 )
 
-type HypertextTransferProtocolStrategy struct {
+type HTTPStrategy struct {
 	beelzebubServiceConfiguration parser.BeelzebubServiceConfiguration
 }
 
-func (httpStrategy HypertextTransferProtocolStrategy) Init(beelzebubServiceConfiguration parser.BeelzebubServiceConfiguration, tr tracer.Tracer) error {
+func (httpStrategy HTTPStrategy) Init(beelzebubServiceConfiguration parser.BeelzebubServiceConfiguration, tr tracer.Tracer) error {
 	httpStrategy.beelzebubServiceConfiguration = beelzebubServiceConfiguration
 	serverMux := http.NewServeMux()
 

protocols/strategies/ssh.go

@@ -15,10 +15,10 @@ import (
 	"golang.org/x/crypto/ssh/terminal"
 )
 
-type SecureShellStrategy struct {
+type SSHStrategy struct {
 }
 
-func (SSHStrategy *SecureShellStrategy) Init(beelzebubServiceConfiguration parser.BeelzebubServiceConfiguration, tr tracer.Tracer) error {
+func (sshStrategy *SSHStrategy) Init(beelzebubServiceConfiguration parser.BeelzebubServiceConfiguration, tr tracer.Tracer) error {
 	go func() {
 		server := &ssh.Server{
 			Addr:        beelzebubServiceConfiguration.Address,

protocols/strategies/tcp.go

@@ -4,16 +4,17 @@ import (
 	"beelzebub/parser"
 	"beelzebub/tracer"
 	"fmt"
-	"github.com/google/uuid"
-	log "github.com/sirupsen/logrus"
 	"net"
 	"time"
+
+	"github.com/google/uuid"
+	log "github.com/sirupsen/logrus"
 )
 
-type TransmissionControlProtocolStrategy struct {
+type TCPStrategy struct {
 }
 
-func (TCPStrategy *TransmissionControlProtocolStrategy) Init(beelzebubServiceConfiguration parser.BeelzebubServiceConfiguration, tr tracer.Tracer) error {
+func (tcpStrategy *TCPStrategy) Init(beelzebubServiceConfiguration parser.BeelzebubServiceConfiguration, tr tracer.Tracer) error {
 	listen, err := net.Listen("tcp", beelzebubServiceConfiguration.Address)
 	if err != nil {
 		log.Errorf("Error during init TCP Protocol: %s", err.Error())