Fix issues reported by go fmt and lint checks

Signed-off-by: Yuan Chen <[email protected]>
NVIDIA · May 10, 2024 · 3221f3a · 3221f3a
1 parent cc2121e
commit 3221f3a
Show file tree

Hide file tree

Showing 22 changed files with 31 additions and 47 deletions.
diff --git a/.yamlfmt.yaml b/.yamlfmt.yaml
@@ -0,0 +1,4 @@
+formatter:
+  type: basic
+  indentless_arrays: true
+  retain_line_breaks_single: true
diff --git a/cmd/knavigator/main.go b/cmd/knavigator/main.go
@@ -22,12 +22,11 @@ import (
 	"fmt"
 	"os"
 
-	"k8s.io/klog/v2"
-	"k8s.io/klog/v2/textlogger"
-
 	"github.com/NVIDIA/knavigator/pkg/config"
 	"github.com/NVIDIA/knavigator/pkg/engine"
 	"github.com/NVIDIA/knavigator/pkg/utils"
+	"k8s.io/klog/v2"
+	"k8s.io/klog/v2/textlogger"
 )
 
 func mainInternal() error {

diff --git a/docs/task_management.md b/docs/task_management.md
@@ -8,4 +8,4 @@ Tasks are defined in a YAML format or received via HTTP/gRPC protocols. The Task
 - Check the spec and status of nodes
 - Check the spec and status of pods
 - Run PromQL query
-- Sleep for a specified duration
+- Sleep for a specified duration
diff --git a/pkg/engine/check_object_task.go b/pkg/engine/check_object_task.go
@@ -20,15 +20,14 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/NVIDIA/knavigator/pkg/config"
+	"github.com/NVIDIA/knavigator/pkg/utils"
 	"github.com/go-logr/logr"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/client-go/dynamic"
 	"k8s.io/client-go/dynamic/dynamicinformer"
 	"k8s.io/client-go/tools/cache"
-
-	"github.com/NVIDIA/knavigator/pkg/config"
-	"github.com/NVIDIA/knavigator/pkg/utils"
 )
 
 // CheckObjTask represents a task that checks object state and status.

diff --git a/pkg/engine/check_object_task_test.go b/pkg/engine/check_object_task_test.go
@@ -20,9 +20,8 @@ import (
 	"testing"
 	"time"
 
-	"github.com/stretchr/testify/require"
-
 	"github.com/NVIDIA/knavigator/pkg/config"
+	"github.com/stretchr/testify/require"
 )
 
 func TestNewCheckObjTask(t *testing.T) {

diff --git a/pkg/engine/check_pod_task.go b/pkg/engine/check_pod_task.go
@@ -21,16 +21,15 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/NVIDIA/knavigator/pkg/config"
+	"github.com/NVIDIA/knavigator/pkg/utils"
 	"github.com/go-logr/logr"
 	"gopkg.in/yaml.v3"
 	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/informers"
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/tools/cache"
-
-	"github.com/NVIDIA/knavigator/pkg/config"
-	"github.com/NVIDIA/knavigator/pkg/utils"
 )
 
 // CheckPodTask represents CheckPod task.

