From db5fec022e448d6723420f6e46b1b1d0e05e179d Mon Sep 17 00:00:00 2001
From: Achilleas Koutsou <achilleas@koutsou.net>
Date: Fri, 29 Nov 2024 13:07:52 +0100
Subject: [PATCH] disk: update TestPartitionTableFeatures() to catch missing
 test case

Update the TestPartitionTableFeatures() to match other tests that use
the TestPartitionTables.

- Switch to require from assert to stop test execution if something
  fails.  This makes it easier to see the important error message.  With
  assert, execution would continue when `ok` is false, which would make
  the assert.Equal() test print an error too (exp would be an empty
  initialised struct of PartitionTableFeatures) and can make it hard to
  notice that the "expected test result not defined" error was printed
  first.
- Use a map for testCases so we can get each test case by name (the
  order is not important).
- Print the same error message as the other similar tests, using
  t.Name() to refer to the test function name.
- Add plain-noboot test case, which was missing from the test.
---
 pkg/disk/partition_table_test.go | 32 ++++++++++++++++++--------------
 1 file changed, 18 insertions(+), 14 deletions(-)

diff --git a/pkg/disk/partition_table_test.go b/pkg/disk/partition_table_test.go
index 2924a5f00b..7377bf5cac 100644
--- a/pkg/disk/partition_table_test.go
+++ b/pkg/disk/partition_table_test.go
@@ -5,6 +5,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 
 	"github.com/osbuild/images/internal/testdisk"
 	"github.com/osbuild/images/pkg/blueprint"
@@ -2284,21 +2285,24 @@ func TestNewCustomPartitionTableErrors(t *testing.T) {
 }
 
 func TestPartitionTableFeatures(t *testing.T) {
-	type testCase struct {
-		partitionType    string
-		expectedFeatures disk.PartitionTableFeatures
-	}
-	testCases := []testCase{
-		{"plain", disk.PartitionTableFeatures{XFS: true, FAT: true}},
-		{"plain-swap", disk.PartitionTableFeatures{XFS: true, FAT: true, Swap: true}},
-		{"luks", disk.PartitionTableFeatures{XFS: true, FAT: true, LUKS: true}},
-		{"luks+lvm", disk.PartitionTableFeatures{XFS: true, FAT: true, LUKS: true, LVM: true}},
-		{"btrfs", disk.PartitionTableFeatures{XFS: true, FAT: true, Btrfs: true}},
-	}
+	require := require.New(t)
 
-	for _, tc := range testCases {
-		pt := testdisk.TestPartitionTables[tc.partitionType]
-		assert.Equal(t, tc.expectedFeatures, disk.GetPartitionTableFeatures(pt))
+	testCases := map[string]disk.PartitionTableFeatures{
+		"plain":        {XFS: true, FAT: true},
+		"plain-noboot": {XFS: true, FAT: true},
+		"plain-swap":   {XFS: true, FAT: true, Swap: true},
+		"luks":         {XFS: true, FAT: true, LUKS: true},
+		"luks+lvm":     {XFS: true, FAT: true, LUKS: true, LVM: true},
+		"btrfs":        {XFS: true, FAT: true, Btrfs: true},
+	}
 
+	for name := range testdisk.TestPartitionTables {
+		// print an informative failure message if a new test partition
+		// table is added and this test is not updated (instead of failing
+		// at the final Equal() check)
+		exp, ok := testCases[name]
+		require.True(ok, "expected test result not defined for test partition table %q: please update the %s test", name, t.Name())
+		pt := testdisk.TestPartitionTables[name]
+		require.Equal(exp, disk.GetPartitionTableFeatures(pt))
 	}
 }