fix review items

Signed-off-by: Tuomas Katila <[email protected]>

Author: tkatila

cmd/gpu_plugin/README.md

@@ -230,7 +230,7 @@ To enable CDI support, container runtime has to support it. The support varies d
 
 Kubernetes CDI support is GA in 1.31. In 1.28 - 1.30 the support has to be enabled via `DevicePluginCDIDevices` feature gate.
 
-> *NOTE*: To use CDI outside of Kubernetes, for example with docker or podman, CDI specs can be generated with the [Intel CDI specs generator](https://github.com/intel/intel-resource-drivers-for-kubernetes/releases/tag/specs-generator-v0.1.0).
+> *NOTE*: To use CDI outside of Kubernetes, for example with Docker or Podman, CDI specs can be generated with the [Intel CDI specs generator](https://github.com/intel/intel-resource-drivers-for-kubernetes/releases/tag/specs-generator-v0.1.0).
 
 ### KMD and UMD
 

cmd/gpu_plugin/gpu_plugin_test.go

@@ -403,14 +403,14 @@ func TestScan(t *testing.T) {
 		t.Run(tc.name, func(t *testing.T) {
 			root, err := os.MkdirTemp("", "test_new_device_plugin")
 			if err != nil {
-				t.Fatalf("can't create temporary directory: %+v", err)
+				t.Fatalf("Can't create temporary directory: %+v", err)
 			}
 			// dirs/files need to be removed for the next test
 			defer os.RemoveAll(root)
 
 			sysfs, devfs, err := createTestFiles(root, tc)
 			if err != nil {
-				t.Errorf("unexpected error: %+v", err)
+				t.Errorf("Unexpected error: %+v", err)
 			}
 
 			plugin := newDevicePlugin(sysfs, devfs, tc.options)
@@ -422,7 +422,7 @@ func TestScan(t *testing.T) {
 			err = plugin.Scan(notifier)
 			// Scans in GPU plugin never fail
 			if err != nil {
-				t.Errorf("unexpected error: %+v", err)
+				t.Errorf("Unexpected error: %+v", err)
 			}
 			if tc.expectedI915Devs != notifier.i915Count {
 				t.Errorf("Expected %d, discovered %d devices (i915)",
@@ -465,14 +465,14 @@ func TestScanFails(t *testing.T) {
 	t.Run(tc.name, func(t *testing.T) {
 		root, err := os.MkdirTemp("", "test_new_device_plugin")
 		if err != nil {
-			t.Fatalf("can't create temporary directory: %+v", err)
+			t.Fatalf("Can't create temporary directory: %+v", err)
 		}
 		// dirs/files need to be removed for the next test
 		defer os.RemoveAll(root)
 
 		sysfs, devfs, err := createTestFiles(root, tc)
 		if err != nil {
-			t.Errorf("unexpected error: %+v", err)
+			t.Errorf("Unexpected error: %+v", err)
 		}
 
 		plugin := newDevicePlugin(sysfs, devfs, tc.options)
@@ -485,7 +485,7 @@ func TestScanFails(t *testing.T) {
 
 		err = plugin.Scan(notifier)
 		if err == nil {
-			t.Error("unexpected nil error")
+			t.Error("Unexpected nil error")
 		}
 	})
 }
@@ -545,14 +545,14 @@ func TestScanWithRmAndTiles(t *testing.T) {
 		t.Run(tc.name, func(t *testing.T) {
 			root, err := os.MkdirTemp("", "test_new_device_plugin")
 			if err != nil {
-				t.Fatalf("can't create temporary directory: %+v", err)
+				t.Fatalf("Can't create temporary directory: %+v", err)
 			}
 			// dirs/files need to be removed for the next test
 			defer os.RemoveAll(root)
 
 			sysfs, devfs, err := createTestFiles(root, tc)
 			if err != nil {
-				t.Errorf("unexpected error: %+v", err)
+				t.Errorf("Unexpected error: %+v", err)
 			}
 
 			plugin := newDevicePlugin(sysfs, devfs, tc.options)
@@ -566,10 +566,10 @@ func TestScanWithRmAndTiles(t *testing.T) {
 
 			err = plugin.Scan(notifier)
 			if err != nil {
-				t.Error("unexpected error")
+				t.Error("Unexpected error")
 			}
 			if rm.tileCount != expectedTileCounts[i] {
-				t.Error("unexpected tilecount for RM")
+				t.Error("Unexpected tilecount for RM")
 			}
 		})
 	}
@@ -673,7 +673,7 @@ func TestBypath(t *testing.T) {
 	for _, td := range tds {
 		root, err := os.MkdirTemp("", "test_bypath_mounting")
 		if err != nil {
-			t.Fatalf("can't create temporary directory: %+v", err)
+			t.Fatalf("Can't create temporary directory: %+v", err)
 		}
 		// dirs/files need to be removed for the next test
 		defer os.RemoveAll(root)
@@ -718,7 +718,7 @@ func TestBypath(t *testing.T) {
 func TestPciDeviceForCard(t *testing.T) {
 	root, err := os.MkdirTemp("", "test_pci_device_for_card")
 	if err != nil {
-		t.Fatalf("can't create temporary directory: %+v", err)
+		t.Fatalf("Can't create temporary directory: %+v", err)
 	}
 	// dirs/files need to be removed for the next test
 	defer os.RemoveAll(root)
@@ -729,24 +729,24 @@ func TestPciDeviceForCard(t *testing.T) {
 	cardDevicePath := filepath.Join(cardPath, "device")
 
 	if err := os.MkdirAll(cardDevicePath, 0750); err != nil {
-		t.Fatalf("couldn't create card's device path")
+		t.Fatalf("Card device path creation failed: %+v", err)
 	}
 
 	data := "0x5959"
 
 	err = os.WriteFile(filepath.Join(cardDevicePath, "device"), []byte(data), 0o600)
 	if err != nil {
-		t.Fatalf("device id write failed: %+v", err)
+		t.Fatalf("Device id write failed: %+v", err)
 	}
 
 	id, err := pciDeviceIDForCard(cardPath)
 
 	if err != nil {
-		t.Error("failed to get device id for card")
+		t.Errorf("Failed to get device id for card: %+v", err)
 	}
 
 	if id != data {
-		t.Errorf("wrong id received %s vs %s", id, data)
+		t.Errorf("Wrong id received %s vs %s", id, data)
 	}
 
 	// Check bad device
@@ -755,18 +755,18 @@ func TestPciDeviceForCard(t *testing.T) {
 	cardDevicePath = filepath.Join(cardPath, "device")
 
 	if err := os.MkdirAll(cardDevicePath, 0750); err != nil {
-		t.Fatalf("couldn't create card's device path")
+		t.Fatalf("Card device path creation failed: %+v", err)
 	}
 
-	err = os.WriteFile(filepath.Join(cardDevicePath, "devicee"), []byte(data), 0o600)
+	err = os.WriteFile(filepath.Join(cardDevicePath, "devicebad"), []byte(data), 0o600)
 	if err != nil {
-		t.Fatalf("device id write failed: %+v", err)
+		t.Fatalf("Device id write failed: %+v", err)
 	}
 
 	id, err = pciDeviceIDForCard(cardPath)
 
 	if err == nil {
-		t.Errorf("id received when it shouldn't be possible: %s", id)
+		t.Errorf("ID received when it shouldn't be possible: %s", id)
 	}
 }
 
@@ -782,17 +782,17 @@ func createSymlinks(t *testing.T, base string, links []symlinkItem) {
 
 		if _, err := os.Stat(linkOld); err != nil {
 			if err := os.MkdirAll(linkOld, 0o750); err != nil && !errors.Is(err, os.ErrExist) {
-				t.Fatalf("failed to create symlink base dir: %+v", err)
+				t.Fatalf("Failed to create symlink base dir: %+v", err)
 			}
 		}
 
 		d := filepath.Dir(linkNew)
 		if err := os.MkdirAll(d, 0o750); err != nil {
-			t.Fatal("failed to create symlink new dir", err)
+			t.Fatal("Failed to create symlink new dir", err)
 		}
 
 		if err := os.Symlink(linkOld, linkNew); err != nil {
-			t.Fatal("failed to create symlink from old to new", err)
+			t.Fatal("Failed to create symlink from old to new", err)
 		}
 	}
 }
@@ -823,7 +823,7 @@ func createDirs(t *testing.T, base string, dirs []string) {
 func TestCDIDeviceInclusion(t *testing.T) {
 	root, err := os.MkdirTemp("", "test_cdidevice")
 	if err != nil {
-		t.Fatalf("can't create temporary directory: %+v", err)
+		t.Fatalf("Can't create temporary directory: %+v", err)
 	}
 	// dirs/files need to be removed for the next test
 	defer os.RemoveAll(root)
@@ -878,7 +878,7 @@ func TestCDIDeviceInclusion(t *testing.T) {
 	tree, err := plugin.scan()
 
 	if err != nil {
-		t.Error("failed to get device id for card")
+		t.Error("Failed to get device id for card")
 	}
 
 	refTree := dpapi.NewDeviceTree()
@@ -954,13 +954,13 @@ func TestCDIDeviceInclusion(t *testing.T) {
 	}))
 
 	if !reflect.DeepEqual(tree, refTree) {
-		t.Error("received device tree isn't expected\n", tree, "\n", refTree)
+		t.Error("Received device tree isn't expected\n", tree, "\n", refTree)
 	}
 
 	if tree.DeviceTypeCount("i915") != 1 {
-		t.Error("invalid count for device (i915)")
+		t.Error("Invalid count for device (i915)")
 	}
 	if tree.DeviceTypeCount("xe") != 1 {
-		t.Error("invalid count for device (xe)")
+		t.Error("Invalid count for device (xe)")
 	}
 }