gadget/install/encrypt.go: rename newEncrypt... to createEncrypt...

Thanks to Alberto for the suggestion. Signed-off-by: Ian Johnson <ian.johnson@canonical.com>
olivercalder · Mar 25, 2022 · f06e06f · f06e06f
1 parent 5ea5784
commit f06e06f
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/gadget/install/encrypt.go b/gadget/install/encrypt.go
@@ -118,9 +118,9 @@ type encryptedDeviceWithSetupHook struct {
 // sanity
 var _ = encryptedDevice(&encryptedDeviceWithSetupHook{})
 
-// newEncryptedDeviceWithSetupHook creates an encrypted device in the
+// createEncryptedDeviceWithSetupHook creates an encrypted device in the
 // existing partition using the specified key using the fde-setup hook
-func newEncryptedDeviceWithSetupHook(part *gadget.OnDiskStructure, key secboot.EncryptionKey, name string) (encryptedDevice, error) {
+func createEncryptedDeviceWithSetupHook(part *gadget.OnDiskStructure, key secboot.EncryptionKey, name string) (encryptedDevice, error) {
 	// for roles requiring encryption, the filesystem label is always set to
 	// either the implicit value or a value that has been validated
 	if part.Name != name || part.Label != name {

diff --git a/gadget/install/encrypt_test.go b/gadget/install/encrypt_test.go
@@ -196,7 +196,7 @@ var mockDeviceStructureForDeviceSetupHook = gadget.OnDiskStructure{
 	Node: "/dev/node1",
 }
 
-func (s *encryptSuite) TestNewEncryptedDeviceWithSetupHook(c *C) {
+func (s *encryptSuite) TestCreateEncryptedDeviceWithSetupHook(c *C) {
 
 	for _, tc := range []struct {
 		mockedOpenErr            string
@@ -234,7 +234,7 @@ func (s *encryptSuite) TestNewEncryptedDeviceWithSetupHook(c *C) {
 		mockDmsetup := testutil.MockCommand(c, "dmsetup", script)
 		s.AddCleanup(mockDmsetup.Restore)
 
-		dev, err := install.NewEncryptedDeviceWithSetupHook(&mockDeviceStructureForDeviceSetupHook,
+		dev, err := install.CreateEncryptedDeviceWithSetupHook(&mockDeviceStructureForDeviceSetupHook,
 			s.mockedEncryptionKey, "ubuntu-data")
 		if tc.expectedErr == "" {
 			c.Assert(err, IsNil)
@@ -258,7 +258,7 @@ func (s *encryptSuite) TestNewEncryptedDeviceWithSetupHook(c *C) {
 	}
 }
 
-func (s *encryptSuite) TestNewEncryptedDeviceWithSetupHookPartitionNameCheck(c *C) {
+func (s *encryptSuite) TestCreateEncryptedDeviceWithSetupHookPartitionNameCheck(c *C) {
 	mockDeviceStructureBadName := gadget.OnDiskStructure{
 		LaidOutStructure: gadget.LaidOutStructure{
 			VolumeStructure: &gadget.VolumeStructure{
@@ -282,7 +282,7 @@ func (s *encryptSuite) TestNewEncryptedDeviceWithSetupHookPartitionNameCheck(c *
 	s.AddCleanup(mockDmsetup.Restore)
 
 	// pass a name that does not match partition name
-	dev, err := install.NewEncryptedDeviceWithSetupHook(&mockDeviceStructureBadName,
+	dev, err := install.CreateEncryptedDeviceWithSetupHook(&mockDeviceStructureBadName,
 		s.mockedEncryptionKey, "some-name")
 	c.Assert(err, ErrorMatches, `cannot use partition name "some-name" for an encrypted structure with system-data role and filesystem with label "ubuntu-data"`)
 	c.Check(dev, IsNil)
@@ -291,7 +291,7 @@ func (s *encryptSuite) TestNewEncryptedDeviceWithSetupHookPartitionNameCheck(c *
 	// the implicit value or has already been validated and matches what is
 	// expected for the particular role
 	mockDeviceStructureBadName.Name = "bad-name"
-	dev, err = install.NewEncryptedDeviceWithSetupHook(&mockDeviceStructureBadName,
+	dev, err = install.CreateEncryptedDeviceWithSetupHook(&mockDeviceStructureBadName,
 		s.mockedEncryptionKey, "bad-name")
 	c.Assert(err, ErrorMatches, `cannot use partition name "bad-name" for an encrypted structure with system-data role and filesystem with label "ubuntu-data"`)
 	c.Check(dev, IsNil)
@@ -309,7 +309,7 @@ func (s *encryptSuite) TestAddRecoveryKeyDeviceWithSetupHook(c *C) {
 	mockDmsetup := testutil.MockCommand(c, "dmsetup", "")
 	s.AddCleanup(mockDmsetup.Restore)
 
-	dev, err := install.NewEncryptedDeviceWithSetupHook(&mockDeviceStructureForDeviceSetupHook,
+	dev, err := install.CreateEncryptedDeviceWithSetupHook(&mockDeviceStructureForDeviceSetupHook,
 		s.mockedEncryptionKey, "ubuntu-data")
 	c.Assert(err, IsNil)
 	c.Check(setupReq.Device, Equals, "/dev/mapper/ubuntu-data")

diff --git a/gadget/install/export_secboot_test.go b/gadget/install/export_secboot_test.go
@@ -28,9 +28,9 @@ import (
 )
 
 var (
-	DiskWithSystemSeed              = diskWithSystemSeed
-	NewEncryptedDeviceLUKS          = newEncryptedDeviceLUKS
-	NewEncryptedDeviceWithSetupHook = newEncryptedDeviceWithSetupHook
+	DiskWithSystemSeed                 = diskWithSystemSeed
+	NewEncryptedDeviceLUKS             = newEncryptedDeviceLUKS
+	CreateEncryptedDeviceWithSetupHook = createEncryptedDeviceWithSetupHook
 )
 
 func MockSecbootFormatEncryptedDevice(f func(key secboot.EncryptionKey, label, node string) error) (restore func()) {

diff --git a/gadget/install/install.go b/gadget/install/install.go
@@ -204,7 +204,7 @@ func Run(model gadget.Model, gadgetRoot, kernelRoot, bootDevice string, options
 				}
 			case secboot.EncryptionTypeDeviceSetupHook:
 				timings.Run(perfTimings, fmt.Sprintf("new-encrypted-device-setup-hook[%s]", roleOrLabelOrName(part)), fmt.Sprintf("Create encryption device for %s using device-setup-hook", roleOrLabelOrName(part)), func(timings.Measurer) {
-					dataPart, err = newEncryptedDeviceWithSetupHook(&part, keys.Key, part.Name)
+					dataPart, err = createEncryptedDeviceWithSetupHook(&part, keys.Key, part.Name)
 				})
 				if err != nil {
 					return nil, err