From 7cbe8f430a34b1ffebaa96854a48a7c618ab5d89 Mon Sep 17 00:00:00 2001 From: Gulsum Atici Date: Mon, 25 Mar 2024 21:47:24 +0300 Subject: [PATCH] chore: Adding webUri input parameter to ConfigWatcher function (#35) * Adding webUri input parameter to ConfigWatcher function Signed-off-by: gatici * Fix lint issue --------- Signed-off-by: gatici Co-authored-by: gab-arrobo --- .github/workflows/main.yml | 15 ++ .golangci.yml | 298 +++++++++++++++++++++++++++++++++++++ logger/logger.go | 3 +- proto/client/gClient.go | 28 ++-- 4 files changed, 329 insertions(+), 15 deletions(-) create mode 100644 .golangci.yml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index b3af1e3..380804e 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -53,3 +53,18 @@ jobs: uses: fossa-contrib/fossa-action@v3 with: fossa-api-key: 0c3bbcdf20e157bbd487dae173751b28 + lint: + name: lint + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-go@v5 + with: + go-version-file: 'go.mod' + + - name: golangci-lint + uses: golangci/golangci-lint-action@v4.0.0 + with: + version: latest + args: -v --config ./.golangci.yml diff --git a/.golangci.yml b/.golangci.yml new file mode 100644 index 0000000..3652396 --- /dev/null +++ b/.golangci.yml @@ -0,0 +1,298 @@ +# SPDX-FileCopyrightText: 2021 Open Networking Foundation +# Copyright 2019 free5GC.org +# +# SPDX-License-Identifier: Apache-2.0 +# + +# This file contains all available configuration options +# with their default values. +# options for analysis running +run: + # default concurrency is a available CPU number + concurrency: 4 + # timeout for analysis, e.g. 30s, 5m, default is 1m + timeout: 1m + # exit code when at least one issue was found, default is 1 + issues-exit-code: 1 + # include test files or not, default is true + tests: true + # list of build tags, all linters use it. Default is empty list. + build-tags: + # which dirs to skip: issues from them won't be reported; + # can use regexp here: generated.*, regexp is applied on full path; + # default value is empty list, but default dirs are skipped independently + # from this option's value (see skip-dirs-use-default). + # "/" will be replaced by current OS file path separator to properly work + # on Windows. + skip-dirs-use-default: true + # which files to skip: they will be analyzed, but issues from them + # won't be reported. Default value is empty list, but there is + # no need to include all autogenerated files, we confidently recognize + # autogenerated files. If it's not please let us know. + # "/" will be replaced by current OS file path separator to properly work + # on Windows. + skip-files: + - "config.pb.go" + - "config_grpc.pb.go" + # by default isn't set. If set we pass it to "go list -mod={option}". From "go help modules": + # If invoked with -mod=readonly, the go command is disallowed from the implicit + # automatic updating of go.mod described above. Instead, it fails when any changes + # to go.mod are needed. This setting is most useful to check that go.mod does + # not need updates, such as in a continuous integration and testing system. + # If invoked with -mod=vendor, the go command assumes that the vendor + # directory holds the correct copies of dependencies and ignores + # the dependency descriptions in go.mod. + #modules-download-mode: readonly|release|vendor + # Allow multiple parallel golangci-lint instances running. + # If false (default) - golangci-lint acquires file lock on start. + allow-parallel-runners: true +# output configuration options +output: + # colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number" + format: colored-line-number + # print lines of code with issue, default is true + print-issued-lines: true + # print linter name in the end of issue text, default is true + print-linter-name: true + # make issues output unique by line, default is true + uniq-by-line: true +# all available settings of specific linters +linters-settings: + errcheck: + # report about not checking of errors in type assertions: `a := b.(MyStruct)`; + # default is false: such cases aren't reported by default. + check-type-assertions: false + # report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`; + # default is false: such cases aren't reported by default. + check-blank: true + # [deprecated] comma-separated list of pairs of the form pkg:regex + # the regex is used to ignore names within pkg. (default "fmt:.*"). + # see https://github.com/kisielk/errcheck#the-deprecated-method for details + #ignore: fmt:.*,io/ioutil:^Read.* + # path to a file containing a list of functions to exclude from checking + # see https://github.com/kisielk/errcheck#excluding-functions for details + #exclude: /path/to/file.txt + funlen: + lines: 60 + statements: 40 + gocognit: + # minimal code complexity to report, 30 by default (but we recommend 10-20) + min-complexity: 10 + nestif: + # minimal complexity of if statements to report, 5 by default + min-complexity: 4 + goconst: + # minimal length of string constant, 3 by default + min-len: 3 + # minimal occurrences count to trigger, 3 by default + min-occurrences: 3 + gocritic: + # Which checks should be enabled; can't be combined with 'disabled-checks'; + # See https://go-critic.github.io/overview#checks-overview + # To check which checks are enabled run `GL_DEBUG=gocritic golangci-lint run` + # By default list of stable checks is used. + enabled-checks: + #- rangeValCopy + # Which checks should be disabled; can't be combined with 'enabled-checks'; default is empty + disabled-checks: + - regexpMust + # Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks. + # Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags". + enabled-tags: + - performance + disabled-tags: + - experimental + settings: # settings passed to gocritic + captLocal: # must be valid enabled check name + paramsOnly: true + rangeValCopy: + sizeThreshold: 32 + gocyclo: + # minimal code complexity to report, 30 by default (but we recommend 10-20) + min-complexity: 10 + godox: + # report any comments starting with keywords, this is useful for TODO or FIXME comments that + # might be left in the code accidentally and should be resolved before merging + keywords: # default keywords are TODO, BUG, and FIXME, these can be overwritten by this setting + #- TODO + - FIXME + - BUG + #- NOTE + #- OPTIMIZE # marks code that should be optimized before merging + #- HACK # marks hack-arounds that should be removed before merging + - XXX # Fatal! Important problem + gofmt: + # simplify code: gofmt with `-s` option, true by default + simplify: true + goimports: + # put imports beginning with prefix after 3rd-party packages; + # it's a comma-separated list of prefixes + local-prefixes: github.com/org/project + golint: + # minimal confidence for issues, default is 0.8 + min-confidence: 0.8 + gomnd: + settings: + mnd: + # the list of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description. + checks: argument,case,condition,operation,return,assign + gomodguard: + allowed: + modules: # List of allowed modules + # - gopkg.in/yaml.v2 + domains: # List of allowed module domains + # - golang.org + blocked: + modules: # List of blocked modules + # - github.com/uudashr/go-module: # Blocked module + # recommendations: # Recommended modules that should be used instead (Optional) + # - golang.org/x/mod + # reason: "`mod` is the official go.mod parser library." # Reason why the recommended module should be used (Optional) + versions: # List of blocked module version constraints + # - github.com/mitchellh/go-homedir: # Blocked module with version constraint + # version: "< 1.1.0" # Version constraint, see https://github.com/Masterminds/semver#basic-comparisons + # reason: "testing if blocked version constraint works." # Reason why the version constraint exists. (Optional) + govet: + # report about shadowed variables + check-shadowing: true + # settings per analyzer + settings: + printf: # analyzer name, run `go tool vet help` to see all analyzers + funcs: # run `go tool vet help printf` to see available settings for `printf` analyzer + - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof + - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf + - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf + - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf + # enable all analyzers + enable-all: true + depguard: + list-type: blacklist + include-go-root: false + packages: + - github.com/sirupsen/logrus + packages-with-error-message: + # specify an error message to output when a blacklisted package is used + - github.com/sirupsen/logrus: "logging is allowed only by logutils.Log" + lll: + # max line length, lines longer will be reported. Default is 120. + # '\t' is counted as 1 character by default, and can be changed with the tab-width option + line-length: 120 + # tab width in spaces. Default to 1. + tab-width: 1 + maligned: + # print struct with more effective memory layout or not, false by default + suggest-new: true + nakedret: + # make an issue if func has more lines of code than this setting and it has naked returns; default is 30 + max-func-lines: 30 + testpackage: + # regexp pattern to skip files + skip-regexp: (export|internal)_test\.go + unused: + # treat code as a program (not a library) and report unused exported identifiers; default is false. + # XXX: if you enable this setting, unused will report a lot of false-positives in text editors: + # if it's called for subdir of a project it can't find funcs usages. All text editor integrations + # with golangci-lint call it on a directory with the changed file. + check-exported: false + whitespace: + multi-if: false # Enforces newlines (or comments) after every multi-line if statement + multi-func: false # Enforces newlines (or comments) after every multi-line function signature + gci: + local-prefixes: "bitbucket.org" + misspell: + #locale: US + ignore-words: + custom: + # Each custom linter should have a unique name. + +linters: + enable: + - gofmt + - govet + - errcheck + # - staticcheck + # - unused + # - gosimple + - ineffassign + - typecheck + # - lll + - godox + #- gomnd + - goconst + # - gocognit + # - nestif + # - gomodguard + - nakedret + - gci + - misspell + - gofumpt + - whitespace + - unconvert + - predeclared + - noctx + - dogsled + # - bodyclose + - asciicheck + # - stylecheck + # - unparam + # - wsl + + #disable-all: false + fast: true +issues: + # List of regexps of issue texts to exclude, empty list by default. + # But independently from this option we use default exclude patterns, + # it can be disabled by `exclude-use-default: false`. To list all + # excluded by default patterns execute `golangci-lint run --help` + exclude: + # Excluding configuration per-path, per-linter, per-text and per-source + exclude-rules: + # Exclude some linters from running on tests files. + # Independently from option `exclude` we use default exclude patterns, + # it can be disabled by this option. To list all + # excluded by default patterns execute `golangci-lint run --help`. + # Default value for this option is true. + exclude-use-default: false + # The default value is false. If set to true exclude and exclude-rules + # regular expressions become case sensitive. + exclude-case-sensitive: false + # The list of ids of default excludes to include or disable. By default it's empty. + include: + #- EXC0002 # disable excluding of issues about comments from golint + # Maximum issues count per one linter. Set to 0 to disable. Default is 50. + #max-issues-per-linter: 0 + # Maximum count of issues with the same text. Set to 0 to disable. Default is 3. + #max-same-issues: 0 + # Show only new issues: if there are unstaged changes or untracked files, + # only those changes are analyzed, else only changes in HEAD~ are analyzed. + # It's a super-useful option for integration of golangci-lint into existing + # large codebase. It's not practical to fix all existing issues at the moment + # of integration: much better don't allow issues in new code. + # Default is false. + new: false + # Show only new issues created after git revision `REV` + new-from-rev: "" + # Show only new issues created in git patch with set file path. + #new-from-patch: path/to/patch/file +severity: + # Default value is empty string. + # Set the default severity for issues. If severity rules are defined and the issues + # do not match or no severity is provided to the rule this will be the default + # severity applied. Severities should match the supported severity names of the + # selected out format. + # - Code climate: https://docs.codeclimate.com/docs/issues#issue-severity + # - Checkstyle: https://checkstyle.sourceforge.io/property_types.html#severity + # - Github: https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message + default-severity: error + # The default value is false. + # If set to true severity-rules regular expressions become case sensitive. + case-sensitive: false + # Default value is empty list. + # When a list of severity rules are provided, severity information will be added to lint + # issues. Severity rules have the same filtering capability as exclude rules except you + # are allowed to specify one matcher per severity rule. + # Only affects out formats that support setting severity information. + rules: + - linters: + - gomnd + severity: ignore diff --git a/logger/logger.go b/logger/logger.go index 95cb6a5..2cee4fd 100644 --- a/logger/logger.go +++ b/logger/logger.go @@ -9,10 +9,9 @@ import ( "time" formatter "github.com/antonfisher/nested-logrus-formatter" - "github.com/sirupsen/logrus" - "github.com/omec-project/logger_conf" "github.com/omec-project/logger_util" + "github.com/sirupsen/logrus" ) var ( diff --git a/proto/client/gClient.go b/proto/client/gClient.go index 9e75f1b..20e9b4a 100644 --- a/proto/client/gClient.go +++ b/proto/client/gClient.go @@ -18,8 +18,10 @@ import ( "google.golang.org/grpc/keepalive" ) -var selfRestartCounter uint32 -var configPodRestartCounter uint32 = 0 +var ( + selfRestartCounter uint32 + configPodRestartCounter uint32 = 0 +) func init() { s1 := rand.NewSource(time.Now().UnixNano()) @@ -52,10 +54,10 @@ type ConfClient interface { // on created channel and returns the channel PublishOnConfigChange(bool) chan *protos.NetworkSliceResponse - //returns grpc connection object + // returns grpc connection object GetConfigClientConn() *grpc.ClientConn - //Client Subscribing channel to ConfigPod to receive configuration + // Client Subscribing channel to ConfigPod to receive configuration subscribeToConfigPod(commChan chan *protos.NetworkSliceResponse) } @@ -78,10 +80,10 @@ func (confClient *ConfigClient) PublishOnConfigChange(mdataFlag bool) chan *prot } // pass structr which has configChangeUpdate interface -func ConfigWatcher() chan *protos.NetworkSliceResponse { - //var confClient *gClient.ConfigClient - //TODO: use port from configmap. - confClient := CreateChannel("webui:9876", 10000) +func ConfigWatcher(webuiUri string) chan *protos.NetworkSliceResponse { + // var confClient *gClient.ConfigClient + // TODO: use port from configmap. + confClient := CreateChannel(webuiUri, 10000) if confClient == nil { logger.GrpcLog.Errorf("create grpc channel to config pod failed") return nil @@ -140,12 +142,11 @@ func newClientConnection(host string) (conn *grpc.ClientConn, err error) { crt := grpc.ConnectParams{Backoff: bc} dialOptions := []grpc.DialOption{grpc.WithInsecure(), grpc.WithKeepaliveParams(kacp), grpc.WithDefaultServiceConfig(retryPolicy), grpc.WithConnectParams(crt)} conn, err = grpc.Dial(host, dialOptions...) - if err != nil { logger.GrpcLog.Errorln("grpc dial err: ", err) return nil, err } - //defer conn.Close() + // defer conn.Close() return conn, err } @@ -190,7 +191,7 @@ func (confClient *ConfigClient) subscribeToConfigPod(commChan chan *protos.Netwo continue } - logger.GrpcLog.Infoln("stream msg recieved ") + logger.GrpcLog.Infoln("stream msg received ") logger.GrpcLog.Debugf("#Network Slices %v, RC of configpod %v ", len(rsp.NetworkSlice), rsp.RestartCounter) if configPodRestartCounter == 0 || (configPodRestartCounter == rsp.RestartCounter) { // first time connection or config update @@ -206,7 +207,7 @@ func (confClient *ConfigClient) subscribeToConfigPod(commChan chan *protos.Netwo } } else if len(rsp.NetworkSlice) > 0 { logger.GrpcLog.Errorf("Config received after config Pod restart") - //config received after config pod restart + // config received after config pod restart configPodRestartCounter = rsp.RestartCounter commChan <- rsp } else { @@ -214,6 +215,7 @@ func (confClient *ConfigClient) subscribeToConfigPod(commChan chan *protos.Netwo } } } + func readConfigInLoop(confClient *ConfigClient, commChan chan *protos.NetworkSliceResponse) { myid := os.Getenv("HOSTNAME") configReadTimeout := time.NewTicker(5000 * time.Millisecond) @@ -243,7 +245,7 @@ func readConfigInLoop(confClient *ConfigClient, commChan chan *protos.NetworkSli } } else if len(rsp.NetworkSlice) > 0 { logger.GrpcLog.Errorf("Config received after config Pod restart") - //config received after config pod restart + // config received after config pod restart configPodRestartCounter = rsp.RestartCounter commChan <- rsp } else {