Resolve "Improve naming"

hidde-jan · MaartendeKruijf · commit aa09314c6181 · 2024-02-19T16:19:42.000Z
diff --git a/application/core.go b/application/core.go
@@ -11,7 +11,7 @@ import (
 	"github.com/gin-gonic/gin"
 )
 
-func InitialiseCore(app *gin.Engine) error {
+func InitializeCore(app *gin.Engine) error {
 	ssh := new(ssh.SshCapability)
 	capabilities := map[string]capability.ICapability{ssh.GetType(): ssh}
 	executer := executer.New(capabilities)
diff --git a/application/database.go b/application/database.go
@@ -11,7 +11,7 @@ import (
 	"github.com/gin-gonic/gin"
 )
 
-func InitialliseDatabase(app *gin.Engine) error {
+func InitializeDatabase(app *gin.Engine) error {
 	mongo.LoadComponent()
 
 	log.Info("SOARCA API Trying to start")
diff --git a/application/setup.go b/application/setup.go
@@ -6,18 +6,19 @@ import (
 	"github.com/gin-gonic/gin"
 )
 
-func InitialiseAppComponents() error {
+func InitializeAppComponents() error {
 	app := gin.New()
+	log.Info("Testing if this works")
 
 	initDatabase := utils.GetEnv("DATABASE", "false")
 	if initDatabase == "true" {
-		errDatabase := InitialliseDatabase(app)
+		errDatabase := InitializeDatabase(app)
 		if errDatabase != nil {
 			log.Error("Failed to init core")
 			return errDatabase
 		}
 	}
-	errCore := InitialiseCore(app)
+	errCore := InitializeCore(app)
 
 	if errCore != nil {
 		log.Error("Failed to init core")
diff --git a/docs/docs.go b/docs/docs.go
@@ -710,7 +710,7 @@ const docTemplate = `{
                 "playbook_variables": {
                     "type": "object",
                     "additionalProperties": {
-                        "$ref": "#/definitions/cacao.Variables"
+                        "$ref": "#/definitions/cacao.Variable"
                     }
                 },
                 "playbook_version": {
@@ -733,7 +733,7 @@ const docTemplate = `{
                 }
             }
         },
-        "cacao.Variables": {
+        "cacao.Variable": {
             "type": "object",
             "properties": {
                 "constant": {
diff --git a/docs/swagger.json b/docs/swagger.json
@@ -699,7 +699,7 @@
                 "playbook_variables": {
                     "type": "object",
                     "additionalProperties": {
-                        "$ref": "#/definitions/cacao.Variables"
+                        "$ref": "#/definitions/cacao.Variable"
                     }
                 },
                 "playbook_version": {
@@ -722,7 +722,7 @@
                 }
             }
         },
-        "cacao.Variables": {
+        "cacao.Variable": {
             "type": "object",
             "properties": {
                 "constant": {
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -345,7 +345,7 @@ definitions:
         type: string
       playbook_variables:
         additionalProperties:
-          $ref: '#/definitions/cacao.Variables'
+          $ref: '#/definitions/cacao.Variable'
         type: object
       playbook_version:
         type: string
@@ -360,7 +360,7 @@ definitions:
       type:
         type: string
     type: object
-  cacao.Variables:
+  cacao.Variable:
     properties:
       constant:
         type: boolean
diff --git a/internal/capability/capability.go b/internal/capability/capability.go
@@ -11,6 +11,6 @@ type ICapability interface {
 		command cacao.Command,
 		authentication cacao.AuthenticationInformation,
 		target cacao.AgentTarget,
-		variables map[string]cacao.Variables) (map[string]cacao.Variables, error)
+		variables map[string]cacao.Variable) (map[string]cacao.Variable, error)
 	GetType() string
 }
diff --git a/internal/capability/http/http.go b/internal/capability/http/http.go
@@ -39,13 +39,13 @@ func (httpCapability *HttpCapability) Execute(
 	command cacao.Command,
 	authentication cacao.AuthenticationInformation,
 	target cacao.AgentTarget,
-	variables map[string]cacao.Variables) (map[string]cacao.Variables, error) {
+	variables map[string]cacao.Variable) (map[string]cacao.Variable, error) {
 
 	// Get request data and handle errors
 	method, url, errmethod := ObtainHttpMethodAndUrlFromCommand(command)
 	if errmethod != nil {
 		log.Error(errmethod)
-		return map[string]cacao.Variables{}, errmethod
+		return map[string]cacao.Variable{}, errmethod
 	}
 	content_data, errcontent := ObtainHttpRequestContentDataFromCommand(command)
 	if errcontent != nil {
@@ -57,7 +57,7 @@ func (httpCapability *HttpCapability) Execute(
 	request, err := http.NewRequest(method, url, bytes.NewBuffer(content_data))
 	if err != nil {
 		log.Error(err)
-		return map[string]cacao.Variables{}, err
+		return map[string]cacao.Variable{}, err
 	}
 
 	for key, httpCapability := range command.Headers {
@@ -66,12 +66,12 @@ func (httpCapability *HttpCapability) Execute(
 	if target.ID != "" {
 		if err := verifyAuthInfoMatchesAgentTarget(&target, &authentication); err != nil {
 			log.Error(err)
-			return map[string]cacao.Variables{}, err
+			return map[string]cacao.Variable{}, err
 		}
 
 		if err := setupAuthHeaders(request, &authentication); err != nil {
 			log.Error(err)
-			return map[string]cacao.Variables{}, err
+			return map[string]cacao.Variable{}, err
 		}
 	}
 
@@ -80,22 +80,22 @@ func (httpCapability *HttpCapability) Execute(
 	response, err := client.Do(request)
 	if err != nil {
 		log.Error(err)
-		return map[string]cacao.Variables{}, err
+		return map[string]cacao.Variable{}, err
 	}
 	defer response.Body.Close()
 
 	responseBytes, err := io.ReadAll(response.Body)
 	if err != nil {
 		log.Error(err)
-		return map[string]cacao.Variables{}, err
+		return map[string]cacao.Variable{}, err
 	}
 	respString := string(responseBytes)
 	sc := response.StatusCode
 	if sc < 200 || sc > 299 {
-		return map[string]cacao.Variables{}, errors.New(respString)
+		return map[string]cacao.Variable{}, errors.New(respString)
 	}
 
-	return map[string]cacao.Variables{
+	return map[string]cacao.Variable{
 		"__soarca_http_result__": {Name: "result", Value: respString}}, nil
 
 }
diff --git a/internal/capability/ssh/ssh.go b/internal/capability/ssh/ssh.go
@@ -31,7 +31,7 @@ func (sshCapability *SshCapability) Execute(executionId uuid.UUID,
 	command cacao.Command,
 	authentication cacao.AuthenticationInformation,
 	target cacao.AgentTarget,
-	variables map[string]cacao.Variables) (map[string]cacao.Variables, error) {
+	variables map[string]cacao.Variable) (map[string]cacao.Variable, error) {
 	log.Trace(executionId)
 
 	host := CombinePortAndAddress(target.Address, target.Port)
@@ -40,7 +40,7 @@ func (sshCapability *SshCapability) Execute(executionId uuid.UUID,
 
 	if errAuth != nil {
 		log.Error(errAuth)
-		return map[string]cacao.Variables{}, errAuth
+		return map[string]cacao.Variable{}, errAuth
 	} else {
 		log.Trace(host)
 	}
@@ -60,7 +60,7 @@ func (sshCapability *SshCapability) Execute(executionId uuid.UUID,
 		signer, errKey := ssh.ParsePrivateKey([]byte(authentication.PrivateKey))
 		if errKey != nil || authentication.Password == "" {
 			log.Error("no valid authentication information: ", errKey)
-			return map[string]cacao.Variables{}, errKey
+			return map[string]cacao.Variable{}, errKey
 		}
 		config = ssh.ClientConfig{
 			User: authentication.Username,
@@ -78,23 +78,23 @@ func (sshCapability *SshCapability) Execute(executionId uuid.UUID,
 	conn, err := ssh.Dial("tcp", host, &config)
 	if err != nil {
 		log.Error(err)
-		return map[string]cacao.Variables{}, err
+		return map[string]cacao.Variable{}, err
 	}
 	var session *ssh.Session
 	session, err = conn.NewSession()
 	if err != nil {
 		log.Error(err)
-		return map[string]cacao.Variables{}, err
+		return map[string]cacao.Variable{}, err
 	}
 
 	response, err := session.Output(StripSshPrepend(command.Command))
 	defer session.Close()
 
 	if err != nil {
 		log.Error(err)
-		return map[string]cacao.Variables{"__soarca_ssh_result__": {Name: "result", Value: string(response)}}, err
+		return map[string]cacao.Variable{"__soarca_ssh_result__": {Name: "result", Value: string(response)}}, err
 	}
-	results := map[string]cacao.Variables{"__soarca_ssh_result__": {Name: "result", Value: string(response)}}
+	results := map[string]cacao.Variable{"__soarca_ssh_result__": {Name: "result", Value: string(response)}}
 	log.Trace("Finished ssh execution will return the variables: ", results)
 	return results, err
 }
diff --git a/internal/decomposer/decomposer.go b/internal/decomposer/decomposer.go
@@ -48,7 +48,7 @@ type Decomposer struct {
 	guid      guid.IGuid
 }
 
-func Callback(executionId uuid.UUID, outputVariables map[string]cacao.Variables) {
+func Callback(executionId uuid.UUID, outputVariables map[string]cacao.Variable) {
 
 }
 
diff --git a/internal/executer/executer.go b/internal/executer/executer.go
@@ -20,8 +20,8 @@ type IExecuter interface {
 		command cacao.Command,
 		authentication cacao.AuthenticationInformation,
 		target cacao.AgentTarget,
-		variable map[string]cacao.Variables,
-		module cacao.AgentTarget) (uuid.UUID, map[string]cacao.Variables, error)
+		variable map[string]cacao.Variable,
+		module cacao.AgentTarget) (uuid.UUID, map[string]cacao.Variable, error)
 }
 
 func init() {
@@ -42,14 +42,14 @@ func (executer *Executer) Execute(executionId uuid.UUID,
 	command cacao.Command,
 	authentication cacao.AuthenticationInformation,
 	target cacao.AgentTarget,
-	variable map[string]cacao.Variables,
-	agent cacao.AgentTarget) (uuid.UUID, map[string]cacao.Variables, error) {
+	variable map[string]cacao.Variable,
+	agent cacao.AgentTarget) (uuid.UUID, map[string]cacao.Variable, error) {
 
 	if capability, ok := executer.capabilities[agent.Name]; ok {
 		returnVariables, err := capability.Execute(executionId, command, authentication, target, variable)
 		return executionId, returnVariables, err
 	} else {
-		empty := map[string]cacao.Variables{}
+		empty := map[string]cacao.Variable{}
 		message := "executor is not available in soarca"
 		err := errors.New(message)
 		log.Error(message)
diff --git a/main.go b/main.go
@@ -39,7 +39,7 @@ func main() {
 		log.Warning("Failed to read env variable, but will continue")
 	}
 
-	errinit := application.InitialiseAppComponents()
+	errinit := application.InitializeAppComponents()
 	if errinit != nil {
 		log.Fatal("Something Went wrong with setting-up the app, msg: ", errinit)
 		panic(errinit)
diff --git a/models/cacao/cacao.go b/models/cacao/cacao.go
@@ -56,7 +56,7 @@ type Playbook struct {
 	AgentDefinitions              map[string]AgentTarget               `bson:"agent_definitions,omitempty" json:"agent_definitions,omitempty"`
 	TargetDefinitions             map[string]AgentTarget               `bson:"target_definitions,omitempty" json:"target_definitions,omitempty"`
 	ExtensionDefinitions          map[string]ExtensionDefinition       `bson:"extension_definitions,omitempty" json:"extension_definitions,omitempty"`
-	PlaybookVariables             map[string]Variables                 `bson:"playbook_variables,omitempty" json:"playbook_variables,omitempty"`
+	PlaybookVariables             map[string]Variable                  `bson:"playbook_variables,omitempty" json:"playbook_variables,omitempty"`
 	PlaybookExtensions            Extensions                           `bson:"playbook_extensions,omitempty" json:"playbook_extensions,omitempty"`
 }
 
@@ -131,7 +131,7 @@ type ExtensionDefinition struct {
 	ExternalReferences []ExternalReferences `bson:"external_references,omitempty" json:"external_references,omitempty"`
 }
 
-type Variables struct {
+type Variable struct {
 	Type        string `bson:"type" json:"type" validate:"required"`
 	Name        string `bson:"name,omitempty" json:"name,omitempty"`
 	Description string `bson:"description,omitempty" json:"description,omitempty"`
@@ -160,7 +160,7 @@ type Step struct {
 	ExternalReferences []ExternalReferences `bson:"external_references,omitempty" json:"external_references,omitempty"`
 	Delay              int                  `bson:"delay,omitempty" json:"delay,omitempty"`
 	Timeout            int                  `bson:"timeout,omitempty" json:"timeout,omitempty"`
-	StepVariables      map[string]Variables `bson:"step_variables,omitempty" json:"step_variables,omitempty"`
+	StepVariables      map[string]Variable  `bson:"step_variables,omitempty" json:"step_variables,omitempty"`
 	Owner              string               `bson:"owner,omitempty" json:"owner,omitempty"`
 	OnCompletion       string               `bson:"on_completion,omitempty" json:"on_completion,omitempty"`
 	OnSuccess          string               `bson:"on_success,omitempty" json:"on_success,omitempty"`
diff --git a/test/capability/http/http_test.go b/test/capability/http/http_test.go
@@ -21,7 +21,7 @@ func TestHttpConnection(t *testing.T) {
 		Headers: map[string]string{"accept": "application/json"},
 	}
 
-	var variable1 = cacao.Variables{
+	var variable1 = cacao.Variable{
 		Type:  "string",
 		Name:  "test_auth",
 		Value: "",
@@ -33,7 +33,7 @@ func TestHttpConnection(t *testing.T) {
 		id, expectedCommand,
 		cacao.AuthenticationInformation{},
 		cacao.AgentTarget{},
-		map[string]cacao.Variables{"test": variable1})
+		map[string]cacao.Variable{"test": variable1})
 	if err != nil {
 		fmt.Println(err)
 		t.Fail()
@@ -57,7 +57,7 @@ func TestHttpOAuth2(t *testing.T) {
 		Headers: map[string]string{"accept": "application/json"},
 	}
 
-	var variable1 = cacao.Variables{
+	var variable1 = cacao.Variable{
 		Type:  "string",
 		Name:  "test_auth",
 		Value: "",
@@ -73,7 +73,7 @@ func TestHttpOAuth2(t *testing.T) {
 	var id, _ = uuid.Parse("6ba7b810-9dad-11d1-80b4-00c04fd430c8")
 
 	results, err := httpCapability.Execute(
-		id, expectedCommand, oauth2_info, target, map[string]cacao.Variables{"test": variable1})
+		id, expectedCommand, oauth2_info, target, map[string]cacao.Variable{"test": variable1})
 	if err != nil {
 		fmt.Println(err)
 		t.Fail()
@@ -97,7 +97,7 @@ func TestHttpBasicAuth(t *testing.T) {
 		Headers: map[string]string{"accept": "application/json"},
 	}
 
-	var variable1 = cacao.Variables{
+	var variable1 = cacao.Variable{
 		Type:  "string",
 		Name:  "test_auth",
 		Value: "",
@@ -112,7 +112,7 @@ func TestHttpBasicAuth(t *testing.T) {
 	var id, _ = uuid.Parse("6ba7b810-9dad-11d1-80b4-00c04fd430c8")
 
 	results, err := httpCapability.Execute(
-		id, expectedCommand, basicauth_info, target, map[string]cacao.Variables{"test": variable1})
+		id, expectedCommand, basicauth_info, target, map[string]cacao.Variable{"test": variable1})
 	if err != nil {
 		fmt.Println(err)
 		t.Fail()
diff --git a/test/capability/ssh/ssh_test.go b/test/capability/ssh/ssh_test.go
@@ -32,7 +32,7 @@ func TestSshConnection(t *testing.T) {
 		AuthInfoIdentifier: "some-authid-1",
 	}
 
-	expectedVariables := cacao.Variables{
+	expectedVariables := cacao.Variable{
 		Type:  "string",
 		Name:  "var1",
 		Value: "testing",
@@ -43,7 +43,7 @@ func TestSshConnection(t *testing.T) {
 		expectedCommand,
 		expectedAuthenticationInformation,
 		expectedTarget,
-		map[string]cacao.Variables{expectedVariables.Name: expectedVariables})
+		map[string]cacao.Variable{expectedVariables.Name: expectedVariables})
 	if err != nil {
 		fmt.Println(err)
 		t.Fail()
diff --git a/test/decomposer/decomposer_test.go b/test/decomposer/decomposer_test.go
diff --git a/test/executor/executor_test.go b/test/executor/executor_test.go
diff --git a/test/mocks/mock_capability/mock_capability.go b/test/mocks/mock_capability/mock_capability.go
diff --git a/test/mocks/mock_executor/mock_executor.go b/test/mocks/mock_executor/mock_executor.go

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import (`
`11`	`11`	`"github.com/gin-gonic/gin"`
`12`	`12`	`)`
`13`	`13`
`14`		`-func InitialiseCore(app *gin.Engine) error {`
	`14`	`+func InitializeCore(app *gin.Engine) error {`
`15`	`15`	`ssh := new(ssh.SshCapability)`
`16`	`16`	`capabilities := map[string]capability.ICapability{ssh.GetType(): ssh}`
`17`	`17`	`executer := executer.New(capabilities)`
Original file line number	Diff line number	Diff line change
@@ -710,7 +710,7 @@ const docTemplate = `{
`710`	`710`	`"playbook_variables": {`
`711`	`711`	`"type": "object",`
`712`	`712`	`"additionalProperties": {`
`713`		`- "$ref": "#/definitions/cacao.Variables"`
	`713`	`+ "$ref": "#/definitions/cacao.Variable"`
`714`	`714`	`}`
`715`	`715`	`},`
`716`	`716`	`"playbook_version": {`
@@ -733,7 +733,7 @@ const docTemplate = `{
`733`	`733`	`}`
`734`	`734`	`}`
`735`	`735`	`},`
`736`		`- "cacao.Variables": {`
	`736`	`+ "cacao.Variable": {`
`737`	`737`	`"type": "object",`
`738`	`738`	`"properties": {`
`739`	`739`	`"constant": {`
Original file line number	Diff line number	Diff line change
`@@ -699,7 +699,7 @@`
`699`	`699`	`"playbook_variables": {`
`700`	`700`	`"type": "object",`
`701`	`701`	`"additionalProperties": {`
`702`		`- "$ref": "#/definitions/cacao.Variables"`
	`702`	`+ "$ref": "#/definitions/cacao.Variable"`
`703`	`703`	`}`
`704`	`704`	`},`
`705`	`705`	`"playbook_version": {`
`@@ -722,7 +722,7 @@`
`722`	`722`	`}`
`723`	`723`	`}`
`724`	`724`	`},`
`725`		`- "cacao.Variables": {`
	`725`	`+ "cacao.Variable": {`
`726`	`726`	`"type": "object",`
`727`	`727`	`"properties": {`
`728`	`728`	`"constant": {`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,6 @@ type ICapability interface {`
`11`	`11`	`command cacao.Command,`
`12`	`12`	`authentication cacao.AuthenticationInformation,`
`13`	`13`	`target cacao.AgentTarget,`
`14`		`- variables map[string]cacao.Variables) (map[string]cacao.Variables, error)`
	`14`	`+ variables map[string]cacao.Variable) (map[string]cacao.Variable, error)`
`15`	`15`	`GetType() string`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ type Decomposer struct {`
`48`	`48`	`guid guid.IGuid`
`49`	`49`	`}`
`50`	`50`
`51`		`-func Callback(executionId uuid.UUID, outputVariables map[string]cacao.Variables) {`
	`51`	`+func Callback(executionId uuid.UUID, outputVariables map[string]cacao.Variable) {`
`52`	`52`
`53`	`53`	`}`
`54`	`54`