diff --git a/pkg/engine/check_pod_task_test.go b/pkg/engine/check_pod_task_test.go
@@ -20,9 +20,8 @@ import (
 	"testing"
 	"time"
 
-	"github.com/stretchr/testify/require"
-
 	"github.com/NVIDIA/knavigator/pkg/config"
+	"github.com/stretchr/testify/require"
 )
 
 func TestCheckPodParams(t *testing.T) {

diff --git a/pkg/engine/delete_object_task.go b/pkg/engine/delete_object_task.go
@@ -20,12 +20,11 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/NVIDIA/knavigator/pkg/config"
 	"github.com/go-logr/logr"
 	"gopkg.in/yaml.v3"
 	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/dynamic"
-
-	"github.com/NVIDIA/knavigator/pkg/config"
 )
 
 type DeleteObjTask struct {

diff --git a/pkg/engine/delete_object_task_test.go b/pkg/engine/delete_object_task_test.go
@@ -19,9 +19,8 @@ package engine
 import (
 	"testing"
 
-	"github.com/stretchr/testify/require"
-
 	"github.com/NVIDIA/knavigator/pkg/config"
+	"github.com/stretchr/testify/require"
 )
 
 func TestNewDeleteObjTask(t *testing.T) {

diff --git a/pkg/engine/engine.go b/pkg/engine/engine.go
@@ -22,12 +22,11 @@ import (
 	"sync"
 	"time"
 
+	"github.com/NVIDIA/knavigator/pkg/config"
 	"github.com/go-logr/logr"
 	"k8s.io/client-go/dynamic"
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/rest"
-
-	"github.com/NVIDIA/knavigator/pkg/config"
 )
 
 type Engine interface {

diff --git a/pkg/engine/engine_test.go b/pkg/engine/engine_test.go
@@ -21,12 +21,11 @@ import (
 	"fmt"
 	"testing"
 
+	"github.com/NVIDIA/knavigator/pkg/config"
 	"github.com/stretchr/testify/require"
 	"k8s.io/client-go/dynamic"
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/klog/v2/textlogger"
-
-	"github.com/NVIDIA/knavigator/pkg/config"
 )
 
 var (

diff --git a/pkg/engine/pause_task.go b/pkg/engine/pause_task.go
@@ -22,9 +22,8 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/go-logr/logr"
-
 	"github.com/NVIDIA/knavigator/pkg/config"
+	"github.com/go-logr/logr"
 )
 
 type PauseTask struct {

diff --git a/pkg/engine/pause_task_test.go b/pkg/engine/pause_task_test.go
@@ -21,9 +21,8 @@ import (
 	"testing"
 	"time"
 
-	"github.com/stretchr/testify/require"
-
 	"github.com/NVIDIA/knavigator/pkg/config"
+	"github.com/stretchr/testify/require"
 )
 
 func TestPauseExec(t *testing.T) {

diff --git a/pkg/engine/sleep_task.go b/pkg/engine/sleep_task.go
@@ -21,10 +21,9 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/NVIDIA/knavigator/pkg/config"
 	"github.com/go-logr/logr"
 	"gopkg.in/yaml.v3"
-
-	"github.com/NVIDIA/knavigator/pkg/config"
 )
 
 type SleepTask struct {

diff --git a/pkg/engine/sleep_task_test.go b/pkg/engine/sleep_task_test.go
@@ -21,9 +21,8 @@ import (
 	"testing"
 	"time"
 
-	"github.com/stretchr/testify/require"
-
 	"github.com/NVIDIA/knavigator/pkg/config"
+	"github.com/stretchr/testify/require"
 )
 
 func TestSleepParams(t *testing.T) {

diff --git a/pkg/engine/submit_object_task.go b/pkg/engine/submit_object_task.go
@@ -21,15 +21,14 @@ import (
 	"fmt"
 	"text/template"
 
+	"github.com/NVIDIA/knavigator/pkg/config"
+	"github.com/NVIDIA/knavigator/pkg/utils"
 	"github.com/go-logr/logr"
 	"gopkg.in/yaml.v3"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/client-go/dynamic"
-
-	"github.com/NVIDIA/knavigator/pkg/config"
-	"github.com/NVIDIA/knavigator/pkg/utils"
 )
 
 type SubmitObjTask struct {

diff --git a/pkg/engine/submit_object_task_test.go b/pkg/engine/submit_object_task_test.go
@@ -19,10 +19,9 @@ package engine
 import (
 	"testing"
 
-	"github.com/stretchr/testify/require"
-
 	"github.com/NVIDIA/knavigator/pkg/config"
 	"github.com/NVIDIA/knavigator/pkg/utils"
+	"github.com/stretchr/testify/require"
 )
 
 func TestNewSubmitObjTask(t *testing.T) {

diff --git a/pkg/engine/update_nodes_task.go b/pkg/engine/update_nodes_task.go
@@ -20,14 +20,13 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/NVIDIA/knavigator/pkg/config"
+	"github.com/NVIDIA/knavigator/pkg/utils"
 	"github.com/go-logr/logr"
 	"gopkg.in/yaml.v3"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/client-go/kubernetes"
-
-	"github.com/NVIDIA/knavigator/pkg/config"
-	"github.com/NVIDIA/knavigator/pkg/utils"
 )
 
 // UpdateNodesTask represents UpdateNodes task.

diff --git a/pkg/engine/update_nodes_task_test.go b/pkg/engine/update_nodes_task_test.go
@@ -19,10 +19,9 @@ package engine
 import (
 	"testing"
 
-	"github.com/stretchr/testify/require"
-
 	"github.com/NVIDIA/knavigator/pkg/config"
 	"github.com/NVIDIA/knavigator/pkg/utils"
+	"github.com/stretchr/testify/require"
 )
 
 func TestUpdateNodesTask(t *testing.T) {

diff --git a/pkg/engine/update_object_task.go b/pkg/engine/update_object_task.go
@@ -20,14 +20,12 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/NVIDIA/knavigator/pkg/config"
+	"github.com/NVIDIA/knavigator/pkg/utils"
 	"github.com/go-logr/logr"
-
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/client-go/dynamic"
-
-	"github.com/NVIDIA/knavigator/pkg/config"
-	"github.com/NVIDIA/knavigator/pkg/utils"
 )
 
 // UpdateObjTask represents task that updates object state and status

diff --git a/pkg/engine/update_task_test.go b/pkg/engine/update_task_test.go
@@ -20,9 +20,8 @@ import (
 	"testing"
 	"time"
 
-	"github.com/stretchr/testify/require"
-
 	"github.com/NVIDIA/knavigator/pkg/config"
+	"github.com/stretchr/testify/require"
 )
 
 func TestNewUpdateObjTask(t *testing.T) {

diff --git a/pkg/utils/k8s_config.go b/pkg/utils/k8s_config.go
@@ -45,7 +45,7 @@ func GetK8sConfig(log logr.Logger, kubeConfigPath, kubectx string) (*rest.Config
 	if err != nil {
 		return nil, err
 	}
-	//update cert file location if needed
+	// update cert file location if needed
 	for _, info := range config.AuthInfos {
 		if len(info.LocationOfOrigin) != 0 {
 			dir := filepath.Dir(info.LocationOfOrigin)