[Refacoring] Remove Code Smell, apply CamelCase, etc (lf-edge#265)

Signed-off-by: Taras Drozdovskyi <t.drozdovsky@gmail.com>

- To reduce the number of warnings that found by SonarCloud and Lint tools, refactoring was performed. 
- This allows us to meet the requirements of the CII Best Practice: elimination of warnings found by the Analysis tools.

cmd/edge-orchestration/capi/main.go

@@ -348,5 +348,5 @@ func PrintLog(cMsg *C.char) (count C.int) {
 }
 
 func main() {
-
+	// Do nothing because it is only to build static lWatcher interface
 }

src/common/commandvalidator/commands/commands.go

@@ -32,7 +32,7 @@ type commands struct {
 	mutex        *sync.Mutex
 }
 
-const NOT_FOUND_REGISTERED_SERVICE = "not found registered service"
+const notFoundRegisteredService = "not found registered service"
 
 var commandList commands
 
@@ -51,7 +51,7 @@ func (c *commands) GetServiceFileName(serviceName string) (string, error) {
 
 	val, ok := c.serviceInfos[serviceName]
 	if !ok {
-		return "", errors.New(NOT_FOUND_REGISTERED_SERVICE)
+		return "", errors.New(notFoundRegisteredService)
 	}
 
 	return val, nil

src/common/commandvalidator/commandvalidator.go

@@ -28,11 +28,11 @@ import (
 )
 
 const (
-	NOT_MATCHED_SERVICE_WITH_EXECUTABLE = "not matched service with executable"
-	NOT_ALLOWED_EXECUTABLE_SERVICE      = "not allowed executable service"
-	NOT_FOUND_EXECUTABLE_FILE           = "not found executable file"
-	FOUND_INJECTION_COMMAND             = "found injection command"
-	ALREADY_REGISTERED                  = "already registered service name"
+	notMatchedServiceWithExecutable = "not matched service with executable"
+	notAllowedExecutableService     = "not allowed executable service"
+	notFoundExecutableFile          = "not found executable file"
+	foundInjectionCommand           = "found injection command"
+	alreadyRegisteredServiceName    = "already registered service name"
 )
 
 type ICommandValidator interface {
@@ -54,12 +54,12 @@ func (CommandValidator) AddWhiteCommand(serviceInfo configuremgrtypes.ServiceInf
 	}
 
 	if blacklist.IsBlack(command) {
-		return errors.New(NOT_ALLOWED_EXECUTABLE_SERVICE)
+		return errors.New(notAllowedExecutableService)
 	}
 
 	_, err = commands.GetInstance().GetServiceFileName(serviceInfo.ServiceName)
 	if err == nil {
-		return errors.New(ALREADY_REGISTERED)
+		return errors.New(alreadyRegisteredServiceName)
 	}
 
 	commands.GetInstance().StoreServiceInfo(serviceInfo.ServiceName, command)
@@ -69,7 +69,7 @@ func (CommandValidator) AddWhiteCommand(serviceInfo configuremgrtypes.ServiceInf
 func (CommandValidator) CheckCommand(serviceName string, command []string) error {
 	fullCommand := strings.Join(command, " ")
 	if injectionchecker.HasInjectionOperator(fullCommand) {
-		return errors.New(FOUND_INJECTION_COMMAND)
+		return errors.New(foundInjectionCommand)
 	}
 
 	expected, err := commands.GetInstance().GetServiceFileName(serviceName)
@@ -83,7 +83,7 @@ func (CommandValidator) CheckCommand(serviceName string, command []string) error
 	}
 
 	if expected != realCommand {
-		return errors.New(NOT_MATCHED_SERVICE_WITH_EXECUTABLE)
+		return errors.New(notMatchedServiceWithExecutable)
 	}
 
 	return nil
@@ -94,7 +94,7 @@ func getExecutableName(str string) (string, error) {
 	commandList := strings.Split(str, "/")
 	switch {
 	case str == "":
-		return "", errors.New(NOT_FOUND_EXECUTABLE_FILE)
+		return "", errors.New(notFoundExecutableFile)
 	case len(commandList) == 1:
 		command = commandList[0]
 	default:

src/common/requestervalidator/requesterstore/requesterstore.go

@@ -32,7 +32,7 @@ type requesters struct {
 	mutex          *sync.Mutex
 }
 
-const NOT_FOUND_REGISTERED_SERVICE = "not found registered service"
+const notFoundRegisteredService = "not found registered service"
 
 var requesterList requesters
 
@@ -48,7 +48,7 @@ func init() {
 func (r requesters) GetRequester(serviceName string) ([]string, error) {
 	val, ok := r.requesterInfos[serviceName]
 	if !ok {
-		return nil, errors.New(NOT_FOUND_REGISTERED_SERVICE)
+		return nil, errors.New(notFoundRegisteredService)
 	}
 
 	return val, nil

src/common/requestervalidator/requestervalidator.go

@@ -30,7 +30,7 @@ type IRequesterValidator interface {
 	CheckRequester(serviceName, requester string) error
 }
 
-const NOT_ALLOWED_SERVICE_EXECUTION = "not allowed service execution"
+const notAllowedServiceExecution = "not allowed service execution"
 
 type RequesterValidator struct{}
 
@@ -43,7 +43,7 @@ func (r RequesterValidator) CheckRequester(serviceName, requester string) error
 	if allowed := common.HasElem(stored, requester); allowed {
 		return nil
 	}
-	return errors.New(NOT_ALLOWED_SERVICE_EXECUTION)
+	return errors.New(notAllowedServiceExecution)
 }
 
 func (RequesterValidator) GetRequester(serviceName string) ([]string, error) {

src/controller/configuremgr/container/container.go

@@ -41,4 +41,5 @@ func GetInstance(configPath string) *ConfigureMgr {
 
 // Watch implements Watcher interface with ConfigureMgr struct
 func (cfgMgr ConfigureMgr) Watch(notifier configuremgr.Notifier) {
+	// Do nothing because it is Watcher interface
 }

src/controller/discoverymgr/mnedc/connectionutil/networkconnectionutil.go

@@ -24,15 +24,15 @@ import (
 	"github.com/lf-edge/edge-home-orchestration-go/src/restinterface/tls"
 
 	rafftls "github.com/raff/tls-ext"
-	"github.com/raff/tls-psk"
+	psk "github.com/raff/tls-psk"
 )
 
 type networkUtilImpl struct{}
 
 var networkUtilIns networkUtilImpl
 
 func init() {
-
+	// Do nothing because there is no need to initialize anything
 }
 
 //NetworkUtil interface declares the network methods

src/controller/discoverymgr/mnedc/tunmgr/tun.go

@@ -19,11 +19,11 @@ package tunmgr
 
 import (
 	"fmt"
-	"github.com/lf-edge/edge-home-orchestration-go/src/common/logmgr"
 	"net"
 	"os/exec"
 	"strings"
 
+	"github.com/lf-edge/edge-home-orchestration-go/src/common/logmgr"
 	"github.com/songgao/water"
 )
 
@@ -36,7 +36,7 @@ var (
 )
 
 func init() {
-
+	// Do nothing because there is no need to initialize anything
 }
 
 //Tun interface declares methods related to setting tun network interface

src/controller/scoringmgr/scoringmgr.go

@@ -26,8 +26,8 @@ import (
 )
 
 const (
-	logPrefix     = "scoringmgr"
-	INVALID_SCORE = 0.0
+	logPrefix    = "scoringmgr"
+	InvalidScore = 0.0
 )
 
 // Scoring is the interface to apply application specific scoring functions
@@ -71,36 +71,36 @@ func (ScoringImpl) GetResource(ID string) (resource map[string]interface{}, err
 	resource = make(map[string]interface{})
 	cpuUsage, err := resourceIns.GetResource(resourceutil.CPUUsage)
 	if err != nil {
-		resource["error"] = INVALID_SCORE
+		resource["error"] = InvalidScore
 		return
 	}
 	resource["cpuUsage"] = cpuUsage
 
 	cpuCount, err := resourceIns.GetResource(resourceutil.CPUCount)
 	if err != nil {
-		resource["error"] = INVALID_SCORE
+		resource["error"] = InvalidScore
 		return
 	}
 	resource["cpuCount"] = cpuCount
 
 	cpuFreq, err := resourceIns.GetResource(resourceutil.CPUFreq)
 	if err != nil {
-		resource["error"] = INVALID_SCORE
+		resource["error"] = InvalidScore
 		return
 	}
 	resource["cpuFreq"] = cpuFreq
 
 	netBandwidth, err := resourceIns.GetResource(resourceutil.NetBandwidth)
 	if err != nil {
-		resource["error"] = INVALID_SCORE
+		resource["error"] = InvalidScore
 		return
 	}
 	resource["netBandwidth"] = netBandwidth
 
 	resourceIns.SetDeviceID(ID)
 	rtt, err := resourceIns.GetResource(resourceutil.NetRTT)
 	if err != nil {
-		resource["error"] = INVALID_SCORE
+		resource["error"] = InvalidScore
 		return
 	}
 	resource["rtt"] = rtt
@@ -111,7 +111,7 @@ func (ScoringImpl) GetResource(ID string) (resource map[string]interface{}, err
 // GetScoreWithResource provides score value of an edge device
 func (ScoringImpl) GetScoreWithResource(resource map[string]interface{}) (scoreValue float64, err error) {
 	if _, found := resource["error"]; found {
-		return INVALID_SCORE, errors.New("Resource Not Found")
+		return InvalidScore, errors.New("Resource Not Found")
 	}
 
 	cpuScore := cpuScore(resource["cpuUsage"].(float64), resource["cpuCount"].(float64), resource["cpuFreq"].(float64))
@@ -123,28 +123,28 @@ func (ScoringImpl) GetScoreWithResource(resource map[string]interface{}) (scoreV
 func calculateScore(ID string) float64 {
 	cpuUsage, err := resourceIns.GetResource(resourceutil.CPUUsage)
 	if err != nil {
-		return INVALID_SCORE
+		return InvalidScore
 	}
 	cpuCount, err := resourceIns.GetResource(resourceutil.CPUCount)
 	if err != nil {
-		return INVALID_SCORE
+		return InvalidScore
 	}
 	cpuFreq, err := resourceIns.GetResource(resourceutil.CPUFreq)
 	if err != nil {
-		return INVALID_SCORE
+		return InvalidScore
 	}
 	cpuScore := cpuScore(cpuUsage, cpuCount, cpuFreq)
 
 	netBandwidth, err := resourceIns.GetResource(resourceutil.NetBandwidth)
 	if err != nil {
-		return INVALID_SCORE
+		return InvalidScore
 	}
 	netScore := netScore(netBandwidth)
 
 	resourceIns.SetDeviceID(ID)
 	rtt, err := resourceIns.GetResource(resourceutil.NetRTT)
 	if err != nil {
-		return INVALID_SCORE
+		return InvalidScore
 	}
 	renderingScore := renderingScore(rtt)
 

src/orchestrationapi/orchestrationapi.go

@@ -95,11 +95,11 @@ type ResponseService struct {
 }
 
 const (
-	ERROR_NONE            = "ERROR_NONE"
-	INVALID_PARAMETER     = "INVALID_PARAMETER"
-	SERVICE_NOT_FOUND     = "SERVICE_NOT_FOUND"
-	INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR"
-	NOT_ALLOWED_COMMAND   = "NOT_ALLOWED_COMMAND"
+	ErrorNone           = "ERROR_NONE"
+	InvalidParameter    = "INVALID_PARAMETER"
+	ServiceNotFound     = "SERVICE_NOT_FOUND"
+	InternalServerError = "INTERNAL_SERVER_ERROR"
+	NotAllowedCommand   = "NOT_ALLOWED_COMMAND"
 )
 
 var (
@@ -123,7 +123,7 @@ func (orcheEngine *orcheImpl) RequestService(serviceInfo ReqeustService) Respons
 
 	if orcheEngine.Ready == false {
 		return ResponseService{
-			Message:          INTERNAL_SERVER_ERROR,
+			Message:          InternalServerError,
 			ServiceName:      serviceInfo.ServiceName,
 			RemoteTargetInfo: TargetInfo{},
 		}
@@ -162,7 +162,7 @@ func (orcheEngine *orcheImpl) RequestService(serviceInfo ReqeustService) Respons
 	}
 
 	errorResp := ResponseService{
-		Message:          SERVICE_NOT_FOUND,
+		Message:          ServiceNotFound,
 		ServiceName:      serviceInfo.ServiceName,
 		RemoteTargetInfo: TargetInfo{},
 	}
@@ -184,7 +184,7 @@ func (orcheEngine *orcheImpl) RequestService(serviceInfo ReqeustService) Respons
 
 	if len(deviceScores) <= 0 {
 		return errorResp
-	} else if deviceScores[0].score == scoringmgr.INVALID_SCORE {
+	} else if deviceScores[0].score == scoringmgr.InvalidScore {
 		return errorResp
 	}
 
@@ -238,7 +238,7 @@ func (orcheEngine *orcheImpl) RequestService(serviceInfo ReqeustService) Respons
 	log.Println("[orchestrationapi] ", deviceScores)
 
 	return ResponseService{
-		Message:     ERROR_NONE,
+		Message:     ErrorNone,
 		ServiceName: serviceInfo.ServiceName,
 		RemoteTargetInfo: TargetInfo{
 			ExecutionType: deviceScores[0].execType,

src/orchestrationapi/orchestrationapi_test.go

@@ -103,7 +103,7 @@ func TestRequestService(t *testing.T) {
 		oche.Ready = true
 
 		res := oche.RequestService(requestServiceInfo)
-		if res.Message != ERROR_NONE {
+		if res.Message != ErrorNone {
 			t.Error("unexpected handle")
 		}
 	})
@@ -119,7 +119,7 @@ func TestRequestService(t *testing.T) {
 
 			oche := getOrcheImple()
 			res := oche.RequestService(requestServiceInfo)
-			if res.Message != INTERNAL_SERVER_ERROR {
+			if res.Message != InternalServerError {
 				t.Error("unexpected Error")
 			}
 		})
@@ -139,7 +139,7 @@ func TestRequestService(t *testing.T) {
 			oche.Ready = true
 
 			res := oche.RequestService(requestServiceInfo)
-			if res.Message == ERROR_NONE {
+			if res.Message == ErrorNone {
 				t.Error("unexpected Error")
 			}
 		})

src/restinterface/externalhandler/externalhandler.go

@@ -170,7 +170,7 @@ func (h *Handler) APIV1RequestServicePost(w http.ResponseWriter, r *http.Request
 	if isParseRequesterFromPort != true {
 		serviceRequester, ok := appCommand["ServiceRequester"].(string)
 		if !ok {
-			responseMsg = orchestrationapi.INVALID_PARAMETER
+			responseMsg = orchestrationapi.InvalidParameter
 			responseName = ""
 			goto SEND_RESP
 		}
@@ -179,15 +179,15 @@ func (h *Handler) APIV1RequestServicePost(w http.ResponseWriter, r *http.Request
 
 	name, ok = appCommand["ServiceName"].(string)
 	if !ok {
-		responseMsg = orchestrationapi.INVALID_PARAMETER
+		responseMsg = orchestrationapi.InvalidParameter
 		responseName = ""
 		goto SEND_RESP
 	}
 	serviceInfos.ServiceName = name
 
 	executeEnvs, ok = appCommand["ServiceInfo"].([]interface{})
 	if !ok {
-		responseMsg = orchestrationapi.INVALID_PARAMETER
+		responseMsg = orchestrationapi.InvalidParameter
 		responseName = name
 		goto SEND_RESP
 	}
@@ -197,15 +197,15 @@ func (h *Handler) APIV1RequestServicePost(w http.ResponseWriter, r *http.Request
 		tmp := executeEnv.(map[string]interface{})
 		exeType, ok := tmp["ExecutionType"].(string)
 		if !ok {
-			responseMsg = orchestrationapi.INVALID_PARAMETER
+			responseMsg = orchestrationapi.InvalidParameter
 			responseName = name
 			goto SEND_RESP
 		}
 		serviceInfos.ServiceInfo[idx].ExecutionType = exeType
 
 		exeCmd, ok := tmp["ExecCmd"].([]interface{})
 		if !ok {
-			responseMsg = orchestrationapi.INVALID_PARAMETER
+			responseMsg = orchestrationapi.InvalidParameter
 			responseName = name
 			goto SEND_RESP
 		}