fix golints G114 and package-comments (openservicemesh#5037)

golints addressed:
1. G114: Use of net/http serve function that has no support for setting timeouts
2. package-comments
3. removes pkg mesh and moves isValidUUID() to pkg/cli/proxy_get.go

Signed-off-by: Shalier Xia <[email protected]>

Author: shalier

.golangci.yml

@@ -1,6 +1,6 @@
 run:
   tests: true
-  timeout: 10m
+  timeout: 20m
   skip-dirs:
     - pkg/gen
   skip-files:
@@ -35,6 +35,10 @@ issues:
         - revive
       source: ". \"github.com/openservicemesh/osm/tests/framework\""
       text: "dot imports"
+    # Ignore error for package comments
+    - linters:
+        - revive
+      text: "package-comments: should have a package comment"
     # Exclude staticcheck messages for deprecated function, variable or constant
     # This causes issues with package github.com/golang/protobuf/proto
     - linters:

demo/cmd/bookbuyer/bookbuyer.go

@@ -1,3 +1,4 @@
+// Package main implements the bookbuyer application
 package main
 
 import (
@@ -77,6 +78,7 @@ func debugServer() {
 	}
 	http.HandleFunc("/favicon.ico", func(w http.ResponseWriter, r *http.Request) {})
 	log.Info().Msgf("Web server running on port %d", *port)
+	//#nosec G114: Use of net/http serve function that has no support for setting timeouts
 	err = http.ListenAndServe(fmt.Sprintf(":%d", *port), router)
 	log.Fatal().Err(err).Msgf("Failed to start HTTP server on port %d", *port)
 }

demo/cmd/bookstore/bookstore.go

@@ -1,3 +1,4 @@
+// Package main implements the bookstore application
 package main
 
 import (
@@ -164,8 +165,8 @@ func main() {
 		router.HandleFunc(h.path, h.fn).Methods(h.method)
 	}
 	http.HandleFunc("/favicon.ico", func(w http.ResponseWriter, r *http.Request) {})
-
 	log.Info().Msgf("Bookstore running on port %d", *port)
+	//#nosec G114: Use of net/http serve function that has no support for setting timeouts
 	err = http.ListenAndServe(fmt.Sprintf(":%d", *port), router)
 	log.Fatal().Err(err).Msgf("Failed to start HTTP server on port %d", *port)
 }

demo/cmd/bookthief/bookthief.go

@@ -1,3 +1,4 @@
+// Package main implements the bookthief application
 package main
 
 import (
@@ -86,6 +87,7 @@ func debugServer() {
 	}
 	http.HandleFunc("/favicon.ico", func(w http.ResponseWriter, r *http.Request) {})
 	log.Info().Msgf("Bookthief running on port %d", *port)
+	//#nosec G114: Use of net/http serve function that has no support for setting timeouts
 	err = http.ListenAndServe(fmt.Sprintf(":%d", *port), router)
 	log.Fatal().Err(err).Msgf("Failed to start HTTP server on port %d", *port)
 }

demo/cmd/bookwarehouse/bookwarehouse.go

@@ -1,3 +1,6 @@
+// Package main implements the bookwarehouse application
+// This create a service which has both inbound as well as outbound service policies
+// i.e. bookbuyer makes a GET call to bookstore, bookstore makes a POST call to bookwarehouse
 package main
 
 import (
@@ -129,6 +132,7 @@ func main() {
 	router.HandleFunc("/", restockBooks).Methods("POST")
 	http.HandleFunc("/favicon.ico", func(w http.ResponseWriter, r *http.Request) {})
 	log.Info().Msgf("Starting BookWarehouse HTTP server on port %d", *port)
+	//#nosec G114: Use of net/http serve function that has no support for setting timeouts
 	err := http.ListenAndServe(fmt.Sprintf(":%d", *port), router)
 	log.Fatal().Err(err).Msgf("Failed to start BookWarehouse HTTP server on port %d", *port)
 }

demo/cmd/bookwatcher/bookwatcher.go

@@ -1,3 +1,4 @@
+// Package main implements the bookwatcher for terminal and JSON output from demo applications
 package main
 
 import (

demo/cmd/common/books.go

@@ -1,3 +1,4 @@
+// Package common implements shared functions and structs between various book* applications
 package common
 
 import (

demo/cmd/database/mysql.go

@@ -1,3 +1,5 @@
+// Package database allows the bookwarehouse service to store
+// total books data into MySQL persistent storage
 package database
 
 import (

mockspec/generate.go

@@ -1,3 +1,7 @@
+// Package mockspec allows the mocks to be generated consistently by doing the following:
+// 1. defining mockgen rules using a file to specify the parameters
+// 2. generating mocks the same way for each of the rules
+// 3. integrating checks for the mocks in the CI
 package main
 
 import (

pkg/auth/types.go

@@ -1,3 +1,4 @@
+// Package auth implements the ExtAuthConfig struct.
 package auth
 
 import (

pkg/certificate/castorage/k8s/k8s.go

@@ -1,3 +1,4 @@
+// Package k8s implements helper functions to get certificates from Kubernetes secret
 package k8s
 
 import (

pkg/certificate/providers/tresor/fake/fake.go

@@ -1,3 +1,4 @@
+// Package fake moves fakes to their own sub-package
 package fake
 
 import (

pkg/envoy/secrets/errors.go

@@ -1,3 +1,4 @@
+// Package secrets contains SDSCert types and methods
 package secrets
 
 import (

pkg/k8s/fake/fake.go

@@ -1,3 +1,7 @@
+// Package informers centralize informers by creating a single object that
+// runs a set of informers, instead of creating different objects
+// that each manage their own informer collections.
+// A pointer to this object is then shared with all objects that need it.
 package informers
 
 import (

pkg/k8s/informers/informers.go

@@ -1,3 +1,4 @@
+// Package models implements the HealthProbe struct.
 package models
 
 import "time"

pkg/models/healthprobe.go

@@ -1,3 +1,4 @@
+// Package protobuf contains function(s) pertaining to protobufs
 package protobuf
 
 import (

pkg/protobuf/util.go

@@ -1,3 +1,6 @@
+// Package ticker reintroduces the ticker concept.
+// It contains a ticker implementation that is fully interacted through pubsub.
+// It starts turned off by default and is run after dispatcher starts.
 package ticker
 
 import (

pkg/ticker/ticker.go

@@ -1,3 +1,21 @@
+// Package workerpool implements the thread-pool paradigm
+// in Go. The benefits of it in Go however, can be quite different
+// from any other language able to schedule itself on system threads.
+//
+// By using a workpool model, the main focus and intention is to limit the
+// number of go routines that can do busy-work and get scheduled concurrenly
+// at any point in time.
+//
+// Too many go routines being scheduled at the same time will cause other
+// go routines (maybe more critical ones) to be scheduled less often, thus
+// incurring in resource starvation on those and potentially triggering other
+// issues.
+//
+// By being able to queue up work, we should be able to run a more deterministic
+// runtime (despite Go's nature, this we will not be able to help), less dependant
+// on the scheduler and more accurate in terms of time, as now the number of routines
+// doing busy work can remain constant as opposed have O(N) routines attempting to run
+// at the same time.
 package workerpool
 
 import (