From 4e25c19021cc4ac2e316975470d3244515985885 Mon Sep 17 00:00:00 2001 From: Sirajudeen Date: Wed, 17 Jun 2020 15:38:07 -0500 Subject: [PATCH] Fix for minor Go lint issues Issues addressed: * package comment should not have leading space * exported var UiConfig should have comment or be unexported * if block ends with a return statement, so drop this else and outdent its block * var UiConfig should be UIConfig Change-Id: I04b380445d7c97a816f75a9af006d2461b256356 --- cmd/airshipui/main.go | 1 + examples/authentication/main.go | 4 ++-- examples/octant/main.go | 1 + internal/commands/root.go | 2 +- internal/commands/version.go | 2 ++ internal/configs/configs.go | 14 ++++++++------ internal/integrations/ctl/airshipctl.go | 1 + internal/integrations/ctl/baremetal.go | 1 + internal/integrations/ctl/config.go | 1 + internal/integrations/ctl/document.go | 3 ++- internal/webservice/server.go | 9 +++++---- 11 files changed, 25 insertions(+), 14 deletions(-) diff --git a/cmd/airshipui/main.go b/cmd/airshipui/main.go index b3f2d48..68c6701 100644 --- a/cmd/airshipui/main.go +++ b/cmd/airshipui/main.go @@ -11,6 +11,7 @@ See the License for the specific language governing permissions and limitations under the License. */ + package main import ( diff --git a/examples/authentication/main.go b/examples/authentication/main.go index 8d82ed4..9078cc3 100755 --- a/examples/authentication/main.go +++ b/examples/authentication/main.go @@ -11,6 +11,7 @@ See the License for the specific language governing permissions and limitations under the License. */ + package main import ( @@ -216,9 +217,8 @@ func randBytes(length int) ([]byte, error) { _, err := rand.Read(b) if err != nil { return nil, err - } else { - return b, nil } + return b, nil } // this creates a random ciphertext for demo purposes diff --git a/examples/octant/main.go b/examples/octant/main.go index a966601..c380b35 100755 --- a/examples/octant/main.go +++ b/examples/octant/main.go @@ -11,6 +11,7 @@ See the License for the specific language governing permissions and limitations under the License. */ + package main import ( diff --git a/internal/commands/root.go b/internal/commands/root.go index 3c4564c..6caa540 100644 --- a/internal/commands/root.go +++ b/internal/commands/root.go @@ -61,7 +61,7 @@ func launch(cmd *cobra.Command, args []string) { // Read AirshipUI config file if err := configs.GetConfigFromFile(); err == nil { // launch any plugins marked as autoStart: true in airshipui.json - for _, p := range configs.UiConfig.Plugins { + for _, p := range configs.UIConfig.Plugins { if p.Executable.AutoStart { waitgrp.Add(1) go RunBinaryWithOptions( diff --git a/internal/commands/version.go b/internal/commands/version.go index 3d1bb2d..80ef213 100644 --- a/internal/commands/version.go +++ b/internal/commands/version.go @@ -11,6 +11,7 @@ See the License for the specific language governing permissions and limitations under the License. */ + package commands import ( @@ -38,6 +39,7 @@ func newVersionCmd() *cobra.Command { return versionCmd } +// Version returns application version func Version() string { return version } diff --git a/internal/configs/configs.go b/internal/configs/configs.go index 92c4d68..fc1ada6 100755 --- a/internal/configs/configs.go +++ b/internal/configs/configs.go @@ -11,6 +11,7 @@ See the License for the specific language governing permissions and limitations under the License. */ + package configs import ( @@ -22,8 +23,9 @@ import ( "opendev.org/airship/airshipctl/pkg/config" ) +// variables related to UI config var ( - UiConfig Config + UIConfig Config ) // Config basic structure to hold configuration params for Airship UI @@ -33,12 +35,14 @@ type Config struct { Clusters []Cluster `json:"clusters,omitempty"` } +// AuthMethod structure to hold authentication parameters type AuthMethod struct { Type string `json:"type,omitempty"` Value []string `json:"values,omitempty"` URL string `json:"url,omitempty"` } +// Plugin structure to hold plugin specific parameters type Plugin struct { Name string `json:"name,omitempty"` Dashboard struct { @@ -86,6 +90,7 @@ type WsComponentType string // WsSubComponentType is used to set the specific subcomponent types allowable for WsRequests type WsSubComponentType string +// constants related to specific request/component/subcomponent types for WsRequests const ( AirshipCTL WsRequestType = "airshipctl" Electron WsRequestType = "electron" @@ -135,6 +140,7 @@ type WsMessage struct { ClusterOptions config.ClusterOptions `json:"clusterOptions,omitempty"` } +// GetConfigFromFile reads configuration file and returns error on any error reading the file // TODO: add watcher to the json file to reload conf on change func GetConfigFromFile() error { var fileName string @@ -158,11 +164,7 @@ func GetConfigFromFile() error { return err } - err = json.Unmarshal(byteValue, &UiConfig) - - if err != nil { - return err - } + err = json.Unmarshal(byteValue, &UIConfig) return err } diff --git a/internal/integrations/ctl/airshipctl.go b/internal/integrations/ctl/airshipctl.go index fca749c..ca69637 100755 --- a/internal/integrations/ctl/airshipctl.go +++ b/internal/integrations/ctl/airshipctl.go @@ -11,6 +11,7 @@ See the License for the specific language governing permissions and limitations under the License. */ + package ctl import ( diff --git a/internal/integrations/ctl/baremetal.go b/internal/integrations/ctl/baremetal.go index 8d92659..7d4370f 100755 --- a/internal/integrations/ctl/baremetal.go +++ b/internal/integrations/ctl/baremetal.go @@ -11,6 +11,7 @@ See the License for the specific language governing permissions and limitations under the License. */ + package ctl import ( diff --git a/internal/integrations/ctl/config.go b/internal/integrations/ctl/config.go index 64675ed..aa725b0 100755 --- a/internal/integrations/ctl/config.go +++ b/internal/integrations/ctl/config.go @@ -11,6 +11,7 @@ See the License for the specific language governing permissions and limitations under the License. */ + package ctl import ( diff --git a/internal/integrations/ctl/document.go b/internal/integrations/ctl/document.go index 212ce45..f710d93 100755 --- a/internal/integrations/ctl/document.go +++ b/internal/integrations/ctl/document.go @@ -11,6 +11,7 @@ See the License for the specific language governing permissions and limitations under the License. */ + package ctl import ( @@ -20,7 +21,7 @@ import ( "opendev.org/airship/airshipui/internal/configs" ) -// HandleBaremetalRequest will flop between requests so we don't have to have them all mapped as function calls +// HandleDocumentRequest will flop between requests so we don't have to have them all mapped as function calls func HandleDocumentRequest(request configs.WsMessage) configs.WsMessage { response := configs.WsMessage{ Type: configs.AirshipCTL, diff --git a/internal/webservice/server.go b/internal/webservice/server.go index e5b94da..d17c20b 100755 --- a/internal/webservice/server.go +++ b/internal/webservice/server.go @@ -11,6 +11,7 @@ See the License for the specific language governing permissions and limitations under the License. */ + package webservice import ( @@ -186,7 +187,7 @@ func WebServer() { func clientInit(configs.WsMessage) configs.WsMessage { // if no auth method is supplied start with minimal functionality - if len(configs.UiConfig.AuthMethod.URL) == 0 { + if len(configs.UIConfig.AuthMethod.URL) == 0 { isAuthenticated = true } @@ -194,8 +195,8 @@ func clientInit(configs.WsMessage) configs.WsMessage { Type: configs.Electron, Component: configs.Initialize, IsAuthenticated: isAuthenticated, - Dashboards: configs.UiConfig.Clusters, - Plugins: configs.UiConfig.Plugins, - Authentication: configs.UiConfig.AuthMethod, + Dashboards: configs.UIConfig.Clusters, + Plugins: configs.UIConfig.Plugins, + Authentication: configs.UIConfig.AuthMethod, } }