chore(go): lint errors

Author: sinanmohd

api/v1beta1/snapshot_types.go

@@ -48,9 +48,10 @@ type SnapShotSelector struct {
 	Container string `json:"container"`
 }
 
+// SnapShotInputPolicy will(TODO:) add support for Replace, etc ...
 type SnapShotInputPolicy string
 
-// TODO: add support for Replace, etc ...
+// IfNotPresent only creates a SnapShot if it's not already present
 const IfNotPresent SnapShotInputPolicy = "IfNotPresent"
 
 type SnapShotInput struct {
@@ -92,17 +93,24 @@ type SnapShotSpec struct {
 type SnapShotStatusStage string
 
 const (
+	// CriuDumping indicates that we called the kublet api and checkpointing is in progress
 	CriuDumping SnapShotStatusStage = "CriuDumping"
-	Fromating   SnapShotStatusStage = "Fromating"
-	Pushing     SnapShotStatusStage = "Pushing"
+	// Fromating indicates that image creation using the checkpoited data is in progress
+	Fromating SnapShotStatusStage = "Fromating"
+	// Pushing indicates we're uploading the OCI image to specified container registry
+	Pushing SnapShotStatusStage = "Pushing"
 )
 
 type SnapShotStatusState string
 
 const (
-	Idle    SnapShotStatusState = "Idle"
+	// Idle indicates the operation has not started
+	Idle SnapShotStatusState = "Idle"
+	// Started indicates the operation has started
 	Started SnapShotStatusState = "Started"
-	Failed  SnapShotStatusState = "Failed"
+	// Failed indicates the operation has failed
+	Failed SnapShotStatusState = "Failed"
+	// Success indicates the operation has completed successfully
 	Success SnapShotStatusState = "Success"
 )
 

internal/controller/snapshot_controller.go

@@ -71,7 +71,6 @@ type CheckPointResp struct {
 
 // Reconcile is part of the main kubernetes reconciliation loop which aims to
 // move the current state of the cluster closer to the desired state.
-
 // For more details, check Reconcile and its Result here:
 // - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.21.0/pkg/reconcile
 // NOTE: breaking down the Reconcile() function furhter will reduce the readability
@@ -96,9 +95,9 @@ func (r *SnapShotReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 	if err != nil {
 		if requeue {
 			return ctrl.Result{}, nil
-		} else {
-			return ctrl.Result{}, err
 		}
+
+		return ctrl.Result{}, err
 	}
 	err = controllerutil.SetControllerReference(snapshot, pod, r.Scheme)
 	if err != nil {
@@ -228,7 +227,7 @@ func (r *SnapShotReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 	}
 
 	if snapshot.Status.JobID == "" {
-		jobId, err := daemonsetInit(
+		jobID, err := daemonsetInit(
 			snapshot.Spec.Output.ContainerRegistry,
 			snapshot.Status.CheckPointNodePath,
 			snapshot.Status.Node,
@@ -238,7 +237,7 @@ func (r *SnapShotReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 			log.Error(err, "unable init daemonset job")
 			return ctrl.Result{}, err
 		}
-		snapshot.Status.JobID = jobId
+		snapshot.Status.JobID = jobID
 		if err := r.Status().Update(ctx, snapshot); err != nil {
 			log.Error(err, "unable to update Snapshot status")
 			return ctrl.Result{}, err
@@ -309,10 +308,10 @@ func (r *SnapShotReconciler) PodImageUpdate(
 }
 
 func daemonsetStausFetch(
-	jobId string,
+	jobID string,
 	node stove8sv1beta1.SnapShotStatusNode,
 ) (*oci.OciStatus, error) {
-	ociEndpoint := fmt.Sprintf("http://%s:%v/oci/%s", node.Addr, node.DeamonsetPort, jobId)
+	ociEndpoint := fmt.Sprintf("http://%s:%v/oci/%s", node.Addr, node.DeamonsetPort, jobID)
 	req, err := http.NewRequest(http.MethodGet, ociEndpoint, nil)
 	if err != nil {
 		return nil, err

internal/daemonset/resources/oci/create.go

@@ -25,7 +25,7 @@ type CreateReq struct {
 }
 
 type CreateResp struct {
-	JobId string `json:"job_id"`
+	JobID string `json:"job_id"`
 }
 
 func (rs OciResource) CreateAsync(id uuid.UUID, data *CreateReq) {
@@ -97,7 +97,7 @@ func (rs OciResource) Create(rw http.ResponseWriter, req *http.Request) {
 	}
 
 	resp, err := json.Marshal(CreateResp{
-		JobId: id.String(),
+		JobID: id.String(),
 	})
 	if err != nil {
 		slog.Error("Marshaling response json", "err", err.Error())

internal/oci/utils.go

@@ -28,8 +28,8 @@ import (
 )
 
 const (
-	ConfigDumpFile = "config.dump"
-	SpecDumpFile   = "spec.dump"
+	configDumpFile = "config.dump"
+	specDumpFile   = "spec.dump"
 )
 
 type ContainerConfig struct {
@@ -135,8 +135,8 @@ func annotationsFromDump(spec *specs.Spec, containerConfig *ContainerConfig) (ma
 
 func dumpInspect(checkpointDump io.Reader) (*specs.Spec, *ContainerConfig, error) {
 	files := []string{
-		SpecDumpFile,
-		ConfigDumpFile,
+		specDumpFile,
+		configDumpFile,
 	}
 
 	raw, err := tarFilesRead(files, checkpointDump)
@@ -145,13 +145,13 @@ func dumpInspect(checkpointDump io.Reader) (*specs.Spec, *ContainerConfig, error
 	}
 
 	var spec specs.Spec
-	err = json.Unmarshal(raw[SpecDumpFile], &spec)
+	err = json.Unmarshal(raw[specDumpFile], &spec)
 	if err != nil {
 		return nil, nil, err
 	}
 
 	var continerConfig ContainerConfig
-	err = json.Unmarshal(raw[ConfigDumpFile], &continerConfig)
+	err = json.Unmarshal(raw[configDumpFile], &continerConfig)
 	if err != nil {
 		return nil, nil, err
 	}
@@ -174,9 +174,8 @@ func ReferenceIsValid(refStr string, authSecret *corev1.Secret) (bool, error) {
 	if err != nil {
 		if strings.Contains(err.Error(), "not found") || strings.Contains(err.Error(), "404") {
 			return false, nil
-		} else {
-			return false, err
 		}
+		return false, err
 
 	}
 

test/utils/utils.go

@@ -24,7 +24,7 @@ import (
 	"os/exec"
 	"strings"
 
-	. "github.com/onsi/ginkgo/v2" // nolint:revive,staticcheck
+	"github.com/onsi/ginkgo/v2" // nolint:revive,staticcheck
 )
 
 const (
@@ -37,7 +37,7 @@ const (
 )
 
 func warnError(err error) {
-	_, _ = fmt.Fprintf(GinkgoWriter, "warning: %v\n", err)
+	_, _ = fmt.Fprintf(ginkgo.GinkgoWriter, "warning: %v\n", err)
 }
 
 // Run executes the provided command within this context
@@ -46,12 +46,12 @@ func Run(cmd *exec.Cmd) (string, error) {
 	cmd.Dir = dir
 
 	if err := os.Chdir(cmd.Dir); err != nil {
-		_, _ = fmt.Fprintf(GinkgoWriter, "chdir dir: %q\n", err)
+		_, _ = fmt.Fprintf(ginkgo.GinkgoWriter, "chdir dir: %q\n", err)
 	}
 
 	cmd.Env = append(os.Environ(), "GO111MODULE=on")
 	command := strings.Join(cmd.Args, " ")
-	_, _ = fmt.Fprintf(GinkgoWriter, "running: %q\n", command)
+	_, _ = fmt.Fprintf(ginkgo.GinkgoWriter, "running: %q\n", command)
 	output, err := cmd.CombinedOutput()
 	if err != nil {
 		return string(output), fmt.Errorf("%q failed with error %q: %w", command, string(output), err)